VKDEVICEWAITIDLE(3)

NAME
vkDeviceWaitIdle - Wait for a device to become idle.

C SPECIFICATION

    VkResult vkDeviceWaitIdle(
        VkDevice                                    device);

PARAMETERS

device
    The handle to the device to idle.

DESCRIPTION

vkDeviceWaitIdle waits for the device specified by device to complete all work submitted by the application and become idle. It is logically equivalent to calling vkQueueWaitIdle on all queues associated with the device.

VALID USAGE

    • 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

vkQueueWaitIdle

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.