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

53 lines
1.4 KiB
Plaintext

vkCreateEvent(3)
=================
Name
----
vkCreateEvent - Create a new event object.
C Specification
---------------
include::../protos/vkCreateEvent.txt[]
Parameters
----------
pname:device::
A handle to the device with which to create the event.
pname:pCreateInfo::
A pointer to the creation info structure.
pname:pEvent::
The address of an VK_EVENT variable that will receive the handle to the new event.
Description
-----------
fname:vkCreateEvent creates a new event object using the device specified as
pname:device. A handle to the newly created event object is placed the
variable pointed to by pname:pEvent. pname:pCreateInfo is a pointer to an
instance of a slink:VkEventCreateInfo structure containing information about
the state in which to create the new object. The definition of
slink:VkEventCreateInfo is:
include::../structs/VkEventCreateInfo.txt[]
The pname:sType member of the slink:VkEventCreateInfo structure should be set to
ename:VK_STRUCTURE_TYPE_EVENT_CREATE_INFO. The pname:pNext member is reserved
for use by extensions and should be set to code:NULL.
The pname:flags member specifies additional information about the event to be
created. There are presently no flags defined for this member and it should be
set to zero.
include::../validity/protos/vkCreateEvent.txt[]
See Also
--------
flink:vkSetEvent, flink:vkResetEvent, flink:vkCmdSetEvent, flink:vkCmdResetEvent
include::footer.txt[]