Safe Haskell	Safe-Inferred
Language	Haskell2010

Vulkan.Extensions.VK_FUCHSIA_external_memory

Description

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

Ratification Status

Not ratified

Extension and Version Dependencies

VK_KHR_external_memory_capabilities and 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

Issues

See VK_KHR_external_memory issues list for further information.

Version History

Revision 1, 2021-03-01 (John Rosasco)
- Initial draft

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

getMemoryZirconHandleFUCHSIA :: forall io. MonadIO io => Device -> MemoryGetZirconHandleInfoFUCHSIA -> io ("zirconHandle" ::: Zx_handle_t)
getMemoryZirconHandlePropertiesFUCHSIA :: forall io. MonadIO io => Device -> ExternalMemoryHandleTypeFlagBits -> ("zirconHandle" ::: Zx_handle_t) -> io MemoryZirconHandlePropertiesFUCHSIA
data ImportMemoryZirconHandleInfoFUCHSIA = ImportMemoryZirconHandleInfoFUCHSIA {
- handleType :: ExternalMemoryHandleTypeFlagBits
- handle :: Zx_handle_t
}
data MemoryZirconHandlePropertiesFUCHSIA = MemoryZirconHandlePropertiesFUCHSIA {
- memoryTypeBits :: Word32
}
data MemoryGetZirconHandleInfoFUCHSIA = MemoryGetZirconHandleInfoFUCHSIA {
- memory :: DeviceMemory
- handleType :: ExternalMemoryHandleTypeFlagBits
}
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

Documentation

getMemoryZirconHandleFUCHSIA Source #

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

Storable ImportMemoryZirconHandleInfoFUCHSIA Source #
Instance details 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 () #
Show ImportMemoryZirconHandleInfoFUCHSIA Source #
Instance details Defined in Vulkan.Extensions.VK_FUCHSIA_external_memory Methods showsPrec :: Int -> ImportMemoryZirconHandleInfoFUCHSIA -> ShowS # show :: ImportMemoryZirconHandleInfoFUCHSIA -> String # showList :: [ImportMemoryZirconHandleInfoFUCHSIA] -> ShowS #
Eq ImportMemoryZirconHandleInfoFUCHSIA Source #
Instance details Defined in Vulkan.Extensions.VK_FUCHSIA_external_memory Methods (==) :: ImportMemoryZirconHandleInfoFUCHSIA -> ImportMemoryZirconHandleInfoFUCHSIA -> Bool # (/=) :: ImportMemoryZirconHandleInfoFUCHSIA -> ImportMemoryZirconHandleInfoFUCHSIA -> Bool #
FromCStruct ImportMemoryZirconHandleInfoFUCHSIA Source #
Instance details Defined in Vulkan.Extensions.VK_FUCHSIA_external_memory Methods peekCStruct :: Ptr ImportMemoryZirconHandleInfoFUCHSIA -> IO ImportMemoryZirconHandleInfoFUCHSIA Source #
ToCStruct ImportMemoryZirconHandleInfoFUCHSIA Source #
Instance details Defined in Vulkan.Extensions.VK_FUCHSIA_external_memory Methods withCStruct :: ImportMemoryZirconHandleInfoFUCHSIA -> (Ptr ImportMemoryZirconHandleInfoFUCHSIA -> IO b) -> IO b Source # pokeCStruct :: Ptr ImportMemoryZirconHandleInfoFUCHSIA -> ImportMemoryZirconHandleInfoFUCHSIA -> IO b -> IO b Source # withZeroCStruct :: (Ptr ImportMemoryZirconHandleInfoFUCHSIA -> IO b) -> IO b Source # pokeZeroCStruct :: Ptr ImportMemoryZirconHandleInfoFUCHSIA -> IO b -> IO b Source # cStructSize :: Int Source # cStructAlignment :: Int Source #
Zero ImportMemoryZirconHandleInfoFUCHSIA Source #
Instance details Defined in Vulkan.Extensions.VK_FUCHSIA_external_memory Methods zero :: ImportMemoryZirconHandleInfoFUCHSIA Source #

data MemoryZirconHandlePropertiesFUCHSIA Source #

VkMemoryZirconHandlePropertiesFUCHSIA - Structure specifying Zircon handle compatible external memory

Valid Usage (Implicit)

