vulkan-3.26.1: Bindings to the Vulkan graphics API.
Safe HaskellSafe-Inferred
LanguageHaskell2010

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; Contact
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 entry points. The new entry points are functionally identical to the core entry points, except that their parameters are specified using extensible structures that can be used to pass extension-specific information.

New Commands

New Structures

New Bitmasks

New Enum Constants

Version History

  • Revision 0, 2022-08-03 (Faith Ekstrand)

    • Internal revisions

  • Revision 1, 2023-03-14

    • Public release

See Also

MemoryMapInfoKHR, MemoryUnmapFlagsKHR, MemoryUnmapInfoKHR, mapMemory2KHR, unmapMemory2KHR

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

Documentation

mapMemory2KHR Source #

Arguments

:: forall io. MonadIO io 
=> Device

device is the logical device that owns the memory.

device must be a valid Device handle

-> MemoryMapInfoKHR

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
Failure

See Also

VK_KHR_map_memory2, Device, MemoryMapInfoKHR

unmapMemory2KHR Source #

Arguments

:: 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 () 

vkUnmapMemory2KHR - Unmap a previously mapped memory object

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

See Also

VK_KHR_map_memory2, Device, MemoryUnmapInfoKHR

data MemoryMapInfoKHR Source #

VkMemoryMapInfoKHR - Structure containing parameters of a memory map operation

Valid Usage

  • memory must not be currently host mapped
  • offset must be less than the size of memory
  • If size is not equal to WHOLE_SIZE, size must be greater than 0
  • If size is not equal to WHOLE_SIZE, size must be less than or equal to the size of the memory minus offset
  • memory must have been created with a memory type that reports MEMORY_PROPERTY_HOST_VISIBLE_BIT
  • memory must not have been allocated with multiple instances

Valid Usage (Implicit)

  • pNext must be NULL
  • flags must be 0
  • memory must be a valid DeviceMemory handle

Host Synchronization

  • Host access to memory must be externally synchronized

See Also

VK_KHR_map_memory2, DeviceMemory, DeviceSize, MemoryMapFlags, StructureType, mapMemory2KHR

Constructors

MemoryMapInfoKHR 

Fields

Instances

Instances details
Storable MemoryMapInfoKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_map_memory2

Methods

sizeOf :: MemoryMapInfoKHR -> Int #

alignment :: MemoryMapInfoKHR -> Int #

peekElemOff :: Ptr MemoryMapInfoKHR -> Int -> IO MemoryMapInfoKHR #

pokeElemOff :: Ptr MemoryMapInfoKHR -> Int -> MemoryMapInfoKHR -> IO () #

peekByteOff :: Ptr b -> Int -> IO MemoryMapInfoKHR #

pokeByteOff :: Ptr b -> Int -> MemoryMapInfoKHR -> IO () #

peek :: Ptr MemoryMapInfoKHR -> IO MemoryMapInfoKHR #

poke :: Ptr MemoryMapInfoKHR -> MemoryMapInfoKHR -> IO () #

Show MemoryMapInfoKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_map_memory2

Methods

showsPrec :: Int -> MemoryMapInfoKHR -> ShowS #

show :: MemoryMapInfoKHR -> String #

showList :: [MemoryMapInfoKHR] -> ShowS #

Eq MemoryMapInfoKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_map_memory2

Methods

(==) :: MemoryMapInfoKHR -> MemoryMapInfoKHR -> Bool #

(/=) :: MemoryMapInfoKHR -> MemoryMapInfoKHR -> Bool #

FromCStruct MemoryMapInfoKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_map_memory2

Methods

peekCStruct :: Ptr MemoryMapInfoKHR -> IO MemoryMapInfoKHR Source #

ToCStruct MemoryMapInfoKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_map_memory2

Methods

withCStruct :: MemoryMapInfoKHR -> (Ptr MemoryMapInfoKHR -> IO b) -> IO b Source #

pokeCStruct :: Ptr MemoryMapInfoKHR -> MemoryMapInfoKHR -> IO b -> IO b Source #

withZeroCStruct :: (Ptr MemoryMapInfoKHR -> IO b) -> IO b Source #

pokeZeroCStruct :: Ptr MemoryMapInfoKHR -> IO b -> IO b Source #

cStructSize :: Int Source #

cStructAlignment :: Int Source #

Zero MemoryMapInfoKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_map_memory2

Methods

zero :: MemoryMapInfoKHR Source #

data MemoryUnmapInfoKHR Source #

VkMemoryUnmapInfoKHR - Structure containing parameters of a memory unmap operation

Valid Usage

  • memory must be currently host mapped

Valid Usage (Implicit)

  • pNext must be NULL
  • flags must be 0
  • memory must be a valid DeviceMemory handle

Host Synchronization

  • Host access to memory must be externally synchronized

See Also

VK_KHR_map_memory2, DeviceMemory, MemoryUnmapFlagsKHR, StructureType, unmapMemory2KHR

Constructors

MemoryUnmapInfoKHR 

Fields

Instances

Instances details
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 #

newtype MemoryUnmapFlagsKHR Source #

VkMemoryUnmapFlagsKHR - Reserved for future use

Description

VkMemoryMapFlagsKHR is a bitmask type for setting a mask, but is currently reserved for future use.

See Also

VK_KHR_map_memory2, MemoryUnmapInfoKHR

Constructors

MemoryUnmapFlagsKHR Flags 

Instances

Instances details
Storable MemoryUnmapFlagsKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_map_memory2

