Vulkan.Extensions.VK_NV_external_memory

Name

VK_NV_external_memory - device extension

VK_NV_external_memory

Name String

VK_NV_external_memory

Extension Type

Device extension

Registered Extension Number

57

Revision

1

Extension and Version Dependencies

• Requires support for Vulkan 1.0
• Requires VK_NV_external_memory_capabilities to be enabled for any device-level functionality

Deprecation state

• Deprecated by VK_KHR_external_memory extension

  • Which in turn was promoted to Vulkan 1.1

Contact

• James Jones @cubanismo%0A*Here describe the issue or question you have about the VK_NV_external_memory extension*

Other Extension Metadata

Last Modified Date

2016-08-19

IP Status

No known IP claims.

Contributors

• James Jones, NVIDIA
• Carsten Rohde, NVIDIA

Description

Applications may wish to export memory to other Vulkan instances or other APIs, or import memory from other Vulkan instances or other APIs to enable Vulkan workloads to be split up across application module, process, or API boundaries. This extension enables applications to create exportable Vulkan memory objects such that the underlying resources can be referenced outside the Vulkan instance that created them.

New Structures

• Extending ImageCreateInfo:

  • ExternalMemoryImageCreateInfoNV

• Extending MemoryAllocateInfo:

  • ExportMemoryAllocateInfoNV

New Enum Constants

• NV_EXTERNAL_MEMORY_EXTENSION_NAME

• NV_EXTERNAL_MEMORY_SPEC_VERSION

• Extending StructureType:

  • STRUCTURE_TYPE_EXPORT_MEMORY_ALLOCATE_INFO_NV
  • STRUCTURE_TYPE_EXTERNAL_MEMORY_IMAGE_CREATE_INFO_NV

Issues

1) If memory objects are shared between processes and APIs, is this considered aliasing according to the rules outlined in the Memory Aliasing section?

RESOLVED: Yes, but strict exceptions to the rules are added to allow some forms of aliasing in these cases. Further, other extensions may build upon these new aliasing rules to define specific support usage within Vulkan for imported native memory objects, or memory objects from other APIs.

2) Are new image layouts or metadata required to specify image layouts and layout transitions compatible with non-Vulkan APIs, or with other instances of the same Vulkan driver?

RESOLVED: No. Separate instances of the same Vulkan driver running on the same GPU should have identical internal layout semantics, so applications have the tools they need to ensure views of images are consistent between the two instances. Other APIs will fall into two categories: Those that are Vulkan compatible (a term to be defined by subsequent interopability extensions), or Vulkan incompatible. When sharing images with Vulkan incompatible APIs, the Vulkan image must be transitioned to the IMAGE_LAYOUT_GENERAL layout before handing it off to the external API.

Note this does not attempt to address cross-device transitions, nor transitions to engines on the same device which are not visible within the Vulkan API. Both of these are beyond the scope of this extension.

Examples

    // TODO: Write some sample code here.

Version History

• Revision 1, 2016-08-19 (James Jones)

  • Initial draft

See Also

ExportMemoryAllocateInfoNV, ExternalMemoryImageCreateInfoNV

Document Notes

For more information, see the Vulkan Specification

This page is a generated document. Fixes and changes should be made to the generator scripts, not directly.

Documentation

data ExternalMemoryImageCreateInfoNV

VkExternalMemoryImageCreateInfoNV - Specify that an image may be backed by external memory

Valid Usage (Implicit)

See Also

VK_NV_external_memory, ExternalMemoryHandleTypeFlagsNV, StructureType

Constructors

ExternalMemoryImageCreateInfoNV

Fields

• handleTypes :: ExternalMemoryHandleTypeFlagsNV

  handleTypes is zero or a bitmask of ExternalMemoryHandleTypeFlagBitsNV specifying one or more external memory handle types.

  handleTypes must be a valid combination of ExternalMemoryHandleTypeFlagBitsNV values

Instances

