Vulkan.Extensions.VK_FUCHSIA_external_memory

Name

VK_FUCHSIA_external_memory - device extension

VK_FUCHSIA_external_memory

Name String

VK_FUCHSIA_external_memory

Extension Type

Device extension

Registered Extension Number

365

Revision

1

Extension and Version Dependencies

• Requires Vulkan 1.0
• Requires VK_KHR_external_memory_capabilities
• Requires VK_KHR_external_memory

Contact

• John Rosasco @rosasco%0A<<Here describe the issue or question you have about the VK_FUCHSIA_external_memory extension> >

Other Extension Metadata

Last Modified Date

2021-03-01

IP Status

No known IP claims.

Contributors

• Craig Stout, Google
• John Bauman, Google
• John Rosasco, Google

Description

Vulkan apps may wish to export or import device memory handles to or from other logical devices, instances or APIs.

This memory sharing can eliminate copies of memory buffers when different subsystems need to interoperate on them. Sharing memory buffers may also facilitate a better distribution of processing workload for more complex memory manipulation pipelines.

New Commands

• getMemoryZirconHandleFUCHSIA

• getMemoryZirconHandlePropertiesFUCHSIA

New Structures

• MemoryGetZirconHandleInfoFUCHSIA

• MemoryZirconHandlePropertiesFUCHSIA

• Extending MemoryAllocateInfo:

  • ImportMemoryZirconHandleInfoFUCHSIA

New Enum Constants

• FUCHSIA_EXTERNAL_MEMORY_EXTENSION_NAME

• FUCHSIA_EXTERNAL_MEMORY_SPEC_VERSION

• Extending ExternalMemoryHandleTypeFlagBits:

  • EXTERNAL_MEMORY_HANDLE_TYPE_ZIRCON_VMO_BIT_FUCHSIA

• Extending StructureType:

  • STRUCTURE_TYPE_IMPORT_MEMORY_ZIRCON_HANDLE_INFO_FUCHSIA
  • STRUCTURE_TYPE_MEMORY_GET_ZIRCON_HANDLE_INFO_FUCHSIA
  • STRUCTURE_TYPE_MEMORY_ZIRCON_HANDLE_PROPERTIES_FUCHSIA

Issues

See VK_KHR_external_memory issues list for further information.

Version History

• Revision 1, 2021-03-01 (John Rosasco)

  • Initial draft

See Also

ImportMemoryZirconHandleInfoFUCHSIA, MemoryGetZirconHandleInfoFUCHSIA, MemoryZirconHandlePropertiesFUCHSIA, getMemoryZirconHandleFUCHSIA, getMemoryZirconHandlePropertiesFUCHSIA

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

getMemoryZirconHandleFUCHSIA

Arguments

:: forall io. MonadIO io

=> Device

device is the Device.

device must be a valid Device handle

-> MemoryGetZirconHandleInfoFUCHSIA

pGetZirconHandleInfo is a pointer to a MemoryGetZirconHandleInfoFUCHSIA structure.

pGetZirconHandleInfo must be a valid pointer to a valid MemoryGetZirconHandleInfoFUCHSIA structure

-> io ("zirconHandle" ::: Zx_handle_t)

vkGetMemoryZirconHandleFUCHSIA - Get a Zircon handle for an external memory object

Return Codes

Success

• SUCCESS

Failure

• ERROR_TOO_MANY_OBJECTS
• ERROR_OUT_OF_HOST_MEMORY

See Also

VK_FUCHSIA_external_memory, Device, MemoryGetZirconHandleInfoFUCHSIA

getMemoryZirconHandlePropertiesFUCHSIA

Arguments

:: forall io. MonadIO io

=> Device

device is the Device.

device must be a valid Device handle

-> ExternalMemoryHandleTypeFlagBits

handleType is a ExternalMemoryHandleTypeFlagBits value specifying the type of zirconHandle

handleType must be EXTERNAL_MEMORY_HANDLE_TYPE_ZIRCON_VMO_BIT_FUCHSIA

handleType must be a valid ExternalMemoryHandleTypeFlagBits value

-> ("zirconHandle" ::: Zx_handle_t)

zirconHandle is a zx_handle_t (Zircon) handle to the external resource.

zirconHandle must reference a valid VMO

-> io MemoryZirconHandlePropertiesFUCHSIA

vkGetMemoryZirconHandlePropertiesFUCHSIA - Get a Zircon handle properties for an external memory object

Return Codes

Success

• SUCCESS

Failure

• ERROR_INVALID_EXTERNAL_HANDLE

See Also

VK_FUCHSIA_external_memory, Device, ExternalMemoryHandleTypeFlagBits, MemoryZirconHandlePropertiesFUCHSIA

data ImportMemoryZirconHandleInfoFUCHSIA

VkImportMemoryZirconHandleInfoFUCHSIA - Structure specifying import parameters for Zircon handle to external memory

Valid Usage

