VKDEVICEWAITIDLE(3)

NAME
vkDeviceWaitIdle - Wait for a device to become idle

C SPECIFICATION

To wait on the host for the completion of outstanding queue operations for all queues on a given logical device, call:

    VkResult vkDeviceWaitIdle(
        VkDevice                                    device);

PARAMETERS

    • device is the logical device to idle.

DESCRIPTION

vkDeviceWaitIdle is equivalent to calling vkQueueWaitIdle for all queues owned by device. Valid Usage (Implicit)

    • device must be a valid VkDevice handle
Host Synchronization

    • Host access to all VkQueue objects created from device must be externally synchronized
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

VkDevice

DOCUMENT NOTES

For more information, see the Vulkan Specification at URL

https://www.khronos.org/registry/vulkan/specs/1.0/xhtml/vkspec.html#vkDeviceWaitIdle

This page is extracted from the Vulkan Specification. Fixes and changes should be made to the Specification,not directly.

COPYRIGHT

Copyright (c) 2014-2016 Khronos Group. This work is licensed under a Creative Commons Attribution 4.0 International License.

AUTHOR

Khronos Group
    Author.