vulkan-3.26.1: Bindings to the Vulkan graphics API.
Safe HaskellSafe-Inferred
LanguageHaskell2010

Vulkan.Extensions.VK_NV_external_memory

Description

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
Ratification Status
Not ratified
Extension and Version Dependencies
VK_NV_external_memory_capabilities
Deprecation State
  • Deprecated by VK_KHR_external_memory extension

Contact

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

New Enum Constants

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.

Synopsis

Documentation

data ExternalMemoryImageCreateInfoNV Source #

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

Instances

Instances details
Storable ExternalMemoryImageCreateInfoNV Source # 
Instance details

Defined in Vulkan.Extensions.VK_NV_external_memory

Show ExternalMemoryImageCreateInfoNV Source # 
Instance details

Defined in Vulkan.Extensions.VK_NV_external_memory

Eq ExternalMemoryImageCreateInfoNV Source # 
Instance details

Defined in Vulkan.Extensions.VK_NV_external_memory

FromCStruct ExternalMemoryImageCreateInfoNV Source # 
Instance details

Defined in Vulkan.Extensions.VK_NV_external_memory

ToCStruct ExternalMemoryImageCreateInfoNV Source # 
Instance details

Defined in Vulkan.Extensions.VK_NV_external_memory

Zero ExternalMemoryImageCreateInfoNV Source # 
Instance details

Defined in Vulkan.Extensions.VK_NV_external_memory

data ExportMemoryAllocateInfoNV Source #

VkExportMemoryAllocateInfoNV - Specify memory handle types that may be exported

Valid Usage (Implicit)

See Also

VK_NV_external_memory, ExternalMemoryHandleTypeFlagsNV, StructureType

Constructors

ExportMemoryAllocateInfoNV 

Fields

Instances

Instances details
Storable ExportMemoryAllocateInfoNV Source # 
Instance details

Defined in Vulkan.Extensions.VK_NV_external_memory

Show ExportMemoryAllocateInfoNV Source # 
Instance details

Defined in Vulkan.Extensions.VK_NV_external_memory

Eq ExportMemoryAllocateInfoNV Source # 
Instance details

Defined in Vulkan.Extensions.VK_NV_external_memory

FromCStruct ExportMemoryAllocateInfoNV Source # 
Instance details

Defined in Vulkan.Extensions.VK_NV_external_memory

ToCStruct ExportMemoryAllocateInfoNV Source # 
Instance details

Defined in Vulkan.Extensions.VK_NV_external_memory

Zero ExportMemoryAllocateInfoNV Source # 
Instance details

Defined in Vulkan.Extensions.VK_NV_external_memory

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

type NV_EXTERNAL_MEMORY_EXTENSION_NAME = "VK_NV_external_memory" Source #

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

newtype ExternalMemoryHandleTypeFlagBitsNV Source #

VkExternalMemoryHandleTypeFlagBitsNV - Bitmask specifying external memory handle types

See Also

VK_NV_external_memory_capabilities, ExternalMemoryHandleTypeFlagsNV

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

Instances details
Storable ExternalMemoryHandleTypeFlagBitsNV Source # 
Instance details

Defined in Vulkan.Extensions.VK_NV_external_memory_capabilities

Bits ExternalMemoryHandleTypeFlagBitsNV Source # 
Instance details

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 Source # 
Instance details

Defined in Vulkan.Extensions.VK_NV_external_memory_capabilities

Read ExternalMemoryHandleTypeFlagBitsNV Source # 
Instance details

Defined in Vulkan.Extensions.VK_NV_external_memory_capabilities

Show ExternalMemoryHandleTypeFlagBitsNV Source # 
Instance details

Defined in Vulkan.Extensions.VK_NV_external_memory_capabilities

Eq ExternalMemoryHandleTypeFlagBitsNV Source # 
Instance details

Defined in Vulkan.Extensions.VK_NV_external_memory_capabilities

Ord ExternalMemoryHandleTypeFlagBitsNV Source # 
Instance details

Defined in Vulkan.Extensions.VK_NV_external_memory_capabilities

Zero ExternalMemoryHandleTypeFlagBitsNV Source # 
Instance details

Defined in Vulkan.Extensions.VK_NV_external_memory_capabilities