Package org.lwjgl.vulkan

Class KHRExternalMemoryCapabilities

java.lang.Object

org.lwjgl.vulkan.KHRExternalMemoryCapabilities

public class KHRExternalMemoryCapabilities
extends Object

An application may wish to reference device memory in multiple Vulkan logical devices or instances, in multiple processes, and/or in multiple APIs. This extension provides a set of capability queries and handle definitions that allow an application to determine what types of “external” memory handles an implementation supports for a given set of use cases.

Promotion to Vulkan 1.1

All functionality in this extension is included in core Vulkan 1.1, with the KHR suffix omitted. The original type, enum, and command names are still available as aliases of the core functionality.

Name String

VK_KHR_external_memory_capabilities

Extension Type

Instance extension

Registered Extension Number

72

Revision

1

Extension and Version Dependencies

VK_KHR_get_physical_device_properties2 or Version 1.1

Deprecation State

• Promoted to Vulkan 1.1

Contact

• James Jones cubanismo

Other Extension Metadata

Last Modified Date

2016-10-17

IP Status

No known IP claims.

Interactions and External Dependencies

• Interacts with VK_KHR_dedicated_allocation.
• Interacts with VK_NV_dedicated_allocation.

Contributors

• Ian Elliott, Google
• Jesse Hall, Google
• James Jones, NVIDIA

Field Summary

Fields

Modifier and Type	Field	Description
static final int	VK_EXTERNAL_MEMORY_FEATURE_DEDICATED_ONLY_BIT_KHR	Extends VkExternalMemoryFeatureFlagBits.
static final int	VK_EXTERNAL_MEMORY_FEATURE_EXPORTABLE_BIT_KHR	Extends VkExternalMemoryFeatureFlagBits.
static final int	VK_EXTERNAL_MEMORY_FEATURE_IMPORTABLE_BIT_KHR	Extends VkExternalMemoryFeatureFlagBits.
static final int	VK_EXTERNAL_MEMORY_HANDLE_TYPE_D3D11_TEXTURE_BIT_KHR	Extends VkExternalMemoryHandleTypeFlagBits.
static final int	VK_EXTERNAL_MEMORY_HANDLE_TYPE_D3D11_TEXTURE_KMT_BIT_KHR	Extends VkExternalMemoryHandleTypeFlagBits.
static final int	VK_EXTERNAL_MEMORY_HANDLE_TYPE_D3D12_HEAP_BIT_KHR	Extends VkExternalMemoryHandleTypeFlagBits.
static final int	VK_EXTERNAL_MEMORY_HANDLE_TYPE_D3D12_RESOURCE_BIT_KHR	Extends VkExternalMemoryHandleTypeFlagBits.
static final int	VK_EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_FD_BIT_KHR	Extends VkExternalMemoryHandleTypeFlagBits.
static final int	VK_EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_WIN32_BIT_KHR	Extends VkExternalMemoryHandleTypeFlagBits.
static final int	VK_EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_WIN32_KMT_BIT_KHR	Extends VkExternalMemoryHandleTypeFlagBits.
static final String	VK_KHR_EXTERNAL_MEMORY_CAPABILITIES_EXTENSION_NAME	The extension name.
static final int	VK_KHR_EXTERNAL_MEMORY_CAPABILITIES_SPEC_VERSION	The extension specification version.
static final int	VK_LUID_SIZE_KHR	VK_LUID_SIZE_KHR
static final int	VK_STRUCTURE_TYPE_EXTERNAL_BUFFER_PROPERTIES_KHR	Extends VkStructureType.
static final int	VK_STRUCTURE_TYPE_EXTERNAL_IMAGE_FORMAT_PROPERTIES_KHR	Extends VkStructureType.
static final int	VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_EXTERNAL_BUFFER_INFO_KHR	Extends VkStructureType.
static final int	VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_EXTERNAL_IMAGE_FORMAT_INFO_KHR	Extends VkStructureType.
static final int	VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_ID_PROPERTIES_KHR	Extends VkStructureType.

Method Summary

Modifier and Type	Method	Description
static void	nvkGetPhysicalDeviceExternalBufferPropertiesKHR(org.lwjgl.vulkan.VkPhysicalDevice physicalDevice, long pExternalBufferInfo, long pExternalBufferProperties)	Unsafe version of: GetPhysicalDeviceExternalBufferPropertiesKHR
static void	vkGetPhysicalDeviceExternalBufferPropertiesKHR(org.lwjgl.vulkan.VkPhysicalDevice physicalDevice, VkPhysicalDeviceExternalBufferInfo pExternalBufferInfo, VkExternalBufferProperties pExternalBufferProperties)	See GetPhysicalDeviceExternalBufferProperties.

