VKGETFENCESTATUS(3)

NAME
vkGetFenceStatus - Return the status of a fence.

C SPECIFICATION

    VkResult vkGetFenceStatus(
        VkDevice                                    device,
        VkFence                                     fence);

PARAMETERS

device
    Logical device which owns fence.

fence
    The fence whose status to return.

DESCRIPTION

vkGetFenceStatus returns the immediate status of the fence whose handle is given in fence. Fences are initially created in the unsignaled state and are associated with submissions to queues through a call to vkQueueSubmit. Fences are signaled by the system when work invoked by vkQueueSubmit completes. Fences may subsequently be reset by calling vkResetFences. To wait for one or more fences to become signaled, it is recommended that vkWaitForFences be used in preference to repeatedly polling vkGetFenceStatus.

VALID USAGE

    • device must be a valid VkDevice handle

    • fence must be a valid VkFence handle

    • fence must have been created, allocated or retrieved from device

    • Each of device and fence must have been created, allocated or retrieved from the same VkPhysicalDevice

RETURN CODES

On success, this command returns

        • VK_SUCCESS

        • VK_NOT_READY

On failure, this command returns

        • VK_ERROR_OUT_OF_HOST_MEMORY

        • VK_ERROR_OUT_OF_DEVICE_MEMORY

        • VK_ERROR_DEVICE_LOST

RETURN VALUE

Upon success, vkGetFenceStatus returns the status of the fence, which may be one of:

    • VK_SUCCESS indicates that the fence has completed (its status is signaled).

    • VK_NOT_READY indicates that the fence has not yet completed (its status is unsignaled).

Upon failure, a descriptive error code is returned.

SEE ALSO

vkCreateFence, vkWaitForFences, 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.