public Class KHRExternalFenceWin32

The extension name.

The extension specification version.

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_IMPORT_FENCE_WIN32_HANDLE_INFO_KHR
• STRUCTURE_TYPE_EXPORT_FENCE_WIN32_HANDLE_INFO_KHR
• STRUCTURE_TYPE_FENCE_GET_WIN32_HANDLE_INFO_KHR

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_IMPORT_FENCE_WIN32_HANDLE_INFO_KHR
• STRUCTURE_TYPE_EXPORT_FENCE_WIN32_HANDLE_INFO_KHR
• STRUCTURE_TYPE_FENCE_GET_WIN32_HANDLE_INFO_KHR

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_IMPORT_FENCE_WIN32_HANDLE_INFO_KHR
• STRUCTURE_TYPE_EXPORT_FENCE_WIN32_HANDLE_INFO_KHR
• STRUCTURE_TYPE_FENCE_GET_WIN32_HANDLE_INFO_KHR

Unsafe version of: GetFenceWin32HandleKHR

Unsafe version of: ImportFenceWin32HandleKHR

Get a Windows HANDLE for a fence.

C Specification

To export a Windows handle representing the state of a fence, call:

VkResult vkGetFenceWin32HandleKHR(
    VkDevice                                    device,
    const VkFenceGetWin32HandleInfoKHR*         pGetWin32HandleInfo,
    HANDLE*                                     pHandle);

Description

For handle types defined as NT handles, the handles returned by vkGetFenceWin32HandleKHR 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 fence may have side effects depending on the transference of the specified handle type, as described in Importing Fence Payloads.

Valid Usage (Implicit)

• device must be a valid VkDevice handle
• pGetWin32HandleInfo must be a valid pointer to a valid VkFenceGetWin32HandleInfoKHR structure
• pHandle must be a valid pointer to a HANDLE value

Return Codes

On success, this command returns

• SUCCESS

On failure, this command returns

• ERROR_TOO_MANY_OBJECTS
• ERROR_OUT_OF_HOST_MEMORY

See Also

VkFenceGetWin32HandleInfoKHR

Parameters

device:VkDevice

the logical device that created the fence being exported.

pGetWin32HandleInfo:VkFenceGetWin32HandleInfoKHR

a pointer to a VkFenceGetWin32HandleInfoKHR structure containing parameters of the export operation.

pHandle:PointerBuffer

will return the Windows handle representing the fence state.

Annotations

@NativeType:VkResult

Import a fence from a Windows HANDLE.

C Specification

To import a fence payload from a Windows handle, call:

VkResult vkImportFenceWin32HandleKHR(
    VkDevice                                    device,
    const VkImportFenceWin32HandleInfoKHR*      pImportFenceWin32HandleInfo);

Description

Importing a fence payload from Windows handles does not transfer ownership of the handle to the Vulkan implementation. For handle types defined as NT handles, the application must release ownership using the CloseHandle system call when the handle is no longer needed.

Applications can import the same fence payload into multiple instances of Vulkan, into the same instance from which it was exported, and multiple times into a given Vulkan instance.

Valid Usage

• fence must not be associated with any queue command that has not yet completed execution on that queue

Valid Usage (Implicit)

• device must be a valid VkDevice handle
• pImportFenceWin32HandleInfo must be a valid pointer to a valid VkImportFenceWin32HandleInfoKHR structure

Return Codes

On success, this command returns

• SUCCESS

On failure, this command returns

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_INVALID_EXTERNAL_HANDLE

See Also

VkImportFenceWin32HandleInfoKHR

Parameters

device:VkDevice

the logical device that created the fence.

pImportFenceWin32HandleInfo:VkImportFenceWin32HandleInfoKHR

a pointer to a VkImportFenceWin32HandleInfoKHR structure specifying the fence and import parameters.

Annotations

@NativeType:VkResult