Methods inherited from class java.lang.Object

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

Field Details

VK_KHR_EXTERNAL_MEMORY_CAPABILITIES_SPEC_VERSION

public static final int VK_KHR_EXTERNAL_MEMORY_CAPABILITIES_SPEC_VERSION

The extension specification version.

See Also:

• Constant Field Values

VK_KHR_EXTERNAL_MEMORY_CAPABILITIES_EXTENSION_NAME

public static final String VK_KHR_EXTERNAL_MEMORY_CAPABILITIES_EXTENSION_NAME

The extension name.

See Also:

• Constant Field Values

VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_EXTERNAL_IMAGE_FORMAT_INFO_KHR

public static final int VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_EXTERNAL_IMAGE_FORMAT_INFO_KHR

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_PHYSICAL_DEVICE_EXTERNAL_IMAGE_FORMAT_INFO_KHR
• STRUCTURE_TYPE_EXTERNAL_IMAGE_FORMAT_PROPERTIES_KHR
• STRUCTURE_TYPE_PHYSICAL_DEVICE_EXTERNAL_BUFFER_INFO_KHR
• STRUCTURE_TYPE_EXTERNAL_BUFFER_PROPERTIES_KHR
• STRUCTURE_TYPE_PHYSICAL_DEVICE_ID_PROPERTIES_KHR

See Also:

• Constant Field Values

VK_STRUCTURE_TYPE_EXTERNAL_IMAGE_FORMAT_PROPERTIES_KHR

public static final int VK_STRUCTURE_TYPE_EXTERNAL_IMAGE_FORMAT_PROPERTIES_KHR

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_PHYSICAL_DEVICE_EXTERNAL_IMAGE_FORMAT_INFO_KHR
• STRUCTURE_TYPE_EXTERNAL_IMAGE_FORMAT_PROPERTIES_KHR
• STRUCTURE_TYPE_PHYSICAL_DEVICE_EXTERNAL_BUFFER_INFO_KHR
• STRUCTURE_TYPE_EXTERNAL_BUFFER_PROPERTIES_KHR
• STRUCTURE_TYPE_PHYSICAL_DEVICE_ID_PROPERTIES_KHR

See Also:

• Constant Field Values

VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_EXTERNAL_BUFFER_INFO_KHR

public static final int VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_EXTERNAL_BUFFER_INFO_KHR

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_PHYSICAL_DEVICE_EXTERNAL_IMAGE_FORMAT_INFO_KHR
• STRUCTURE_TYPE_EXTERNAL_IMAGE_FORMAT_PROPERTIES_KHR
• STRUCTURE_TYPE_PHYSICAL_DEVICE_EXTERNAL_BUFFER_INFO_KHR
• STRUCTURE_TYPE_EXTERNAL_BUFFER_PROPERTIES_KHR
• STRUCTURE_TYPE_PHYSICAL_DEVICE_ID_PROPERTIES_KHR

See Also:

• Constant Field Values

VK_STRUCTURE_TYPE_EXTERNAL_BUFFER_PROPERTIES_KHR

public static final int VK_STRUCTURE_TYPE_EXTERNAL_BUFFER_PROPERTIES_KHR

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_PHYSICAL_DEVICE_EXTERNAL_IMAGE_FORMAT_INFO_KHR
• STRUCTURE_TYPE_EXTERNAL_IMAGE_FORMAT_PROPERTIES_KHR
• STRUCTURE_TYPE_PHYSICAL_DEVICE_EXTERNAL_BUFFER_INFO_KHR
• STRUCTURE_TYPE_EXTERNAL_BUFFER_PROPERTIES_KHR
• STRUCTURE_TYPE_PHYSICAL_DEVICE_ID_PROPERTIES_KHR

See Also:

• Constant Field Values

VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_ID_PROPERTIES_KHR

public static final int VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_ID_PROPERTIES_KHR

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_PHYSICAL_DEVICE_EXTERNAL_IMAGE_FORMAT_INFO_KHR
• STRUCTURE_TYPE_EXTERNAL_IMAGE_FORMAT_PROPERTIES_KHR
• STRUCTURE_TYPE_PHYSICAL_DEVICE_EXTERNAL_BUFFER_INFO_KHR
• STRUCTURE_TYPE_EXTERNAL_BUFFER_PROPERTIES_KHR
• STRUCTURE_TYPE_PHYSICAL_DEVICE_ID_PROPERTIES_KHR

See Also:

• Constant Field Values

VK_LUID_SIZE_KHR

public static final int VK_LUID_SIZE_KHR

VK_LUID_SIZE_KHR

See Also:

• Constant Field Values

VK_EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_FD_BIT_KHR

