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

61 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/
vkCreateEvent(3)
================
Name
----
vkCreateEvent - Create a new event object.
C Specification
---------------
// refBegin vkCreateEvent Create a new event object.
To create an event, call:
include::../api/protos/vkCreateEvent.txt[]
Parameters
----------
* pname:device is the logical device that creates the event.
* pname:pCreateInfo is a pointer to an instance of the
sname:VkEventCreateInfo structure which contains information about how
the event is to be created.
* pname:pAllocator controls host memory allocation as described in the
<<memory-allocation, Memory Allocation>> chapter.
* pname:pEvent points to a handle in which the resulting event object is
returned.
Description
-----------
When created, the event object is in the unsignaled state.
include::../validity/protos/vkCreateEvent.txt[]
See Also
--------
slink:VkAllocationCallbacks, slink:VkDevice, slink:VkEvent, slink:VkEventCreateInfo
Document Notes
--------------
For more information, see the Vulkan Specification at URL
https://www.khronos.org/registry/vulkan/specs/1.0/xhtml/vkspec.html#vkCreateEvent
This page is extracted from the Vulkan Specification.
Fixes and changes should be made to the Specification,not directly.
include::footer.txt[]