Package org.lwjgl.vulkan

Class NVExternalMemoryCapabilities

java.lang.Object

org.lwjgl.vulkan.NVExternalMemoryCapabilities

public class NVExternalMemoryCapabilities
extends Object

Applications may wish to import memory from the Direct 3D API, or export memory to other Vulkan instances. This extension provides a set of capability queries that allow applications determine what types of win32 memory handles an implementation supports for a given set of use cases.

Name String

VK_NV_external_memory_capabilities

Extension Type

Instance extension

Registered Extension Number

56

Revision

1

Deprecation State

• Deprecated by VK_KHR_external_memory_capabilities extension
  • Which in turn was promoted to Vulkan 1.1

Contact

• James Jones cubanismo

Other Extension Metadata

Last Modified Date

2016-08-19

IP Status

No known IP claims.

Interactions and External Dependencies

• Interacts with Vulkan 1.1.
• Interacts with VK_KHR_dedicated_allocation.
• Interacts with VK_NV_dedicated_allocation.

Contributors

• James Jones, NVIDIA

Field Summary

Fields

Modifier and Type	Field	Description
static final int	VK_EXTERNAL_MEMORY_FEATURE_DEDICATED_ONLY_BIT_NV	VkExternalMemoryFeatureFlagBitsNV - Bitmask specifying external memory features
static final int	VK_EXTERNAL_MEMORY_FEATURE_EXPORTABLE_BIT_NV	VkExternalMemoryFeatureFlagBitsNV - Bitmask specifying external memory features
static final int	VK_EXTERNAL_MEMORY_FEATURE_IMPORTABLE_BIT_NV	VkExternalMemoryFeatureFlagBitsNV - Bitmask specifying external memory features
static final int	VK_EXTERNAL_MEMORY_HANDLE_TYPE_D3D11_IMAGE_BIT_NV	VkExternalMemoryHandleTypeFlagBitsNV - Bitmask specifying external memory handle types
static final int	VK_EXTERNAL_MEMORY_HANDLE_TYPE_D3D11_IMAGE_KMT_BIT_NV	VkExternalMemoryHandleTypeFlagBitsNV - Bitmask specifying external memory handle types
static final int	VK_EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_WIN32_BIT_NV	VkExternalMemoryHandleTypeFlagBitsNV - Bitmask specifying external memory handle types
static final int	VK_EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_WIN32_KMT_BIT_NV	VkExternalMemoryHandleTypeFlagBitsNV - Bitmask specifying external memory handle types
static final String	VK_NV_EXTERNAL_MEMORY_CAPABILITIES_EXTENSION_NAME	The extension name.
static final int	VK_NV_EXTERNAL_MEMORY_CAPABILITIES_SPEC_VERSION	The extension specification version.

Method Summary

Modifier and Type	Method	Description
static int	nvkGetPhysicalDeviceExternalImageFormatPropertiesNV(org.lwjgl.vulkan.VkPhysicalDevice physicalDevice, int format, int type, int tiling, int usage, int flags, int externalHandleType, long pExternalImageFormatProperties)	Unsafe version of: GetPhysicalDeviceExternalImageFormatPropertiesNV
static int	vkGetPhysicalDeviceExternalImageFormatPropertiesNV(org.lwjgl.vulkan.VkPhysicalDevice physicalDevice, int format, int type, int tiling, int usage, int flags, int externalHandleType, VkExternalImageFormatPropertiesNV pExternalImageFormatProperties)	Determine image capabilities compatible with external memory handle types.

Methods inherited from class java.lang.Object

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

Field Details

VK_NV_EXTERNAL_MEMORY_CAPABILITIES_SPEC_VERSION

public static final int VK_NV_EXTERNAL_MEMORY_CAPABILITIES_SPEC_VERSION

The extension specification version.

See Also:

• Constant Field Values

VK_NV_EXTERNAL_MEMORY_CAPABILITIES_EXTENSION_NAME

public static final String VK_NV_EXTERNAL_MEMORY_CAPABILITIES_EXTENSION_NAME

The extension name.

See Also:

• Constant Field Values

VK_EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_WIN32_BIT_NV

public static final int VK_EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_WIN32_BIT_NV

VkExternalMemoryHandleTypeFlagBitsNV - Bitmask specifying external memory handle types

Description

• EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_WIN32_KMT_BIT_NV specifies a handle to memory returned by GetMemoryWin32HandleNV.
• EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_WIN32_BIT_NV specifies a handle to memory returned by GetMemoryWin32HandleNV, or one duplicated from such a handle using DuplicateHandle().
• EXTERNAL_MEMORY_HANDLE_TYPE_D3D11_IMAGE_BIT_NV specifies a valid NT handle to memory returned by IDXGIResource1::CreateSharedHandle, or a handle duplicated from such a handle using DuplicateHandle().
• EXTERNAL_MEMORY_HANDLE_TYPE_D3D11_IMAGE_KMT_BIT_NV specifies a handle to memory returned by IDXGIResource::GetSharedHandle().