Storable ExternalMemoryImageCreateInfoNV

Defined in Vulkan.Extensions.VK_NV_external_memory

Methods

sizeOf :: ExternalMemoryImageCreateInfoNV -> Int

alignment :: ExternalMemoryImageCreateInfoNV -> Int

peekElemOff :: Ptr ExternalMemoryImageCreateInfoNV -> Int -> IO ExternalMemoryImageCreateInfoNV

pokeElemOff :: Ptr ExternalMemoryImageCreateInfoNV -> Int -> ExternalMemoryImageCreateInfoNV -> IO ()

peekByteOff :: Ptr b -> Int -> IO ExternalMemoryImageCreateInfoNV

pokeByteOff :: Ptr b -> Int -> ExternalMemoryImageCreateInfoNV -> IO ()

peek :: Ptr ExternalMemoryImageCreateInfoNV -> IO ExternalMemoryImageCreateInfoNV

poke :: Ptr ExternalMemoryImageCreateInfoNV -> ExternalMemoryImageCreateInfoNV -> IO ()

Show ExternalMemoryImageCreateInfoNV

Defined in Vulkan.Extensions.VK_NV_external_memory

Methods

showsPrec :: Int -> ExternalMemoryImageCreateInfoNV -> ShowS

show :: ExternalMemoryImageCreateInfoNV -> String

showList :: [ExternalMemoryImageCreateInfoNV] -> ShowS

Eq ExternalMemoryImageCreateInfoNV

Defined in Vulkan.Extensions.VK_NV_external_memory

Methods

(==) :: ExternalMemoryImageCreateInfoNV -> ExternalMemoryImageCreateInfoNV -> Bool

(/=) :: ExternalMemoryImageCreateInfoNV -> ExternalMemoryImageCreateInfoNV -> Bool

FromCStruct ExternalMemoryImageCreateInfoNV

Defined in Vulkan.Extensions.VK_NV_external_memory

Methods

peekCStruct :: Ptr ExternalMemoryImageCreateInfoNV -> IO ExternalMemoryImageCreateInfoNV

ToCStruct ExternalMemoryImageCreateInfoNV

Defined in Vulkan.Extensions.VK_NV_external_memory

Methods

withCStruct :: ExternalMemoryImageCreateInfoNV -> (Ptr ExternalMemoryImageCreateInfoNV -> IO b) -> IO b

pokeCStruct :: Ptr ExternalMemoryImageCreateInfoNV -> ExternalMemoryImageCreateInfoNV -> IO b -> IO b

withZeroCStruct :: (Ptr ExternalMemoryImageCreateInfoNV -> IO b) -> IO b

pokeZeroCStruct :: Ptr ExternalMemoryImageCreateInfoNV -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero ExternalMemoryImageCreateInfoNV

Defined in Vulkan.Extensions.VK_NV_external_memory

Methods

zero :: ExternalMemoryImageCreateInfoNV

data ExportMemoryAllocateInfoNV

VkExportMemoryAllocateInfoNV - Specify memory handle types that may be exported

Valid Usage (Implicit)

See Also

VK_NV_external_memory, ExternalMemoryHandleTypeFlagsNV, StructureType

Constructors

ExportMemoryAllocateInfoNV

Fields

• handleTypes :: ExternalMemoryHandleTypeFlagsNV

  handleTypes is a bitmask of ExternalMemoryHandleTypeFlagBitsNV specifying one or more memory handle types that may be exported. Multiple handle types may be requested for the same allocation as long as they are compatible, as reported by getPhysicalDeviceExternalImageFormatPropertiesNV.

  handleTypes must be a valid combination of ExternalMemoryHandleTypeFlagBitsNV values

Instances

Storable ExportMemoryAllocateInfoNV

Defined in Vulkan.Extensions.VK_NV_external_memory

Methods

sizeOf :: ExportMemoryAllocateInfoNV -> Int

alignment :: ExportMemoryAllocateInfoNV -> Int

