{-# language CPP #-}
-- No documentation found for Chapter "CommandBufferResetFlagBits"
module Vulkan.Core10.Enums.CommandBufferResetFlagBits  ( CommandBufferResetFlags
                                                       , CommandBufferResetFlagBits( COMMAND_BUFFER_RESET_RELEASE_RESOURCES_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 CommandBufferResetFlags = CommandBufferResetFlagBits

-- | VkCommandBufferResetFlagBits - Bitmask controlling behavior of a command
-- buffer reset
--
-- = See Also
--
-- <https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#VK_VERSION_1_0 VK_VERSION_1_0>,
-- 'CommandBufferResetFlags'
newtype CommandBufferResetFlagBits = CommandBufferResetFlagBits Flags
  deriving newtype (CommandBufferResetFlagBits -> CommandBufferResetFlagBits -> Bool
(CommandBufferResetFlagBits -> CommandBufferResetFlagBits -> Bool)
-> (CommandBufferResetFlagBits
    -> CommandBufferResetFlagBits -> Bool)
-> Eq CommandBufferResetFlagBits
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
$c== :: CommandBufferResetFlagBits -> CommandBufferResetFlagBits -> Bool
== :: CommandBufferResetFlagBits -> CommandBufferResetFlagBits -> Bool
$c/= :: CommandBufferResetFlagBits -> CommandBufferResetFlagBits -> Bool
/= :: CommandBufferResetFlagBits -> CommandBufferResetFlagBits -> Bool
Eq, Eq CommandBufferResetFlagBits
Eq CommandBufferResetFlagBits =>
(CommandBufferResetFlagBits
 -> CommandBufferResetFlagBits -> Ordering)
-> (CommandBufferResetFlagBits
    -> CommandBufferResetFlagBits -> Bool)
-> (CommandBufferResetFlagBits
    -> CommandBufferResetFlagBits -> Bool)
-> (CommandBufferResetFlagBits
    -> CommandBufferResetFlagBits -> Bool)
-> (CommandBufferResetFlagBits
    -> CommandBufferResetFlagBits -> Bool)
-> (CommandBufferResetFlagBits
    -> CommandBufferResetFlagBits -> CommandBufferResetFlagBits)
-> (CommandBufferResetFlagBits
    -> CommandBufferResetFlagBits -> CommandBufferResetFlagBits)
-> Ord CommandBufferResetFlagBits
CommandBufferResetFlagBits -> CommandBufferResetFlagBits -> Bool
CommandBufferResetFlagBits
-> CommandBufferResetFlagBits -> Ordering
CommandBufferResetFlagBits
-> CommandBufferResetFlagBits -> CommandBufferResetFlagBits
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 :: CommandBufferResetFlagBits
-> CommandBufferResetFlagBits -> Ordering
compare :: CommandBufferResetFlagBits
-> CommandBufferResetFlagBits -> Ordering
$c< :: CommandBufferResetFlagBits -> CommandBufferResetFlagBits -> Bool
< :: CommandBufferResetFlagBits -> CommandBufferResetFlagBits -> Bool
$c<= :: CommandBufferResetFlagBits -> CommandBufferResetFlagBits -> Bool
<= :: CommandBufferResetFlagBits -> CommandBufferResetFlagBits -> Bool
$c> :: CommandBufferResetFlagBits -> CommandBufferResetFlagBits -> Bool
> :: CommandBufferResetFlagBits -> CommandBufferResetFlagBits -> Bool
$c>= :: CommandBufferResetFlagBits -> CommandBufferResetFlagBits -> Bool
>= :: CommandBufferResetFlagBits -> CommandBufferResetFlagBits -> Bool
$cmax :: CommandBufferResetFlagBits
-> CommandBufferResetFlagBits -> CommandBufferResetFlagBits
max :: CommandBufferResetFlagBits
-> CommandBufferResetFlagBits -> CommandBufferResetFlagBits
$cmin :: CommandBufferResetFlagBits
-> CommandBufferResetFlagBits -> CommandBufferResetFlagBits
min :: CommandBufferResetFlagBits
-> CommandBufferResetFlagBits -> CommandBufferResetFlagBits
Ord, Ptr CommandBufferResetFlagBits -> IO CommandBufferResetFlagBits
Ptr CommandBufferResetFlagBits
-> Int -> IO CommandBufferResetFlagBits
Ptr CommandBufferResetFlagBits
-> Int -> CommandBufferResetFlagBits -> IO ()
Ptr CommandBufferResetFlagBits
-> CommandBufferResetFlagBits -> IO ()
CommandBufferResetFlagBits -> Int
(CommandBufferResetFlagBits -> Int)
-> (CommandBufferResetFlagBits -> Int)
-> (Ptr CommandBufferResetFlagBits
    -> Int -> IO CommandBufferResetFlagBits)
-> (Ptr CommandBufferResetFlagBits
    -> Int -> CommandBufferResetFlagBits -> IO ())
-> (forall b. Ptr b -> Int -> IO CommandBufferResetFlagBits)
-> (forall b. Ptr b -> Int -> CommandBufferResetFlagBits -> IO ())
-> (Ptr CommandBufferResetFlagBits
    -> IO CommandBufferResetFlagBits)
-> (Ptr CommandBufferResetFlagBits
    -> CommandBufferResetFlagBits -> IO ())
-> Storable CommandBufferResetFlagBits
forall b. Ptr b -> Int -> IO CommandBufferResetFlagBits
forall b. Ptr b -> Int -> CommandBufferResetFlagBits -> 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 :: CommandBufferResetFlagBits -> Int
sizeOf :: CommandBufferResetFlagBits -> Int
$calignment :: CommandBufferResetFlagBits -> Int
alignment :: CommandBufferResetFlagBits -> Int
$cpeekElemOff :: Ptr CommandBufferResetFlagBits
-> Int -> IO CommandBufferResetFlagBits
peekElemOff :: Ptr CommandBufferResetFlagBits
-> Int -> IO CommandBufferResetFlagBits
$cpokeElemOff :: Ptr CommandBufferResetFlagBits
-> Int -> CommandBufferResetFlagBits -> IO ()
pokeElemOff :: Ptr CommandBufferResetFlagBits
-> Int -> CommandBufferResetFlagBits -> IO ()
$cpeekByteOff :: forall b. Ptr b -> Int -> IO CommandBufferResetFlagBits
peekByteOff :: forall b. Ptr b -> Int -> IO CommandBufferResetFlagBits
$cpokeByteOff :: forall b. Ptr b -> Int -> CommandBufferResetFlagBits -> IO ()
pokeByteOff :: forall b. Ptr b -> Int -> CommandBufferResetFlagBits -> IO ()
$cpeek :: Ptr CommandBufferResetFlagBits -> IO CommandBufferResetFlagBits
peek :: Ptr CommandBufferResetFlagBits -> IO CommandBufferResetFlagBits
$cpoke :: Ptr CommandBufferResetFlagBits
-> CommandBufferResetFlagBits -> IO ()
poke :: Ptr CommandBufferResetFlagBits
-> CommandBufferResetFlagBits -> IO ()
Storable, CommandBufferResetFlagBits
CommandBufferResetFlagBits -> Zero CommandBufferResetFlagBits
forall a. a -> Zero a
$czero :: CommandBufferResetFlagBits
zero :: CommandBufferResetFlagBits
Zero, Eq CommandBufferResetFlagBits
CommandBufferResetFlagBits
Eq CommandBufferResetFlagBits =>
(CommandBufferResetFlagBits
 -> CommandBufferResetFlagBits -> CommandBufferResetFlagBits)
-> (CommandBufferResetFlagBits
    -> CommandBufferResetFlagBits -> CommandBufferResetFlagBits)
-> (CommandBufferResetFlagBits
    -> CommandBufferResetFlagBits -> CommandBufferResetFlagBits)
-> (CommandBufferResetFlagBits -> CommandBufferResetFlagBits)
-> (CommandBufferResetFlagBits
    -> Int -> CommandBufferResetFlagBits)
-> (CommandBufferResetFlagBits
    -> Int -> CommandBufferResetFlagBits)
-> CommandBufferResetFlagBits
-> (Int -> CommandBufferResetFlagBits)
-> (CommandBufferResetFlagBits
    -> Int -> CommandBufferResetFlagBits)
-> (CommandBufferResetFlagBits
    -> Int -> CommandBufferResetFlagBits)
-> (CommandBufferResetFlagBits
    -> Int -> CommandBufferResetFlagBits)
-> (CommandBufferResetFlagBits -> Int -> Bool)
-> (CommandBufferResetFlagBits -> Maybe Int)
-> (CommandBufferResetFlagBits -> Int)
-> (CommandBufferResetFlagBits -> Bool)
-> (CommandBufferResetFlagBits
    -> Int -> CommandBufferResetFlagBits)
-> (CommandBufferResetFlagBits
    -> Int -> CommandBufferResetFlagBits)
-> (CommandBufferResetFlagBits
    -> Int -> CommandBufferResetFlagBits)
-> (CommandBufferResetFlagBits
    -> Int -> CommandBufferResetFlagBits)
-> (CommandBufferResetFlagBits
    -> Int -> CommandBufferResetFlagBits)
-> (CommandBufferResetFlagBits
    -> Int -> CommandBufferResetFlagBits)
-> (CommandBufferResetFlagBits -> Int)
-> Bits CommandBufferResetFlagBits
Int -> CommandBufferResetFlagBits
CommandBufferResetFlagBits -> Bool
CommandBufferResetFlagBits -> Int
CommandBufferResetFlagBits -> Maybe Int
CommandBufferResetFlagBits -> CommandBufferResetFlagBits
CommandBufferResetFlagBits -> Int -> Bool
CommandBufferResetFlagBits -> Int -> CommandBufferResetFlagBits
CommandBufferResetFlagBits
-> CommandBufferResetFlagBits -> CommandBufferResetFlagBits
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.&. :: CommandBufferResetFlagBits
-> CommandBufferResetFlagBits -> CommandBufferResetFlagBits
.&. :: CommandBufferResetFlagBits
-> CommandBufferResetFlagBits -> CommandBufferResetFlagBits
$c.|. :: CommandBufferResetFlagBits
-> CommandBufferResetFlagBits -> CommandBufferResetFlagBits
.|. :: CommandBufferResetFlagBits
-> CommandBufferResetFlagBits -> CommandBufferResetFlagBits
$cxor :: CommandBufferResetFlagBits
-> CommandBufferResetFlagBits -> CommandBufferResetFlagBits
xor :: CommandBufferResetFlagBits
-> CommandBufferResetFlagBits -> CommandBufferResetFlagBits
$ccomplement :: CommandBufferResetFlagBits -> CommandBufferResetFlagBits
complement :: CommandBufferResetFlagBits -> CommandBufferResetFlagBits
$cshift :: CommandBufferResetFlagBits -> Int -> CommandBufferResetFlagBits
shift :: CommandBufferResetFlagBits -> Int -> CommandBufferResetFlagBits
$crotate :: CommandBufferResetFlagBits -> Int -> CommandBufferResetFlagBits
rotate :: CommandBufferResetFlagBits -> Int -> CommandBufferResetFlagBits
$czeroBits :: CommandBufferResetFlagBits
zeroBits :: CommandBufferResetFlagBits
$cbit :: Int -> CommandBufferResetFlagBits
bit :: Int -> CommandBufferResetFlagBits
$csetBit :: CommandBufferResetFlagBits -> Int -> CommandBufferResetFlagBits
setBit :: CommandBufferResetFlagBits -> Int -> CommandBufferResetFlagBits
$cclearBit :: CommandBufferResetFlagBits -> Int -> CommandBufferResetFlagBits
clearBit :: CommandBufferResetFlagBits -> Int -> CommandBufferResetFlagBits
$ccomplementBit :: CommandBufferResetFlagBits -> Int -> CommandBufferResetFlagBits
complementBit :: CommandBufferResetFlagBits -> Int -> CommandBufferResetFlagBits
$ctestBit :: CommandBufferResetFlagBits -> Int -> Bool
testBit :: CommandBufferResetFlagBits -> Int -> Bool
$cbitSizeMaybe :: CommandBufferResetFlagBits -> Maybe Int
bitSizeMaybe :: CommandBufferResetFlagBits -> Maybe Int
$cbitSize :: CommandBufferResetFlagBits -> Int
bitSize :: CommandBufferResetFlagBits -> Int
$cisSigned :: CommandBufferResetFlagBits -> Bool
isSigned :: CommandBufferResetFlagBits -> Bool
$cshiftL :: CommandBufferResetFlagBits -> Int -> CommandBufferResetFlagBits
shiftL :: CommandBufferResetFlagBits -> Int -> CommandBufferResetFlagBits
$cunsafeShiftL :: CommandBufferResetFlagBits -> Int -> CommandBufferResetFlagBits
unsafeShiftL :: CommandBufferResetFlagBits -> Int -> CommandBufferResetFlagBits
$cshiftR :: CommandBufferResetFlagBits -> Int -> CommandBufferResetFlagBits
shiftR :: CommandBufferResetFlagBits -> Int -> CommandBufferResetFlagBits
$cunsafeShiftR :: CommandBufferResetFlagBits -> Int -> CommandBufferResetFlagBits
unsafeShiftR :: CommandBufferResetFlagBits -> Int -> CommandBufferResetFlagBits
$crotateL :: CommandBufferResetFlagBits -> Int -> CommandBufferResetFlagBits
rotateL :: CommandBufferResetFlagBits -> Int -> CommandBufferResetFlagBits
$crotateR :: CommandBufferResetFlagBits -> Int -> CommandBufferResetFlagBits
rotateR :: CommandBufferResetFlagBits -> Int -> CommandBufferResetFlagBits
$cpopCount :: CommandBufferResetFlagBits -> Int
popCount :: CommandBufferResetFlagBits -> Int
Bits, Bits CommandBufferResetFlagBits
Bits CommandBufferResetFlagBits =>
(CommandBufferResetFlagBits -> Int)
-> (CommandBufferResetFlagBits -> Int)
-> (CommandBufferResetFlagBits -> Int)
-> FiniteBits CommandBufferResetFlagBits
CommandBufferResetFlagBits -> Int
forall b.
Bits b =>
(b -> Int) -> (b -> Int) -> (b -> Int) -> FiniteBits b
$cfiniteBitSize :: CommandBufferResetFlagBits -> Int
finiteBitSize :: CommandBufferResetFlagBits -> Int
$ccountLeadingZeros :: CommandBufferResetFlagBits -> Int
countLeadingZeros :: CommandBufferResetFlagBits -> Int
$ccountTrailingZeros :: CommandBufferResetFlagBits -> Int
countTrailingZeros :: CommandBufferResetFlagBits -> Int
FiniteBits)

-- | 'COMMAND_BUFFER_RESET_RELEASE_RESOURCES_BIT' specifies that most or all
-- memory resources currently owned by the command buffer /should/ be
-- returned to the parent command pool. If this flag is not set, then the
-- command buffer /may/ hold onto memory resources and reuse them when
-- recording commands. @commandBuffer@ is moved to the
-- <https://registry.khronos.org/vulkan/specs/1.3-extensions/html/vkspec.html#commandbuffers-lifecycle initial state>.
pattern $bCOMMAND_BUFFER_RESET_RELEASE_RESOURCES_BIT :: CommandBufferResetFlagBits
$mCOMMAND_BUFFER_RESET_RELEASE_RESOURCES_BIT :: forall {r}.
CommandBufferResetFlagBits -> ((# #) -> r) -> ((# #) -> r) -> r
COMMAND_BUFFER_RESET_RELEASE_RESOURCES_BIT = CommandBufferResetFlagBits 0x00000001

conNameCommandBufferResetFlagBits :: String
conNameCommandBufferResetFlagBits :: String
conNameCommandBufferResetFlagBits = String
"CommandBufferResetFlagBits"

enumPrefixCommandBufferResetFlagBits :: String
enumPrefixCommandBufferResetFlagBits :: String
enumPrefixCommandBufferResetFlagBits = String
"COMMAND_BUFFER_RESET_RELEASE_RESOURCES_BIT"

showTableCommandBufferResetFlagBits :: [(CommandBufferResetFlagBits, String)]
showTableCommandBufferResetFlagBits :: [(CommandBufferResetFlagBits, String)]
showTableCommandBufferResetFlagBits =
  [
    ( CommandBufferResetFlagBits
COMMAND_BUFFER_RESET_RELEASE_RESOURCES_BIT
    , String
""
    )
  ]

instance Show CommandBufferResetFlagBits where
  showsPrec :: Int -> CommandBufferResetFlagBits -> ShowS
showsPrec =
    String
-> [(CommandBufferResetFlagBits, String)]
-> String
-> (CommandBufferResetFlagBits -> Flags)
-> (Flags -> ShowS)
-> Int
-> CommandBufferResetFlagBits
-> ShowS
forall a i.
Eq a =>
String
-> [(a, String)]
-> String
-> (a -> i)
-> (i -> ShowS)
-> Int
-> a
-> ShowS
enumShowsPrec
      String
enumPrefixCommandBufferResetFlagBits
      [(CommandBufferResetFlagBits, String)]
showTableCommandBufferResetFlagBits
      String
conNameCommandBufferResetFlagBits
      (\(CommandBufferResetFlagBits Flags
x) -> Flags
x)
      (\Flags
x -> String -> ShowS
showString String
"0x" ShowS -> ShowS -> ShowS
forall b c a. (b -> c) -> (a -> b) -> a -> c
. Flags -> ShowS
forall a. Integral a => a -> ShowS
showHex Flags
x)

instance Read CommandBufferResetFlagBits where
  readPrec :: ReadPrec CommandBufferResetFlagBits
readPrec =
    String
-> [(CommandBufferResetFlagBits, String)]
-> String
-> (Flags -> CommandBufferResetFlagBits)
-> ReadPrec CommandBufferResetFlagBits
forall i a.
Read i =>
String -> [(a, String)] -> String -> (i -> a) -> ReadPrec a
enumReadPrec
      String
enumPrefixCommandBufferResetFlagBits
      [(CommandBufferResetFlagBits, String)]
showTableCommandBufferResetFlagBits
      String
conNameCommandBufferResetFlagBits
      Flags -> CommandBufferResetFlagBits
CommandBufferResetFlagBits