Safe Haskell	None
Language	Haskell2010

Vulkan.Extensions.VK_EXT_external_memory_host

Synopsis

getMemoryHostPointerPropertiesEXT :: forall io. MonadIO io => Device -> ExternalMemoryHandleTypeFlagBits -> ("hostPointer" ::: Ptr ()) -> io MemoryHostPointerPropertiesEXT
data ImportMemoryHostPointerInfoEXT = ImportMemoryHostPointerInfoEXT {
- handleType :: ExternalMemoryHandleTypeFlagBits
- hostPointer :: Ptr ()
}
data MemoryHostPointerPropertiesEXT = MemoryHostPointerPropertiesEXT {
- memoryTypeBits :: Word32
}
data PhysicalDeviceExternalMemoryHostPropertiesEXT = PhysicalDeviceExternalMemoryHostPropertiesEXT {
- minImportedHostPointerAlignment :: DeviceSize
}
type EXT_EXTERNAL_MEMORY_HOST_SPEC_VERSION = 1
pattern EXT_EXTERNAL_MEMORY_HOST_SPEC_VERSION :: forall a. Integral a => a
type EXT_EXTERNAL_MEMORY_HOST_EXTENSION_NAME = "VK_EXT_external_memory_host"
pattern EXT_EXTERNAL_MEMORY_HOST_EXTENSION_NAME :: forall a. (Eq a, IsString a) => a

Documentation

getMemoryHostPointerPropertiesEXT Source #

Arguments

:: forall io. MonadIO io
=> Device	`device` is the logical device that will be importing `pHostPointer`.
-> ExternalMemoryHandleTypeFlagBits	`handleType` is the type of the handle `pHostPointer`.
-> ("hostPointer" ::: Ptr ())	`pHostPointer` is the host pointer to import from.
-> io MemoryHostPointerPropertiesEXT

vkGetMemoryHostPointerPropertiesEXT - Get properties of external memory host pointer

Valid Usage

handleType must be EXTERNAL_MEMORY_HANDLE_TYPE_HOST_ALLOCATION_BIT_EXT or EXTERNAL_MEMORY_HANDLE_TYPE_HOST_MAPPED_FOREIGN_MEMORY_BIT_EXT

pHostPointer must be a pointer aligned to an integer multiple of PhysicalDeviceExternalMemoryHostPropertiesEXT::minImportedHostPointerAlignment
If handleType is EXTERNAL_MEMORY_HANDLE_TYPE_HOST_ALLOCATION_BIT_EXT, pHostPointer must be a pointer to host memory
If handleType is EXTERNAL_MEMORY_HANDLE_TYPE_HOST_MAPPED_FOREIGN_MEMORY_BIT_EXT, pHostPointer must be a pointer to host mapped foreign memory

Valid Usage (Implicit)

device must be a valid Device handle

handleType must be a valid ExternalMemoryHandleTypeFlagBits value
pMemoryHostPointerProperties must be a valid pointer to a MemoryHostPointerPropertiesEXT structure

Return Codes

Success

SUCCESS

Failure

ERROR_INVALID_EXTERNAL_HANDLE

Description

Importing memory from a host pointer shares ownership of the memory between the host and the Vulkan implementation. The application can continue to access the memory through the host pointer but it is the application’s responsibility to synchronize device and non-device access to the underlying memory as defined in Host Access to Device Memory Objects.

Applications can import the same underlying memory into multiple instances of Vulkan and multiple times into a given Vulkan instance. However, implementations may fail to import the same underlying memory multiple times into a given physical device due to platform constraints.

Importing memory from a particular host pointer may not be possible due to additional platform-specific restrictions beyond the scope of this specification in which case the implementation must fail the memory import operation with the error code ERROR_INVALID_EXTERNAL_HANDLE_KHR.

The application must ensure that the imported memory range remains valid and accessible for the lifetime of the imported memory object.

Valid Usage

If handleType is not 0, it must be supported for import, as reported in ExternalMemoryProperties

If handleType is not 0, it must be EXTERNAL_MEMORY_HANDLE_TYPE_HOST_ALLOCATION_BIT_EXT or EXTERNAL_MEMORY_HANDLE_TYPE_HOST_MAPPED_FOREIGN_MEMORY_BIT_EXT
pHostPointer must be a pointer aligned to an integer multiple of PhysicalDeviceExternalMemoryHostPropertiesEXT::minImportedHostPointerAlignment
If handleType is EXTERNAL_MEMORY_HANDLE_TYPE_HOST_ALLOCATION_BIT_EXT, pHostPointer must be a pointer to allocationSize number of bytes of host memory, where allocationSize is the member of the MemoryAllocateInfo structure this structure is chained to
If handleType is EXTERNAL_MEMORY_HANDLE_TYPE_HOST_MAPPED_FOREIGN_MEMORY_BIT_EXT, pHostPointer must be a pointer to allocationSize number of bytes of host mapped foreign memory, where allocationSize is the member of the MemoryAllocateInfo structure this structure is chained to

