vkCreateSemaphore - Create a new queue semaphore object

Valid Usage (Implicit)

• device must be a valid Device handle

• pCreateInfo must be a valid pointer to a valid SemaphoreCreateInfo structure
• If pAllocator is not NULL, pAllocator must be a valid pointer to a valid AllocationCallbacks structure
• pSemaphore must be a valid pointer to a Semaphore handle

Return Codes

Success

• SUCCESS

Failure

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY

See Also

VK_VERSION_1_0, AllocationCallbacks, Device, Semaphore, SemaphoreCreateInfo

A convenience wrapper to make a compatible pair of calls to createSemaphore and destroySemaphore

To ensure that destroySemaphore is always called: pass bracket (or the allocate function from your favourite resource management library) as the last argument. To just extract the pair pass (,) as the last argument.

vkDestroySemaphore - Destroy a semaphore object

Valid Usage

• All submitted batches that refer to semaphore must have completed execution

• If AllocationCallbacks were provided when semaphore was created, a compatible set of callbacks must be provided here
• If no AllocationCallbacks were provided when semaphore was created, pAllocator must be NULL

Valid Usage (Implicit)

• device must be a valid Device handle

• If semaphore is not NULL_HANDLE, semaphore must be a valid Semaphore handle
• If pAllocator is not NULL, pAllocator must be a valid pointer to a valid AllocationCallbacks structure
• If semaphore is a valid handle, it must have been created, allocated, or retrieved from device

Host Synchronization

• Host access to semaphore must be externally synchronized

See Also

VK_VERSION_1_0, AllocationCallbacks, Device, Semaphore

VkSemaphoreCreateInfo - Structure specifying parameters of a newly created semaphore

Valid Usage

• If the pNext chain includes a ExportMetalObjectCreateInfoEXT structure, its exportObjectType member must be EXPORT_METAL_OBJECT_TYPE_METAL_SHARED_EVENT_BIT_EXT

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_SEMAPHORE_CREATE_INFO

• Each pNext member of any structure (including this one) in the pNext chain must be either NULL or a pointer to a valid instance of ExportMetalObjectCreateInfoEXT, ExportSemaphoreCreateInfo, ExportSemaphoreWin32HandleInfoKHR, ImportMetalSharedEventInfoEXT, QueryLowLatencySupportNV, or SemaphoreTypeCreateInfo
• The sType value of each struct in the pNext chain must be unique, with the exception of structures of type ExportMetalObjectCreateInfoEXT
• flags must be 0

See Also

VK_VERSION_1_0, SemaphoreCreateFlags, StructureType, createSemaphore

VkSemaphore - Opaque handle to a semaphore object

See Also

VK_VERSION_1_0, AcquireNextImageInfoKHR, BindSparseInfo, ExportMetalSharedEventInfoEXT, ImportSemaphoreFdInfoKHR, ImportSemaphoreWin32HandleInfoKHR, ImportSemaphoreZirconHandleInfoFUCHSIA, LatencySleepInfoNV, PresentInfoKHR, SemaphoreGetFdInfoKHR, SemaphoreGetWin32HandleInfoKHR, SemaphoreGetZirconHandleInfoFUCHSIA, SemaphoreSignalInfo, SemaphoreSubmitInfo, SemaphoreWaitInfo, SubmitInfo, acquireNextImageKHR, createSemaphore, destroySemaphore, getSemaphoreCounterValue, getSemaphoreCounterValueKHR

VkSemaphoreCreateFlags - Reserved for future use

Description

SemaphoreCreateFlags is a bitmask type for setting a mask, but is currently reserved for future use.

See Also

VK_VERSION_1_0, SemaphoreCreateInfo