Methods

sizeOf :: MemoryUnmapFlagsKHR -> Int #

alignment :: MemoryUnmapFlagsKHR -> Int #

peekElemOff :: Ptr MemoryUnmapFlagsKHR -> Int -> IO MemoryUnmapFlagsKHR #

pokeElemOff :: Ptr MemoryUnmapFlagsKHR -> Int -> MemoryUnmapFlagsKHR -> IO () #

peekByteOff :: Ptr b -> Int -> IO MemoryUnmapFlagsKHR #

pokeByteOff :: Ptr b -> Int -> MemoryUnmapFlagsKHR -> IO () #

peek :: Ptr MemoryUnmapFlagsKHR -> IO MemoryUnmapFlagsKHR #

poke :: Ptr MemoryUnmapFlagsKHR -> MemoryUnmapFlagsKHR -> IO () #

Bits MemoryUnmapFlagsKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_map_memory2

Methods

(.&.) :: MemoryUnmapFlagsKHR -> MemoryUnmapFlagsKHR -> MemoryUnmapFlagsKHR #

(.|.) :: MemoryUnmapFlagsKHR -> MemoryUnmapFlagsKHR -> MemoryUnmapFlagsKHR #

xor :: MemoryUnmapFlagsKHR -> MemoryUnmapFlagsKHR -> MemoryUnmapFlagsKHR #

complement :: MemoryUnmapFlagsKHR -> MemoryUnmapFlagsKHR #

shift :: MemoryUnmapFlagsKHR -> Int -> MemoryUnmapFlagsKHR #

rotate :: MemoryUnmapFlagsKHR -> Int -> MemoryUnmapFlagsKHR #

zeroBits :: MemoryUnmapFlagsKHR #

bit :: Int -> MemoryUnmapFlagsKHR #

setBit :: MemoryUnmapFlagsKHR -> Int -> MemoryUnmapFlagsKHR #

clearBit :: MemoryUnmapFlagsKHR -> Int -> MemoryUnmapFlagsKHR #

complementBit :: MemoryUnmapFlagsKHR -> Int -> MemoryUnmapFlagsKHR #

testBit :: MemoryUnmapFlagsKHR -> Int -> Bool #

bitSizeMaybe :: MemoryUnmapFlagsKHR -> Maybe Int #

bitSize :: MemoryUnmapFlagsKHR -> Int #

isSigned :: MemoryUnmapFlagsKHR -> Bool #

shiftL :: MemoryUnmapFlagsKHR -> Int -> MemoryUnmapFlagsKHR #

unsafeShiftL :: MemoryUnmapFlagsKHR -> Int -> MemoryUnmapFlagsKHR #

shiftR :: MemoryUnmapFlagsKHR -> Int -> MemoryUnmapFlagsKHR #

unsafeShiftR :: MemoryUnmapFlagsKHR -> Int -> MemoryUnmapFlagsKHR #

rotateL :: MemoryUnmapFlagsKHR -> Int -> MemoryUnmapFlagsKHR #

rotateR :: MemoryUnmapFlagsKHR -> Int -> MemoryUnmapFlagsKHR #

popCount :: MemoryUnmapFlagsKHR -> Int #

FiniteBits MemoryUnmapFlagsKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_map_memory2

Methods

finiteBitSize :: MemoryUnmapFlagsKHR -> Int #

countLeadingZeros :: MemoryUnmapFlagsKHR -> Int #

countTrailingZeros :: MemoryUnmapFlagsKHR -> Int #

Read MemoryUnmapFlagsKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_map_memory2

Methods

readsPrec :: Int -> ReadS MemoryUnmapFlagsKHR #

readList :: ReadS [MemoryUnmapFlagsKHR] #

readPrec :: ReadPrec MemoryUnmapFlagsKHR #

readListPrec :: ReadPrec [MemoryUnmapFlagsKHR] #

Show MemoryUnmapFlagsKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_map_memory2

Methods

showsPrec :: Int -> MemoryUnmapFlagsKHR -> ShowS #

show :: MemoryUnmapFlagsKHR -> String #

showList :: [MemoryUnmapFlagsKHR] -> ShowS #

Eq MemoryUnmapFlagsKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_map_memory2

Methods

(==) :: MemoryUnmapFlagsKHR -> MemoryUnmapFlagsKHR -> Bool #

(/=) :: MemoryUnmapFlagsKHR -> MemoryUnmapFlagsKHR -> Bool #

Ord MemoryUnmapFlagsKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_map_memory2

Methods

compare :: MemoryUnmapFlagsKHR -> MemoryUnmapFlagsKHR -> Ordering #

(<) :: MemoryUnmapFlagsKHR -> MemoryUnmapFlagsKHR -> Bool #

(<=) :: MemoryUnmapFlagsKHR -> MemoryUnmapFlagsKHR -> Bool #

(>) :: MemoryUnmapFlagsKHR -> MemoryUnmapFlagsKHR -> Bool #

(>=) :: MemoryUnmapFlagsKHR -> MemoryUnmapFlagsKHR -> Bool #

max :: MemoryUnmapFlagsKHR -> MemoryUnmapFlagsKHR -> MemoryUnmapFlagsKHR #

min :: MemoryUnmapFlagsKHR -> MemoryUnmapFlagsKHR -> MemoryUnmapFlagsKHR #

Zero MemoryUnmapFlagsKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_map_memory2

Methods

zero :: MemoryUnmapFlagsKHR 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 #