Package org.lwjgl.vulkan

Class EXTExternalMemoryHost

java.lang.Object

org.lwjgl.vulkan.EXTExternalMemoryHost

public class EXTExternalMemoryHost
extends Object

This extension enables an application to import host allocations and host mapped foreign device memory to Vulkan memory objects.

VK_EXT_external_memory_host

Name String

VK_EXT_external_memory_host

Extension Type

Device extension

Registered Extension Number

179

Revision

1

Extension and Version Dependencies

VK_KHR_external_memory or Version 1.1

Contact

• Daniel Rakos drakos-amd

Other Extension Metadata

Last Modified Date

2017-11-10

IP Status

No known IP claims.

Contributors

• Jaakko Konttinen, AMD
• David Mao, AMD
• Daniel Rakos, AMD
• Tobias Hector, Imagination Technologies
• Faith Ekstrand, Intel
• James Jones, NVIDIA

Field Summary

Fields

Modifier and Type	Field	Description
static final String	VK_EXT_EXTERNAL_MEMORY_HOST_EXTENSION_NAME	The extension name.
static final int	VK_EXT_EXTERNAL_MEMORY_HOST_SPEC_VERSION	The extension specification version.
static final int	VK_EXTERNAL_MEMORY_HANDLE_TYPE_HOST_ALLOCATION_BIT_EXT	Extends VkExternalMemoryHandleTypeFlagBits.
static final int	VK_EXTERNAL_MEMORY_HANDLE_TYPE_HOST_MAPPED_FOREIGN_MEMORY_BIT_EXT	Extends VkExternalMemoryHandleTypeFlagBits.
static final int	VK_STRUCTURE_TYPE_IMPORT_MEMORY_HOST_POINTER_INFO_EXT	Extends VkStructureType.
static final int	VK_STRUCTURE_TYPE_MEMORY_HOST_POINTER_PROPERTIES_EXT	Extends VkStructureType.
static final int	VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_EXTERNAL_MEMORY_HOST_PROPERTIES_EXT	Extends VkStructureType.

Method Summary

Modifier and Type	Method	Description
static int	nvkGetMemoryHostPointerPropertiesEXT(VkDevice device, int handleType, long pHostPointer, long pMemoryHostPointerProperties)	Unsafe version of: GetMemoryHostPointerPropertiesEXT
static int	vkGetMemoryHostPointerPropertiesEXT(VkDevice device, int handleType, long pHostPointer, VkMemoryHostPointerPropertiesEXT pMemoryHostPointerProperties)	Get properties of external memory host pointer.

Methods inherited from class java.lang.Object

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

Field Details

VK_EXT_EXTERNAL_MEMORY_HOST_SPEC_VERSION

public static final int VK_EXT_EXTERNAL_MEMORY_HOST_SPEC_VERSION

The extension specification version.

See Also:

• Constant Field Values

VK_EXT_EXTERNAL_MEMORY_HOST_EXTENSION_NAME

public static final String VK_EXT_EXTERNAL_MEMORY_HOST_EXTENSION_NAME

The extension name.

See Also:

• Constant Field Values

VK_STRUCTURE_TYPE_IMPORT_MEMORY_HOST_POINTER_INFO_EXT

public static final int VK_STRUCTURE_TYPE_IMPORT_MEMORY_HOST_POINTER_INFO_EXT

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_IMPORT_MEMORY_HOST_POINTER_INFO_EXT
• STRUCTURE_TYPE_MEMORY_HOST_POINTER_PROPERTIES_EXT
• STRUCTURE_TYPE_PHYSICAL_DEVICE_EXTERNAL_MEMORY_HOST_PROPERTIES_EXT

See Also:

• Constant Field Values

VK_STRUCTURE_TYPE_MEMORY_HOST_POINTER_PROPERTIES_EXT

public static final int VK_STRUCTURE_TYPE_MEMORY_HOST_POINTER_PROPERTIES_EXT

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_IMPORT_MEMORY_HOST_POINTER_INFO_EXT
• STRUCTURE_TYPE_MEMORY_HOST_POINTER_PROPERTIES_EXT
• STRUCTURE_TYPE_PHYSICAL_DEVICE_EXTERNAL_MEMORY_HOST_PROPERTIES_EXT

