Package org.lwjgl.vulkan

Class KHRExternalSemaphoreWin32

java.lang.Object

org.lwjgl.vulkan.KHRExternalSemaphoreWin32

public class KHRExternalSemaphoreWin32
extends java.lang.Object

An application using external memory may wish to synchronize access to that memory using semaphores. This extension enables an application to export semaphore payload to and import semaphore payload from Windows handles.

Name String

VK_KHR_external_semaphore_win32

Extension Type

Device extension

Registered Extension Number

79

Revision

1

Extension and Version Dependencies

• Requires Vulkan 1.0
• Requires VK_KHR_external_semaphore

Contact

• James Jones cubanismo

Last Modified Date

2016-10-21

IP Status

No known IP claims.

Contributors

• James Jones, NVIDIA
• Jeff Juliano, NVIDIA
• Carsten Rohde, NVIDIA

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	VK_KHR_EXTERNAL_SEMAPHORE_WIN32_EXTENSION_NAME	The extension name.
static int	VK_KHR_EXTERNAL_SEMAPHORE_WIN32_SPEC_VERSION	The extension specification version.
static int	VK_STRUCTURE_TYPE_D3D12_FENCE_SUBMIT_INFO_KHR VK_STRUCTURE_TYPE_EXPORT_SEMAPHORE_WIN32_HANDLE_INFO_KHR VK_STRUCTURE_TYPE_IMPORT_SEMAPHORE_WIN32_HANDLE_INFO_KHR VK_STRUCTURE_TYPE_SEMAPHORE_GET_WIN32_HANDLE_INFO_KHR	Extends VkStructureType.

Method Summary

Modifier and Type	Method	Description
static int	nvkGetSemaphoreWin32HandleKHR(VkDevice device, long pGetWin32HandleInfo, long pHandle)	Unsafe version of: GetSemaphoreWin32HandleKHR
static int	nvkImportSemaphoreWin32HandleKHR(VkDevice device, long pImportSemaphoreWin32HandleInfo)	Unsafe version of: ImportSemaphoreWin32HandleKHR
static int	vkGetSemaphoreWin32HandleKHR(VkDevice device, VkSemaphoreGetWin32HandleInfoKHR pGetWin32HandleInfo, org.lwjgl.PointerBuffer pHandle)	Get a Windows HANDLE for a semaphore.
static int	vkImportSemaphoreWin32HandleKHR(VkDevice device, VkImportSemaphoreWin32HandleInfoKHR pImportSemaphoreWin32HandleInfo)	Import a semaphore from a Windows HANDLE.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

VK_KHR_EXTERNAL_SEMAPHORE_WIN32_SPEC_VERSION

The extension specification version.

VK_KHR_EXTERNAL_SEMAPHORE_WIN32_EXTENSION_NAME

The extension name.

VK_STRUCTURE_TYPE_IMPORT_SEMAPHORE_WIN32_HANDLE_INFO_KHR, VK_STRUCTURE_TYPE_EXPORT_SEMAPHORE_WIN32_HANDLE_INFO_KHR, VK_STRUCTURE_TYPE_D3D12_FENCE_SUBMIT_INFO_KHR, VK_STRUCTURE_TYPE_SEMAPHORE_GET_WIN32_HANDLE_INFO_KHR

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_IMPORT_SEMAPHORE_WIN32_HANDLE_INFO_KHR
• STRUCTURE_TYPE_EXPORT_SEMAPHORE_WIN32_HANDLE_INFO_KHR
• STRUCTURE_TYPE_D3D12_FENCE_SUBMIT_INFO_KHR
• STRUCTURE_TYPE_SEMAPHORE_GET_WIN32_HANDLE_INFO_KHR

Method Detail

nvkImportSemaphoreWin32HandleKHR

public static int nvkImportSemaphoreWin32HandleKHR(VkDevice device,
                                                   long pImportSemaphoreWin32HandleInfo)

Unsafe version of: ImportSemaphoreWin32HandleKHR

vkImportSemaphoreWin32HandleKHR

public static int vkImportSemaphoreWin32HandleKHR(VkDevice device,
                                                  VkImportSemaphoreWin32HandleInfoKHR pImportSemaphoreWin32HandleInfo)

Import a semaphore from a Windows HANDLE.

C Specification

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

 VkResult vkImportSemaphoreWin32HandleKHR(
     VkDevice                                    device,
     const VkImportSemaphoreWin32HandleInfoKHR*  pImportSemaphoreWin32HandleInfo);

Description

Importing a semaphore 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 semaphore 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 (Implicit)

• device must be a valid VkDevice handle
• pImportSemaphoreWin32HandleInfo must be a valid pointer to a valid VkImportSemaphoreWin32HandleInfoKHR 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

VkImportSemaphoreWin32HandleInfoKHR

Parameters:

device - the logical device that created the semaphore.

pImportSemaphoreWin32HandleInfo - points to a VkImportSemaphoreWin32HandleInfoKHR structure specifying the semaphore and import parameters.

nvkGetSemaphoreWin32HandleKHR

public static int nvkGetSemaphoreWin32HandleKHR(VkDevice device,
                                                long pGetWin32HandleInfo,
                                                long pHandle)

Unsafe version of: GetSemaphoreWin32HandleKHR

vkGetSemaphoreWin32HandleKHR

public static int vkGetSemaphoreWin32HandleKHR(VkDevice device,
                                               VkSemaphoreGetWin32HandleInfoKHR pGetWin32HandleInfo,
                                               org.lwjgl.PointerBuffer pHandle)

Get a Windows HANDLE for a semaphore.

C Specification

To export a Windows handle representing the payload of a semaphore, call:

 VkResult vkGetSemaphoreWin32HandleKHR(
     VkDevice                                    device,
     const VkSemaphoreGetWin32HandleInfoKHR*     pGetWin32HandleInfo,
     HANDLE*                                     pHandle);

Description

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)

• device must be a valid VkDevice handle
• pGetWin32HandleInfo must be a valid pointer to a valid VkSemaphoreGetWin32HandleInfoKHR 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

VkSemaphoreGetWin32HandleInfoKHR

Parameters:

device - the logical device that created the semaphore being exported.

pGetWin32HandleInfo - a pointer to an instance of the VkSemaphoreGetWin32HandleInfoKHR structure containing parameters of the export operation.

pHandle - will return the Windows handle representing the semaphore state.