public Class KHRExternalMemoryFd

The extension name.

The extension specification version.

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_IMPORT_MEMORY_FD_INFO_KHR
• STRUCTURE_TYPE_MEMORY_FD_PROPERTIES_KHR
• STRUCTURE_TYPE_MEMORY_GET_FD_INFO_KHR

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_IMPORT_MEMORY_FD_INFO_KHR
• STRUCTURE_TYPE_MEMORY_FD_PROPERTIES_KHR
• STRUCTURE_TYPE_MEMORY_GET_FD_INFO_KHR

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_IMPORT_MEMORY_FD_INFO_KHR
• STRUCTURE_TYPE_MEMORY_FD_PROPERTIES_KHR
• STRUCTURE_TYPE_MEMORY_GET_FD_INFO_KHR

Unsafe version of: GetMemoryFdKHR

Unsafe version of: GetMemoryFdPropertiesKHR

Get a POSIX file descriptor for a memory object.

C Specification

To export a POSIX file descriptor referencing the payload of a Vulkan device memory object, call:

VkResult vkGetMemoryFdKHR(
    VkDevice                                    device,
    const VkMemoryGetFdInfoKHR*                 pGetFdInfo,
    int*                                        pFd);

Description

Each call to vkGetMemoryFdKHR must create a new file descriptor holding a reference to the memory object’s payload and transfer ownership of the file descriptor to the application. To avoid leaking resources, the application must release ownership of the file descriptor using the close system call when it is no longer needed, or by importing a Vulkan memory object from it. Where supported by the operating system, the implementation must set the file descriptor to be closed automatically when an execve system call is made.

Valid Usage (Implicit)

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

VkMemoryGetFdInfoKHR

Parameters

device:VkDevice

the logical device that created the device memory being exported.

pGetFdInfo:VkMemoryGetFdInfoKHR

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

pFd:IntBuffer

will return a file descriptor referencing the payload of the device memory object.

Annotations

@NativeType:VkResult

Array version of: GetMemoryFdKHR

Annotations

@NativeType:VkResult

Get Properties of External Memory File Descriptors.

C Specification

POSIX file descriptor memory handles compatible with Vulkan may also be created by non-Vulkan APIs using methods beyond the scope of this specification. To determine the correct parameters to use when importing such handles, call:

VkResult vkGetMemoryFdPropertiesKHR(
    VkDevice                                    device,
    VkExternalMemoryHandleTypeFlagBits          handleType,
    int                                         fd,
    VkMemoryFdPropertiesKHR*                    pMemoryFdProperties);

Valid Usage

• fd must point to a valid POSIX file descriptor memory handle
• handleType must not be EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_FD_BIT

Valid Usage (Implicit)

• device must be a valid VkDevice handle
• handleType must be a valid VkExternalMemoryHandleTypeFlagBits value
• pMemoryFdProperties must be a valid pointer to a VkMemoryFdPropertiesKHR 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

VkMemoryFdPropertiesKHR

Parameters

device:VkDevice

the logical device that will be importing fd.

handleType:int

a VkExternalMemoryHandleTypeFlagBits value specifying the type of the handle fd.

fd:int

the handle which will be imported.

pMemoryFdProperties:VkMemoryFdPropertiesKHR

a pointer to a VkMemoryFdPropertiesKHR structure in which the properties of the handle fd are returned.

Annotations

@NativeType:VkResult