Vulkan-Docs/doc/specs/vulkan/man/vkGetFenceStatus.txt

59 lines
1.3 KiB
Plaintext

// Copyright (c) 2014-2016 Khronos Group. This work is licensed under a
// Creative Commons Attribution 4.0 International License; see
// http://creativecommons.org/licenses/by/4.0/
vkGetFenceStatus(3)
===================
Name
----
vkGetFenceStatus - Return the status of a fence.
C Specification
---------------
// refBegin vkGetFenceStatus Return the status of a fence.
To query the status of a fence from the host, use the command
include::../api/protos/vkGetFenceStatus.txt[]
Parameters
----------
* pname:device is the logical device that owns the fence.
* pname:fence is the handle of the fence to query.
Description
-----------
Upon success, fname:vkGetFenceStatus returns the status of the fence,
which is one of:
* ename:VK_SUCCESS indicates that the fence is signaled.
* ename:VK_NOT_READY indicates that the fence is unsignaled.
include::../validity/protos/vkGetFenceStatus.txt[]
See Also
--------
slink:VkDevice, slink: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.
include::footer.txt[]