org.lwjgl.vulkan

Class KHRExternalSemaphoreFd

java.lang.Object

org.lwjgl.vulkan.KHRExternalSemaphoreFd

public class KHRExternalSemaphoreFd
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 POSIX file descriptors.

Name String

VK_KHR_external_semaphore_fd

Extension Type

Device extension

Registered Extension Number

80

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

• Jesse Hall, Google
• James Jones, NVIDIA
• Jeff Juliano, NVIDIA
• Carsten Rohde, NVIDIA

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	VK_KHR_EXTERNAL_SEMAPHORE_FD_EXTENSION_NAME The extension name.
static int	VK_KHR_EXTERNAL_SEMAPHORE_FD_SPEC_VERSION The extension specification version.
static int	VK_STRUCTURE_TYPE_IMPORT_SEMAPHORE_FD_INFO_KHR Extends VkStructureType.
static int	VK_STRUCTURE_TYPE_SEMAPHORE_GET_FD_INFO_KHR Extends VkStructureType.

Method Summary

Modifier and Type	Method and Description
static int	nvkGetSemaphoreFdKHR(org.lwjgl.vulkan.VkDevice device, long pGetFdInfo, long pFd) Unsafe version of: GetSemaphoreFdKHR
static int	nvkImportSemaphoreFdKHR(org.lwjgl.vulkan.VkDevice device, long pImportSemaphoreFdInfo) Unsafe version of: ImportSemaphoreFdKHR
static int	vkGetSemaphoreFdKHR(org.lwjgl.vulkan.VkDevice device, VkSemaphoreGetFdInfoKHR pGetFdInfo, int[] pFd) Array version of: GetSemaphoreFdKHR
static int	vkGetSemaphoreFdKHR(org.lwjgl.vulkan.VkDevice device, VkSemaphoreGetFdInfoKHR pGetFdInfo, java.nio.IntBuffer pFd) Get a POSIX file descriptor handle for a semaphore.
static int	vkImportSemaphoreFdKHR(org.lwjgl.vulkan.VkDevice device, VkImportSemaphoreFdInfoKHR pImportSemaphoreFdInfo) Import a semaphore from a POSIX file descriptor.

Methods inherited from class java.lang.Object

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

Field Detail

VK_KHR_EXTERNAL_SEMAPHORE_FD_SPEC_VERSION

public static final int VK_KHR_EXTERNAL_SEMAPHORE_FD_SPEC_VERSION

The extension specification version.

See Also:

Constant Field Values

VK_KHR_EXTERNAL_SEMAPHORE_FD_EXTENSION_NAME

public static final java.lang.String VK_KHR_EXTERNAL_SEMAPHORE_FD_EXTENSION_NAME

The extension name.

See Also:

Constant Field Values

VK_STRUCTURE_TYPE_IMPORT_SEMAPHORE_FD_INFO_KHR

public static final int VK_STRUCTURE_TYPE_IMPORT_SEMAPHORE_FD_INFO_KHR

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_IMPORT_SEMAPHORE_FD_INFO_KHR
• STRUCTURE_TYPE_SEMAPHORE_GET_FD_INFO_KHR

See Also:

Constant Field Values

VK_STRUCTURE_TYPE_SEMAPHORE_GET_FD_INFO_KHR

public static final int VK_STRUCTURE_TYPE_SEMAPHORE_GET_FD_INFO_KHR

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_IMPORT_SEMAPHORE_FD_INFO_KHR
• STRUCTURE_TYPE_SEMAPHORE_GET_FD_INFO_KHR

See Also:

Constant Field Values

Method Detail

nvkImportSemaphoreFdKHR

public static int nvkImportSemaphoreFdKHR(org.lwjgl.vulkan.VkDevice device,
                                          long pImportSemaphoreFdInfo)

Unsafe version of: ImportSemaphoreFdKHR

vkImportSemaphoreFdKHR

public static int vkImportSemaphoreFdKHR(org.lwjgl.vulkan.VkDevice device,
                                         VkImportSemaphoreFdInfoKHR pImportSemaphoreFdInfo)

Import a semaphore from a POSIX file descriptor.

C Specification

To import a semaphore payload from a POSIX file descriptor, call:

 VkResult vkImportSemaphoreFdKHR(
     VkDevice                                    device,
     const VkImportSemaphoreFdInfoKHR*           pImportSemaphoreFdInfo);

Description

Importing a semaphore payload from a file descriptor transfers ownership of the file descriptor from the application to the Vulkan implementation. The application must not perform any operations on the file descriptor after a successful import.

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

• semaphore 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
• pImportSemaphoreFdInfo must be a valid pointer to a valid VkImportSemaphoreFdInfoKHR 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

VkImportSemaphoreFdInfoKHR

Parameters:

device - the logical device that created the semaphore.

pImportSemaphoreFdInfo - a pointer to a VkImportSemaphoreFdInfoKHR structure specifying the semaphore and import parameters.

nvkGetSemaphoreFdKHR

public static int nvkGetSemaphoreFdKHR(org.lwjgl.vulkan.VkDevice device,
                                       long pGetFdInfo,
                                       long pFd)

Unsafe version of: GetSemaphoreFdKHR

vkGetSemaphoreFdKHR

public static int vkGetSemaphoreFdKHR(org.lwjgl.vulkan.VkDevice device,
                                      VkSemaphoreGetFdInfoKHR pGetFdInfo,
                                      java.nio.IntBuffer pFd)

Get a POSIX file descriptor handle for a semaphore.

C Specification

To export a POSIX file descriptor representing the payload of a semaphore, call:

 VkResult vkGetSemaphoreFdKHR(
     VkDevice                                    device,
     const VkSemaphoreGetFdInfoKHR*              pGetFdInfo,
     int*                                        pFd);

Description

Each call to vkGetSemaphoreFdKHR must create a new file descriptor and transfer ownership of it to the application. To avoid leaking resources, the application must release ownership of the file descriptor when it is no longer needed.

Note

Ownership can be released in many ways. For example, the application can call close() on the file descriptor, or transfer ownership back to Vulkan by using the file descriptor to import a semaphore payload.

Where supported by the operating system, the implementation must set the file descriptor to be closed automatically when an execve system call is made.

Exporting a file descriptor from a semaphore may have side effects depending on the transference of the specified handle type, as described in Importing Semaphore State.

Valid Usage (Implicit)

• device must be a valid VkDevice handle
• pGetFdInfo must be a valid pointer to a valid VkSemaphoreGetFdInfoKHR structure
• pFd must be a valid pointer to an int 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

VkSemaphoreGetFdInfoKHR

Parameters:

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

pGetFdInfo - a pointer to a VkSemaphoreGetFdInfoKHR structure containing parameters of the export operation.

pFd - will return the file descriptor representing the semaphore payload.

vkGetSemaphoreFdKHR

public static int vkGetSemaphoreFdKHR(org.lwjgl.vulkan.VkDevice device,
                                      VkSemaphoreGetFdInfoKHR pGetFdInfo,
                                      int[] pFd)

Array version of: GetSemaphoreFdKHR