Graphics.Vulkan.Extensions.VK_EXT_external_memory_host

Documentation

pattern VK_STRUCTURE_TYPE_IMPORT_MEMORY_HOST_POINTER_INFO_EXT :: VkStructureType

pattern VK_STRUCTURE_TYPE_MEMORY_HOST_POINTER_PROPERTIES_EXT :: VkStructureType

pattern VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_EXTERNAL_MEMORY_HOST_PROPERTIES_EXT :: VkStructureType

pattern VK_EXTERNAL_MEMORY_HANDLE_TYPE_HOST_ALLOCATION_BIT_EXT :: VkExternalMemoryHandleTypeFlagBits

pattern VK_EXTERNAL_MEMORY_HANDLE_TYPE_HOST_MAPPED_FOREIGN_MEMORY_BIT_EXT :: VkExternalMemoryHandleTypeFlagBits

pattern VK_EXT_EXTERNAL_MEMORY_HOST_SPEC_VERSION :: Integral a => a

pattern VK_EXT_EXTERNAL_MEMORY_HOST_EXTENSION_NAME :: (Eq a, IsString a) => a

vkGetMemoryHostPointerPropertiesEXT :: ("device" ::: VkDevice) -> ("handleType" ::: VkExternalMemoryHandleTypeFlagBits) -> ("pHostPointer" ::: Ptr ()) -> ("pMemoryHostPointerProperties" ::: Ptr VkMemoryHostPointerPropertiesEXT) -> IO VkResult

vkGetMemoryHostPointerPropertiesEXT - Get properties of external memory host pointer

Parameters

• device is the logical device that will be importing pHostPointer.

• handleType is the type of the handle pHostPointer.
• pHostPointer is the host pointer to import from.

Description

Valid Usage

• handleType must be VK_EXTERNAL_MEMORY_HANDLE_TYPE_HOST_ALLOCATION_BIT_EXT or VK_EXTERNAL_MEMORY_HANDLE_TYPE_HOST_MAPPED_FOREIGN_MEMORY_BIT_EXT

• pHostPointer must be a pointer aligned to an integer multiple of VkPhysicalDeviceExternalMemoryHostPropertiesEXT::minImportedHostPointerAlignment
• If handleType is VK_EXTERNAL_MEMORY_HANDLE_TYPE_HOST_ALLOCATION_BIT_EXT, pHostPointer must be a pointer to host memory
• If handleType is VK_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 VkDevice handle

• handleType must be a valid VkExternalMemoryHandleTypeFlagBits value
• pMemoryHostPointerProperties must be a valid pointer to a VkMemoryHostPointerPropertiesEXT structure

Return Codes

Success

- VK_SUCCESS

Failure

- VK_ERROR_INVALID_EXTERNAL_HANDLE

See Also

VkDevice, VkExternalMemoryHandleTypeFlagBits, VkMemoryHostPointerPropertiesEXT

data VkImportMemoryHostPointerInfoEXT

VkImportMemoryHostPointerInfoEXT - import memory from a host pointer

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 VK_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 VkExternalMemoryPropertiesKHR

• If handleType is not 0, it must be VK_EXTERNAL_MEMORY_HANDLE_TYPE_HOST_ALLOCATION_BIT_EXT or VK_EXTERNAL_MEMORY_HANDLE_TYPE_HOST_MAPPED_FOREIGN_MEMORY_BIT_EXT
• pHostPointer must be a pointer aligned to an integer multiple of VkPhysicalDeviceExternalMemoryHostPropertiesEXT::minImportedHostPointerAlignment
• If handleType is VK_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 VkMemoryAllocateInfo structure this structure is chained to
• If handleType is VK_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 VkMemoryAllocateInfo structure this structure is chained to

Valid Usage (Implicit)

• sType must be VK_STRUCTURE_TYPE_IMPORT_MEMORY_HOST_POINTER_INFO_EXT

• handleType must be a valid VkExternalMemoryHandleTypeFlagBits value

See Also

VkExternalMemoryHandleTypeFlagBits, VkStructureType

Constructors

VkImportMemoryHostPointerInfoEXT

Fields

• vkSType :: VkStructureType

  sType is the type of this structure.

• vkPNext :: Ptr ()

  pNext is NULL or a pointer to an extension-specific structure.

• vkHandleType :: VkExternalMemoryHandleTypeFlagBits

  handleType specifies the handle type.

