{-# language CPP #-}
-- | = Name
--
-- VK_NV_device_diagnostic_checkpoints - device extension
--
-- == VK_NV_device_diagnostic_checkpoints
--
-- [__Name String__]
--     @VK_NV_device_diagnostic_checkpoints@
--
-- [__Extension Type__]
--     Device extension
--
-- [__Registered Extension Number__]
--     207
--
-- [__Revision__]
--     2
--
-- [__Ratification Status__]
--     Not ratified
--
-- [__Extension and Version Dependencies__]
--     <https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#VK_KHR_get_physical_device_properties2 VK_KHR_get_physical_device_properties2>
--
-- [__Contact__]
--
--     -   Nuno Subtil
--         <https://github.com/KhronosGroup/Vulkan-Docs/issues/new?body=[VK_NV_device_diagnostic_checkpoints] @nsubtil%0A*Here describe the issue or question you have about the VK_NV_device_diagnostic_checkpoints extension* >
--
-- == Other Extension Metadata
--
-- [__Last Modified Date__]
--     2018-07-16
--
-- [__Contributors__]
--
--     -   Oleg Kuznetsov, NVIDIA
--
--     -   Alex Dunn, NVIDIA
--
--     -   Jeff Bolz, NVIDIA
--
--     -   Eric Werness, NVIDIA
--
--     -   Daniel Koch, NVIDIA
--
-- == Description
--
-- This extension allows applications to insert markers in the command
-- stream and associate them with custom data.
--
-- If a device lost error occurs, the application /may/ then query the
-- implementation for the last markers to cross specific
-- implementation-defined pipeline stages, in order to narrow down which
-- commands were executing at the time and might have caused the failure.
--
-- == New Commands
--
-- -   'cmdSetCheckpointNV'
--
-- -   'getQueueCheckpointDataNV'
--
-- == New Structures
--
-- -   'CheckpointDataNV'
--
-- -   Extending
--     'Vulkan.Core11.Promoted_From_VK_KHR_get_physical_device_properties2.QueueFamilyProperties2':
--
--     -   'QueueFamilyCheckpointPropertiesNV'
--
-- == New Enum Constants
--
-- -   'NV_DEVICE_DIAGNOSTIC_CHECKPOINTS_EXTENSION_NAME'
--
-- -   'NV_DEVICE_DIAGNOSTIC_CHECKPOINTS_SPEC_VERSION'
--
-- -   Extending 'Vulkan.Core10.Enums.StructureType.StructureType':
--
--     -   'Vulkan.Core10.Enums.StructureType.STRUCTURE_TYPE_CHECKPOINT_DATA_NV'
--
--     -   'Vulkan.Core10.Enums.StructureType.STRUCTURE_TYPE_QUEUE_FAMILY_CHECKPOINT_PROPERTIES_NV'
--
-- == Version History
--
-- -   Revision 1, 2018-07-16 (Nuno Subtil)
--
--     -   Internal revisions
--
-- -   Revision 2, 2018-07-16 (Nuno Subtil)
--
--     -   ???
--
-- == See Also
--
-- 'CheckpointDataNV', 'QueueFamilyCheckpointPropertiesNV',
-- 'cmdSetCheckpointNV', 'getQueueCheckpointDataNV'
--
-- == Document Notes
--
-- For more information, see the
-- <https://registry.khronos.org/vulkan/specs/1.3-extensions/html/vkspec.html#VK_NV_device_diagnostic_checkpoints Vulkan Specification>
--
-- This page is a generated document. Fixes and changes should be made to
-- the generator scripts, not directly.
module Vulkan.Extensions.VK_NV_device_diagnostic_checkpoints  ( cmdSetCheckpointNV
                                                              , getQueueCheckpointDataNV
                                                              , QueueFamilyCheckpointPropertiesNV(..)
                                                              , CheckpointDataNV(..)
                                                              , NV_DEVICE_DIAGNOSTIC_CHECKPOINTS_SPEC_VERSION
                                                              , pattern NV_DEVICE_DIAGNOSTIC_CHECKPOINTS_SPEC_VERSION
                                                              , NV_DEVICE_DIAGNOSTIC_CHECKPOINTS_EXTENSION_NAME
                                                              , pattern NV_DEVICE_DIAGNOSTIC_CHECKPOINTS_EXTENSION_NAME
                                                              ) where

import Vulkan.Internal.Utils (traceAroundEvent)
import Control.Exception.Base (bracket)
import Control.Monad (unless)
import Control.Monad.IO.Class (liftIO)
import Foreign.Marshal.Alloc (allocaBytes)
import Foreign.Marshal.Alloc (callocBytes)
import Foreign.Marshal.Alloc (free)
import GHC.IO (throwIO)
import GHC.Ptr (nullFunPtr)
import Foreign.Ptr (nullPtr)
import Foreign.Ptr (plusPtr)
import Control.Monad.Trans.Class (lift)
import Control.Monad.Trans.Cont (evalContT)
import Data.Vector (generateM)
import Vulkan.CStruct (FromCStruct)
import Vulkan.CStruct (FromCStruct(..))
import Vulkan.CStruct (ToCStruct)
import Vulkan.CStruct (ToCStruct(..))
import Vulkan.Zero (Zero(..))
import Control.Monad.IO.Class (MonadIO)
import Data.String (IsString)
import Data.Typeable (Typeable)
import Foreign.Storable (Storable)
import Foreign.Storable (Storable(peek))
import Foreign.Storable (Storable(poke))
import qualified Foreign.Storable (Storable(..))
import GHC.Generics (Generic)
import GHC.IO.Exception (IOErrorType(..))
import GHC.IO.Exception (IOException(..))
import Foreign.Ptr (FunPtr)
import Foreign.Ptr (Ptr)
import Data.Word (Word32)
import Data.Kind (Type)
import Control.Monad.Trans.Cont (ContT(..))
import Data.Vector (Vector)
import Vulkan.CStruct.Utils (advancePtrBytes)
import Vulkan.NamedType ((:::))
import Vulkan.Core10.Handles (CommandBuffer)
import Vulkan.Core10.Handles (CommandBuffer(..))
import Vulkan.Core10.Handles (CommandBuffer(CommandBuffer))
import Vulkan.Core10.Handles (CommandBuffer_T)
import Vulkan.Dynamic (DeviceCmds(pVkCmdSetCheckpointNV))
import Vulkan.Dynamic (DeviceCmds(pVkGetQueueCheckpointDataNV))
import Vulkan.Core10.Enums.PipelineStageFlagBits (PipelineStageFlagBits)
import Vulkan.Core10.Enums.PipelineStageFlagBits (PipelineStageFlags)
import Vulkan.Core10.Handles (Queue)
import Vulkan.Core10.Handles (Queue(..))
import Vulkan.Core10.Handles (Queue(Queue))
import Vulkan.Core10.Handles (Queue_T)
import Vulkan.Core10.Enums.StructureType (StructureType)
import Vulkan.Core10.Enums.StructureType (StructureType(STRUCTURE_TYPE_CHECKPOINT_DATA_NV))
import Vulkan.Core10.Enums.StructureType (StructureType(STRUCTURE_TYPE_QUEUE_FAMILY_CHECKPOINT_PROPERTIES_NV))
foreign import ccall
#if !defined(SAFE_FOREIGN_CALLS)
  unsafe
#endif
  "dynamic" mkVkCmdSetCheckpointNV
  :: FunPtr (Ptr CommandBuffer_T -> Ptr () -> IO ()) -> Ptr CommandBuffer_T -> Ptr () -> IO ()

-- | vkCmdSetCheckpointNV - Insert diagnostic checkpoint in command stream
--
-- == Valid Usage (Implicit)
--
-- -   #VUID-vkCmdSetCheckpointNV-commandBuffer-parameter# @commandBuffer@
--     /must/ be a valid 'Vulkan.Core10.Handles.CommandBuffer' handle
--
-- -   #VUID-vkCmdSetCheckpointNV-commandBuffer-recording# @commandBuffer@
--     /must/ be in the
--     <https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#commandbuffers-lifecycle recording state>
--
-- -   #VUID-vkCmdSetCheckpointNV-commandBuffer-cmdpool# The
--     'Vulkan.Core10.Handles.CommandPool' that @commandBuffer@ was
--     allocated from /must/ support graphics, compute, or transfer
--     operations
--
-- -   #VUID-vkCmdSetCheckpointNV-videocoding# This command /must/ only be
--     called outside of a video coding scope
--
-- == Host Synchronization
--
-- -   Host access to @commandBuffer@ /must/ be externally synchronized
--
-- -   Host access to the 'Vulkan.Core10.Handles.CommandPool' that
--     @commandBuffer@ was allocated from /must/ be externally synchronized
--
-- == Command Properties
--
-- \'
--
-- +----------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
-- | <https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#VkCommandBufferLevel Command Buffer Levels> | <https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#vkCmdBeginRenderPass Render Pass Scope> | <https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#vkCmdBeginVideoCodingKHR Video Coding Scope> | <https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#VkQueueFlagBits Supported Queue Types> | <https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#fundamentals-queueoperation-command-types Command Type> |
-- +============================================================================================================================+========================================================================================================================+=============================================================================================================================+=======================================================================================================================+========================================================================================================================================+
-- | Primary                                                                                                                    | Both                                                                                                                   | Outside                                                                                                                     | Graphics                                                                                                              | Action                                                                                                                                 |
-- | Secondary                                                                                                                  |                                                                                                                        |                                                                                                                             | Compute                                                                                                               |                                                                                                                                        |
-- |                                                                                                                            |                                                                                                                        |                                                                                                                             | Transfer                                                                                                              |                                                                                                                                        |
-- +----------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
--
-- = See Also
--
-- <https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#VK_NV_device_diagnostic_checkpoints VK_NV_device_diagnostic_checkpoints>,
-- 'Vulkan.Core10.Handles.CommandBuffer'
cmdSetCheckpointNV :: forall io
                    . (MonadIO io)
                   => -- | @commandBuffer@ is the command buffer that will receive the marker
                      CommandBuffer
                   -> -- | @pCheckpointMarker@ is an opaque application-provided value that will be
                      -- associated with the checkpoint.
                      ("checkpointMarker" ::: Ptr ())
                   -> io ()
cmdSetCheckpointNV :: forall (io :: * -> *).
MonadIO io =>
CommandBuffer -> ("checkpointMarker" ::: Ptr ()) -> io ()
cmdSetCheckpointNV CommandBuffer
commandBuffer "checkpointMarker" ::: Ptr ()
checkpointMarker = forall (m :: * -> *) a. MonadIO m => IO a -> m a
liftIO forall a b. (a -> b) -> a -> b
$ do
  let vkCmdSetCheckpointNVPtr :: FunPtr
  (Ptr CommandBuffer_T -> ("checkpointMarker" ::: Ptr ()) -> IO ())
vkCmdSetCheckpointNVPtr = DeviceCmds
-> FunPtr
     (Ptr CommandBuffer_T -> ("checkpointMarker" ::: Ptr ()) -> IO ())
pVkCmdSetCheckpointNV (case CommandBuffer
commandBuffer of CommandBuffer{DeviceCmds
$sel:deviceCmds:CommandBuffer :: CommandBuffer -> DeviceCmds
deviceCmds :: DeviceCmds
deviceCmds} -> DeviceCmds
deviceCmds)
  forall (f :: * -> *). Applicative f => Bool -> f () -> f ()
unless (FunPtr
  (Ptr CommandBuffer_T -> ("checkpointMarker" ::: Ptr ()) -> IO ())
vkCmdSetCheckpointNVPtr forall a. Eq a => a -> a -> Bool
/= forall a. FunPtr a
nullFunPtr) forall a b. (a -> b) -> a -> b
$
    forall e a. Exception e => e -> IO a
throwIO forall a b. (a -> b) -> a -> b
$ Maybe Handle
-> IOErrorType
-> String
-> String
-> Maybe CInt
-> Maybe String
-> IOException
IOError forall a. Maybe a
Nothing IOErrorType
InvalidArgument String
"" String
"The function pointer for vkCmdSetCheckpointNV is null" forall a. Maybe a
Nothing forall a. Maybe a
Nothing
  let vkCmdSetCheckpointNV' :: Ptr CommandBuffer_T -> ("checkpointMarker" ::: Ptr ()) -> IO ()
vkCmdSetCheckpointNV' = FunPtr
  (Ptr CommandBuffer_T -> ("checkpointMarker" ::: Ptr ()) -> IO ())
-> Ptr CommandBuffer_T -> ("checkpointMarker" ::: Ptr ()) -> IO ()
mkVkCmdSetCheckpointNV FunPtr
  (Ptr CommandBuffer_T -> ("checkpointMarker" ::: Ptr ()) -> IO ())
vkCmdSetCheckpointNVPtr
  forall a. String -> IO a -> IO a
traceAroundEvent String
"vkCmdSetCheckpointNV" (Ptr CommandBuffer_T -> ("checkpointMarker" ::: Ptr ()) -> IO ()
vkCmdSetCheckpointNV'
                                             (CommandBuffer -> Ptr CommandBuffer_T
commandBufferHandle (CommandBuffer
commandBuffer))
                                             ("checkpointMarker" ::: Ptr ()
checkpointMarker))
  forall (f :: * -> *) a. Applicative f => a -> f a
pure forall a b. (a -> b) -> a -> b
$ ()


foreign import ccall
#if !defined(SAFE_FOREIGN_CALLS)
  unsafe
#endif
  "dynamic" mkVkGetQueueCheckpointDataNV
  :: FunPtr (Ptr Queue_T -> Ptr Word32 -> Ptr CheckpointDataNV -> IO ()) -> Ptr Queue_T -> Ptr Word32 -> Ptr CheckpointDataNV -> IO ()

-- | vkGetQueueCheckpointDataNV - Retrieve diagnostic checkpoint data
--
-- = Description
--
-- If @pCheckpointData@ is @NULL@, then the number of checkpoint markers
-- available is returned in @pCheckpointDataCount@.
--
-- Otherwise, @pCheckpointDataCount@ /must/ point to a variable set by the
-- user to the number of elements in the @pCheckpointData@ array, and on
-- return the variable is overwritten with the number of structures
-- actually written to @pCheckpointData@.
--
-- If @pCheckpointDataCount@ is less than the number of checkpoint markers
-- available, at most @pCheckpointDataCount@ structures will be written.
--
-- == Valid Usage
--
-- -   #VUID-vkGetQueueCheckpointDataNV-queue-02025# The device that
--     @queue@ belongs to /must/ be in the lost state
--
-- == Valid Usage (Implicit)
--
-- -   #VUID-vkGetQueueCheckpointDataNV-queue-parameter# @queue@ /must/ be
--     a valid 'Vulkan.Core10.Handles.Queue' handle
--
-- -   #VUID-vkGetQueueCheckpointDataNV-pCheckpointDataCount-parameter#
--     @pCheckpointDataCount@ /must/ be a valid pointer to a @uint32_t@
--     value
--
-- -   #VUID-vkGetQueueCheckpointDataNV-pCheckpointData-parameter# If the
--     value referenced by @pCheckpointDataCount@ is not @0@, and
--     @pCheckpointData@ is not @NULL@, @pCheckpointData@ /must/ be a valid
--     pointer to an array of @pCheckpointDataCount@ 'CheckpointDataNV'
--     structures
--
-- = See Also
--
-- <https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#VK_NV_device_diagnostic_checkpoints VK_NV_device_diagnostic_checkpoints>,
-- 'CheckpointDataNV', 'Vulkan.Core10.Handles.Queue'
getQueueCheckpointDataNV :: forall io
                          . (MonadIO io)
                         => -- | @queue@ is the 'Vulkan.Core10.Handles.Queue' object the caller would
                            -- like to retrieve checkpoint data for
                            Queue
                         -> io (("checkpointData" ::: Vector CheckpointDataNV))
getQueueCheckpointDataNV :: forall (io :: * -> *).
MonadIO io =>
Queue -> io ("checkpointData" ::: Vector CheckpointDataNV)
getQueueCheckpointDataNV Queue
queue = forall (m :: * -> *) a. MonadIO m => IO a -> m a
liftIO forall b c a. (b -> c) -> (a -> b) -> a -> c
. forall (m :: * -> *) r. Monad m => ContT r m r -> m r
evalContT forall a b. (a -> b) -> a -> b
$ do
  let vkGetQueueCheckpointDataNVPtr :: FunPtr
  (Ptr Queue_T
   -> ("pCheckpointDataCount" ::: Ptr Word32)
   -> ("pCheckpointData" ::: Ptr CheckpointDataNV)
   -> IO ())
vkGetQueueCheckpointDataNVPtr = DeviceCmds
-> FunPtr
     (Ptr Queue_T
      -> ("pCheckpointDataCount" ::: Ptr Word32)
      -> ("pCheckpointData" ::: Ptr CheckpointDataNV)
      -> IO ())
pVkGetQueueCheckpointDataNV (case Queue
queue of Queue{DeviceCmds
$sel:deviceCmds:Queue :: Queue -> DeviceCmds
deviceCmds :: DeviceCmds
deviceCmds} -> DeviceCmds
deviceCmds)
  forall (t :: (* -> *) -> * -> *) (m :: * -> *) a.
(MonadTrans t, Monad m) =>
m a -> t m a
lift forall a b. (a -> b) -> a -> b
$ forall (f :: * -> *). Applicative f => Bool -> f () -> f ()
unless (FunPtr
  (Ptr Queue_T
   -> ("pCheckpointDataCount" ::: Ptr Word32)
   -> ("pCheckpointData" ::: Ptr CheckpointDataNV)
   -> IO ())
vkGetQueueCheckpointDataNVPtr forall a. Eq a => a -> a -> Bool
/= forall a. FunPtr a
nullFunPtr) forall a b. (a -> b) -> a -> b
$
    forall e a. Exception e => e -> IO a
throwIO forall a b. (a -> b) -> a -> b
$ Maybe Handle
-> IOErrorType
-> String
-> String
-> Maybe CInt
-> Maybe String
-> IOException
IOError forall a. Maybe a
Nothing IOErrorType
InvalidArgument String
"" String
"The function pointer for vkGetQueueCheckpointDataNV is null" forall a. Maybe a
Nothing forall a. Maybe a
Nothing
  let vkGetQueueCheckpointDataNV' :: Ptr Queue_T
-> ("pCheckpointDataCount" ::: Ptr Word32)
-> ("pCheckpointData" ::: Ptr CheckpointDataNV)
-> IO ()
vkGetQueueCheckpointDataNV' = FunPtr
  (Ptr Queue_T
   -> ("pCheckpointDataCount" ::: Ptr Word32)
   -> ("pCheckpointData" ::: Ptr CheckpointDataNV)
   -> IO ())
-> Ptr Queue_T
-> ("pCheckpointDataCount" ::: Ptr Word32)
-> ("pCheckpointData" ::: Ptr CheckpointDataNV)
-> IO ()
mkVkGetQueueCheckpointDataNV FunPtr
  (Ptr Queue_T
   -> ("pCheckpointDataCount" ::: Ptr Word32)
   -> ("pCheckpointData" ::: Ptr CheckpointDataNV)
   -> IO ())
vkGetQueueCheckpointDataNVPtr
  let queue' :: Ptr Queue_T
queue' = Queue -> Ptr Queue_T
queueHandle (Queue
queue)
  "pCheckpointDataCount" ::: Ptr Word32
pPCheckpointDataCount <- forall {k} (r :: k) (m :: k -> *) a.
((a -> m r) -> m r) -> ContT r m a
ContT forall a b. (a -> b) -> a -> b
$ forall a b c. IO a -> (a -> IO b) -> (a -> IO c) -> IO c
bracket (forall a. Int -> IO (Ptr a)
callocBytes @Word32 Int
4) forall a. Ptr a -> IO ()
free
  forall (t :: (* -> *) -> * -> *) (m :: * -> *) a.
(MonadTrans t, Monad m) =>
m a -> t m a
lift forall a b. (a -> b) -> a -> b
$ forall a. String -> IO a -> IO a
traceAroundEvent String
"vkGetQueueCheckpointDataNV" (Ptr Queue_T
-> ("pCheckpointDataCount" ::: Ptr Word32)
-> ("pCheckpointData" ::: Ptr CheckpointDataNV)
-> IO ()
vkGetQueueCheckpointDataNV'
                                                          Ptr Queue_T
queue'
                                                          ("pCheckpointDataCount" ::: Ptr Word32
pPCheckpointDataCount)
                                                          (forall a. Ptr a
nullPtr))
  Word32
pCheckpointDataCount <- forall (t :: (* -> *) -> * -> *) (m :: * -> *) a.
(MonadTrans t, Monad m) =>
m a -> t m a
lift forall a b. (a -> b) -> a -> b
$ forall a. Storable a => Ptr a -> IO a
peek @Word32 "pCheckpointDataCount" ::: Ptr Word32
pPCheckpointDataCount
  "pCheckpointData" ::: Ptr CheckpointDataNV
pPCheckpointData <- forall {k} (r :: k) (m :: k -> *) a.
((a -> m r) -> m r) -> ContT r m a
ContT forall a b. (a -> b) -> a -> b
$ forall a b c. IO a -> (a -> IO b) -> (a -> IO c) -> IO c
bracket (forall a. Int -> IO (Ptr a)
callocBytes @CheckpointDataNV ((forall a b. (Integral a, Num b) => a -> b
fromIntegral (Word32
pCheckpointDataCount)) forall a. Num a => a -> a -> a
* Int
32)) forall a. Ptr a -> IO ()
free
  [()]
_ <- forall (t :: * -> *) (f :: * -> *) a b.
(Traversable t, Applicative f) =>
(a -> f b) -> t a -> f (t b)
traverse (\Int
i -> forall {k} (r :: k) (m :: k -> *) a.
((a -> m r) -> m r) -> ContT r m a
ContT forall a b. (a -> b) -> a -> b
$ forall a b. ToCStruct a => Ptr a -> IO b -> IO b
pokeZeroCStruct ("pCheckpointData" ::: Ptr CheckpointDataNV
pPCheckpointData forall a. Ptr a -> Int -> Ptr a
`advancePtrBytes` (Int
i forall a. Num a => a -> a -> a
* Int
32) :: Ptr CheckpointDataNV) forall b c a. (b -> c) -> (a -> b) -> a -> c
. (forall a b. (a -> b) -> a -> b
$ ())) [Int
0..(forall a b. (Integral a, Num b) => a -> b
fromIntegral (Word32
pCheckpointDataCount)) forall a. Num a => a -> a -> a
- Int
1]
  forall (t :: (* -> *) -> * -> *) (m :: * -> *) a.
(MonadTrans t, Monad m) =>
m a -> t m a
lift forall a b. (a -> b) -> a -> b
$ forall a. String -> IO a -> IO a
traceAroundEvent String
"vkGetQueueCheckpointDataNV" (Ptr Queue_T
-> ("pCheckpointDataCount" ::: Ptr Word32)
-> ("pCheckpointData" ::: Ptr CheckpointDataNV)
-> IO ()
vkGetQueueCheckpointDataNV'
                                                          Ptr Queue_T
queue'
                                                          ("pCheckpointDataCount" ::: Ptr Word32
pPCheckpointDataCount)
                                                          (("pCheckpointData" ::: Ptr CheckpointDataNV
pPCheckpointData)))
  Word32
pCheckpointDataCount' <- forall (t :: (* -> *) -> * -> *) (m :: * -> *) a.
(MonadTrans t, Monad m) =>
m a -> t m a
lift forall a b. (a -> b) -> a -> b
$ forall a. Storable a => Ptr a -> IO a
peek @Word32 "pCheckpointDataCount" ::: Ptr Word32
pPCheckpointDataCount
  "checkpointData" ::: Vector CheckpointDataNV
pCheckpointData' <- forall (t :: (* -> *) -> * -> *) (m :: * -> *) a.
(MonadTrans t, Monad m) =>
m a -> t m a
lift forall a b. (a -> b) -> a -> b
$ forall (m :: * -> *) a.
Monad m =>
Int -> (Int -> m a) -> m (Vector a)
generateM (forall a b. (Integral a, Num b) => a -> b
fromIntegral (Word32
pCheckpointDataCount')) (\Int
i -> forall a. FromCStruct a => Ptr a -> IO a
peekCStruct @CheckpointDataNV ((("pCheckpointData" ::: Ptr CheckpointDataNV
pPCheckpointData) forall a. Ptr a -> Int -> Ptr a
`advancePtrBytes` (Int
32 forall a. Num a => a -> a -> a
* (Int
i)) :: Ptr CheckpointDataNV)))
  forall (f :: * -> *) a. Applicative f => a -> f a
pure forall a b. (a -> b) -> a -> b
$ ("checkpointData" ::: Vector CheckpointDataNV
pCheckpointData')


-- | VkQueueFamilyCheckpointPropertiesNV - Return structure for queue family
-- checkpoint information query
--
-- = Description
--
-- Additional queue family information can be queried by setting
-- 'Vulkan.Core11.Promoted_From_VK_KHR_get_physical_device_properties2.QueueFamilyProperties2'::@pNext@
-- to point to a 'QueueFamilyCheckpointPropertiesNV' structure.
--
-- == Valid Usage (Implicit)
--
-- = See Also
--
-- <https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#VK_NV_device_diagnostic_checkpoints VK_NV_device_diagnostic_checkpoints>,
-- 'Vulkan.Core10.Enums.PipelineStageFlagBits.PipelineStageFlags',
-- 'Vulkan.Core10.Enums.StructureType.StructureType'
data QueueFamilyCheckpointPropertiesNV = QueueFamilyCheckpointPropertiesNV
  { -- | @checkpointExecutionStageMask@ is a mask indicating which pipeline
    -- stages the implementation can execute checkpoint markers in.
    QueueFamilyCheckpointPropertiesNV -> PipelineStageFlags
checkpointExecutionStageMask :: PipelineStageFlags }
  deriving (Typeable, QueueFamilyCheckpointPropertiesNV
-> QueueFamilyCheckpointPropertiesNV -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: QueueFamilyCheckpointPropertiesNV
-> QueueFamilyCheckpointPropertiesNV -> Bool
$c/= :: QueueFamilyCheckpointPropertiesNV
-> QueueFamilyCheckpointPropertiesNV -> Bool
== :: QueueFamilyCheckpointPropertiesNV
-> QueueFamilyCheckpointPropertiesNV -> Bool
$c== :: QueueFamilyCheckpointPropertiesNV
-> QueueFamilyCheckpointPropertiesNV -> Bool
Eq)
#if defined(GENERIC_INSTANCES)
deriving instance Generic (QueueFamilyCheckpointPropertiesNV)
#endif
deriving instance Show QueueFamilyCheckpointPropertiesNV

instance ToCStruct QueueFamilyCheckpointPropertiesNV where
  withCStruct :: forall b.
QueueFamilyCheckpointPropertiesNV
-> (Ptr QueueFamilyCheckpointPropertiesNV -> IO b) -> IO b
withCStruct QueueFamilyCheckpointPropertiesNV
x Ptr QueueFamilyCheckpointPropertiesNV -> IO b
f = forall a b. Int -> (Ptr a -> IO b) -> IO b
allocaBytes Int
24 forall a b. (a -> b) -> a -> b
$ \Ptr QueueFamilyCheckpointPropertiesNV
p -> forall a b. ToCStruct a => Ptr a -> a -> IO b -> IO b
pokeCStruct Ptr QueueFamilyCheckpointPropertiesNV
p QueueFamilyCheckpointPropertiesNV
x (Ptr QueueFamilyCheckpointPropertiesNV -> IO b
f Ptr QueueFamilyCheckpointPropertiesNV
p)
  pokeCStruct :: forall b.
Ptr QueueFamilyCheckpointPropertiesNV
-> QueueFamilyCheckpointPropertiesNV -> IO b -> IO b
pokeCStruct Ptr QueueFamilyCheckpointPropertiesNV
p QueueFamilyCheckpointPropertiesNV{PipelineStageFlags
checkpointExecutionStageMask :: PipelineStageFlags
$sel:checkpointExecutionStageMask:QueueFamilyCheckpointPropertiesNV :: QueueFamilyCheckpointPropertiesNV -> PipelineStageFlags
..} IO b
f = do
    forall a. Storable a => Ptr a -> a -> IO ()
poke ((Ptr QueueFamilyCheckpointPropertiesNV
p forall a b. Ptr a -> Int -> Ptr b
`plusPtr` Int
0 :: Ptr StructureType)) (StructureType
STRUCTURE_TYPE_QUEUE_FAMILY_CHECKPOINT_PROPERTIES_NV)
    forall a. Storable a => Ptr a -> a -> IO ()
poke ((Ptr QueueFamilyCheckpointPropertiesNV
p forall a b. Ptr a -> Int -> Ptr b
`plusPtr` Int
8 :: Ptr (Ptr ()))) (forall a. Ptr a
nullPtr)
    forall a. Storable a => Ptr a -> a -> IO ()
poke ((Ptr QueueFamilyCheckpointPropertiesNV
p forall a b. Ptr a -> Int -> Ptr b
`plusPtr` Int
16 :: Ptr PipelineStageFlags)) (PipelineStageFlags
checkpointExecutionStageMask)
    IO b
f
  cStructSize :: Int
cStructSize = Int
24
  cStructAlignment :: Int
cStructAlignment = Int
8
  pokeZeroCStruct :: forall b. Ptr QueueFamilyCheckpointPropertiesNV -> IO b -> IO b
pokeZeroCStruct Ptr QueueFamilyCheckpointPropertiesNV
p IO b
f = do
    forall a. Storable a => Ptr a -> a -> IO ()
poke ((Ptr QueueFamilyCheckpointPropertiesNV
p forall a b. Ptr a -> Int -> Ptr b
`plusPtr` Int
0 :: Ptr StructureType)) (StructureType
STRUCTURE_TYPE_QUEUE_FAMILY_CHECKPOINT_PROPERTIES_NV)
    forall a. Storable a => Ptr a -> a -> IO ()
poke ((Ptr QueueFamilyCheckpointPropertiesNV
p forall a b. Ptr a -> Int -> Ptr b
`plusPtr` Int
8 :: Ptr (Ptr ()))) (forall a. Ptr a
nullPtr)
    forall a. Storable a => Ptr a -> a -> IO ()
poke ((Ptr QueueFamilyCheckpointPropertiesNV
p forall a b. Ptr a -> Int -> Ptr b
`plusPtr` Int
16 :: Ptr PipelineStageFlags)) (forall a. Zero a => a
zero)
    IO b
f

instance FromCStruct QueueFamilyCheckpointPropertiesNV where
  peekCStruct :: Ptr QueueFamilyCheckpointPropertiesNV
-> IO QueueFamilyCheckpointPropertiesNV
peekCStruct Ptr QueueFamilyCheckpointPropertiesNV
p = do
    PipelineStageFlags
checkpointExecutionStageMask <- forall a. Storable a => Ptr a -> IO a
peek @PipelineStageFlags ((Ptr QueueFamilyCheckpointPropertiesNV
p forall a b. Ptr a -> Int -> Ptr b
`plusPtr` Int
16 :: Ptr PipelineStageFlags))
    forall (f :: * -> *) a. Applicative f => a -> f a
pure forall a b. (a -> b) -> a -> b
$ PipelineStageFlags -> QueueFamilyCheckpointPropertiesNV
QueueFamilyCheckpointPropertiesNV
             PipelineStageFlags
checkpointExecutionStageMask

instance Storable QueueFamilyCheckpointPropertiesNV where
  sizeOf :: QueueFamilyCheckpointPropertiesNV -> Int
sizeOf ~QueueFamilyCheckpointPropertiesNV
_ = Int
24
  alignment :: QueueFamilyCheckpointPropertiesNV -> Int
alignment ~QueueFamilyCheckpointPropertiesNV
_ = Int
8
  peek :: Ptr QueueFamilyCheckpointPropertiesNV
-> IO QueueFamilyCheckpointPropertiesNV
peek = forall a. FromCStruct a => Ptr a -> IO a
peekCStruct
  poke :: Ptr QueueFamilyCheckpointPropertiesNV
-> QueueFamilyCheckpointPropertiesNV -> IO ()
poke Ptr QueueFamilyCheckpointPropertiesNV
ptr QueueFamilyCheckpointPropertiesNV
poked = forall a b. ToCStruct a => Ptr a -> a -> IO b -> IO b
pokeCStruct Ptr QueueFamilyCheckpointPropertiesNV
ptr QueueFamilyCheckpointPropertiesNV
poked (forall (f :: * -> *) a. Applicative f => a -> f a
pure ())

instance Zero QueueFamilyCheckpointPropertiesNV where
  zero :: QueueFamilyCheckpointPropertiesNV
zero = PipelineStageFlags -> QueueFamilyCheckpointPropertiesNV
QueueFamilyCheckpointPropertiesNV
           forall a. Zero a => a
zero


-- | VkCheckpointDataNV - Return structure for command buffer checkpoint data
--
-- = Description
--
-- The stages at which a checkpoint marker /can/ be executed are
-- implementation-defined and /can/ be queried by calling
-- 'Vulkan.Core11.Promoted_From_VK_KHR_get_physical_device_properties2.getPhysicalDeviceQueueFamilyProperties2'.
--
-- == Valid Usage (Implicit)
--
-- = See Also
--
-- <https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#VK_NV_device_diagnostic_checkpoints VK_NV_device_diagnostic_checkpoints>,
-- 'Vulkan.Core10.Enums.PipelineStageFlagBits.PipelineStageFlagBits',
-- 'Vulkan.Core10.Enums.StructureType.StructureType',
-- 'getQueueCheckpointDataNV'
data CheckpointDataNV = CheckpointDataNV
  { -- | @stage@ is a
    -- 'Vulkan.Core10.Enums.PipelineStageFlagBits.PipelineStageFlagBits' value
    -- specifying which pipeline stage the checkpoint marker data refers to.
    CheckpointDataNV -> PipelineStageFlags
stage :: PipelineStageFlagBits
  , -- | @pCheckpointMarker@ contains the value of the last checkpoint marker
    -- executed in the stage that @stage@ refers to.
    CheckpointDataNV -> "checkpointMarker" ::: Ptr ()
checkpointMarker :: Ptr ()
  }
  deriving (Typeable)
#if defined(GENERIC_INSTANCES)
deriving instance Generic (CheckpointDataNV)
#endif
deriving instance Show CheckpointDataNV

instance ToCStruct CheckpointDataNV where
  withCStruct :: forall b.
CheckpointDataNV
-> (("pCheckpointData" ::: Ptr CheckpointDataNV) -> IO b) -> IO b
withCStruct CheckpointDataNV
x ("pCheckpointData" ::: Ptr CheckpointDataNV) -> IO b
f = forall a b. Int -> (Ptr a -> IO b) -> IO b
allocaBytes Int
32 forall a b. (a -> b) -> a -> b
$ \"pCheckpointData" ::: Ptr CheckpointDataNV
p -> forall a b. ToCStruct a => Ptr a -> a -> IO b -> IO b
pokeCStruct "pCheckpointData" ::: Ptr CheckpointDataNV
p CheckpointDataNV
x (("pCheckpointData" ::: Ptr CheckpointDataNV) -> IO b
f "pCheckpointData" ::: Ptr CheckpointDataNV
p)
  pokeCStruct :: forall b.
("pCheckpointData" ::: Ptr CheckpointDataNV)
-> CheckpointDataNV -> IO b -> IO b
pokeCStruct "pCheckpointData" ::: Ptr CheckpointDataNV
p CheckpointDataNV{"checkpointMarker" ::: Ptr ()
PipelineStageFlags
checkpointMarker :: "checkpointMarker" ::: Ptr ()
stage :: PipelineStageFlags
$sel:checkpointMarker:CheckpointDataNV :: CheckpointDataNV -> "checkpointMarker" ::: Ptr ()
$sel:stage:CheckpointDataNV :: CheckpointDataNV -> PipelineStageFlags
..} IO b
f = do
    forall a. Storable a => Ptr a -> a -> IO ()
poke (("pCheckpointData" ::: Ptr CheckpointDataNV
p forall a b. Ptr a -> Int -> Ptr b
`plusPtr` Int
0 :: Ptr StructureType)) (StructureType
STRUCTURE_TYPE_CHECKPOINT_DATA_NV)
    forall a. Storable a => Ptr a -> a -> IO ()
poke (("pCheckpointData" ::: Ptr CheckpointDataNV
p forall a b. Ptr a -> Int -> Ptr b
`plusPtr` Int
8 :: Ptr (Ptr ()))) (forall a. Ptr a
nullPtr)
    forall a. Storable a => Ptr a -> a -> IO ()
poke (("pCheckpointData" ::: Ptr CheckpointDataNV
p forall a b. Ptr a -> Int -> Ptr b
`plusPtr` Int
16 :: Ptr PipelineStageFlagBits)) (PipelineStageFlags
stage)
    forall a. Storable a => Ptr a -> a -> IO ()
poke (("pCheckpointData" ::: Ptr CheckpointDataNV
p forall a b. Ptr a -> Int -> Ptr b
`plusPtr` Int
24 :: Ptr (Ptr ()))) ("checkpointMarker" ::: Ptr ()
checkpointMarker)
    IO b
f
  cStructSize :: Int
cStructSize = Int
32
  cStructAlignment :: Int
cStructAlignment = Int
8
  pokeZeroCStruct :: forall b.
("pCheckpointData" ::: Ptr CheckpointDataNV) -> IO b -> IO b
pokeZeroCStruct "pCheckpointData" ::: Ptr CheckpointDataNV
p IO b
f = do
    forall a. Storable a => Ptr a -> a -> IO ()
poke (("pCheckpointData" ::: Ptr CheckpointDataNV
p forall a b. Ptr a -> Int -> Ptr b
`plusPtr` Int
0 :: Ptr StructureType)) (StructureType
STRUCTURE_TYPE_CHECKPOINT_DATA_NV)
    forall a. Storable a => Ptr a -> a -> IO ()
poke (("pCheckpointData" ::: Ptr CheckpointDataNV
p forall a b. Ptr a -> Int -> Ptr b
`plusPtr` Int
8 :: Ptr (Ptr ()))) (forall a. Ptr a
nullPtr)
    forall a. Storable a => Ptr a -> a -> IO ()
poke (("pCheckpointData" ::: Ptr CheckpointDataNV
p forall a b. Ptr a -> Int -> Ptr b
`plusPtr` Int
16 :: Ptr PipelineStageFlagBits)) (forall a. Zero a => a
zero)
    forall a. Storable a => Ptr a -> a -> IO ()
poke (("pCheckpointData" ::: Ptr CheckpointDataNV
p forall a b. Ptr a -> Int -> Ptr b
`plusPtr` Int
24 :: Ptr (Ptr ()))) (forall a. Zero a => a
zero)
    IO b
f

instance FromCStruct CheckpointDataNV where
  peekCStruct :: ("pCheckpointData" ::: Ptr CheckpointDataNV) -> IO CheckpointDataNV
peekCStruct "pCheckpointData" ::: Ptr CheckpointDataNV
p = do
    PipelineStageFlags
stage <- forall a. Storable a => Ptr a -> IO a
peek @PipelineStageFlagBits (("pCheckpointData" ::: Ptr CheckpointDataNV
p forall a b. Ptr a -> Int -> Ptr b
`plusPtr` Int
16 :: Ptr PipelineStageFlagBits))
    "checkpointMarker" ::: Ptr ()
pCheckpointMarker <- forall a. Storable a => Ptr a -> IO a
peek @(Ptr ()) (("pCheckpointData" ::: Ptr CheckpointDataNV
p forall a b. Ptr a -> Int -> Ptr b
`plusPtr` Int
24 :: Ptr (Ptr ())))
    forall (f :: * -> *) a. Applicative f => a -> f a
pure forall a b. (a -> b) -> a -> b
$ PipelineStageFlags
-> ("checkpointMarker" ::: Ptr ()) -> CheckpointDataNV
CheckpointDataNV
             PipelineStageFlags
stage "checkpointMarker" ::: Ptr ()
pCheckpointMarker

instance Storable CheckpointDataNV where
  sizeOf :: CheckpointDataNV -> Int
sizeOf ~CheckpointDataNV
_ = Int
32
  alignment :: CheckpointDataNV -> Int
alignment ~CheckpointDataNV
_ = Int
8
  peek :: ("pCheckpointData" ::: Ptr CheckpointDataNV) -> IO CheckpointDataNV
peek = forall a. FromCStruct a => Ptr a -> IO a
peekCStruct
  poke :: ("pCheckpointData" ::: Ptr CheckpointDataNV)
-> CheckpointDataNV -> IO ()
poke "pCheckpointData" ::: Ptr CheckpointDataNV
ptr CheckpointDataNV
poked = forall a b. ToCStruct a => Ptr a -> a -> IO b -> IO b
pokeCStruct "pCheckpointData" ::: Ptr CheckpointDataNV
ptr CheckpointDataNV
poked (forall (f :: * -> *) a. Applicative f => a -> f a
pure ())

instance Zero CheckpointDataNV where
  zero :: CheckpointDataNV
zero = PipelineStageFlags
-> ("checkpointMarker" ::: Ptr ()) -> CheckpointDataNV
CheckpointDataNV
           forall a. Zero a => a
zero
           forall a. Zero a => a
zero


type NV_DEVICE_DIAGNOSTIC_CHECKPOINTS_SPEC_VERSION = 2

-- No documentation found for TopLevel "VK_NV_DEVICE_DIAGNOSTIC_CHECKPOINTS_SPEC_VERSION"
pattern NV_DEVICE_DIAGNOSTIC_CHECKPOINTS_SPEC_VERSION :: forall a . Integral a => a
pattern $bNV_DEVICE_DIAGNOSTIC_CHECKPOINTS_SPEC_VERSION :: forall a. Integral a => a
$mNV_DEVICE_DIAGNOSTIC_CHECKPOINTS_SPEC_VERSION :: forall {r} {a}.
Integral a =>
a -> ((# #) -> r) -> ((# #) -> r) -> r
NV_DEVICE_DIAGNOSTIC_CHECKPOINTS_SPEC_VERSION = 2


type NV_DEVICE_DIAGNOSTIC_CHECKPOINTS_EXTENSION_NAME = "VK_NV_device_diagnostic_checkpoints"

-- No documentation found for TopLevel "VK_NV_DEVICE_DIAGNOSTIC_CHECKPOINTS_EXTENSION_NAME"
pattern NV_DEVICE_DIAGNOSTIC_CHECKPOINTS_EXTENSION_NAME :: forall a . (Eq a, IsString a) => a
pattern $bNV_DEVICE_DIAGNOSTIC_CHECKPOINTS_EXTENSION_NAME :: forall a. (Eq a, IsString a) => a
$mNV_DEVICE_DIAGNOSTIC_CHECKPOINTS_EXTENSION_NAME :: forall {r} {a}.
(Eq a, IsString a) =>
a -> ((# #) -> r) -> ((# #) -> r) -> r
NV_DEVICE_DIAGNOSTIC_CHECKPOINTS_EXTENSION_NAME = "VK_NV_device_diagnostic_checkpoints"