See Also:

• Constant Field Values

VK_EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_WIN32_KMT_BIT_NV

public static final int VK_EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_WIN32_KMT_BIT_NV

VkExternalMemoryHandleTypeFlagBitsNV - Bitmask specifying external memory handle types

Description

• EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_WIN32_KMT_BIT_NV specifies a handle to memory returned by GetMemoryWin32HandleNV.
• EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_WIN32_BIT_NV specifies a handle to memory returned by GetMemoryWin32HandleNV, or one duplicated from such a handle using DuplicateHandle().
• EXTERNAL_MEMORY_HANDLE_TYPE_D3D11_IMAGE_BIT_NV specifies a valid NT handle to memory returned by IDXGIResource1::CreateSharedHandle, or a handle duplicated from such a handle using DuplicateHandle().
• EXTERNAL_MEMORY_HANDLE_TYPE_D3D11_IMAGE_KMT_BIT_NV specifies a handle to memory returned by IDXGIResource::GetSharedHandle().

See Also:

• Constant Field Values

VK_EXTERNAL_MEMORY_HANDLE_TYPE_D3D11_IMAGE_BIT_NV

public static final int VK_EXTERNAL_MEMORY_HANDLE_TYPE_D3D11_IMAGE_BIT_NV

VkExternalMemoryHandleTypeFlagBitsNV - Bitmask specifying external memory handle types

Description

• EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_WIN32_KMT_BIT_NV specifies a handle to memory returned by GetMemoryWin32HandleNV.
• EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_WIN32_BIT_NV specifies a handle to memory returned by GetMemoryWin32HandleNV, or one duplicated from such a handle using DuplicateHandle().
• EXTERNAL_MEMORY_HANDLE_TYPE_D3D11_IMAGE_BIT_NV specifies a valid NT handle to memory returned by IDXGIResource1::CreateSharedHandle, or a handle duplicated from such a handle using DuplicateHandle().
• EXTERNAL_MEMORY_HANDLE_TYPE_D3D11_IMAGE_KMT_BIT_NV specifies a handle to memory returned by IDXGIResource::GetSharedHandle().

See Also:

• Constant Field Values

VK_EXTERNAL_MEMORY_HANDLE_TYPE_D3D11_IMAGE_KMT_BIT_NV

public static final int VK_EXTERNAL_MEMORY_HANDLE_TYPE_D3D11_IMAGE_KMT_BIT_NV

VkExternalMemoryHandleTypeFlagBitsNV - Bitmask specifying external memory handle types

Description

• EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_WIN32_KMT_BIT_NV specifies a handle to memory returned by GetMemoryWin32HandleNV.
• EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_WIN32_BIT_NV specifies a handle to memory returned by GetMemoryWin32HandleNV, or one duplicated from such a handle using DuplicateHandle().
• EXTERNAL_MEMORY_HANDLE_TYPE_D3D11_IMAGE_BIT_NV specifies a valid NT handle to memory returned by IDXGIResource1::CreateSharedHandle, or a handle duplicated from such a handle using DuplicateHandle().
• EXTERNAL_MEMORY_HANDLE_TYPE_D3D11_IMAGE_KMT_BIT_NV specifies a handle to memory returned by IDXGIResource::GetSharedHandle().

See Also:

• Constant Field Values

VK_EXTERNAL_MEMORY_FEATURE_DEDICATED_ONLY_BIT_NV

public static final int VK_EXTERNAL_MEMORY_FEATURE_DEDICATED_ONLY_BIT_NV

VkExternalMemoryFeatureFlagBitsNV - Bitmask specifying external memory features

Description

• EXTERNAL_MEMORY_FEATURE_DEDICATED_ONLY_BIT_NV specifies that external memory of the specified type must be created as a dedicated allocation when used in the manner specified.
• EXTERNAL_MEMORY_FEATURE_EXPORTABLE_BIT_NV specifies that the implementation supports exporting handles of the specified type.
• EXTERNAL_MEMORY_FEATURE_IMPORTABLE_BIT_NV specifies that the implementation supports importing handles of the specified type.

See Also

VkExternalImageFormatPropertiesNV, GetPhysicalDeviceExternalImageFormatPropertiesNV

See Also:

• Constant Field Values

VK_EXTERNAL_MEMORY_FEATURE_EXPORTABLE_BIT_NV

public static final int VK_EXTERNAL_MEMORY_FEATURE_EXPORTABLE_BIT_NV

VkExternalMemoryFeatureFlagBitsNV - Bitmask specifying external memory features

Description

