Graphics.Vulkan.Core10.Enums.MemoryPropertyFlagBits

Documentation

newtype MemoryPropertyFlagBits

VkMemoryPropertyFlagBits - Bitmask specifying properties for a memory type

Description

For any memory allocated with both the MEMORY_PROPERTY_HOST_COHERENT_BIT and the MEMORY_PROPERTY_DEVICE_COHERENT_BIT_AMD, host or device accesses also perform automatic memory domain transfer operations, such that writes are always automatically available and visible to both host and device memory domains.

Note

Device coherence is a useful property for certain debugging use cases (e.g. crash analysis, where performing separate coherence actions could mean values are not reported correctly). However, device coherent accesses may be slower than equivalent accesses without device coherence, particularly if they are also device uncached. For device uncached memory in particular, repeated accesses to the same or neighbouring memory locations over a short time period (e.g. within a frame) may be slower than it would be for the equivalent cached memory type. As such, it is generally inadvisable to use device coherent or device uncached memory except when really needed.

See Also

MemoryPropertyFlags

Constructors

MemoryPropertyFlagBits Flags

Bundled Patterns

pattern MEMORY_PROPERTY_DEVICE_LOCAL_BIT :: MemoryPropertyFlagBits

MEMORY_PROPERTY_DEVICE_LOCAL_BIT bit specifies that memory allocated with this type is the most efficient for device access. This property will be set if and only if the memory type belongs to a heap with the MEMORY_HEAP_DEVICE_LOCAL_BIT set.

pattern MEMORY_PROPERTY_HOST_VISIBLE_BIT :: MemoryPropertyFlagBits

MEMORY_PROPERTY_HOST_VISIBLE_BIT bit specifies that memory allocated with this type can be mapped for host access using mapMemory.

pattern MEMORY_PROPERTY_HOST_COHERENT_BIT :: MemoryPropertyFlagBits

MEMORY_PROPERTY_HOST_COHERENT_BIT bit specifies that the host cache management commands flushMappedMemoryRanges and invalidateMappedMemoryRanges are not needed to flush host writes to the device or make device writes visible to the host, respectively.

pattern MEMORY_PROPERTY_HOST_CACHED_BIT :: MemoryPropertyFlagBits

MEMORY_PROPERTY_HOST_CACHED_BIT bit specifies that memory allocated with this type is cached on the host. Host memory accesses to uncached memory are slower than to cached memory, however uncached memory is always host coherent.

pattern MEMORY_PROPERTY_LAZILY_ALLOCATED_BIT :: MemoryPropertyFlagBits

MEMORY_PROPERTY_LAZILY_ALLOCATED_BIT bit specifies that the memory type only allows device access to the memory. Memory types must not have both MEMORY_PROPERTY_LAZILY_ALLOCATED_BIT and MEMORY_PROPERTY_HOST_VISIBLE_BIT set. Additionally, the object’s backing memory may be provided by the implementation lazily as specified in Lazily Allocated Memory.

pattern MEMORY_PROPERTY_DEVICE_UNCACHED_BIT_AMD :: MemoryPropertyFlagBits

MEMORY_PROPERTY_DEVICE_UNCACHED_BIT_AMD bit specifies that memory allocated with this type is not cached on the device. Uncached device memory is always device coherent.

pattern MEMORY_PROPERTY_DEVICE_COHERENT_BIT_AMD :: MemoryPropertyFlagBits

MEMORY_PROPERTY_DEVICE_COHERENT_BIT_AMD bit specifies that device accesses to allocations of this memory type are automatically made available and visible.

pattern MEMORY_PROPERTY_PROTECTED_BIT :: MemoryPropertyFlagBits

MEMORY_PROPERTY_PROTECTED_BIT bit specifies that the memory type only allows device access to the memory, and allows protected queue operations to access the memory. Memory types must not have MEMORY_PROPERTY_PROTECTED_BIT set and any of MEMORY_PROPERTY_HOST_VISIBLE_BIT set, or MEMORY_PROPERTY_HOST_COHERENT_BIT set, or MEMORY_PROPERTY_HOST_CACHED_BIT set.

Instances

Eq MemoryPropertyFlagBits

Defined in Graphics.Vulkan.Core10.Enums.MemoryPropertyFlagBits

Methods

(==) :: MemoryPropertyFlagBits -> MemoryPropertyFlagBits -> Bool

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

Ord MemoryPropertyFlagBits

