Top Description Fields Constructors Methods
org.lwjgl.vulkan

public Class NVExternalMemoryCapabilities

extends Object
Class Inheritance
Imports
org.lwjgl.system.*

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.
VK_NV_external_memory_capabilities
Name String
VK_NV_external_memory_capabilities
Extension Type
Instance extension
Registered Extension Number
56
Revision
1
Deprecation state
Contact
Other Extension Metadata
Last Modified Date
2016-08-19
IP Status
No known IP claims.
Interactions and External Dependencies
Contributors
  • James Jones, NVIDIA

Field Summary

Modifier and TypeField and Description
public static final int
VK_EXTERNAL_MEMORY_FEATURE_DEDICATED_ONLY_BIT_NV

VkExternalMemoryFeatureFlagBitsNV - Bitmask specifying external memory features Description

public static final int
VK_EXTERNAL_MEMORY_FEATURE_EXPORTABLE_BIT_NV

VkExternalMemoryFeatureFlagBitsNV - Bitmask specifying external memory features Description

public static final int
VK_EXTERNAL_MEMORY_FEATURE_IMPORTABLE_BIT_NV

VkExternalMemoryFeatureFlagBitsNV - Bitmask specifying external memory features Description

public static final int
VK_EXTERNAL_MEMORY_HANDLE_TYPE_D3D11_IMAGE_BIT_NV

VkExternalMemoryHandleTypeFlagBitsNV - Bitmask specifying external memory handle types Description

public static final int
VK_EXTERNAL_MEMORY_HANDLE_TYPE_D3D11_IMAGE_KMT_BIT_NV

VkExternalMemoryHandleTypeFlagBitsNV - Bitmask specifying external memory handle types Description

public static final int
VK_EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_WIN32_BIT_NV

VkExternalMemoryHandleTypeFlagBitsNV - Bitmask specifying external memory handle types Description

public static final int
VK_EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_WIN32_KMT_BIT_NV

VkExternalMemoryHandleTypeFlagBitsNV - Bitmask specifying external memory handle types Description

public static final String
public static final int
VK_NV_EXTERNAL_MEMORY_CAPABILITIES_SPEC_VERSION

The extension specification version.

Constructor Summary

AccessConstructor and Description
protected

Method Summary

Modifier and TypeMethod and Description
public static int
nvkGetPhysicalDeviceExternalImageFormatPropertiesNV(VkPhysicalDevice physicalDevice, int format, int type, int tiling, int usage, int flags, int externalHandleType, long pExternalImageFormatProperties)

Unsafe version of: GetPhysicalDeviceExternalImageFormatPropertiesNV

public static int
vkGetPhysicalDeviceExternalImageFormatPropertiesNV(VkPhysicalDevice
the physical device from which to query the image capabilities
physicalDevice
,
int
the image format, corresponding to VkImageCreateInfo::format.
format
,
int
the image type, corresponding to VkImageCreateInfo::imageType.
type
,
int
the image tiling, corresponding to VkImageCreateInfo::tiling.
tiling
,
int
the intended usage of the image, corresponding to VkImageCreateInfo::usage.
usage
,
int
a bitmask describing additional parameters of the image, corresponding to VkImageCreateInfo::flags.
flags
,
int
either one of the bits from VkExternalMemoryHandleTypeFlagBitsNV, or 0.
externalHandleType
,
VkExternalImageFormatPropertiesNV
a pointer to a VkExternalImageFormatPropertiesNV structure in which capabilities are returned.
pExternalImageFormatProperties
)

Determine image capabilities compatible with external memory handle types.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

VK_EXTERNAL_MEMORY_FEATURE_DEDICATED_ONLY_BIT_NVback to summary
public static final int VK_EXTERNAL_MEMORY_FEATURE_DEDICATED_ONLY_BIT_NV

VkExternalMemoryFeatureFlagBitsNV - Bitmask specifying external memory features

Description
See Also

VkExternalImageFormatPropertiesNV, GetPhysicalDeviceExternalImageFormatPropertiesNV