peekElemOff :: Ptr ExportMemoryAllocateInfoNV -> Int -> IO ExportMemoryAllocateInfoNV

pokeElemOff :: Ptr ExportMemoryAllocateInfoNV -> Int -> ExportMemoryAllocateInfoNV -> IO ()

peekByteOff :: Ptr b -> Int -> IO ExportMemoryAllocateInfoNV

pokeByteOff :: Ptr b -> Int -> ExportMemoryAllocateInfoNV -> IO ()

peek :: Ptr ExportMemoryAllocateInfoNV -> IO ExportMemoryAllocateInfoNV

poke :: Ptr ExportMemoryAllocateInfoNV -> ExportMemoryAllocateInfoNV -> IO ()

Show ExportMemoryAllocateInfoNV

Defined in Vulkan.Extensions.VK_NV_external_memory

Methods

showsPrec :: Int -> ExportMemoryAllocateInfoNV -> ShowS

show :: ExportMemoryAllocateInfoNV -> String

showList :: [ExportMemoryAllocateInfoNV] -> ShowS

Eq ExportMemoryAllocateInfoNV

Defined in Vulkan.Extensions.VK_NV_external_memory

Methods

(==) :: ExportMemoryAllocateInfoNV -> ExportMemoryAllocateInfoNV -> Bool

(/=) :: ExportMemoryAllocateInfoNV -> ExportMemoryAllocateInfoNV -> Bool

FromCStruct ExportMemoryAllocateInfoNV

Defined in Vulkan.Extensions.VK_NV_external_memory

Methods

peekCStruct :: Ptr ExportMemoryAllocateInfoNV -> IO ExportMemoryAllocateInfoNV

ToCStruct ExportMemoryAllocateInfoNV

Defined in Vulkan.Extensions.VK_NV_external_memory

Methods

withCStruct :: ExportMemoryAllocateInfoNV -> (Ptr ExportMemoryAllocateInfoNV -> IO b) -> IO b

pokeCStruct :: Ptr ExportMemoryAllocateInfoNV -> ExportMemoryAllocateInfoNV -> IO b -> IO b

withZeroCStruct :: (Ptr ExportMemoryAllocateInfoNV -> IO b) -> IO b

pokeZeroCStruct :: Ptr ExportMemoryAllocateInfoNV -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero ExportMemoryAllocateInfoNV

Defined in Vulkan.Extensions.VK_NV_external_memory

Methods

zero :: ExportMemoryAllocateInfoNV

type NV_EXTERNAL_MEMORY_SPEC_VERSION = 1

pattern NV_EXTERNAL_MEMORY_SPEC_VERSION :: forall a. Integral a => a

type NV_EXTERNAL_MEMORY_EXTENSION_NAME = "VK_NV_external_memory"

pattern NV_EXTERNAL_MEMORY_EXTENSION_NAME :: forall a. (Eq a, IsString a) => a

newtype ExternalMemoryHandleTypeFlagBitsNV

VkExternalMemoryHandleTypeFlagBitsNV - Bitmask specifying external memory handle types

See Also

VK_NV_external_memory_capabilities, ExternalMemoryHandleTypeFlagsNV

Constructors

ExternalMemoryHandleTypeFlagBitsNV Flags

Bundled Patterns

pattern EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_WIN32_BIT_NV :: ExternalMemoryHandleTypeFlagBitsNV

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().

pattern EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_WIN32_KMT_BIT_NV :: ExternalMemoryHandleTypeFlagBitsNV

EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_WIN32_KMT_BIT_NV specifies a handle to memory returned by getMemoryWin32HandleNV.

pattern EXTERNAL_MEMORY_HANDLE_TYPE_D3D11_IMAGE_BIT_NV :: ExternalMemoryHandleTypeFlagBitsNV

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().

pattern EXTERNAL_MEMORY_HANDLE_TYPE_D3D11_IMAGE_KMT_BIT_NV :: ExternalMemoryHandleTypeFlagBitsNV

