Safe Haskell	Safe-Inferred
Language	Haskell2010

Vulkan.Extensions.VK_EXT_map_memory_placed

Description

Name

VK_EXT_map_memory_placed - device extension

VK_EXT_map_memory_placed

Name String: VK_EXT_map_memory_placed

Extension Type

Device extension

Registered Extension Number

273

Revision

1

Ratification Status

Ratified

Extension and Version Dependencies

VK_KHR_map_memory2

Contact

Faith Ekstrand @gfxstrand%0A*Here describe the issue or question you have about the VK_EXT_map_memory_placed extension*

Extension Proposal

VK_EXT_map_memory_placed

Other Extension Metadata

Last Modified Date: 2023-03-21

IP Status

No known IP claims.

Interactions and External Dependencies

Depends on apitext:VK_KHR_map_memory2
Interacts with apitext:VK_EXT_external_memory_host

Contributors

Faith Ekstrand, Collabora
Tobias Hector, AMD
James Jones, NVIDIA
Georg Lehmann, Valve
Derek Lesho, Codeweavers

Description

This extension allows an application to request that mapMemory2KHR attempt to place the memory map at a particular virtual address.

New Structures

Extending MemoryMapInfoKHR:
- MemoryMapPlacedInfoEXT

Extending PhysicalDeviceFeatures2, DeviceCreateInfo:
- PhysicalDeviceMapMemoryPlacedFeaturesEXT
Extending PhysicalDeviceProperties2:
- PhysicalDeviceMapMemoryPlacedPropertiesEXT

New Enum Constants

EXT_MAP_MEMORY_PLACED_EXTENSION_NAME

EXT_MAP_MEMORY_PLACED_SPEC_VERSION
Extending MemoryMapFlagBits:
- MEMORY_MAP_PLACED_BIT_EXT
Extending MemoryUnmapFlagBitsKHR:
- MEMORY_UNMAP_RESERVE_BIT_EXT
Extending StructureType:

Version History

Revision 0, 2024-01-14 (Faith Ekstrand)
- Internal revisions

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

data PhysicalDeviceMapMemoryPlacedFeaturesEXT = PhysicalDeviceMapMemoryPlacedFeaturesEXT {
- memoryMapPlaced :: Bool
- memoryMapRangePlaced :: Bool
- memoryUnmapReserve :: Bool
}
data PhysicalDeviceMapMemoryPlacedPropertiesEXT = PhysicalDeviceMapMemoryPlacedPropertiesEXT {
- minPlacedMemoryMapAlignment :: DeviceSize
}
data MemoryMapPlacedInfoEXT = MemoryMapPlacedInfoEXT {
- placedAddress :: Ptr ()
}
type EXT_MAP_MEMORY_PLACED_SPEC_VERSION = 1
pattern EXT_MAP_MEMORY_PLACED_SPEC_VERSION :: forall a. Integral a => a
type EXT_MAP_MEMORY_PLACED_EXTENSION_NAME = "VK_EXT_map_memory_placed"
pattern EXT_MAP_MEMORY_PLACED_EXTENSION_NAME :: forall a. (Eq a, IsString a) => a
newtype MemoryUnmapFlagBitsKHR where
- MemoryUnmapFlagBitsKHR Flags
- pattern MEMORY_UNMAP_RESERVE_BIT_EXT :: MemoryUnmapFlagBitsKHR
type MemoryUnmapFlagsKHR = MemoryUnmapFlagBitsKHR

Documentation

data PhysicalDeviceMapMemoryPlacedFeaturesEXT Source #

VkPhysicalDeviceMapMemoryPlacedFeaturesEXT - Structure describing placed memory map features that can be supported by an implementation

Members

This structure describes the following features:

Description

If the PhysicalDeviceMapMemoryPlacedFeaturesEXT structure is included in the pNext chain of the PhysicalDeviceFeatures2 structure passed to getPhysicalDeviceFeatures2, it is filled in to indicate whether each corresponding feature is supported. PhysicalDeviceMapMemoryPlacedFeaturesEXT can also be used in the pNext chain of DeviceCreateInfo to selectively enable these features.

Valid Usage (Implicit)

Members

The members of the PhysicalDeviceMapMemoryPlacedPropertiesEXT structure describe the following:

Description

If the PhysicalDeviceMapMemoryPlacedPropertiesEXT structure is included in the pNext chain of the PhysicalDeviceProperties2 structure passed to getPhysicalDeviceProperties2, it is filled in with each corresponding implementation-dependent property.

Valid Usage (Implicit)

MEMORY_UNMAP_RESERVE_BIT_EXT requests that virtual address range currently occupied by the memory map remain reserved after the unmapMemory2KHR call completes. Future system memory map operations or calls to mapMemory or mapMemory2KHR will not return addresses in that range unless the range has since been unreserved by the application or the mapping is explicitly placed in that range by calling mapMemory2KHR with MEMORY_MAP_PLACED_BIT_EXT, or doing the system memory map equivalent. When MEMORY_UNMAP_RESERVE_BIT_EXT is set, the memory unmap operation may fail, in which case the memory object will remain host mapped and unmapMemory2KHR will return ERROR_MEMORY_MAP_FAILED.

Instances

Instances details

Storable MemoryUnmapFlagBitsKHR Source #
Instance details Defined in Vulkan.Extensions.VK_KHR_map_memory2 Methods sizeOf :: MemoryUnmapFlagBitsKHR -> Int # alignment :: MemoryUnmapFlagBitsKHR -> Int # peekElemOff :: Ptr MemoryUnmapFlagBitsKHR -> Int -> IO MemoryUnmapFlagBitsKHR # pokeElemOff :: Ptr MemoryUnmapFlagBitsKHR -> Int -> MemoryUnmapFlagBitsKHR -> IO () # peekByteOff :: Ptr b -> Int -> IO MemoryUnmapFlagBitsKHR # pokeByteOff :: Ptr b -> Int -> MemoryUnmapFlagBitsKHR -> IO () # peek :: Ptr MemoryUnmapFlagBitsKHR -> IO MemoryUnmapFlagBitsKHR # poke :: Ptr MemoryUnmapFlagBitsKHR -> MemoryUnmapFlagBitsKHR -> IO () #
Bits MemoryUnmapFlagBitsKHR Source #
Instance details Defined in Vulkan.Extensions.VK_KHR_map_memory2 Methods (.&.) :: MemoryUnmapFlagBitsKHR -> MemoryUnmapFlagBitsKHR -> MemoryUnmapFlagBitsKHR # (.\|.) :: MemoryUnmapFlagBitsKHR -> MemoryUnmapFlagBitsKHR -> MemoryUnmapFlagBitsKHR # xor :: MemoryUnmapFlagBitsKHR -> MemoryUnmapFlagBitsKHR -> MemoryUnmapFlagBitsKHR # complement :: MemoryUnmapFlagBitsKHR -> MemoryUnmapFlagBitsKHR # shift :: MemoryUnmapFlagBitsKHR -> Int -> MemoryUnmapFlagBitsKHR # rotate :: MemoryUnmapFlagBitsKHR -> Int -> MemoryUnmapFlagBitsKHR # zeroBits :: MemoryUnmapFlagBitsKHR # bit :: Int -> MemoryUnmapFlagBitsKHR # setBit :: MemoryUnmapFlagBitsKHR -> Int -> MemoryUnmapFlagBitsKHR # clearBit :: MemoryUnmapFlagBitsKHR -> Int -> MemoryUnmapFlagBitsKHR # complementBit :: MemoryUnmapFlagBitsKHR -> Int -> MemoryUnmapFlagBitsKHR # testBit :: MemoryUnmapFlagBitsKHR -> Int -> Bool # bitSizeMaybe :: MemoryUnmapFlagBitsKHR -> Maybe Int # bitSize :: MemoryUnmapFlagBitsKHR -> Int # isSigned :: MemoryUnmapFlagBitsKHR -> Bool # shiftL :: MemoryUnmapFlagBitsKHR -> Int -> MemoryUnmapFlagBitsKHR # unsafeShiftL :: MemoryUnmapFlagBitsKHR -> Int -> MemoryUnmapFlagBitsKHR # shiftR :: MemoryUnmapFlagBitsKHR -> Int -> MemoryUnmapFlagBitsKHR # unsafeShiftR :: MemoryUnmapFlagBitsKHR -> Int -> MemoryUnmapFlagBitsKHR # rotateL :: MemoryUnmapFlagBitsKHR -> Int -> MemoryUnmapFlagBitsKHR # rotateR :: MemoryUnmapFlagBitsKHR -> Int -> MemoryUnmapFlagBitsKHR # popCount :: MemoryUnmapFlagBitsKHR -> Int #
FiniteBits MemoryUnmapFlagBitsKHR Source #
Instance details Defined in Vulkan.Extensions.VK_KHR_map_memory2 Methods finiteBitSize :: MemoryUnmapFlagBitsKHR -> Int # countLeadingZeros :: MemoryUnmapFlagBitsKHR -> Int # countTrailingZeros :: MemoryUnmapFlagBitsKHR -> Int #
Read MemoryUnmapFlagBitsKHR Source #
Instance details Defined in Vulkan.Extensions.VK_KHR_map_memory2 Methods readsPrec :: Int -> ReadS MemoryUnmapFlagBitsKHR # readList :: ReadS [MemoryUnmapFlagBitsKHR] # readPrec :: ReadPrec MemoryUnmapFlagBitsKHR # readListPrec :: ReadPrec [MemoryUnmapFlagBitsKHR] #
Show MemoryUnmapFlagBitsKHR Source #
Instance details Defined in Vulkan.Extensions.VK_KHR_map_memory2 Methods showsPrec :: Int -> MemoryUnmapFlagBitsKHR -> ShowS # show :: MemoryUnmapFlagBitsKHR -> String # showList :: [MemoryUnmapFlagBitsKHR] -> ShowS #
Eq MemoryUnmapFlagBitsKHR Source #
Instance details Defined in Vulkan.Extensions.VK_KHR_map_memory2 Methods (==) :: MemoryUnmapFlagBitsKHR -> MemoryUnmapFlagBitsKHR -> Bool # (/=) :: MemoryUnmapFlagBitsKHR -> MemoryUnmapFlagBitsKHR -> Bool #
Ord MemoryUnmapFlagBitsKHR Source #
Instance details Defined in Vulkan.Extensions.VK_KHR_map_memory2 Methods compare :: MemoryUnmapFlagBitsKHR -> MemoryUnmapFlagBitsKHR -> Ordering # (<) :: MemoryUnmapFlagBitsKHR -> MemoryUnmapFlagBitsKHR -> Bool # (<=) :: MemoryUnmapFlagBitsKHR -> MemoryUnmapFlagBitsKHR -> Bool # (>) :: MemoryUnmapFlagBitsKHR -> MemoryUnmapFlagBitsKHR -> Bool # (>=) :: MemoryUnmapFlagBitsKHR -> MemoryUnmapFlagBitsKHR -> Bool # max :: MemoryUnmapFlagBitsKHR -> MemoryUnmapFlagBitsKHR -> MemoryUnmapFlagBitsKHR # min :: MemoryUnmapFlagBitsKHR -> MemoryUnmapFlagBitsKHR -> MemoryUnmapFlagBitsKHR #
Zero MemoryUnmapFlagBitsKHR Source #
Instance details Defined in Vulkan.Extensions.VK_KHR_map_memory2 Methods zero :: MemoryUnmapFlagBitsKHR Source #

type MemoryUnmapFlagsKHR = MemoryUnmapFlagBitsKHR Source #

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

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

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

Name

VK_EXT_map_memory_placed

Other Extension Metadata

Description

New Structures

New Enum Constants

Version History

See Also

Document Notes

Documentation

Members

Description

Valid Usage (Implicit)

See Also

Instances

Members

Description

Valid Usage (Implicit)

See Also

Instances

Valid Usage

Valid Usage (Implicit)

See Also

Instances

See Also

Instances

PhysicalDeviceMapMemoryPlacedPropertiesEXT
Fields minPlacedMemoryMapAlignment :: DeviceSize `minPlacedMemoryMapAlignment` is the minimum alignment required for memory object offsets and virtual address ranges when using placed memory mapping.

MemoryMapPlacedInfoEXT
Fields placedAddress :: Ptr () `pPlacedAddress` is the virtual address at which to place the address. If `MemoryMapInfoKHR`::`flags` does not contain `MEMORY_MAP_PLACED_BIT_EXT`, this value is ignored.