Safe Haskell	None
Language	Haskell2010

Vulkan.Extensions.VK_EXT_external_memory_metal

Description

Name

VK_EXT_external_memory_metal - device extension

VK_EXT_external_memory_metal

Name String: VK_EXT_external_memory_metal

Extension Type

Device extension

Registered Extension Number

603

Revision

1

Ratification Status

Ratified

Extension and Version Dependencies

VK_KHR_external_memory or Vulkan Version 1.1

Contact

Aitor Camacho Larrondo @aitor-lunarg%0A*Here describe the issue or question you have about the VK_EXT_external_memory_metal extension*

Extension Proposal

VK_EXT_external_memory_metal

Other Extension Metadata

Last Modified Date: 2024-07-18

IP Status

No known IP claims.

Contributors

Aitor Camacho Larrondo, LunarG Inc.

Description

An application may wish to reference device memory in multiple Vulkan device instances, in multiple processes, and/or in Metal API. This extension enables an application to export and import Metal handles from Vulkan memory objects such that the underlying resources can be referenced outside the scope of the Vulkan device instance that created them.

New Commands

getMemoryMetalHandleEXT

getMemoryMetalHandlePropertiesEXT

New Structures

MemoryGetMetalHandleInfoEXT

MemoryMetalHandlePropertiesEXT
Extending MemoryAllocateInfo:
- ImportMemoryMetalHandleInfoEXT

New Enum Constants

EXT_EXTERNAL_MEMORY_METAL_EXTENSION_NAME

Version History

Revision 1, 2024-07-18 (Aitor Camacho Larrondo)
- Initial revision

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

getMemoryMetalHandleEXT :: MonadIO io => Device -> MemoryGetMetalHandleInfoEXT -> io ("handle" ::: Ptr ())
getMemoryMetalHandlePropertiesEXT :: MonadIO io => Device -> ExternalMemoryHandleTypeFlagBits -> ("handle" ::: Ptr ()) -> io MemoryMetalHandlePropertiesEXT
data ImportMemoryMetalHandleInfoEXT = ImportMemoryMetalHandleInfoEXT {
- handleType :: ExternalMemoryHandleTypeFlagBits
- handle :: Ptr ()
}
data MemoryMetalHandlePropertiesEXT = MemoryMetalHandlePropertiesEXT {
- memoryTypeBits :: Word32
}
data MemoryGetMetalHandleInfoEXT = MemoryGetMetalHandleInfoEXT {
- memory :: DeviceMemory
- handleType :: ExternalMemoryHandleTypeFlagBits
}
type EXT_EXTERNAL_MEMORY_METAL_SPEC_VERSION = 1
pattern EXT_EXTERNAL_MEMORY_METAL_SPEC_VERSION :: Integral a => a
type EXT_EXTERNAL_MEMORY_METAL_EXTENSION_NAME = "VK_EXT_external_memory_metal"
pattern EXT_EXTERNAL_MEMORY_METAL_EXTENSION_NAME :: (Eq a, IsString a) => a

Documentation

getMemoryMetalHandleEXT Source #

Arguments

:: MonadIO io
=> Device	`device` is the logical device that created the device memory being exported. `device` must be a valid `Device` handle
-> MemoryGetMetalHandleInfoEXT	`pGetMetalHandleInfo` is a pointer to a `MemoryGetMetalHandleInfoEXT` structure containing parameters of the export operation. `pGetMetalHandleInfo` must be a valid pointer to a valid `MemoryGetMetalHandleInfoEXT` structure
-> io ("handle" ::: Ptr ())

vkGetMemoryMetalHandleEXT - Get a Metal handle for a memory object

Description

Unless the app retains the handle object returned by the call, the lifespan will be the same as the associated DeviceMemory.

Return Codes

Success

SUCCESS

Failure

Description

Importing memory object payloads from Metal handles shares the ownership of the handle to the Vulkan implementation.

Applications can import the same payload into multiple instances of Vulkan, into the same instance from which it was exported, and multiple times into a given Vulkan instance. In all cases, each import operation must create a distinct DeviceMemory object.

Valid Usage