public static final int VK_EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_FD_BIT_KHR

Extends VkExternalMemoryHandleTypeFlagBits.

Enum values:

• EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_FD_BIT_KHR
• EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_WIN32_BIT_KHR
• EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_WIN32_KMT_BIT_KHR
• EXTERNAL_MEMORY_HANDLE_TYPE_D3D11_TEXTURE_BIT_KHR
• EXTERNAL_MEMORY_HANDLE_TYPE_D3D11_TEXTURE_KMT_BIT_KHR
• EXTERNAL_MEMORY_HANDLE_TYPE_D3D12_HEAP_BIT_KHR
• EXTERNAL_MEMORY_HANDLE_TYPE_D3D12_RESOURCE_BIT_KHR

See Also:

• Constant Field Values

VK_EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_WIN32_BIT_KHR

public static final int VK_EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_WIN32_BIT_KHR

Extends VkExternalMemoryHandleTypeFlagBits.

Enum values:

• EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_FD_BIT_KHR
• EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_WIN32_BIT_KHR
• EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_WIN32_KMT_BIT_KHR
• EXTERNAL_MEMORY_HANDLE_TYPE_D3D11_TEXTURE_BIT_KHR
• EXTERNAL_MEMORY_HANDLE_TYPE_D3D11_TEXTURE_KMT_BIT_KHR
• EXTERNAL_MEMORY_HANDLE_TYPE_D3D12_HEAP_BIT_KHR
• EXTERNAL_MEMORY_HANDLE_TYPE_D3D12_RESOURCE_BIT_KHR

See Also:

• Constant Field Values

VK_EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_WIN32_KMT_BIT_KHR

public static final int VK_EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_WIN32_KMT_BIT_KHR

Extends VkExternalMemoryHandleTypeFlagBits.

Enum values:

• EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_FD_BIT_KHR
• EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_WIN32_BIT_KHR
• EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_WIN32_KMT_BIT_KHR
• EXTERNAL_MEMORY_HANDLE_TYPE_D3D11_TEXTURE_BIT_KHR
• EXTERNAL_MEMORY_HANDLE_TYPE_D3D11_TEXTURE_KMT_BIT_KHR
• EXTERNAL_MEMORY_HANDLE_TYPE_D3D12_HEAP_BIT_KHR
• EXTERNAL_MEMORY_HANDLE_TYPE_D3D12_RESOURCE_BIT_KHR

See Also:

• Constant Field Values

VK_EXTERNAL_MEMORY_HANDLE_TYPE_D3D11_TEXTURE_BIT_KHR

public static final int VK_EXTERNAL_MEMORY_HANDLE_TYPE_D3D11_TEXTURE_BIT_KHR

Extends VkExternalMemoryHandleTypeFlagBits.

Enum values:

• EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_FD_BIT_KHR
• EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_WIN32_BIT_KHR
• EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_WIN32_KMT_BIT_KHR
• EXTERNAL_MEMORY_HANDLE_TYPE_D3D11_TEXTURE_BIT_KHR
• EXTERNAL_MEMORY_HANDLE_TYPE_D3D11_TEXTURE_KMT_BIT_KHR
• EXTERNAL_MEMORY_HANDLE_TYPE_D3D12_HEAP_BIT_KHR
• EXTERNAL_MEMORY_HANDLE_TYPE_D3D12_RESOURCE_BIT_KHR

See Also:

• Constant Field Values

VK_EXTERNAL_MEMORY_HANDLE_TYPE_D3D11_TEXTURE_KMT_BIT_KHR

public static final int VK_EXTERNAL_MEMORY_HANDLE_TYPE_D3D11_TEXTURE_KMT_BIT_KHR

Extends VkExternalMemoryHandleTypeFlagBits.

Enum values:

• EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_FD_BIT_KHR
• EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_WIN32_BIT_KHR
• EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_WIN32_KMT_BIT_KHR
• EXTERNAL_MEMORY_HANDLE_TYPE_D3D11_TEXTURE_BIT_KHR
• EXTERNAL_MEMORY_HANDLE_TYPE_D3D11_TEXTURE_KMT_BIT_KHR
• EXTERNAL_MEMORY_HANDLE_TYPE_D3D12_HEAP_BIT_KHR
• EXTERNAL_MEMORY_HANDLE_TYPE_D3D12_RESOURCE_BIT_KHR

See Also:

• Constant Field Values

VK_EXTERNAL_MEMORY_HANDLE_TYPE_D3D12_HEAP_BIT_KHR

public static final int VK_EXTERNAL_MEMORY_HANDLE_TYPE_D3D12_HEAP_BIT_KHR