Defined in Graphics.Vulkan.Core10.Enums.MemoryPropertyFlagBits

Methods

compare :: MemoryPropertyFlagBits -> MemoryPropertyFlagBits -> Ordering

(<) :: MemoryPropertyFlagBits -> MemoryPropertyFlagBits -> Bool

(<=) :: MemoryPropertyFlagBits -> MemoryPropertyFlagBits -> Bool

(>) :: MemoryPropertyFlagBits -> MemoryPropertyFlagBits -> Bool

(>=) :: MemoryPropertyFlagBits -> MemoryPropertyFlagBits -> Bool

max :: MemoryPropertyFlagBits -> MemoryPropertyFlagBits -> MemoryPropertyFlagBits

min :: MemoryPropertyFlagBits -> MemoryPropertyFlagBits -> MemoryPropertyFlagBits

Read MemoryPropertyFlagBits

Defined in Graphics.Vulkan.Core10.Enums.MemoryPropertyFlagBits

Methods

readsPrec :: Int -> ReadS MemoryPropertyFlagBits

readList :: ReadS [MemoryPropertyFlagBits]

readPrec :: ReadPrec MemoryPropertyFlagBits

readListPrec :: ReadPrec [MemoryPropertyFlagBits]

Show MemoryPropertyFlagBits

Defined in Graphics.Vulkan.Core10.Enums.MemoryPropertyFlagBits

Methods

showsPrec :: Int -> MemoryPropertyFlagBits -> ShowS

show :: MemoryPropertyFlagBits -> String

showList :: [MemoryPropertyFlagBits] -> ShowS

Storable MemoryPropertyFlagBits

Defined in Graphics.Vulkan.Core10.Enums.MemoryPropertyFlagBits

Methods

sizeOf :: MemoryPropertyFlagBits -> Int

alignment :: MemoryPropertyFlagBits -> Int

peekElemOff :: Ptr MemoryPropertyFlagBits -> Int -> IO MemoryPropertyFlagBits

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

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

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

peek :: Ptr MemoryPropertyFlagBits -> IO MemoryPropertyFlagBits

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

Bits MemoryPropertyFlagBits

Defined in Graphics.Vulkan.Core10.Enums.MemoryPropertyFlagBits

Methods

(.&.) :: MemoryPropertyFlagBits -> MemoryPropertyFlagBits -> MemoryPropertyFlagBits

(.|.) :: MemoryPropertyFlagBits -> MemoryPropertyFlagBits -> MemoryPropertyFlagBits

xor :: MemoryPropertyFlagBits -> MemoryPropertyFlagBits -> MemoryPropertyFlagBits

complement :: MemoryPropertyFlagBits -> MemoryPropertyFlagBits

shift :: MemoryPropertyFlagBits -> Int -> MemoryPropertyFlagBits

rotate :: MemoryPropertyFlagBits -> Int -> MemoryPropertyFlagBits

zeroBits :: MemoryPropertyFlagBits

bit :: Int -> MemoryPropertyFlagBits

setBit :: MemoryPropertyFlagBits -> Int -> MemoryPropertyFlagBits

clearBit :: MemoryPropertyFlagBits -> Int -> MemoryPropertyFlagBits

complementBit :: MemoryPropertyFlagBits -> Int -> MemoryPropertyFlagBits

testBit :: MemoryPropertyFlagBits -> Int -> Bool

bitSizeMaybe :: MemoryPropertyFlagBits -> Maybe Int

bitSize :: MemoryPropertyFlagBits -> Int

isSigned :: MemoryPropertyFlagBits -> Bool

shiftL :: MemoryPropertyFlagBits -> Int -> MemoryPropertyFlagBits

unsafeShiftL :: MemoryPropertyFlagBits -> Int -> MemoryPropertyFlagBits

shiftR :: MemoryPropertyFlagBits -> Int -> MemoryPropertyFlagBits

unsafeShiftR :: MemoryPropertyFlagBits -> Int -> MemoryPropertyFlagBits

rotateL :: MemoryPropertyFlagBits -> Int -> MemoryPropertyFlagBits

rotateR :: MemoryPropertyFlagBits -> Int -> MemoryPropertyFlagBits

popCount :: MemoryPropertyFlagBits -> Int

Zero MemoryPropertyFlagBits

Defined in Graphics.Vulkan.Core10.Enums.MemoryPropertyFlagBits

Methods

zero :: MemoryPropertyFlagBits

type MemoryPropertyFlags = MemoryPropertyFlagBits