Safe Haskell	Safe-Inferred
Language	Haskell2010

Vulkan.Extensions.VK_KHR_map_memory2

Description

Name

VK_KHR_map_memory2 - device extension

VK_KHR_map_memory2

Name String: VK_KHR_map_memory2

Extension Type

Device extension

Registered Extension Number

272

Revision

1

Ratification Status

Ratified

Extension and Version Dependencies

None

Contact

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

Extension Proposal

VK_KHR_map_memory2

Other Extension Metadata

Last Modified Date: 2023-03-14

Interactions and External Dependencies

None

Contributors

Faith Ekstrand, Collabora
Tobias Hector, AMD

Description

This extension provides extensible versions of the Vulkan memory map and unmap commands. The new commands are functionally identical to the core commands, except that their parameters are specified using extensible structures that can be used to pass extension-specific information.

New Commands

mapMemory2KHR

unmapMemory2KHR

New Structures

MemoryMapInfoKHR

MemoryUnmapInfoKHR

New Enums

MemoryUnmapFlagBitsKHR

New Bitmasks

MemoryUnmapFlagsKHR

New Enum Constants

KHR_MAP_MEMORY_2_EXTENSION_NAME

KHR_MAP_MEMORY_2_SPEC_VERSION
Extending StructureType:
- STRUCTURE_TYPE_MEMORY_MAP_INFO_KHR
- STRUCTURE_TYPE_MEMORY_UNMAP_INFO_KHR

Version History

Revision 0, 2022-08-03 (Faith Ekstrand)
- Internal revisions

Revision 1, 2023-03-14
- Public release

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

mapMemory2KHR :: forall a io. (Extendss MemoryMapInfoKHR a, PokeChain a, MonadIO io) => Device -> MemoryMapInfoKHR a -> io ("data" ::: Ptr ())
unmapMemory2KHR :: forall io. MonadIO io => Device -> MemoryUnmapInfoKHR -> io ()
data MemoryMapInfoKHR (es :: [Type]) = MemoryMapInfoKHR {
- next :: Chain es
- flags :: MemoryMapFlags
- memory :: DeviceMemory
- offset :: DeviceSize
- size :: DeviceSize
}
data MemoryUnmapInfoKHR = MemoryUnmapInfoKHR {
- flags :: MemoryUnmapFlagsKHR
- memory :: DeviceMemory
}
type MemoryUnmapFlagsKHR = MemoryUnmapFlagBitsKHR
newtype MemoryUnmapFlagBitsKHR where
- MemoryUnmapFlagBitsKHR Flags
- pattern MEMORY_UNMAP_RESERVE_BIT_EXT :: MemoryUnmapFlagBitsKHR
type KHR_MAP_MEMORY_2_SPEC_VERSION = 1
pattern KHR_MAP_MEMORY_2_SPEC_VERSION :: forall a. Integral a => a
type KHR_MAP_MEMORY_2_EXTENSION_NAME = "VK_KHR_map_memory2"
pattern KHR_MAP_MEMORY_2_EXTENSION_NAME :: forall a. (Eq a, IsString a) => a

Documentation

mapMemory2KHR Source #

Arguments

:: forall a io. (Extendss MemoryMapInfoKHR a, PokeChain a, MonadIO io)
=> Device	`device` is the logical device that owns the memory. `device` must be a valid `Device` handle
-> MemoryMapInfoKHR a	`pMemoryMapInfo` is a pointer to a `MemoryMapInfoKHR` structure describing parameters of the map. `pMemoryMapInfo` must be a valid pointer to a valid `MemoryMapInfoKHR` structure
-> io ("data" ::: Ptr ())

vkMapMemory2KHR - Map a memory object into application address space

Description

This function behaves identically to mapMemory except that it gets its parameters via an extensible structure pointer rather than directly as function arguments.

Return Codes

Success

SUCCESS

Failure

Description