• EXTERNAL_MEMORY_FEATURE_DEDICATED_ONLY_BIT_NV specifies that external memory of the specified type must be created as a dedicated allocation when used in the manner specified.
• EXTERNAL_MEMORY_FEATURE_EXPORTABLE_BIT_NV specifies that the implementation supports exporting handles of the specified type.
• EXTERNAL_MEMORY_FEATURE_IMPORTABLE_BIT_NV specifies that the implementation supports importing handles of the specified type.

See Also

VkExternalImageFormatPropertiesNV, GetPhysicalDeviceExternalImageFormatPropertiesNV

See Also:

• Constant Field Values

VK_EXTERNAL_MEMORY_FEATURE_IMPORTABLE_BIT_NV

public static final int VK_EXTERNAL_MEMORY_FEATURE_IMPORTABLE_BIT_NV

VkExternalMemoryFeatureFlagBitsNV - Bitmask specifying external memory features

Description

• EXTERNAL_MEMORY_FEATURE_DEDICATED_ONLY_BIT_NV specifies that external memory of the specified type must be created as a dedicated allocation when used in the manner specified.
• EXTERNAL_MEMORY_FEATURE_EXPORTABLE_BIT_NV specifies that the implementation supports exporting handles of the specified type.
• EXTERNAL_MEMORY_FEATURE_IMPORTABLE_BIT_NV specifies that the implementation supports importing handles of the specified type.

See Also

VkExternalImageFormatPropertiesNV, GetPhysicalDeviceExternalImageFormatPropertiesNV

See Also:

• Constant Field Values

Method Details

nvkGetPhysicalDeviceExternalImageFormatPropertiesNV

public static int nvkGetPhysicalDeviceExternalImageFormatPropertiesNV(org.lwjgl.vulkan.VkPhysicalDevice physicalDevice,
 int format,
 int type,
 int tiling,
 int usage,
 int flags,
 int externalHandleType,
 long pExternalImageFormatProperties)

Unsafe version of: GetPhysicalDeviceExternalImageFormatPropertiesNV

vkGetPhysicalDeviceExternalImageFormatPropertiesNV

public static int vkGetPhysicalDeviceExternalImageFormatPropertiesNV(org.lwjgl.vulkan.VkPhysicalDevice physicalDevice,
 int format,
 int type,
 int tiling,
 int usage,
 int flags,
 int externalHandleType,
 VkExternalImageFormatPropertiesNV pExternalImageFormatProperties)

Determine image capabilities compatible with external memory handle types.

C Specification

To determine the image capabilities compatible with an external memory handle type, call:

 VkResult vkGetPhysicalDeviceExternalImageFormatPropertiesNV(
     VkPhysicalDevice                            physicalDevice,
     VkFormat                                    format,
     VkImageType                                 type,
     VkImageTiling                               tiling,
     VkImageUsageFlags                           usage,
     VkImageCreateFlags                          flags,
     VkExternalMemoryHandleTypeFlagsNV           externalHandleType,
     VkExternalImageFormatPropertiesNV*          pExternalImageFormatProperties);

Description

If externalHandleType is 0, pExternalImageFormatProperties→imageFormatProperties will return the same values as a call to GetPhysicalDeviceImageFormatProperties, and the other members of pExternalImageFormatProperties will all be 0. Otherwise, they are filled in as described for VkExternalImageFormatPropertiesNV.

Valid Usage

• externalHandleType must not have more than one bit set

Valid Usage (Implicit)

• physicalDevice must be a valid VkPhysicalDevice handle
• format must be a valid VkFormat value
• type must be a valid VkImageType value
• tiling must be a valid VkImageTiling value
• usage must be a valid combination of VkImageUsageFlagBits values
• usage must not be 0
• flags must be a valid combination of VkImageCreateFlagBits values
• externalHandleType must be a valid combination of VkExternalMemoryHandleTypeFlagBitsNV values
• pExternalImageFormatProperties must be a valid pointer to a VkExternalImageFormatPropertiesNV structure

Return Codes

On success, this command returns

• SUCCESS

On failure, this command returns

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY
• ERROR_FORMAT_NOT_SUPPORTED

See Also

VkExternalImageFormatPropertiesNV

Parameters:

physicalDevice - the physical device from which to query the image capabilities

format - the image format, corresponding to VkImageCreateInfo::format.

type - the image type, corresponding to VkImageCreateInfo::imageType.

tiling - the image tiling, corresponding to VkImageCreateInfo::tiling.

usage - the intended usage of the image, corresponding to VkImageCreateInfo::usage.

flags - a bitmask describing additional parameters of the image, corresponding to VkImageCreateInfo::flags.

externalHandleType - either one of the bits from VkExternalMemoryHandleTypeFlagBitsNV, or 0.

pExternalImageFormatProperties - a pointer to a VkExternalImageFormatPropertiesNV structure in which capabilities are returned.