See Also:

• Constant Field Values

VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_EXTERNAL_MEMORY_HOST_PROPERTIES_EXT

public static final int VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_EXTERNAL_MEMORY_HOST_PROPERTIES_EXT

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_IMPORT_MEMORY_HOST_POINTER_INFO_EXT
• STRUCTURE_TYPE_MEMORY_HOST_POINTER_PROPERTIES_EXT
• STRUCTURE_TYPE_PHYSICAL_DEVICE_EXTERNAL_MEMORY_HOST_PROPERTIES_EXT

See Also:

• Constant Field Values

VK_EXTERNAL_MEMORY_HANDLE_TYPE_HOST_ALLOCATION_BIT_EXT

public static final int VK_EXTERNAL_MEMORY_HANDLE_TYPE_HOST_ALLOCATION_BIT_EXT

Extends VkExternalMemoryHandleTypeFlagBits.

Enum values:

• EXTERNAL_MEMORY_HANDLE_TYPE_HOST_ALLOCATION_BIT_EXT
• EXTERNAL_MEMORY_HANDLE_TYPE_HOST_MAPPED_FOREIGN_MEMORY_BIT_EXT

See Also:

• Constant Field Values

VK_EXTERNAL_MEMORY_HANDLE_TYPE_HOST_MAPPED_FOREIGN_MEMORY_BIT_EXT

public static final int VK_EXTERNAL_MEMORY_HANDLE_TYPE_HOST_MAPPED_FOREIGN_MEMORY_BIT_EXT

Extends VkExternalMemoryHandleTypeFlagBits.

Enum values:

• EXTERNAL_MEMORY_HANDLE_TYPE_HOST_ALLOCATION_BIT_EXT
• EXTERNAL_MEMORY_HANDLE_TYPE_HOST_MAPPED_FOREIGN_MEMORY_BIT_EXT

See Also:

• Constant Field Values

Method Details

nvkGetMemoryHostPointerPropertiesEXT

public static int nvkGetMemoryHostPointerPropertiesEXT(VkDevice device,
 int handleType,
 long pHostPointer,
 long pMemoryHostPointerProperties)

Unsafe version of: GetMemoryHostPointerPropertiesEXT

vkGetMemoryHostPointerPropertiesEXT

public static int vkGetMemoryHostPointerPropertiesEXT(VkDevice device,
 int handleType,
 long pHostPointer,
 VkMemoryHostPointerPropertiesEXT pMemoryHostPointerProperties)

Get properties of external memory host pointer.

C Specification

To determine the correct parameters to use when importing host pointers, call:

 VkResult vkGetMemoryHostPointerPropertiesEXT(
     VkDevice                                    device,
     VkExternalMemoryHandleTypeFlagBits          handleType,
     const void*                                 pHostPointer,
     VkMemoryHostPointerPropertiesEXT*           pMemoryHostPointerProperties);

Valid Usage

• handleType must be EXTERNAL_MEMORY_HANDLE_TYPE_HOST_ALLOCATION_BIT_EXT or EXTERNAL_MEMORY_HANDLE_TYPE_HOST_MAPPED_FOREIGN_MEMORY_BIT_EXT
• pHostPointer must be a pointer aligned to an integer multiple of VkPhysicalDeviceExternalMemoryHostPropertiesEXT::minImportedHostPointerAlignment
• If handleType is EXTERNAL_MEMORY_HANDLE_TYPE_HOST_ALLOCATION_BIT_EXT, pHostPointer must be a pointer to host memory
• If handleType is EXTERNAL_MEMORY_HANDLE_TYPE_HOST_MAPPED_FOREIGN_MEMORY_BIT_EXT, pHostPointer must be a pointer to host mapped foreign memory

Valid Usage (Implicit)

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

VkMemoryHostPointerPropertiesEXT

Parameters:

device - the logical device that will be importing pHostPointer.

handleType - a VkExternalMemoryHandleTypeFlagBits value specifying the type of the handle pHostPointer.

pHostPointer - the host pointer to import from.

pMemoryHostPointerProperties - a pointer to a VkMemoryHostPointerPropertiesEXT structure in which the host pointer properties are returned.