This function behaves identically to unmapMemory except that it gets its parameters via an extensible structure pointer rather than directly as function arguments.

Return Codes

Success

SUCCESS

Failure

ERROR_MEMORY_MAP_FAILED

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 KHR_MAP_MEMORY_2_SPEC_VERSION = 1 Source #

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

type KHR_MAP_MEMORY_2_EXTENSION_NAME = "VK_KHR_map_memory2" Source #

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

Extensible MemoryMapInfoKHR Source #
Instance details Defined in Vulkan.Extensions.VK_KHR_map_memory2 Methods extensibleTypeName :: String Source # getNext :: forall (es :: [Type]). MemoryMapInfoKHR es -> Chain es Source # setNext :: forall (ds :: [Type]) (es :: [Type]). MemoryMapInfoKHR ds -> Chain es -> MemoryMapInfoKHR es Source # extends :: forall e b proxy. Typeable e => proxy e -> (Extends MemoryMapInfoKHR e => b) -> Maybe b Source #
Show (Chain es) => Show (MemoryMapInfoKHR es) Source #
Instance details Defined in Vulkan.Extensions.VK_KHR_map_memory2 Methods showsPrec :: Int -> MemoryMapInfoKHR es -> ShowS # show :: MemoryMapInfoKHR es -> String # showList :: [MemoryMapInfoKHR es] -> ShowS #
(Extendss MemoryMapInfoKHR es, PeekChain es) => FromCStruct (MemoryMapInfoKHR es) Source #
Instance details Defined in Vulkan.Extensions.VK_KHR_map_memory2 Methods peekCStruct :: Ptr (MemoryMapInfoKHR es) -> IO (MemoryMapInfoKHR es) Source #
(Extendss MemoryMapInfoKHR es, PokeChain es) => ToCStruct (MemoryMapInfoKHR es) Source #
Instance details Defined in Vulkan.Extensions.VK_KHR_map_memory2 Methods withCStruct :: MemoryMapInfoKHR es -> (Ptr (MemoryMapInfoKHR es) -> IO b) -> IO b Source # pokeCStruct :: Ptr (MemoryMapInfoKHR es) -> MemoryMapInfoKHR es -> IO b -> IO b Source # withZeroCStruct :: (Ptr (MemoryMapInfoKHR es) -> IO b) -> IO b Source # pokeZeroCStruct :: Ptr (MemoryMapInfoKHR es) -> IO b -> IO b Source # cStructSize :: Int Source # cStructAlignment :: Int Source #
es ~ ('[] :: [Type]) => Zero (MemoryMapInfoKHR es) Source #
Instance details Defined in Vulkan.Extensions.VK_KHR_map_memory2 Methods zero :: MemoryMapInfoKHR es Source #

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

Name

VK_KHR_map_memory2

Other Extension Metadata

Description

New Commands

New Structures

New Enums

New Bitmasks

New Enum Constants

Version History

See Also

Document Notes

Documentation

Description

Return Codes

See Also

Description

Return Codes

See Also

Valid Usage

Valid Usage (Implicit)

Host Synchronization

See Also

Instances

Valid Usage

Valid Usage (Implicit)

Host Synchronization

See Also

Instances

See Also

Instances

:: forall io. MonadIO io
=> Device	`device` is the logical device that owns the memory. `device` must be a valid `Device` handle
-> MemoryUnmapInfoKHR	`pMemoryUnmapInfo` is a pointer to a `MemoryUnmapInfoKHR` structure describing parameters of the unmap. `pMemoryUnmapInfo` must be a valid pointer to a valid `MemoryUnmapInfoKHR` structure
-> io ()

MemoryUnmapInfoKHR
Fields flags :: MemoryUnmapFlagsKHR `flags` is a bitmask of `MemoryUnmapFlagBitsKHR` specifying additional parameters of the memory map operation. memory :: DeviceMemory `memory` is the `DeviceMemory` object to be unmapped.