public Class KHRExternalFenceFd

The extension name.

The extension specification version.

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_IMPORT_FENCE_FD_INFO_KHR
• STRUCTURE_TYPE_FENCE_GET_FD_INFO_KHR

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_IMPORT_FENCE_FD_INFO_KHR
• STRUCTURE_TYPE_FENCE_GET_FD_INFO_KHR

Unsafe version of: GetFenceFdKHR

Unsafe version of: ImportFenceFdKHR

Get a POSIX file descriptor handle for a fence.

C Specification

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

VkResult vkGetFenceFdKHR(
    VkDevice                                    device,
    const VkFenceGetFdInfoKHR*                  pGetFdInfo,
    int*                                        pFd);

Description

Each call to vkGetFenceFdKHR 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.

If pGetFdInfo→handleType is EXTERNAL_FENCE_HANDLE_TYPE_SYNC_FD_BIT and the fence is signaled at the time vkGetFenceFdKHR is called, pFd may return the value -1 instead of a valid file descriptor.

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 fence may have side effects depending on the transference of the specified handle type, as described in Importing Fence State.

Valid Usage (Implicit)

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

VkFenceGetFdInfoKHR

Parameters

device:VkDevice

the logical device that created the fence being exported.

pGetFdInfo:VkFenceGetFdInfoKHR

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

pFd:IntBuffer

will return the file descriptor representing the fence payload.

Annotations

@NativeType:VkResult

Array version of: GetFenceFdKHR

Annotations

@NativeType:VkResult

Import a fence from a POSIX file descriptor.

C Specification

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

VkResult vkImportFenceFdKHR(
    VkDevice                                    device,
    const VkImportFenceFdInfoKHR*               pImportFenceFdInfo);

Description

Importing a fence 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 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
• pImportFenceFdInfo must be a valid pointer to a valid VkImportFenceFdInfoKHR 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

VkImportFenceFdInfoKHR

Parameters

device:VkDevice

the logical device that created the fence.

pImportFenceFdInfo:VkImportFenceFdInfoKHR

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

Annotations

@NativeType:VkResult