VKQUEUEWAITIDLE(3)

NAME
vkQueueWaitIdle - Wait for a queue to become idle.

C SPECIFICATION

    VkResult vkQueueWaitIdle(
        VkQueue                                     queue);

PARAMETERS

queue
    A handle to the queue that is to become idle.

DESCRIPTION

vkQueueWaitIdle waits for all work submitted to the specified queue to complete and for the queue to become idle. After the queue becomes idle, the following guarantees are made:

    • Any command buffers previously submitted to the queue have completed execution.

    • Any events set or reset by command buffers submitted to that queue will be in their new state.

    • Any semaphores signaled by previous calls to vkQueueSubmit will have reached signaled state.

VALID USAGE

    • queue must be a valid VkQueue handle

COMMAND PROPERTIES
Command Buffer Levels | Render Pass Scope | Supported Queue Types
- | - | Any

RETURN CODES

On success, this command returns

        • VK_SUCCESS

On failure, this command returns

        • VK_ERROR_OUT_OF_HOST_MEMORY

        • VK_ERROR_OUT_OF_DEVICE_MEMORY

        • VK_ERROR_DEVICE_LOST

SEE ALSO

vkDeviceWaitIdle, vkQueueSubmit

COPYRIGHT

Copyright © 2014-2016 Khronos Group. This material may be distributed subject to the terms and conditions set forth in the Open Publication License, v 1.0, 8 June 1999. http://opencontent.org/openpub/.

AUTHOR

Khronos Group
    Author.