{-# language CPP #-}
-- No documentation found for Chapter "MemoryMapFlagBits"
module Vulkan.Core10.Enums.MemoryMapFlagBits  ( MemoryMapFlags
                                              , MemoryMapFlagBits( MEMORY_MAP_PLACED_BIT_EXT
                                                                 , ..
                                                                 )
                                              ) 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 MemoryMapFlags = MemoryMapFlagBits

-- | VkMemoryMapFlagBits - Bitmask specifying additional parameters of a
-- memory map
--
-- = Description
--
-- -   'MEMORY_MAP_PLACED_BIT_EXT' requests that the implementation place
--     the memory map at the virtual address specified by the application
--     via
--     'Vulkan.Extensions.VK_EXT_map_memory_placed.MemoryMapPlacedInfoEXT'::@pPlacedAddress@,
--     replacing any existing mapping at that address. This flag /must/ not
--     be used with 'Vulkan.Core10.Memory.mapMemory' as there is no way to
--     specify the placement address.
--
-- = See Also
--
-- <https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#VK_VERSION_1_0 VK_VERSION_1_0>,
-- 'MemoryMapFlags'
newtype MemoryMapFlagBits = MemoryMapFlagBits Flags
  deriving newtype (MemoryMapFlagBits -> MemoryMapFlagBits -> Bool
(MemoryMapFlagBits -> MemoryMapFlagBits -> Bool)
-> (MemoryMapFlagBits -> MemoryMapFlagBits -> Bool)
-> Eq MemoryMapFlagBits
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
$c== :: MemoryMapFlagBits -> MemoryMapFlagBits -> Bool
== :: MemoryMapFlagBits -> MemoryMapFlagBits -> Bool
$c/= :: MemoryMapFlagBits -> MemoryMapFlagBits -> Bool
/= :: MemoryMapFlagBits -> MemoryMapFlagBits -> Bool
Eq, Eq MemoryMapFlagBits
Eq MemoryMapFlagBits =>
(MemoryMapFlagBits -> MemoryMapFlagBits -> Ordering)
-> (MemoryMapFlagBits -> MemoryMapFlagBits -> Bool)
-> (MemoryMapFlagBits -> MemoryMapFlagBits -> Bool)
-> (MemoryMapFlagBits -> MemoryMapFlagBits -> Bool)
-> (MemoryMapFlagBits -> MemoryMapFlagBits -> Bool)
-> (MemoryMapFlagBits -> MemoryMapFlagBits -> MemoryMapFlagBits)
-> (MemoryMapFlagBits -> MemoryMapFlagBits -> MemoryMapFlagBits)
-> Ord MemoryMapFlagBits
MemoryMapFlagBits -> MemoryMapFlagBits -> Bool
MemoryMapFlagBits -> MemoryMapFlagBits -> Ordering
MemoryMapFlagBits -> MemoryMapFlagBits -> MemoryMapFlagBits
forall a.
Eq a =>
(a -> a -> Ordering)
-> (a -> a -> Bool)
-> (a -> a -> Bool)
-> (a -> a -> Bool)
-> (a -> a -> Bool)
-> (a -> a -> a)
-> (a -> a -> a)
-> Ord a
$ccompare :: MemoryMapFlagBits -> MemoryMapFlagBits -> Ordering
compare :: MemoryMapFlagBits -> MemoryMapFlagBits -> Ordering
$c< :: MemoryMapFlagBits -> MemoryMapFlagBits -> Bool
< :: MemoryMapFlagBits -> MemoryMapFlagBits -> Bool
$c<= :: MemoryMapFlagBits -> MemoryMapFlagBits -> Bool
<= :: MemoryMapFlagBits -> MemoryMapFlagBits -> Bool
$c> :: MemoryMapFlagBits -> MemoryMapFlagBits -> Bool
> :: MemoryMapFlagBits -> MemoryMapFlagBits -> Bool
$c>= :: MemoryMapFlagBits -> MemoryMapFlagBits -> Bool
>= :: MemoryMapFlagBits -> MemoryMapFlagBits -> Bool
$cmax :: MemoryMapFlagBits -> MemoryMapFlagBits -> MemoryMapFlagBits
max :: MemoryMapFlagBits -> MemoryMapFlagBits -> MemoryMapFlagBits
$cmin :: MemoryMapFlagBits -> MemoryMapFlagBits -> MemoryMapFlagBits
min :: MemoryMapFlagBits -> MemoryMapFlagBits -> MemoryMapFlagBits
Ord, Ptr MemoryMapFlagBits -> IO MemoryMapFlagBits
Ptr MemoryMapFlagBits -> Int -> IO MemoryMapFlagBits
Ptr MemoryMapFlagBits -> Int -> MemoryMapFlagBits -> IO ()
Ptr MemoryMapFlagBits -> MemoryMapFlagBits -> IO ()
MemoryMapFlagBits -> Int
(MemoryMapFlagBits -> Int)
-> (MemoryMapFlagBits -> Int)
-> (Ptr MemoryMapFlagBits -> Int -> IO MemoryMapFlagBits)
-> (Ptr MemoryMapFlagBits -> Int -> MemoryMapFlagBits -> IO ())
-> (forall b. Ptr b -> Int -> IO MemoryMapFlagBits)
-> (forall b. Ptr b -> Int -> MemoryMapFlagBits -> IO ())
-> (Ptr MemoryMapFlagBits -> IO MemoryMapFlagBits)
-> (Ptr MemoryMapFlagBits -> MemoryMapFlagBits -> IO ())
-> Storable MemoryMapFlagBits
forall b. Ptr b -> Int -> IO MemoryMapFlagBits
forall b. Ptr b -> Int -> MemoryMapFlagBits -> IO ()
forall a.
(a -> Int)
-> (a -> Int)
-> (Ptr a -> Int -> IO a)
-> (Ptr a -> Int -> a -> IO ())
-> (forall b. Ptr b -> Int -> IO a)
-> (forall b. Ptr b -> Int -> a -> IO ())
-> (Ptr a -> IO a)
-> (Ptr a -> a -> IO ())
-> Storable a
$csizeOf :: MemoryMapFlagBits -> Int
sizeOf :: MemoryMapFlagBits -> Int
$calignment :: MemoryMapFlagBits -> Int
alignment :: MemoryMapFlagBits -> Int
$cpeekElemOff :: Ptr MemoryMapFlagBits -> Int -> IO MemoryMapFlagBits
peekElemOff :: Ptr MemoryMapFlagBits -> Int -> IO MemoryMapFlagBits
$cpokeElemOff :: Ptr MemoryMapFlagBits -> Int -> MemoryMapFlagBits -> IO ()
pokeElemOff :: Ptr MemoryMapFlagBits -> Int -> MemoryMapFlagBits -> IO ()
$cpeekByteOff :: forall b. Ptr b -> Int -> IO MemoryMapFlagBits
peekByteOff :: forall b. Ptr b -> Int -> IO MemoryMapFlagBits
$cpokeByteOff :: forall b. Ptr b -> Int -> MemoryMapFlagBits -> IO ()
pokeByteOff :: forall b. Ptr b -> Int -> MemoryMapFlagBits -> IO ()
$cpeek :: Ptr MemoryMapFlagBits -> IO MemoryMapFlagBits
peek :: Ptr MemoryMapFlagBits -> IO MemoryMapFlagBits
$cpoke :: Ptr MemoryMapFlagBits -> MemoryMapFlagBits -> IO ()
poke :: Ptr MemoryMapFlagBits -> MemoryMapFlagBits -> IO ()
Storable, MemoryMapFlagBits
MemoryMapFlagBits -> Zero MemoryMapFlagBits
forall a. a -> Zero a
$czero :: MemoryMapFlagBits
zero :: MemoryMapFlagBits
Zero, Eq MemoryMapFlagBits
MemoryMapFlagBits
Eq MemoryMapFlagBits =>
(MemoryMapFlagBits -> MemoryMapFlagBits -> MemoryMapFlagBits)
-> (MemoryMapFlagBits -> MemoryMapFlagBits -> MemoryMapFlagBits)
-> (MemoryMapFlagBits -> MemoryMapFlagBits -> MemoryMapFlagBits)
-> (MemoryMapFlagBits -> MemoryMapFlagBits)
-> (MemoryMapFlagBits -> Int -> MemoryMapFlagBits)
-> (MemoryMapFlagBits -> Int -> MemoryMapFlagBits)
-> MemoryMapFlagBits
-> (Int -> MemoryMapFlagBits)
-> (MemoryMapFlagBits -> Int -> MemoryMapFlagBits)
-> (MemoryMapFlagBits -> Int -> MemoryMapFlagBits)
-> (MemoryMapFlagBits -> Int -> MemoryMapFlagBits)
-> (MemoryMapFlagBits -> Int -> Bool)
-> (MemoryMapFlagBits -> Maybe Int)
-> (MemoryMapFlagBits -> Int)
-> (MemoryMapFlagBits -> Bool)
-> (MemoryMapFlagBits -> Int -> MemoryMapFlagBits)
-> (MemoryMapFlagBits -> Int -> MemoryMapFlagBits)
-> (MemoryMapFlagBits -> Int -> MemoryMapFlagBits)
-> (MemoryMapFlagBits -> Int -> MemoryMapFlagBits)
-> (MemoryMapFlagBits -> Int -> MemoryMapFlagBits)
-> (MemoryMapFlagBits -> Int -> MemoryMapFlagBits)
-> (MemoryMapFlagBits -> Int)
-> Bits MemoryMapFlagBits
Int -> MemoryMapFlagBits
MemoryMapFlagBits -> Bool
MemoryMapFlagBits -> Int
MemoryMapFlagBits -> Maybe Int
MemoryMapFlagBits -> MemoryMapFlagBits
MemoryMapFlagBits -> Int -> Bool
MemoryMapFlagBits -> Int -> MemoryMapFlagBits
MemoryMapFlagBits -> MemoryMapFlagBits -> MemoryMapFlagBits
forall a.
Eq a =>
(a -> a -> a)
-> (a -> a -> a)
-> (a -> a -> a)
-> (a -> a)
-> (a -> Int -> a)
-> (a -> Int -> a)
-> a
-> (Int -> a)
-> (a -> Int -> a)
-> (a -> Int -> a)
-> (a -> Int -> a)
-> (a -> Int -> Bool)
-> (a -> Maybe Int)
-> (a -> Int)
-> (a -> Bool)
-> (a -> Int -> a)
-> (a -> Int -> a)
-> (a -> Int -> a)
-> (a -> Int -> a)
-> (a -> Int -> a)
-> (a -> Int -> a)
-> (a -> Int)
-> Bits a
$c.&. :: MemoryMapFlagBits -> MemoryMapFlagBits -> MemoryMapFlagBits
.&. :: MemoryMapFlagBits -> MemoryMapFlagBits -> MemoryMapFlagBits
$c.|. :: MemoryMapFlagBits -> MemoryMapFlagBits -> MemoryMapFlagBits
.|. :: MemoryMapFlagBits -> MemoryMapFlagBits -> MemoryMapFlagBits
$cxor :: MemoryMapFlagBits -> MemoryMapFlagBits -> MemoryMapFlagBits
xor :: MemoryMapFlagBits -> MemoryMapFlagBits -> MemoryMapFlagBits
$ccomplement :: MemoryMapFlagBits -> MemoryMapFlagBits
complement :: MemoryMapFlagBits -> MemoryMapFlagBits
$cshift :: MemoryMapFlagBits -> Int -> MemoryMapFlagBits
shift :: MemoryMapFlagBits -> Int -> MemoryMapFlagBits
$crotate :: MemoryMapFlagBits -> Int -> MemoryMapFlagBits
rotate :: MemoryMapFlagBits -> Int -> MemoryMapFlagBits
$czeroBits :: MemoryMapFlagBits
zeroBits :: MemoryMapFlagBits
$cbit :: Int -> MemoryMapFlagBits
bit :: Int -> MemoryMapFlagBits
$csetBit :: MemoryMapFlagBits -> Int -> MemoryMapFlagBits
setBit :: MemoryMapFlagBits -> Int -> MemoryMapFlagBits
$cclearBit :: MemoryMapFlagBits -> Int -> MemoryMapFlagBits
clearBit :: MemoryMapFlagBits -> Int -> MemoryMapFlagBits
$ccomplementBit :: MemoryMapFlagBits -> Int -> MemoryMapFlagBits
complementBit :: MemoryMapFlagBits -> Int -> MemoryMapFlagBits
$ctestBit :: MemoryMapFlagBits -> Int -> Bool
testBit :: MemoryMapFlagBits -> Int -> Bool
$cbitSizeMaybe :: MemoryMapFlagBits -> Maybe Int
bitSizeMaybe :: MemoryMapFlagBits -> Maybe Int
$cbitSize :: MemoryMapFlagBits -> Int
bitSize :: MemoryMapFlagBits -> Int
$cisSigned :: MemoryMapFlagBits -> Bool
isSigned :: MemoryMapFlagBits -> Bool
$cshiftL :: MemoryMapFlagBits -> Int -> MemoryMapFlagBits
shiftL :: MemoryMapFlagBits -> Int -> MemoryMapFlagBits
$cunsafeShiftL :: MemoryMapFlagBits -> Int -> MemoryMapFlagBits
unsafeShiftL :: MemoryMapFlagBits -> Int -> MemoryMapFlagBits
$cshiftR :: MemoryMapFlagBits -> Int -> MemoryMapFlagBits
shiftR :: MemoryMapFlagBits -> Int -> MemoryMapFlagBits
$cunsafeShiftR :: MemoryMapFlagBits -> Int -> MemoryMapFlagBits
unsafeShiftR :: MemoryMapFlagBits -> Int -> MemoryMapFlagBits
$crotateL :: MemoryMapFlagBits -> Int -> MemoryMapFlagBits
rotateL :: MemoryMapFlagBits -> Int -> MemoryMapFlagBits
$crotateR :: MemoryMapFlagBits -> Int -> MemoryMapFlagBits
rotateR :: MemoryMapFlagBits -> Int -> MemoryMapFlagBits
$cpopCount :: MemoryMapFlagBits -> Int
popCount :: MemoryMapFlagBits -> Int
Bits, Bits MemoryMapFlagBits
Bits MemoryMapFlagBits =>
(MemoryMapFlagBits -> Int)
-> (MemoryMapFlagBits -> Int)
-> (MemoryMapFlagBits -> Int)
-> FiniteBits MemoryMapFlagBits
MemoryMapFlagBits -> Int
forall b.
Bits b =>
(b -> Int) -> (b -> Int) -> (b -> Int) -> FiniteBits b
$cfiniteBitSize :: MemoryMapFlagBits -> Int
finiteBitSize :: MemoryMapFlagBits -> Int
$ccountLeadingZeros :: MemoryMapFlagBits -> Int
countLeadingZeros :: MemoryMapFlagBits -> Int
$ccountTrailingZeros :: MemoryMapFlagBits -> Int
countTrailingZeros :: MemoryMapFlagBits -> Int
FiniteBits)

-- No documentation found for Nested "VkMemoryMapFlagBits" "VK_MEMORY_MAP_PLACED_BIT_EXT"
pattern $mMEMORY_MAP_PLACED_BIT_EXT :: forall {r}. MemoryMapFlagBits -> ((# #) -> r) -> ((# #) -> r) -> r
$bMEMORY_MAP_PLACED_BIT_EXT :: MemoryMapFlagBits
MEMORY_MAP_PLACED_BIT_EXT = MemoryMapFlagBits 0x00000001

conNameMemoryMapFlagBits :: String
conNameMemoryMapFlagBits :: String
conNameMemoryMapFlagBits = String
"MemoryMapFlagBits"

enumPrefixMemoryMapFlagBits :: String
enumPrefixMemoryMapFlagBits :: String
enumPrefixMemoryMapFlagBits = String
"MEMORY_MAP_PLACED_BIT_EXT"

showTableMemoryMapFlagBits :: [(MemoryMapFlagBits, String)]
showTableMemoryMapFlagBits :: [(MemoryMapFlagBits, String)]
showTableMemoryMapFlagBits = [(MemoryMapFlagBits
MEMORY_MAP_PLACED_BIT_EXT, String
"")]

instance Show MemoryMapFlagBits where
  showsPrec :: Int -> MemoryMapFlagBits -> ShowS
showsPrec =
    String
-> [(MemoryMapFlagBits, String)]
-> String
-> (MemoryMapFlagBits -> Word32)
-> (Word32 -> ShowS)
-> Int
-> MemoryMapFlagBits
-> ShowS
forall a i.
Eq a =>
String
-> [(a, String)]
-> String
-> (a -> i)
-> (i -> ShowS)
-> Int
-> a
-> ShowS
enumShowsPrec
      String
enumPrefixMemoryMapFlagBits
      [(MemoryMapFlagBits, String)]
showTableMemoryMapFlagBits
      String
conNameMemoryMapFlagBits
      (\(MemoryMapFlagBits Word32
x) -> Word32
x)
      (\Word32
x -> String -> ShowS
showString String
"0x" ShowS -> ShowS -> ShowS
forall b c a. (b -> c) -> (a -> b) -> a -> c
. Word32 -> ShowS
forall a. Integral a => a -> ShowS
showHex Word32
x)

instance Read MemoryMapFlagBits where
  readPrec :: ReadPrec MemoryMapFlagBits
readPrec =
    String
-> [(MemoryMapFlagBits, String)]
-> String
-> (Word32 -> MemoryMapFlagBits)
-> ReadPrec MemoryMapFlagBits
forall i a.
Read i =>
String -> [(a, String)] -> String -> (i -> a) -> ReadPrec a
enumReadPrec
      String
enumPrefixMemoryMapFlagBits
      [(MemoryMapFlagBits, String)]
showTableMemoryMapFlagBits
      String
conNameMemoryMapFlagBits
      Word32 -> MemoryMapFlagBits
MemoryMapFlagBits