VK_EXTERNAL_MEMORY_FEATURE_EXPORTABLE_BIT_NVback to summary
public static final int VK_EXTERNAL_MEMORY_FEATURE_EXPORTABLE_BIT_NV

VkExternalMemoryFeatureFlagBitsNV - Bitmask specifying external memory features

Description
See Also

VkExternalImageFormatPropertiesNV, GetPhysicalDeviceExternalImageFormatPropertiesNV

VK_EXTERNAL_MEMORY_FEATURE_IMPORTABLE_BIT_NVback to summary
public static final int VK_EXTERNAL_MEMORY_FEATURE_IMPORTABLE_BIT_NV

VkExternalMemoryFeatureFlagBitsNV - Bitmask specifying external memory features

Description
See Also

VkExternalImageFormatPropertiesNV, GetPhysicalDeviceExternalImageFormatPropertiesNV

VK_EXTERNAL_MEMORY_HANDLE_TYPE_D3D11_IMAGE_BIT_NVback to summary
public static final int VK_EXTERNAL_MEMORY_HANDLE_TYPE_D3D11_IMAGE_BIT_NV

VkExternalMemoryHandleTypeFlagBitsNV - Bitmask specifying external memory handle types

Description
VK_EXTERNAL_MEMORY_HANDLE_TYPE_D3D11_IMAGE_KMT_BIT_NVback to summary
public static final int VK_EXTERNAL_MEMORY_HANDLE_TYPE_D3D11_IMAGE_KMT_BIT_NV

VkExternalMemoryHandleTypeFlagBitsNV - Bitmask specifying external memory handle types

Description
VK_EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_WIN32_BIT_NVback to summary
public static final int VK_EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_WIN32_BIT_NV

VkExternalMemoryHandleTypeFlagBitsNV - Bitmask specifying external memory handle types

Description
VK_EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_WIN32_KMT_BIT_NVback to summary
public static final int VK_EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_WIN32_KMT_BIT_NV

VkExternalMemoryHandleTypeFlagBitsNV - Bitmask specifying external memory handle types

Description
VK_NV_EXTERNAL_MEMORY_CAPABILITIES_EXTENSION_NAMEback to summary
public static final String VK_NV_EXTERNAL_MEMORY_CAPABILITIES_EXTENSION_NAME

The extension name.

VK_NV_EXTERNAL_MEMORY_CAPABILITIES_SPEC_VERSIONback to summary
public static final int VK_NV_EXTERNAL_MEMORY_CAPABILITIES_SPEC_VERSION

The extension specification version.

Constructor Detail

NVExternalMemoryCapabilitiesback to summary
protected NVExternalMemoryCapabilities()

Method Detail

nvkGetPhysicalDeviceExternalImageFormatPropertiesNVback to summary
public static int nvkGetPhysicalDeviceExternalImageFormatPropertiesNV(VkPhysicalDevice physicalDevice, int format, int type, int tiling, int usage, int flags, int externalHandleType, long pExternalImageFormatProperties)

Unsafe version of: GetPhysicalDeviceExternalImageFormatPropertiesNV

vkGetPhysicalDeviceExternalImageFormatPropertiesNVback to summary
public static int vkGetPhysicalDeviceExternalImageFormatPropertiesNV(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
On failure, this command returns
See Also

VkExternalImageFormatPropertiesNV

Parameters
physicalDevice:VkPhysicalDevice

the physical device from which to query the image capabilities

format:int

the image format, corresponding to VkImageCreateInfo::format.

type:int

the image type, corresponding to VkImageCreateInfo::imageType.

tiling:int

the image tiling, corresponding to VkImageCreateInfo::tiling.

usage:int

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

flags:int

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

externalHandleType:int

either one of the bits from VkExternalMemoryHandleTypeFlagBitsNV, or 0.

pExternalImageFormatProperties:VkExternalImageFormatPropertiesNV

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

Annotations
@NativeType:VkResult