• vkPHostPointer :: Ptr ()

  pHostPointer is the host pointer to import from.

Instances

Eq VkImportMemoryHostPointerInfoEXT

Methods

(==) :: VkImportMemoryHostPointerInfoEXT -> VkImportMemoryHostPointerInfoEXT -> Bool

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

Show VkImportMemoryHostPointerInfoEXT

Methods

showsPrec :: Int -> VkImportMemoryHostPointerInfoEXT -> ShowS

show :: VkImportMemoryHostPointerInfoEXT -> String

showList :: [VkImportMemoryHostPointerInfoEXT] -> ShowS

Storable VkImportMemoryHostPointerInfoEXT

Methods

sizeOf :: VkImportMemoryHostPointerInfoEXT -> Int

alignment :: VkImportMemoryHostPointerInfoEXT -> Int

peekElemOff :: Ptr VkImportMemoryHostPointerInfoEXT -> Int -> IO VkImportMemoryHostPointerInfoEXT

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

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

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

peek :: Ptr VkImportMemoryHostPointerInfoEXT -> IO VkImportMemoryHostPointerInfoEXT

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

data VkMemoryHostPointerPropertiesEXT

Constructors

VkMemoryHostPointerPropertiesEXT

Fields

• vkSType :: VkStructureType
• vkPNext :: Ptr ()
• vkMemoryTypeBits :: Word32

Instances

Eq VkMemoryHostPointerPropertiesEXT

Methods

(==) :: VkMemoryHostPointerPropertiesEXT -> VkMemoryHostPointerPropertiesEXT -> Bool

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

Show VkMemoryHostPointerPropertiesEXT

Methods

showsPrec :: Int -> VkMemoryHostPointerPropertiesEXT -> ShowS

show :: VkMemoryHostPointerPropertiesEXT -> String

showList :: [VkMemoryHostPointerPropertiesEXT] -> ShowS

Storable VkMemoryHostPointerPropertiesEXT

Methods

sizeOf :: VkMemoryHostPointerPropertiesEXT -> Int

alignment :: VkMemoryHostPointerPropertiesEXT -> Int

peekElemOff :: Ptr VkMemoryHostPointerPropertiesEXT -> Int -> IO VkMemoryHostPointerPropertiesEXT

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

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

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

peek :: Ptr VkMemoryHostPointerPropertiesEXT -> IO VkMemoryHostPointerPropertiesEXT

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

data VkPhysicalDeviceExternalMemoryHostPropertiesEXT

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

Members

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

Description

• 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.

Valid Usage (Implicit)

• sType must be VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_EXTERNAL_MEMORY_HOST_PROPERTIES_EXT

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

See Also

VkDeviceSize, VkStructureType

Constructors

VkPhysicalDeviceExternalMemoryHostPropertiesEXT

Fields

• vkSType :: VkStructureType
• vkPNext :: Ptr ()
• vkMinImportedHostPointerAlignment :: VkDeviceSize

Instances

Eq VkPhysicalDeviceExternalMemoryHostPropertiesEXT

Methods

(==) :: VkPhysicalDeviceExternalMemoryHostPropertiesEXT -> VkPhysicalDeviceExternalMemoryHostPropertiesEXT -> Bool

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

Show VkPhysicalDeviceExternalMemoryHostPropertiesEXT

Methods

showsPrec :: Int -> VkPhysicalDeviceExternalMemoryHostPropertiesEXT -> ShowS

show :: VkPhysicalDeviceExternalMemoryHostPropertiesEXT -> String

showList :: [VkPhysicalDeviceExternalMemoryHostPropertiesEXT] -> ShowS

Storable VkPhysicalDeviceExternalMemoryHostPropertiesEXT

Methods

sizeOf :: VkPhysicalDeviceExternalMemoryHostPropertiesEXT -> Int

alignment :: VkPhysicalDeviceExternalMemoryHostPropertiesEXT -> Int

peekElemOff :: Ptr VkPhysicalDeviceExternalMemoryHostPropertiesEXT -> Int -> IO VkPhysicalDeviceExternalMemoryHostPropertiesEXT

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

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

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

peek :: Ptr VkPhysicalDeviceExternalMemoryHostPropertiesEXT -> IO VkPhysicalDeviceExternalMemoryHostPropertiesEXT

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