Valid Usage (Implicit)

sType must be STRUCTURE_TYPE_IMPORT_MEMORY_HOST_POINTER_INFO_EXT

handleType must be a valid ExternalMemoryHandleTypeFlagBits value

Show ImportMemoryHostPointerInfoEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_external_memory_host Methods showsPrec :: Int -> ImportMemoryHostPointerInfoEXT -> ShowS # show :: ImportMemoryHostPointerInfoEXT -> String # showList :: [ImportMemoryHostPointerInfoEXT] -> ShowS #
Generic ImportMemoryHostPointerInfoEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_external_memory_host Associated Types type Rep ImportMemoryHostPointerInfoEXT :: Type -> Type # Methods from :: ImportMemoryHostPointerInfoEXT -> Rep ImportMemoryHostPointerInfoEXT x # to :: Rep ImportMemoryHostPointerInfoEXT x -> ImportMemoryHostPointerInfoEXT #
Storable ImportMemoryHostPointerInfoEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_external_memory_host Methods sizeOf :: ImportMemoryHostPointerInfoEXT -> Int # alignment :: ImportMemoryHostPointerInfoEXT -> Int # peekElemOff :: Ptr ImportMemoryHostPointerInfoEXT -> Int -> IO ImportMemoryHostPointerInfoEXT # pokeElemOff :: Ptr ImportMemoryHostPointerInfoEXT -> Int -> ImportMemoryHostPointerInfoEXT -> IO () # peekByteOff :: Ptr b -> Int -> IO ImportMemoryHostPointerInfoEXT # pokeByteOff :: Ptr b -> Int -> ImportMemoryHostPointerInfoEXT -> IO () # peek :: Ptr ImportMemoryHostPointerInfoEXT -> IO ImportMemoryHostPointerInfoEXT # poke :: Ptr ImportMemoryHostPointerInfoEXT -> ImportMemoryHostPointerInfoEXT -> IO () #
FromCStruct ImportMemoryHostPointerInfoEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_external_memory_host Methods peekCStruct :: Ptr ImportMemoryHostPointerInfoEXT -> IO ImportMemoryHostPointerInfoEXT Source #
ToCStruct ImportMemoryHostPointerInfoEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_external_memory_host Methods withCStruct :: ImportMemoryHostPointerInfoEXT -> (Ptr ImportMemoryHostPointerInfoEXT -> IO b) -> IO b Source # pokeCStruct :: Ptr ImportMemoryHostPointerInfoEXT -> ImportMemoryHostPointerInfoEXT -> IO b -> IO b Source # withZeroCStruct :: (Ptr ImportMemoryHostPointerInfoEXT -> IO b) -> IO b Source # pokeZeroCStruct :: Ptr ImportMemoryHostPointerInfoEXT -> IO b -> IO b Source # cStructSize :: Int Source # cStructAlignment :: Int Source #
Zero ImportMemoryHostPointerInfoEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_external_memory_host Methods zero :: ImportMemoryHostPointerInfoEXT Source #
type Rep ImportMemoryHostPointerInfoEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_external_memory_host type Rep ImportMemoryHostPointerInfoEXT = D1 ('MetaData "ImportMemoryHostPointerInfoEXT" "Vulkan.Extensions.VK_EXT_external_memory_host" "vulkan-3.6.2-inplace" 'False) (C1 ('MetaCons "ImportMemoryHostPointerInfoEXT" 'PrefixI 'True) (S1 ('MetaSel ('Just "handleType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ExternalMemoryHandleTypeFlagBits) :*: S1 ('MetaSel ('Just "hostPointer") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Ptr ()))))

data MemoryHostPointerPropertiesEXT Source #

VkMemoryHostPointerPropertiesEXT - Properties of external memory host pointer

Description

The value returned by memoryTypeBits must only include bits that identify memory types which are host visible.

Valid Usage (Implicit)

Eq MemoryHostPointerPropertiesEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_external_memory_host Methods (==) :: MemoryHostPointerPropertiesEXT -> MemoryHostPointerPropertiesEXT -> Bool # (/=) :: MemoryHostPointerPropertiesEXT -> MemoryHostPointerPropertiesEXT -> Bool #
Show MemoryHostPointerPropertiesEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_external_memory_host Methods showsPrec :: Int -> MemoryHostPointerPropertiesEXT -> ShowS # show :: MemoryHostPointerPropertiesEXT -> String # showList :: [MemoryHostPointerPropertiesEXT] -> ShowS #
Generic MemoryHostPointerPropertiesEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_external_memory_host Associated Types type Rep MemoryHostPointerPropertiesEXT :: Type -> Type # Methods from :: MemoryHostPointerPropertiesEXT -> Rep MemoryHostPointerPropertiesEXT x # to :: Rep MemoryHostPointerPropertiesEXT x -> MemoryHostPointerPropertiesEXT #
Storable MemoryHostPointerPropertiesEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_external_memory_host Methods sizeOf :: MemoryHostPointerPropertiesEXT -> Int # alignment :: MemoryHostPointerPropertiesEXT -> Int # peekElemOff :: Ptr MemoryHostPointerPropertiesEXT -> Int -> IO MemoryHostPointerPropertiesEXT # pokeElemOff :: Ptr MemoryHostPointerPropertiesEXT -> Int -> MemoryHostPointerPropertiesEXT -> IO () # peekByteOff :: Ptr b -> Int -> IO MemoryHostPointerPropertiesEXT # pokeByteOff :: Ptr b -> Int -> MemoryHostPointerPropertiesEXT -> IO () # peek :: Ptr MemoryHostPointerPropertiesEXT -> IO MemoryHostPointerPropertiesEXT # poke :: Ptr MemoryHostPointerPropertiesEXT -> MemoryHostPointerPropertiesEXT -> IO () #
FromCStruct MemoryHostPointerPropertiesEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_external_memory_host Methods peekCStruct :: Ptr MemoryHostPointerPropertiesEXT -> IO MemoryHostPointerPropertiesEXT Source #
ToCStruct MemoryHostPointerPropertiesEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_external_memory_host Methods withCStruct :: MemoryHostPointerPropertiesEXT -> (Ptr MemoryHostPointerPropertiesEXT -> IO b) -> IO b Source # pokeCStruct :: Ptr MemoryHostPointerPropertiesEXT -> MemoryHostPointerPropertiesEXT -> IO b -> IO b Source # withZeroCStruct :: (Ptr MemoryHostPointerPropertiesEXT -> IO b) -> IO b Source # pokeZeroCStruct :: Ptr MemoryHostPointerPropertiesEXT -> IO b -> IO b Source # cStructSize :: Int Source # cStructAlignment :: Int Source #
Zero MemoryHostPointerPropertiesEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_external_memory_host Methods zero :: MemoryHostPointerPropertiesEXT Source #
type Rep MemoryHostPointerPropertiesEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_external_memory_host type Rep MemoryHostPointerPropertiesEXT = D1 ('MetaData "MemoryHostPointerPropertiesEXT" "Vulkan.Extensions.VK_EXT_external_memory_host" "vulkan-3.6.2-inplace" 'False) (C1 ('MetaCons "MemoryHostPointerPropertiesEXT" 'PrefixI 'True) (S1 ('MetaSel ('Just "memoryTypeBits") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Word32)))

data PhysicalDeviceExternalMemoryHostPropertiesEXT Source #

VkPhysicalDeviceExternalMemoryHostPropertiesEXT - Structure describing external memory host pointer limits that can be supported by an implementation

Members

The members of the PhysicalDeviceExternalMemoryHostPropertiesEXT structure describe the following implementation-dependent limits:

Description

If the PhysicalDeviceExternalMemoryHostPropertiesEXT structure is included in the pNext chain of PhysicalDeviceProperties2, it is filled with the implementation-dependent limits.

Valid Usage (Implicit)

Eq PhysicalDeviceExternalMemoryHostPropertiesEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_external_memory_host Methods (==) :: PhysicalDeviceExternalMemoryHostPropertiesEXT -> PhysicalDeviceExternalMemoryHostPropertiesEXT -> Bool # (/=) :: PhysicalDeviceExternalMemoryHostPropertiesEXT -> PhysicalDeviceExternalMemoryHostPropertiesEXT -> Bool #
Show PhysicalDeviceExternalMemoryHostPropertiesEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_external_memory_host Methods showsPrec :: Int -> PhysicalDeviceExternalMemoryHostPropertiesEXT -> ShowS # show :: PhysicalDeviceExternalMemoryHostPropertiesEXT -> String # showList :: [PhysicalDeviceExternalMemoryHostPropertiesEXT] -> ShowS #
Generic PhysicalDeviceExternalMemoryHostPropertiesEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_external_memory_host Associated Types type Rep PhysicalDeviceExternalMemoryHostPropertiesEXT :: Type -> Type # Methods from :: PhysicalDeviceExternalMemoryHostPropertiesEXT -> Rep PhysicalDeviceExternalMemoryHostPropertiesEXT x # to :: Rep PhysicalDeviceExternalMemoryHostPropertiesEXT x -> PhysicalDeviceExternalMemoryHostPropertiesEXT #
Storable PhysicalDeviceExternalMemoryHostPropertiesEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_external_memory_host Methods sizeOf :: PhysicalDeviceExternalMemoryHostPropertiesEXT -> Int # alignment :: PhysicalDeviceExternalMemoryHostPropertiesEXT -> Int # peekElemOff :: Ptr PhysicalDeviceExternalMemoryHostPropertiesEXT -> Int -> IO PhysicalDeviceExternalMemoryHostPropertiesEXT # pokeElemOff :: Ptr PhysicalDeviceExternalMemoryHostPropertiesEXT -> Int -> PhysicalDeviceExternalMemoryHostPropertiesEXT -> IO () # peekByteOff :: Ptr b -> Int -> IO PhysicalDeviceExternalMemoryHostPropertiesEXT # pokeByteOff :: Ptr b -> Int -> PhysicalDeviceExternalMemoryHostPropertiesEXT -> IO () # peek :: Ptr PhysicalDeviceExternalMemoryHostPropertiesEXT -> IO PhysicalDeviceExternalMemoryHostPropertiesEXT # poke :: Ptr PhysicalDeviceExternalMemoryHostPropertiesEXT -> PhysicalDeviceExternalMemoryHostPropertiesEXT -> IO () #
FromCStruct PhysicalDeviceExternalMemoryHostPropertiesEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_external_memory_host Methods peekCStruct :: Ptr PhysicalDeviceExternalMemoryHostPropertiesEXT -> IO PhysicalDeviceExternalMemoryHostPropertiesEXT Source #
ToCStruct PhysicalDeviceExternalMemoryHostPropertiesEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_external_memory_host Methods withCStruct :: PhysicalDeviceExternalMemoryHostPropertiesEXT -> (Ptr PhysicalDeviceExternalMemoryHostPropertiesEXT -> IO b) -> IO b Source # pokeCStruct :: Ptr PhysicalDeviceExternalMemoryHostPropertiesEXT -> PhysicalDeviceExternalMemoryHostPropertiesEXT -> IO b -> IO b Source # withZeroCStruct :: (Ptr PhysicalDeviceExternalMemoryHostPropertiesEXT -> IO b) -> IO b Source # pokeZeroCStruct :: Ptr PhysicalDeviceExternalMemoryHostPropertiesEXT -> IO b -> IO b Source # cStructSize :: Int Source # cStructAlignment :: Int Source #
Zero PhysicalDeviceExternalMemoryHostPropertiesEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_external_memory_host Methods zero :: PhysicalDeviceExternalMemoryHostPropertiesEXT Source #
type Rep PhysicalDeviceExternalMemoryHostPropertiesEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_external_memory_host type Rep PhysicalDeviceExternalMemoryHostPropertiesEXT = D1 ('MetaData "PhysicalDeviceExternalMemoryHostPropertiesEXT" "Vulkan.Extensions.VK_EXT_external_memory_host" "vulkan-3.6.2-inplace" 'False) (C1 ('MetaCons "PhysicalDeviceExternalMemoryHostPropertiesEXT" 'PrefixI 'True) (S1 ('MetaSel ('Just "minImportedHostPointerAlignment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DeviceSize)))

type EXT_EXTERNAL_MEMORY_HOST_SPEC_VERSION = 1 Source #

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

type EXT_EXTERNAL_MEMORY_HOST_EXTENSION_NAME = "VK_EXT_external_memory_host" Source #

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

Documentation

Valid Usage

Valid Usage (Implicit)

Return Codes

See Also

Description

Valid Usage

Valid Usage (Implicit)

See Also

Instances

Description

Valid Usage (Implicit)

See Also

Instances

Members

Description

Valid Usage (Implicit)

See Also

Instances

ImportMemoryHostPointerInfoEXT
Fields handleType :: ExternalMemoryHandleTypeFlagBits `handleType` specifies the handle type. hostPointer :: Ptr () `pHostPointer` is the host pointer to import from.

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

PhysicalDeviceExternalMemoryHostPropertiesEXT
Fields minImportedHostPointerAlignment :: DeviceSize `minImportedHostPointerAlignment` is the minimum required alignment, in bytes, for the base address and size of host pointers that can be imported to a Vulkan memory object.