If handleType is not 0, it must be supported for import, as reported by ExternalImageFormatProperties or ExternalBufferProperties

The memory from which handle was exported must have been created on the same underlying physical device as device
If handleType is not 0, it must be EXTERNAL_MEMORY_HANDLE_TYPE_MTLBUFFER_BIT_EXT, EXTERNAL_MEMORY_HANDLE_TYPE_MTLTEXTURE_BIT_EXT or EXTERNAL_MEMORY_HANDLE_TYPE_MTLHEAP_BIT_EXT
If handleType is not 0 , handle must be a valid non-NULL handle of the type specified by handleType
handle must obey any requirements listed for handleType in external memory handle types compatibility

Valid Usage (Implicit)

sType must be STRUCTURE_TYPE_IMPORT_MEMORY_METAL_HANDLE_INFO_EXT

If handleType is not 0, handleType must be a valid ExternalMemoryHandleTypeFlagBits value

Description

The properties of the handle returned depend on the value of handleType. See ExternalMemoryHandleTypeFlagBits for a description of the properties of the defined external memory handle types.

Valid Usage (Implicit)

memory :: DeviceMemory
memory is the memory object from which the handle will be exported.
memory must have been created with a valid ExportMemoryAllocateInfo
memory must be a valid DeviceMemory handle
handleType :: ExternalMemoryHandleTypeFlagBits
handleType is a ExternalMemoryHandleTypeFlagBits value specifying the type of handle requested.
handleType must have been included in ExportMemoryAllocateInfo::handleTypes when memory was created
handleType must be EXTERNAL_MEMORY_HANDLE_TYPE_MTLBUFFER_BIT_EXT, EXTERNAL_MEMORY_HANDLE_TYPE_MTLTEXTURE_BIT_EXT or EXTERNAL_MEMORY_HANDLE_TYPE_MTLHEAP_BIT_EXT
handleType must be a valid ExternalMemoryHandleTypeFlagBits value

Instances

Instances details

Eq MemoryGetMetalHandleInfoEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_external_memory_metal Methods (==) :: MemoryGetMetalHandleInfoEXT -> MemoryGetMetalHandleInfoEXT -> Bool # (/=) :: MemoryGetMetalHandleInfoEXT -> MemoryGetMetalHandleInfoEXT -> Bool #
Storable MemoryGetMetalHandleInfoEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_external_memory_metal Methods sizeOf :: MemoryGetMetalHandleInfoEXT -> Int # alignment :: MemoryGetMetalHandleInfoEXT -> Int # peekElemOff :: Ptr MemoryGetMetalHandleInfoEXT -> Int -> IO MemoryGetMetalHandleInfoEXT # pokeElemOff :: Ptr MemoryGetMetalHandleInfoEXT -> Int -> MemoryGetMetalHandleInfoEXT -> IO () # peekByteOff :: Ptr b -> Int -> IO MemoryGetMetalHandleInfoEXT # pokeByteOff :: Ptr b -> Int -> MemoryGetMetalHandleInfoEXT -> IO () # peek :: Ptr MemoryGetMetalHandleInfoEXT -> IO MemoryGetMetalHandleInfoEXT # poke :: Ptr MemoryGetMetalHandleInfoEXT -> MemoryGetMetalHandleInfoEXT -> IO () #
Show MemoryGetMetalHandleInfoEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_external_memory_metal Methods showsPrec :: Int -> MemoryGetMetalHandleInfoEXT -> ShowS # show :: MemoryGetMetalHandleInfoEXT -> String # showList :: [MemoryGetMetalHandleInfoEXT] -> ShowS #
FromCStruct MemoryGetMetalHandleInfoEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_external_memory_metal Methods peekCStruct :: Ptr MemoryGetMetalHandleInfoEXT -> IO MemoryGetMetalHandleInfoEXT Source #
ToCStruct MemoryGetMetalHandleInfoEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_external_memory_metal Methods withCStruct :: MemoryGetMetalHandleInfoEXT -> (Ptr MemoryGetMetalHandleInfoEXT -> IO b) -> IO b Source # pokeCStruct :: Ptr MemoryGetMetalHandleInfoEXT -> MemoryGetMetalHandleInfoEXT -> IO b -> IO b Source # withZeroCStruct :: (Ptr MemoryGetMetalHandleInfoEXT -> IO b) -> IO b Source # pokeZeroCStruct :: Ptr MemoryGetMetalHandleInfoEXT -> IO b -> IO b Source # cStructSize :: Int Source # cStructAlignment :: Int Source #
Zero MemoryGetMetalHandleInfoEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_external_memory_metal Methods zero :: MemoryGetMetalHandleInfoEXT Source #

