vulkan-3.27: src/Vulkan/Core10/Enums/MemoryPropertyFlagBits.hs
{-# language CPP #-}
-- No documentation found for Chapter "MemoryPropertyFlagBits"
module Vulkan.Core10.Enums.MemoryPropertyFlagBits ( MemoryPropertyFlags
, MemoryPropertyFlagBits( MEMORY_PROPERTY_DEVICE_LOCAL_BIT
, MEMORY_PROPERTY_HOST_VISIBLE_BIT
, MEMORY_PROPERTY_HOST_COHERENT_BIT
, MEMORY_PROPERTY_HOST_CACHED_BIT
, MEMORY_PROPERTY_LAZILY_ALLOCATED_BIT
, MEMORY_PROPERTY_RDMA_CAPABLE_BIT_NV
, MEMORY_PROPERTY_DEVICE_UNCACHED_BIT_AMD
, MEMORY_PROPERTY_DEVICE_COHERENT_BIT_AMD
, MEMORY_PROPERTY_PROTECTED_BIT
, ..
)
) where
import Data.Bits (Bits)
import Data.Bits (FiniteBits)
import Vulkan.Internal.Utils (enumReadPrec)
import Vulkan.Internal.Utils (enumShowsPrec)
import GHC.Show (showString)
import Numeric (showHex)
import Vulkan.Zero (Zero)
import Foreign.Storable (Storable)
import GHC.Read (Read(readPrec))
import GHC.Show (Show(showsPrec))
import Vulkan.Core10.FundamentalTypes (Flags)
type MemoryPropertyFlags = MemoryPropertyFlagBits
-- | VkMemoryPropertyFlagBits - Bitmask specifying properties for a memory
-- type
--
-- = Description
--
-- - '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
-- 'Vulkan.Core10.Enums.MemoryHeapFlagBits.MEMORY_HEAP_DEVICE_LOCAL_BIT'
-- set.
--
-- - 'MEMORY_PROPERTY_HOST_VISIBLE_BIT' bit specifies that memory
-- allocated with this type /can/ be mapped for host access using
-- 'Vulkan.Core10.Memory.mapMemory'.
--
-- - #memory-coherent# 'MEMORY_PROPERTY_HOST_COHERENT_BIT' bit specifies
-- that the host cache management commands
-- 'Vulkan.Core10.Memory.flushMappedMemoryRanges' and
-- 'Vulkan.Core10.Memory.invalidateMappedMemoryRanges' are not needed
-- to manage
-- <https://registry.khronos.org/vulkan/specs/latest/html/vkspec.html#synchronization-dependencies-available-and-visible availability and visibility>
-- on the host.
--
-- - '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.
--
-- - '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
-- <https://registry.khronos.org/vulkan/specs/latest/html/vkspec.html#memory-device-lazy_allocation Lazily Allocated Memory>.
--
-- - '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.
--
-- - 'MEMORY_PROPERTY_DEVICE_COHERENT_BIT_AMD' bit specifies that device
-- accesses to allocations of this memory type are automatically made
-- <https://registry.khronos.org/vulkan/specs/latest/html/vkspec.html#synchronization-dependencies-available-and-visible available and visible>
-- on the device. If paired with 'MEMORY_PROPERTY_HOST_COHERENT_BIT',
-- <https://registry.khronos.org/vulkan/specs/latest/html/vkspec.html#synchronization-dependencies-available-and-visible memory domain operations>
-- are also performed automatically between host and device.
--
-- - '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.
--
-- - 'MEMORY_PROPERTY_RDMA_CAPABLE_BIT_NV' bit specifies that external
-- devices can access this memory directly.
--
-- 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.
--
-- 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
-- neighboring 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
--
-- <https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#VK_VERSION_1_0 VK_VERSION_1_0>,
-- 'MemoryPropertyFlags'
newtype MemoryPropertyFlagBits = MemoryPropertyFlagBits Flags
deriving newtype (Eq, Ord, Storable, Zero, Bits, FiniteBits)
-- No documentation found for Nested "VkMemoryPropertyFlagBits" "VK_MEMORY_PROPERTY_DEVICE_LOCAL_BIT"
pattern MEMORY_PROPERTY_DEVICE_LOCAL_BIT = MemoryPropertyFlagBits 0x00000001
-- No documentation found for Nested "VkMemoryPropertyFlagBits" "VK_MEMORY_PROPERTY_HOST_VISIBLE_BIT"
pattern MEMORY_PROPERTY_HOST_VISIBLE_BIT = MemoryPropertyFlagBits 0x00000002
-- No documentation found for Nested "VkMemoryPropertyFlagBits" "VK_MEMORY_PROPERTY_HOST_COHERENT_BIT"
pattern MEMORY_PROPERTY_HOST_COHERENT_BIT = MemoryPropertyFlagBits 0x00000004
-- No documentation found for Nested "VkMemoryPropertyFlagBits" "VK_MEMORY_PROPERTY_HOST_CACHED_BIT"
pattern MEMORY_PROPERTY_HOST_CACHED_BIT = MemoryPropertyFlagBits 0x00000008
-- No documentation found for Nested "VkMemoryPropertyFlagBits" "VK_MEMORY_PROPERTY_LAZILY_ALLOCATED_BIT"
pattern MEMORY_PROPERTY_LAZILY_ALLOCATED_BIT = MemoryPropertyFlagBits 0x00000010
-- No documentation found for Nested "VkMemoryPropertyFlagBits" "VK_MEMORY_PROPERTY_RDMA_CAPABLE_BIT_NV"
pattern MEMORY_PROPERTY_RDMA_CAPABLE_BIT_NV = MemoryPropertyFlagBits 0x00000100
-- No documentation found for Nested "VkMemoryPropertyFlagBits" "VK_MEMORY_PROPERTY_DEVICE_UNCACHED_BIT_AMD"
pattern MEMORY_PROPERTY_DEVICE_UNCACHED_BIT_AMD = MemoryPropertyFlagBits 0x00000080
-- No documentation found for Nested "VkMemoryPropertyFlagBits" "VK_MEMORY_PROPERTY_DEVICE_COHERENT_BIT_AMD"
pattern MEMORY_PROPERTY_DEVICE_COHERENT_BIT_AMD = MemoryPropertyFlagBits 0x00000040
-- No documentation found for Nested "VkMemoryPropertyFlagBits" "VK_MEMORY_PROPERTY_PROTECTED_BIT"
pattern MEMORY_PROPERTY_PROTECTED_BIT = MemoryPropertyFlagBits 0x00000020
conNameMemoryPropertyFlagBits :: String
conNameMemoryPropertyFlagBits = "MemoryPropertyFlagBits"
enumPrefixMemoryPropertyFlagBits :: String
enumPrefixMemoryPropertyFlagBits = "MEMORY_PROPERTY_"
showTableMemoryPropertyFlagBits :: [(MemoryPropertyFlagBits, String)]
showTableMemoryPropertyFlagBits =
[
( MEMORY_PROPERTY_DEVICE_LOCAL_BIT
, "DEVICE_LOCAL_BIT"
)
,
( MEMORY_PROPERTY_HOST_VISIBLE_BIT
, "HOST_VISIBLE_BIT"
)
,
( MEMORY_PROPERTY_HOST_COHERENT_BIT
, "HOST_COHERENT_BIT"
)
,
( MEMORY_PROPERTY_HOST_CACHED_BIT
, "HOST_CACHED_BIT"
)
,
( MEMORY_PROPERTY_LAZILY_ALLOCATED_BIT
, "LAZILY_ALLOCATED_BIT"
)
,
( MEMORY_PROPERTY_RDMA_CAPABLE_BIT_NV
, "RDMA_CAPABLE_BIT_NV"
)
,
( MEMORY_PROPERTY_DEVICE_UNCACHED_BIT_AMD
, "DEVICE_UNCACHED_BIT_AMD"
)
,
( MEMORY_PROPERTY_DEVICE_COHERENT_BIT_AMD
, "DEVICE_COHERENT_BIT_AMD"
)
,
( MEMORY_PROPERTY_PROTECTED_BIT
, "PROTECTED_BIT"
)
]
instance Show MemoryPropertyFlagBits where
showsPrec =
enumShowsPrec
enumPrefixMemoryPropertyFlagBits
showTableMemoryPropertyFlagBits
conNameMemoryPropertyFlagBits
(\(MemoryPropertyFlagBits x) -> x)
(\x -> showString "0x" . showHex x)
instance Read MemoryPropertyFlagBits where
readPrec =
enumReadPrec
enumPrefixMemoryPropertyFlagBits
showTableMemoryPropertyFlagBits
conNameMemoryPropertyFlagBits
MemoryPropertyFlagBits