EXTERNAL_MEMORY_HANDLE_TYPE_D3D11_IMAGE_KMT_BIT_NV specifies a handle to memory returned by IDXGIResource::GetSharedHandle().

Instances

Storable ExternalMemoryHandleTypeFlagBitsNV

Defined in Vulkan.Extensions.VK_NV_external_memory_capabilities

Methods

sizeOf :: ExternalMemoryHandleTypeFlagBitsNV -> Int

alignment :: ExternalMemoryHandleTypeFlagBitsNV -> Int

peekElemOff :: Ptr ExternalMemoryHandleTypeFlagBitsNV -> Int -> IO ExternalMemoryHandleTypeFlagBitsNV

pokeElemOff :: Ptr ExternalMemoryHandleTypeFlagBitsNV -> Int -> ExternalMemoryHandleTypeFlagBitsNV -> IO ()

peekByteOff :: Ptr b -> Int -> IO ExternalMemoryHandleTypeFlagBitsNV

pokeByteOff :: Ptr b -> Int -> ExternalMemoryHandleTypeFlagBitsNV -> IO ()

peek :: Ptr ExternalMemoryHandleTypeFlagBitsNV -> IO ExternalMemoryHandleTypeFlagBitsNV

poke :: Ptr ExternalMemoryHandleTypeFlagBitsNV -> ExternalMemoryHandleTypeFlagBitsNV -> IO ()

Bits ExternalMemoryHandleTypeFlagBitsNV

Defined in Vulkan.Extensions.VK_NV_external_memory_capabilities

Methods

(.&.) :: ExternalMemoryHandleTypeFlagBitsNV -> ExternalMemoryHandleTypeFlagBitsNV -> ExternalMemoryHandleTypeFlagBitsNV

(.|.) :: ExternalMemoryHandleTypeFlagBitsNV -> ExternalMemoryHandleTypeFlagBitsNV -> ExternalMemoryHandleTypeFlagBitsNV

xor :: ExternalMemoryHandleTypeFlagBitsNV -> ExternalMemoryHandleTypeFlagBitsNV -> ExternalMemoryHandleTypeFlagBitsNV

complement :: ExternalMemoryHandleTypeFlagBitsNV -> ExternalMemoryHandleTypeFlagBitsNV

shift :: ExternalMemoryHandleTypeFlagBitsNV -> Int -> ExternalMemoryHandleTypeFlagBitsNV

rotate :: ExternalMemoryHandleTypeFlagBitsNV -> Int -> ExternalMemoryHandleTypeFlagBitsNV

zeroBits :: ExternalMemoryHandleTypeFlagBitsNV

bit :: Int -> ExternalMemoryHandleTypeFlagBitsNV

setBit :: ExternalMemoryHandleTypeFlagBitsNV -> Int -> ExternalMemoryHandleTypeFlagBitsNV

clearBit :: ExternalMemoryHandleTypeFlagBitsNV -> Int -> ExternalMemoryHandleTypeFlagBitsNV

complementBit :: ExternalMemoryHandleTypeFlagBitsNV -> Int -> ExternalMemoryHandleTypeFlagBitsNV

testBit :: ExternalMemoryHandleTypeFlagBitsNV -> Int -> Bool

bitSizeMaybe :: ExternalMemoryHandleTypeFlagBitsNV -> Maybe Int

bitSize :: ExternalMemoryHandleTypeFlagBitsNV -> Int

isSigned :: ExternalMemoryHandleTypeFlagBitsNV -> Bool

shiftL :: ExternalMemoryHandleTypeFlagBitsNV -> Int -> ExternalMemoryHandleTypeFlagBitsNV

unsafeShiftL :: ExternalMemoryHandleTypeFlagBitsNV -> Int -> ExternalMemoryHandleTypeFlagBitsNV

shiftR :: ExternalMemoryHandleTypeFlagBitsNV -> Int -> ExternalMemoryHandleTypeFlagBitsNV