• handleType must be EXTERNAL_MEMORY_HANDLE_TYPE_ZIRCON_VMO_BIT_FUCHSIA

• handle must be a valid VMO handle

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_IMPORT_MEMORY_ZIRCON_HANDLE_INFO_FUCHSIA

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

See Also

VK_FUCHSIA_external_memory, ExternalMemoryHandleTypeFlagBits, StructureType

Constructors

ImportMemoryZirconHandleInfoFUCHSIA

Fields

• handleType :: ExternalMemoryHandleTypeFlagBits

  handleType is a ExternalMemoryHandleTypeFlagBits value specifying the type of handle.

• handle :: Zx_handle_t

  handle is a zx_handle_t (Zircon) handle to the external memory.

Instances

Eq ImportMemoryZirconHandleInfoFUCHSIA

Defined in Vulkan.Extensions.VK_FUCHSIA_external_memory

Methods

(==) :: ImportMemoryZirconHandleInfoFUCHSIA -> ImportMemoryZirconHandleInfoFUCHSIA -> Bool

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

Show ImportMemoryZirconHandleInfoFUCHSIA

Defined in Vulkan.Extensions.VK_FUCHSIA_external_memory

Methods

showsPrec :: Int -> ImportMemoryZirconHandleInfoFUCHSIA -> ShowS

show :: ImportMemoryZirconHandleInfoFUCHSIA -> String

showList :: [ImportMemoryZirconHandleInfoFUCHSIA] -> ShowS

Storable ImportMemoryZirconHandleInfoFUCHSIA

Defined in Vulkan.Extensions.VK_FUCHSIA_external_memory

Methods

sizeOf :: ImportMemoryZirconHandleInfoFUCHSIA -> Int

alignment :: ImportMemoryZirconHandleInfoFUCHSIA -> Int

peekElemOff :: Ptr ImportMemoryZirconHandleInfoFUCHSIA -> Int -> IO ImportMemoryZirconHandleInfoFUCHSIA

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

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

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

peek :: Ptr ImportMemoryZirconHandleInfoFUCHSIA -> IO ImportMemoryZirconHandleInfoFUCHSIA

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

FromCStruct ImportMemoryZirconHandleInfoFUCHSIA

Defined in Vulkan.Extensions.VK_FUCHSIA_external_memory

Methods

peekCStruct :: Ptr ImportMemoryZirconHandleInfoFUCHSIA -> IO ImportMemoryZirconHandleInfoFUCHSIA

ToCStruct ImportMemoryZirconHandleInfoFUCHSIA

Defined in Vulkan.Extensions.VK_FUCHSIA_external_memory

Methods

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

pokeCStruct :: Ptr ImportMemoryZirconHandleInfoFUCHSIA -> ImportMemoryZirconHandleInfoFUCHSIA -> IO b -> IO b

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

pokeZeroCStruct :: Ptr ImportMemoryZirconHandleInfoFUCHSIA -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero ImportMemoryZirconHandleInfoFUCHSIA

Defined in Vulkan.Extensions.VK_FUCHSIA_external_memory

Methods

zero :: ImportMemoryZirconHandleInfoFUCHSIA

data MemoryZirconHandlePropertiesFUCHSIA

VkMemoryZirconHandlePropertiesFUCHSIA - Structure specifying Zircon handle compatible external memory

Valid Usage (Implicit)

See Also

VK_FUCHSIA_external_memory, StructureType, getMemoryZirconHandlePropertiesFUCHSIA

Constructors

MemoryZirconHandlePropertiesFUCHSIA

Fields

• memoryTypeBits :: Word32

  memoryTypeBits a bitmask containing one bit set for every memory type which the specified handle can be imported as.

Instances

Eq MemoryZirconHandlePropertiesFUCHSIA

Defined in Vulkan.Extensions.VK_FUCHSIA_external_memory

Methods

(==) :: MemoryZirconHandlePropertiesFUCHSIA -> MemoryZirconHandlePropertiesFUCHSIA -> Bool

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

Show MemoryZirconHandlePropertiesFUCHSIA

Defined in Vulkan.Extensions.VK_FUCHSIA_external_memory

Methods

showsPrec :: Int -> MemoryZirconHandlePropertiesFUCHSIA -> ShowS

show :: MemoryZirconHandlePropertiesFUCHSIA -> String

showList :: [MemoryZirconHandlePropertiesFUCHSIA] -> ShowS

Storable MemoryZirconHandlePropertiesFUCHSIA

Defined in Vulkan.Extensions.VK_FUCHSIA_external_memory

Methods

sizeOf :: MemoryZirconHandlePropertiesFUCHSIA -> Int

alignment :: MemoryZirconHandlePropertiesFUCHSIA -> Int

peekElemOff :: Ptr MemoryZirconHandlePropertiesFUCHSIA -> Int -> IO MemoryZirconHandlePropertiesFUCHSIA

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

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

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

