Safe Haskell	None
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 or Vulkan Version 1.4

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 MemoryMapInfo:
- 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 MemoryUnmapFlagBits:
- MEMORY_UNMAP_RESERVE_BIT_EXT
Extending StructureType:

Version History

Revision 1, 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 :: Integral a => a
type EXT_MAP_MEMORY_PLACED_EXTENSION_NAME = "VK_EXT_map_memory_placed"
pattern EXT_MAP_MEMORY_PLACED_EXTENSION_NAME :: (Eq a, IsString a) => a

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. If the application wishes to use a Device with any features described by PhysicalDeviceMapMemoryPlacedFeaturesEXT, it must add an instance of the structure, with the desired feature members set to TRUE, to the pNext chain of DeviceCreateInfo when creating the Device.

Valid Usage (Implicit)

memoryMapPlaced :: Bool
memoryMapPlaced indicates that the implementation supports placing memory maps at application-specified virtual addresses.
memoryMapRangePlaced :: Bool
memoryMapRangePlaced indicates that the implementation supports placing memory maps of a subrange of a memory object at application-specified virtual addresses.
memoryUnmapReserve :: Bool
memoryUnmapReserve indicates that the implementation supports leaving the memory range reserved when unmapping a memory object.

Instances

Instances details

Eq PhysicalDeviceMapMemoryPlacedFeaturesEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_map_memory_placed Methods (==) :: PhysicalDeviceMapMemoryPlacedFeaturesEXT -> PhysicalDeviceMapMemoryPlacedFeaturesEXT -> Bool # (/=) :: PhysicalDeviceMapMemoryPlacedFeaturesEXT -> PhysicalDeviceMapMemoryPlacedFeaturesEXT -> Bool #
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 #
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 #

data PhysicalDeviceMapMemoryPlacedPropertiesEXT Source #

VkPhysicalDeviceMapMemoryPlacedPropertiesEXT - Structure describing the alignment requirements of placed memory maps for a physical device

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)

Eq PhysicalDeviceMapMemoryPlacedPropertiesEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_map_memory_placed Methods (==) :: PhysicalDeviceMapMemoryPlacedPropertiesEXT -> PhysicalDeviceMapMemoryPlacedPropertiesEXT -> Bool # (/=) :: PhysicalDeviceMapMemoryPlacedPropertiesEXT -> PhysicalDeviceMapMemoryPlacedPropertiesEXT -> Bool #
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 #
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 #

data MemoryMapPlacedInfoEXT Source #

VkMemoryMapPlacedInfoEXT - Structure containing memory map placement parameters

Valid Usage

pPlacedAddress must be aligned to an integer multiple of PhysicalDeviceMapMemoryPlacedPropertiesEXT::minPlacedMemoryMapAlignment

The address range specified by pPlacedAddress and MemoryMapInfo::size must not overlap any existing Vulkan memory object mapping

Valid Usage (Implicit)

sType must be STRUCTURE_TYPE_MEMORY_MAP_PLACED_INFO_EXT

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

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 `MemoryMapInfo`::`flags` does not contain `MEMORY_MAP_PLACED_BIT_EXT`, this value is ignored.