type EXT_EXTERNAL_MEMORY_METAL_SPEC_VERSION = 1 Source #

pattern EXT_EXTERNAL_MEMORY_METAL_SPEC_VERSION :: Integral a => a Source #

type EXT_EXTERNAL_MEMORY_METAL_EXTENSION_NAME = "VK_EXT_external_memory_metal" Source #

pattern EXT_EXTERNAL_MEMORY_METAL_EXTENSION_NAME :: (Eq a, IsString a) => a Source #

Storable ImportMemoryMetalHandleInfoEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_external_memory_metal Methods sizeOf :: ImportMemoryMetalHandleInfoEXT -> Int # alignment :: ImportMemoryMetalHandleInfoEXT -> Int # peekElemOff :: Ptr ImportMemoryMetalHandleInfoEXT -> Int -> IO ImportMemoryMetalHandleInfoEXT # pokeElemOff :: Ptr ImportMemoryMetalHandleInfoEXT -> Int -> ImportMemoryMetalHandleInfoEXT -> IO () # peekByteOff :: Ptr b -> Int -> IO ImportMemoryMetalHandleInfoEXT # pokeByteOff :: Ptr b -> Int -> ImportMemoryMetalHandleInfoEXT -> IO () # peek :: Ptr ImportMemoryMetalHandleInfoEXT -> IO ImportMemoryMetalHandleInfoEXT # poke :: Ptr ImportMemoryMetalHandleInfoEXT -> ImportMemoryMetalHandleInfoEXT -> IO () #
Show ImportMemoryMetalHandleInfoEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_external_memory_metal Methods showsPrec :: Int -> ImportMemoryMetalHandleInfoEXT -> ShowS # show :: ImportMemoryMetalHandleInfoEXT -> String # showList :: [ImportMemoryMetalHandleInfoEXT] -> ShowS #
FromCStruct ImportMemoryMetalHandleInfoEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_external_memory_metal Methods peekCStruct :: Ptr ImportMemoryMetalHandleInfoEXT -> IO ImportMemoryMetalHandleInfoEXT Source #
ToCStruct ImportMemoryMetalHandleInfoEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_external_memory_metal Methods withCStruct :: ImportMemoryMetalHandleInfoEXT -> (Ptr ImportMemoryMetalHandleInfoEXT -> IO b) -> IO b Source # pokeCStruct :: Ptr ImportMemoryMetalHandleInfoEXT -> ImportMemoryMetalHandleInfoEXT -> IO b -> IO b Source # withZeroCStruct :: (Ptr ImportMemoryMetalHandleInfoEXT -> IO b) -> IO b Source # pokeZeroCStruct :: Ptr ImportMemoryMetalHandleInfoEXT -> IO b -> IO b Source # cStructSize :: Int Source # cStructAlignment :: Int Source #
Zero ImportMemoryMetalHandleInfoEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_external_memory_metal Methods zero :: ImportMemoryMetalHandleInfoEXT Source #

Eq MemoryMetalHandlePropertiesEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_external_memory_metal Methods (==) :: MemoryMetalHandlePropertiesEXT -> MemoryMetalHandlePropertiesEXT -> Bool # (/=) :: MemoryMetalHandlePropertiesEXT -> MemoryMetalHandlePropertiesEXT -> Bool #
Storable MemoryMetalHandlePropertiesEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_external_memory_metal Methods sizeOf :: MemoryMetalHandlePropertiesEXT -> Int # alignment :: MemoryMetalHandlePropertiesEXT -> Int # peekElemOff :: Ptr MemoryMetalHandlePropertiesEXT -> Int -> IO MemoryMetalHandlePropertiesEXT # pokeElemOff :: Ptr MemoryMetalHandlePropertiesEXT -> Int -> MemoryMetalHandlePropertiesEXT -> IO () # peekByteOff :: Ptr b -> Int -> IO MemoryMetalHandlePropertiesEXT # pokeByteOff :: Ptr b -> Int -> MemoryMetalHandlePropertiesEXT -> IO () # peek :: Ptr MemoryMetalHandlePropertiesEXT -> IO MemoryMetalHandlePropertiesEXT # poke :: Ptr MemoryMetalHandlePropertiesEXT -> MemoryMetalHandlePropertiesEXT -> IO () #
Show MemoryMetalHandlePropertiesEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_external_memory_metal Methods showsPrec :: Int -> MemoryMetalHandlePropertiesEXT -> ShowS # show :: MemoryMetalHandlePropertiesEXT -> String # showList :: [MemoryMetalHandlePropertiesEXT] -> ShowS #
FromCStruct MemoryMetalHandlePropertiesEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_external_memory_metal Methods peekCStruct :: Ptr MemoryMetalHandlePropertiesEXT -> IO MemoryMetalHandlePropertiesEXT Source #
ToCStruct MemoryMetalHandlePropertiesEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_external_memory_metal Methods withCStruct :: MemoryMetalHandlePropertiesEXT -> (Ptr MemoryMetalHandlePropertiesEXT -> IO b) -> IO b Source # pokeCStruct :: Ptr MemoryMetalHandlePropertiesEXT -> MemoryMetalHandlePropertiesEXT -> IO b -> IO b Source # withZeroCStruct :: (Ptr MemoryMetalHandlePropertiesEXT -> IO b) -> IO b Source # pokeZeroCStruct :: Ptr MemoryMetalHandlePropertiesEXT -> IO b -> IO b Source # cStructSize :: Int Source # cStructAlignment :: Int Source #
Zero MemoryMetalHandlePropertiesEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_external_memory_metal Methods zero :: MemoryMetalHandlePropertiesEXT Source #

Name

VK_EXT_external_memory_metal

Other Extension Metadata

Description

New Commands

New Structures

New Enum Constants

Version History

See Also

Document Notes

Documentation

Description

Return Codes

See Also

Return Codes

See Also

Description

Valid Usage

Valid Usage (Implicit)

See Also

Instances

Valid Usage (Implicit)

See Also

Instances

Description

Valid Usage (Implicit)

See Also

Instances

:: MonadIO io
=> Device	`device` is the logical device that will be importing `pHandle`. `device` must be a valid `Device` handle
-> ExternalMemoryHandleTypeFlagBits	`handleType` is a `ExternalMemoryHandleTypeFlagBits` value specifying the type of the handle `pHandle`. `handleType` must be `EXTERNAL_MEMORY_HANDLE_TYPE_MTLBUFFER_BIT_EXT`, `EXTERNAL_MEMORY_HANDLE_TYPE_MTLTEXTURE_BIT_EXT` or `EXTERNAL_MEMORY_HANDLE_TYPE_MTLHEAP_BIT_EXT` `handleType` must be a valid `ExternalMemoryHandleTypeFlagBits` value
-> ("handle" ::: Ptr ())	`pHandle` is the handle which will be imported. `pHandle` must point to a valid id<MTLBuffer>, id<MTLTexture> or id<MTLDevice> `pHandle` must be a pointer value
-> io MemoryMetalHandlePropertiesEXT

ImportMemoryMetalHandleInfoEXT
Fields handleType :: ExternalMemoryHandleTypeFlagBits `handleType` is a `ExternalMemoryHandleTypeFlagBits` value specifying the type of `handle` or `name`. handle :: Ptr () `handle` is `NULL` or the external handle to import.

MemoryMetalHandlePropertiesEXT
Fields memoryTypeBits :: Word32 `memoryTypeBits` is a bitmask containing one bit set for every memory type which the specified Metal handle can be imported as.