Extends VkExternalMemoryHandleTypeFlagBits.

Enum values:

• EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_FD_BIT_KHR
• EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_WIN32_BIT_KHR
• EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_WIN32_KMT_BIT_KHR
• EXTERNAL_MEMORY_HANDLE_TYPE_D3D11_TEXTURE_BIT_KHR
• EXTERNAL_MEMORY_HANDLE_TYPE_D3D11_TEXTURE_KMT_BIT_KHR
• EXTERNAL_MEMORY_HANDLE_TYPE_D3D12_HEAP_BIT_KHR
• EXTERNAL_MEMORY_HANDLE_TYPE_D3D12_RESOURCE_BIT_KHR

See Also:

• Constant Field Values

VK_EXTERNAL_MEMORY_HANDLE_TYPE_D3D12_RESOURCE_BIT_KHR

public static final int VK_EXTERNAL_MEMORY_HANDLE_TYPE_D3D12_RESOURCE_BIT_KHR

Extends VkExternalMemoryHandleTypeFlagBits.

Enum values:

• EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_FD_BIT_KHR
• EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_WIN32_BIT_KHR
• EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_WIN32_KMT_BIT_KHR
• EXTERNAL_MEMORY_HANDLE_TYPE_D3D11_TEXTURE_BIT_KHR
• EXTERNAL_MEMORY_HANDLE_TYPE_D3D11_TEXTURE_KMT_BIT_KHR
• EXTERNAL_MEMORY_HANDLE_TYPE_D3D12_HEAP_BIT_KHR
• EXTERNAL_MEMORY_HANDLE_TYPE_D3D12_RESOURCE_BIT_KHR

See Also:

• Constant Field Values

VK_EXTERNAL_MEMORY_FEATURE_DEDICATED_ONLY_BIT_KHR

public static final int VK_EXTERNAL_MEMORY_FEATURE_DEDICATED_ONLY_BIT_KHR

Extends VkExternalMemoryFeatureFlagBits.

Enum values:

• EXTERNAL_MEMORY_FEATURE_DEDICATED_ONLY_BIT_KHR
• EXTERNAL_MEMORY_FEATURE_EXPORTABLE_BIT_KHR
• EXTERNAL_MEMORY_FEATURE_IMPORTABLE_BIT_KHR

See Also:

• Constant Field Values

VK_EXTERNAL_MEMORY_FEATURE_EXPORTABLE_BIT_KHR

public static final int VK_EXTERNAL_MEMORY_FEATURE_EXPORTABLE_BIT_KHR

Extends VkExternalMemoryFeatureFlagBits.

Enum values:

• EXTERNAL_MEMORY_FEATURE_DEDICATED_ONLY_BIT_KHR
• EXTERNAL_MEMORY_FEATURE_EXPORTABLE_BIT_KHR
• EXTERNAL_MEMORY_FEATURE_IMPORTABLE_BIT_KHR

See Also:

• Constant Field Values

VK_EXTERNAL_MEMORY_FEATURE_IMPORTABLE_BIT_KHR

public static final int VK_EXTERNAL_MEMORY_FEATURE_IMPORTABLE_BIT_KHR

Extends VkExternalMemoryFeatureFlagBits.

Enum values:

• EXTERNAL_MEMORY_FEATURE_DEDICATED_ONLY_BIT_KHR
• EXTERNAL_MEMORY_FEATURE_EXPORTABLE_BIT_KHR
• EXTERNAL_MEMORY_FEATURE_IMPORTABLE_BIT_KHR

See Also:

• Constant Field Values

Method Details

nvkGetPhysicalDeviceExternalBufferPropertiesKHR

public static void nvkGetPhysicalDeviceExternalBufferPropertiesKHR(org.lwjgl.vulkan.VkPhysicalDevice physicalDevice,
 long pExternalBufferInfo,
 long pExternalBufferProperties)

Unsafe version of: GetPhysicalDeviceExternalBufferPropertiesKHR

vkGetPhysicalDeviceExternalBufferPropertiesKHR

public static void vkGetPhysicalDeviceExternalBufferPropertiesKHR(org.lwjgl.vulkan.VkPhysicalDevice physicalDevice,
 VkPhysicalDeviceExternalBufferInfo pExternalBufferInfo,
 VkExternalBufferProperties pExternalBufferProperties)

See GetPhysicalDeviceExternalBufferProperties.

Parameters:

physicalDevice - the physical device from which to query the buffer capabilities.

pExternalBufferInfo - a pointer to a VkPhysicalDeviceExternalBufferInfo structure describing the parameters that would be consumed by CreateBuffer.

pExternalBufferProperties - a pointer to a VkExternalBufferProperties structure in which capabilities are returned.