unsafeShiftR :: ExternalMemoryHandleTypeFlagBitsNV -> Int -> ExternalMemoryHandleTypeFlagBitsNV

rotateL :: ExternalMemoryHandleTypeFlagBitsNV -> Int -> ExternalMemoryHandleTypeFlagBitsNV

rotateR :: ExternalMemoryHandleTypeFlagBitsNV -> Int -> ExternalMemoryHandleTypeFlagBitsNV

popCount :: ExternalMemoryHandleTypeFlagBitsNV -> Int

FiniteBits ExternalMemoryHandleTypeFlagBitsNV

Defined in Vulkan.Extensions.VK_NV_external_memory_capabilities

Methods

finiteBitSize :: ExternalMemoryHandleTypeFlagBitsNV -> Int

countLeadingZeros :: ExternalMemoryHandleTypeFlagBitsNV -> Int

countTrailingZeros :: ExternalMemoryHandleTypeFlagBitsNV -> Int

Read ExternalMemoryHandleTypeFlagBitsNV

Defined in Vulkan.Extensions.VK_NV_external_memory_capabilities

Methods

readsPrec :: Int -> ReadS ExternalMemoryHandleTypeFlagBitsNV

readList :: ReadS [ExternalMemoryHandleTypeFlagBitsNV]

readPrec :: ReadPrec ExternalMemoryHandleTypeFlagBitsNV

readListPrec :: ReadPrec [ExternalMemoryHandleTypeFlagBitsNV]

Show ExternalMemoryHandleTypeFlagBitsNV

Defined in Vulkan.Extensions.VK_NV_external_memory_capabilities

Methods

showsPrec :: Int -> ExternalMemoryHandleTypeFlagBitsNV -> ShowS

show :: ExternalMemoryHandleTypeFlagBitsNV -> String

showList :: [ExternalMemoryHandleTypeFlagBitsNV] -> ShowS

Eq ExternalMemoryHandleTypeFlagBitsNV

Defined in Vulkan.Extensions.VK_NV_external_memory_capabilities

Methods

(==) :: ExternalMemoryHandleTypeFlagBitsNV -> ExternalMemoryHandleTypeFlagBitsNV -> Bool

(/=) :: ExternalMemoryHandleTypeFlagBitsNV -> ExternalMemoryHandleTypeFlagBitsNV -> Bool

Ord ExternalMemoryHandleTypeFlagBitsNV

Defined in Vulkan.Extensions.VK_NV_external_memory_capabilities

Methods

compare :: ExternalMemoryHandleTypeFlagBitsNV -> ExternalMemoryHandleTypeFlagBitsNV -> Ordering

(<) :: ExternalMemoryHandleTypeFlagBitsNV -> ExternalMemoryHandleTypeFlagBitsNV -> Bool

(<=) :: ExternalMemoryHandleTypeFlagBitsNV -> ExternalMemoryHandleTypeFlagBitsNV -> Bool

(>) :: ExternalMemoryHandleTypeFlagBitsNV -> ExternalMemoryHandleTypeFlagBitsNV -> Bool

(>=) :: ExternalMemoryHandleTypeFlagBitsNV -> ExternalMemoryHandleTypeFlagBitsNV -> Bool

max :: ExternalMemoryHandleTypeFlagBitsNV -> ExternalMemoryHandleTypeFlagBitsNV -> ExternalMemoryHandleTypeFlagBitsNV

min :: ExternalMemoryHandleTypeFlagBitsNV -> ExternalMemoryHandleTypeFlagBitsNV -> ExternalMemoryHandleTypeFlagBitsNV

Zero ExternalMemoryHandleTypeFlagBitsNV

Defined in Vulkan.Extensions.VK_NV_external_memory_capabilities

Methods

zero :: ExternalMemoryHandleTypeFlagBitsNV

type ExternalMemoryHandleTypeFlagsNV = ExternalMemoryHandleTypeFlagBitsNV