peek :: Ptr MemoryZirconHandlePropertiesFUCHSIA -> IO MemoryZirconHandlePropertiesFUCHSIA

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

FromCStruct MemoryZirconHandlePropertiesFUCHSIA

Defined in Vulkan.Extensions.VK_FUCHSIA_external_memory

Methods

peekCStruct :: Ptr MemoryZirconHandlePropertiesFUCHSIA -> IO MemoryZirconHandlePropertiesFUCHSIA

ToCStruct MemoryZirconHandlePropertiesFUCHSIA

Defined in Vulkan.Extensions.VK_FUCHSIA_external_memory

Methods

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

pokeCStruct :: Ptr MemoryZirconHandlePropertiesFUCHSIA -> MemoryZirconHandlePropertiesFUCHSIA -> IO b -> IO b

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

pokeZeroCStruct :: Ptr MemoryZirconHandlePropertiesFUCHSIA -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero MemoryZirconHandlePropertiesFUCHSIA

Defined in Vulkan.Extensions.VK_FUCHSIA_external_memory

Methods

zero :: MemoryZirconHandlePropertiesFUCHSIA

data MemoryGetZirconHandleInfoFUCHSIA

VkMemoryGetZirconHandleInfoFUCHSIA - Structure specifying export parameters for Zircon handle to device memory

Valid Usage (Implicit)

See Also

VK_FUCHSIA_external_memory, DeviceMemory, ExternalMemoryHandleTypeFlagBits, StructureType, getMemoryZirconHandleFUCHSIA

Constructors

MemoryGetZirconHandleInfoFUCHSIA

Fields

• memory :: DeviceMemory

  memory the DeviceMemory being exported.

  memory must be a valid DeviceMemory handle

• handleType :: ExternalMemoryHandleTypeFlagBits

  handleType is a ExternalMemoryHandleTypeFlagBits value specifying the type of the handle pointed to by getMemoryZirconHandleFUCHSIA::pZirconHandle.

  handleType must be EXTERNAL_MEMORY_HANDLE_TYPE_ZIRCON_VMO_BIT_FUCHSIA

  handleType must have been included in the handleTypes field of the ExportMemoryAllocateInfo structure when the external memory was allocated

  handleType must be a valid ExternalMemoryHandleTypeFlagBits value

Instances

Eq MemoryGetZirconHandleInfoFUCHSIA

Defined in Vulkan.Extensions.VK_FUCHSIA_external_memory

Methods

(==) :: MemoryGetZirconHandleInfoFUCHSIA -> MemoryGetZirconHandleInfoFUCHSIA -> Bool

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

Show MemoryGetZirconHandleInfoFUCHSIA

Defined in Vulkan.Extensions.VK_FUCHSIA_external_memory

Methods

showsPrec :: Int -> MemoryGetZirconHandleInfoFUCHSIA -> ShowS

show :: MemoryGetZirconHandleInfoFUCHSIA -> String

showList :: [MemoryGetZirconHandleInfoFUCHSIA] -> ShowS

Storable MemoryGetZirconHandleInfoFUCHSIA

Defined in Vulkan.Extensions.VK_FUCHSIA_external_memory

Methods

sizeOf :: MemoryGetZirconHandleInfoFUCHSIA -> Int

alignment :: MemoryGetZirconHandleInfoFUCHSIA -> Int

peekElemOff :: Ptr MemoryGetZirconHandleInfoFUCHSIA -> Int -> IO MemoryGetZirconHandleInfoFUCHSIA

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

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

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

peek :: Ptr MemoryGetZirconHandleInfoFUCHSIA -> IO MemoryGetZirconHandleInfoFUCHSIA

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

FromCStruct MemoryGetZirconHandleInfoFUCHSIA

Defined in Vulkan.Extensions.VK_FUCHSIA_external_memory

Methods

peekCStruct :: Ptr MemoryGetZirconHandleInfoFUCHSIA -> IO MemoryGetZirconHandleInfoFUCHSIA

ToCStruct MemoryGetZirconHandleInfoFUCHSIA

Defined in Vulkan.Extensions.VK_FUCHSIA_external_memory

Methods

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

pokeCStruct :: Ptr MemoryGetZirconHandleInfoFUCHSIA -> MemoryGetZirconHandleInfoFUCHSIA -> IO b -> IO b

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

pokeZeroCStruct :: Ptr MemoryGetZirconHandleInfoFUCHSIA -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero MemoryGetZirconHandleInfoFUCHSIA

Defined in Vulkan.Extensions.VK_FUCHSIA_external_memory

Methods

zero :: MemoryGetZirconHandleInfoFUCHSIA

type FUCHSIA_EXTERNAL_MEMORY_SPEC_VERSION = 1

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

type FUCHSIA_EXTERNAL_MEMORY_EXTENSION_NAME = "VK_FUCHSIA_external_memory"

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

type Zx_handle_t = Word32