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

40 lines
1.0 KiB
Plaintext
Raw Normal View History

2016-02-16 09:53:44 +00:00
vkGetEventStatus(3)
===================
Name
----
vkGetEventStatus - Retrieve the status of an event object.
C Specification
---------------
include::../protos/vkGetEventStatus.txt[]
Parameters
----------
pname:device::
Logical device which owns the event.
pname:event::
A handle to the event whose status to retrieve.
Description
-----------
fname:vkGetEventStatus retrieves the status of the event object specified in pname:event. Event
objects cannot be directly waited for by the host although it is possible to wait within a command
buffer for an event to become signaled by calling flink:vkCmdWaitEvents. Events are set
from within a command buffer by calling flink:vkCmdSetEvent and may be reset by calling
flink:vkCmdResetEvent. On the host, events may be set and reset by calling flink:vkSetEvent
and flink:vkResetEvent, respectively.
include::../validity/protos/vkGetEventStatus.txt[]
See Also
--------
flink:vkSetEvent, flink:vkResetEvent, flink:vkCmdSetEvent, flink:vkCmdResetEvent, flink:vkCmdWaitEvents
include::footer.txt[]