VKGETFENCESTATUS(3)

NAME
vkGetFenceStatus - Return the status of a fence

C SPECIFICATION

To query the status of a fence from the host, use the command

    VkResult vkGetFenceStatus(
        VkDevice                                    device,
        VkFence                                     fence);

PARAMETERS

    • device is the logical device that owns the fence.

    • fence is the handle of the fence to query.

DESCRIPTION

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

    • VK_SUCCESS indicates that the fence is signaled.

    • VK_NOT_READY indicates that the fence is unsignaled.
Valid Usage (Implicit)

    • device must be a valid VkDevice handle

    • fence must be a valid VkFence handle

    • fence must have been created, allocated, or retrieved from device
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

SEE ALSO

VkDevice, VkFence

DOCUMENT NOTES

For more information, see the Vulkan Specification at URL

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

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.