Storable MemoryZirconHandlePropertiesFUCHSIA Source #
Instance details 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 () #
Show MemoryZirconHandlePropertiesFUCHSIA Source #
Instance details Defined in Vulkan.Extensions.VK_FUCHSIA_external_memory Methods showsPrec :: Int -> MemoryZirconHandlePropertiesFUCHSIA -> ShowS # show :: MemoryZirconHandlePropertiesFUCHSIA -> String # showList :: [MemoryZirconHandlePropertiesFUCHSIA] -> ShowS #
Eq MemoryZirconHandlePropertiesFUCHSIA Source #
Instance details Defined in Vulkan.Extensions.VK_FUCHSIA_external_memory Methods (==) :: MemoryZirconHandlePropertiesFUCHSIA -> MemoryZirconHandlePropertiesFUCHSIA -> Bool # (/=) :: MemoryZirconHandlePropertiesFUCHSIA -> MemoryZirconHandlePropertiesFUCHSIA -> Bool #
FromCStruct MemoryZirconHandlePropertiesFUCHSIA Source #
Instance details Defined in Vulkan.Extensions.VK_FUCHSIA_external_memory Methods peekCStruct :: Ptr MemoryZirconHandlePropertiesFUCHSIA -> IO MemoryZirconHandlePropertiesFUCHSIA Source #
ToCStruct MemoryZirconHandlePropertiesFUCHSIA Source #
Instance details Defined in Vulkan.Extensions.VK_FUCHSIA_external_memory Methods withCStruct :: MemoryZirconHandlePropertiesFUCHSIA -> (Ptr MemoryZirconHandlePropertiesFUCHSIA -> IO b) -> IO b Source # pokeCStruct :: Ptr MemoryZirconHandlePropertiesFUCHSIA -> MemoryZirconHandlePropertiesFUCHSIA -> IO b -> IO b Source # withZeroCStruct :: (Ptr MemoryZirconHandlePropertiesFUCHSIA -> IO b) -> IO b Source # pokeZeroCStruct :: Ptr MemoryZirconHandlePropertiesFUCHSIA -> IO b -> IO b Source # cStructSize :: Int Source # cStructAlignment :: Int Source #
Zero MemoryZirconHandlePropertiesFUCHSIA Source #
Instance details Defined in Vulkan.Extensions.VK_FUCHSIA_external_memory Methods zero :: MemoryZirconHandlePropertiesFUCHSIA Source #

data MemoryGetZirconHandleInfoFUCHSIA Source #

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

Valid Usage (Implicit)

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

Instances details

Storable MemoryGetZirconHandleInfoFUCHSIA Source #
Instance details 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 () #
Show MemoryGetZirconHandleInfoFUCHSIA Source #
Instance details Defined in Vulkan.Extensions.VK_FUCHSIA_external_memory Methods showsPrec :: Int -> MemoryGetZirconHandleInfoFUCHSIA -> ShowS # show :: MemoryGetZirconHandleInfoFUCHSIA -> String # showList :: [MemoryGetZirconHandleInfoFUCHSIA] -> ShowS #
Eq MemoryGetZirconHandleInfoFUCHSIA Source #
Instance details Defined in Vulkan.Extensions.VK_FUCHSIA_external_memory Methods (==) :: MemoryGetZirconHandleInfoFUCHSIA -> MemoryGetZirconHandleInfoFUCHSIA -> Bool # (/=) :: MemoryGetZirconHandleInfoFUCHSIA -> MemoryGetZirconHandleInfoFUCHSIA -> Bool #
FromCStruct MemoryGetZirconHandleInfoFUCHSIA Source #
Instance details Defined in Vulkan.Extensions.VK_FUCHSIA_external_memory Methods peekCStruct :: Ptr MemoryGetZirconHandleInfoFUCHSIA -> IO MemoryGetZirconHandleInfoFUCHSIA Source #
ToCStruct MemoryGetZirconHandleInfoFUCHSIA Source #
Instance details Defined in Vulkan.Extensions.VK_FUCHSIA_external_memory Methods withCStruct :: MemoryGetZirconHandleInfoFUCHSIA -> (Ptr MemoryGetZirconHandleInfoFUCHSIA -> IO b) -> IO b Source # pokeCStruct :: Ptr MemoryGetZirconHandleInfoFUCHSIA -> MemoryGetZirconHandleInfoFUCHSIA -> IO b -> IO b Source # withZeroCStruct :: (Ptr MemoryGetZirconHandleInfoFUCHSIA -> IO b) -> IO b Source # pokeZeroCStruct :: Ptr MemoryGetZirconHandleInfoFUCHSIA -> IO b -> IO b Source # cStructSize :: Int Source # cStructAlignment :: Int Source #
Zero MemoryGetZirconHandleInfoFUCHSIA Source #
Instance details Defined in Vulkan.Extensions.VK_FUCHSIA_external_memory Methods zero :: MemoryGetZirconHandleInfoFUCHSIA Source #

type FUCHSIA_EXTERNAL_MEMORY_SPEC_VERSION = 1 Source #

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

type FUCHSIA_EXTERNAL_MEMORY_EXTENSION_NAME = "VK_FUCHSIA_external_memory" Source #

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

type Zx_handle_t = Word32 Source #

Name

VK_FUCHSIA_external_memory

Other Extension Metadata

Description

New Commands

New Structures

New Enum Constants

Issues

Version History

See Also

Document Notes

Documentation

Return Codes

See Also

Return Codes

See Also

Valid Usage

Valid Usage (Implicit)

See Also

Instances

Valid Usage (Implicit)

See Also

Instances

Valid Usage (Implicit)

See Also

Instances

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.

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