Function Prototype
vkGetSemaphoreWin32HandleKHR
Get a Windows HANDLE for a semaphore
To export a Windows handle representing the payload of a semaphore, call:
VkResult vkGetSemaphoreWin32HandleKHR(
VkDevice device,
const VkSemaphoreGetWin32HandleInfoKHR* pGetWin32HandleInfo,
HANDLE* pHandle);
device
is the logical device that created the semaphore being exported.pGetWin32HandleInfo
is a pointer to a VkSemaphoreGetWin32HandleInfoKHR structure containing parameters of the export operation.pHandle
will return the Windows handle representing the semaphore state.
For handle types defined as NT handles, the handles returned by
vkGetSemaphoreWin32HandleKHR
are owned by the application.
To avoid leaking resources, the application must release ownership of them
using the CloseHandle
system call when they are no longer needed.
Exporting a Windows handle from a semaphore may have side effects depending on the transference of the specified handle type, as described in Importing Semaphore Payloads.
Valid Usage (Implicit)
VUID-vkGetSemaphoreWin32HandleKHR-device-parameter
device
must be a valid VkDevice handle
VUID-vkGetSemaphoreWin32HandleKHR-pGetWin32HandleInfo-parameter
pGetWin32HandleInfo
must be a valid pointer to a valid VkSemaphoreGetWin32HandleInfoKHR structure
VUID-vkGetSemaphoreWin32HandleKHR-pHandle-parameter
pHandle
must be a valid pointer to a HANDLE
value