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

54 lines
1.4 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/
VkEvent(3)
==========
Name
----
VkEvent - Opaque handle to a event object
C Specification
---------------
// refBegin VkEvent - Opaque handle to a event object
Events represent a fine-grained synchronization primitive that can: be used
to gauge progress through a sequence of commands executed on a queue by
Vulkan. An event is initially in the unsignaled state. It can: be
signaled by a device, using commands inserted into the command buffer, or by
the host. It can: also be reset to the unsignaled state by a device or the
host. The host can: query the state of an event. A device can: wait for one
or more events to become signaled.
Events are represented by sname:VkEvent handles:
include::../handles/VkEvent.txt[]
Description
-----------
// refEnd VkEvent
See Also
--------
flink:vkCmdResetEvent, flink:vkCmdSetEvent, flink:vkCmdWaitEvents, flink:vkCreateEvent, flink:vkDestroyEvent, flink:vkGetEventStatus, flink:vkResetEvent, flink:vkSetEvent
Document Notes
--------------
For more information, see the Vulkan Specification at URL
https://www.khronos.org/registry/vulkan/specs/1.0/xhtml/vkspec.html#VkEvent
This page is extracted from the Vulkan Specification.
Fixes and changes should be made to the Specification,not directly.
include::footer.txt[]