mirror of
https://github.com/status-im/Vulkan-Docs.git
synced 2025-01-12 06:54:14 +00:00
58 lines
1.7 KiB
Plaintext
58 lines
1.7 KiB
Plaintext
|
vkCreateSemaphore(3)
|
||
|
|
=====================
|
||
|
|
|
||
|
|
Name
|
||
|
|
----
|
||
|
|
vkCreateSemaphore - Create a new queue semaphore object.
|
||
|
|
|
||
|
|
C Specification
|
||
|
|
---------------
|
||
|
|
|
||
|
|
include::../protos/vkCreateSemaphore.txt[]
|
||
|
|
|
||
|
|
Parameters
|
||
|
|
----------
|
||
|
|
|
||
|
|
pname:device::
|
||
|
|
The device with which to create the queue semaphore object.
|
||
|
|
|
||
|
|
pname:pCreateInfo::
|
||
|
|
A pointer to a structure containing information to be placed in the object.
|
||
|
|
|
||
|
|
pname:pSemaphore::
|
||
|
|
A pointer to a variable which will receive the handle to the new object.
|
||
|
|
|
||
|
|
Description
|
||
|
|
-----------
|
||
|
|
|
||
|
|
fname:vkCreateSemaphore creates a new queue semaphore object using the
|
||
|
|
information contained in pname:pCreateInfo and the device specified in
|
||
|
|
pname:device. Upon success, a handle to the new queue semaphore object is
|
||
|
|
deposited in the variable pointed to by pname:pSemaphore. pname:pCreateInfo
|
||
|
|
should point to an instance of the slink:VkSemaphoreCreateInfo structure,
|
||
|
|
the definition of which is:
|
||
|
|
|
||
|
|
include::../structs/VkSemaphoreCreateInfo.txt[]
|
||
|
|
|
||
|
|
The pname:sType member of the sname:VkSemaphoreCreateInfo structure should be
|
||
|
|
set to ename:VK_STRUCTURE_TYPE_SEMAPHORE_CREATE_INFO. The pname:pNext member
|
||
|
|
is reserved for use by extensions and should be set to code:NULL.
|
||
|
|
|
||
|
|
The pname:flags member of the sname:VkSemaphoreCreateInfo structure pointed
|
||
|
|
to by pname:pCreateInfo contains flags defining the initial state and
|
||
|
|
behavior of the semaphore. Currently, no flags are defined.
|
||
|
|
|
||
|
|
// include::../enums/VkSemaphoreCreateFlagBits.txt[]
|
||
|
|
|
||
|
|
The semaphore is created in the unsignaled state and may be signaled by submitting
|
||
|
|
it to a queue through a call to flink:vkQueueSubmit.
|
||
|
|
|
||
|
|
include::../validity/protos/vkCreateSemaphore.txt[]
|
||
|
|
|
||
|
|
See Also
|
||
|
|
--------
|
||
|
|
|
||
|
|
flink:vkDestroySemaphore, flink:vkQueueSubmit
|
||
|
|
|
||
|
|
include::footer.txt[]
|