{-# language CPP #-}
-- No documentation found for Chapter "Promoted_From_VK_KHR_buffer_device_address"
module Vulkan.Core12.Promoted_From_VK_KHR_buffer_device_address  ( getBufferOpaqueCaptureAddress
                                                                 , getBufferDeviceAddress
                                                                 , getDeviceMemoryOpaqueCaptureAddress
                                                                 , PhysicalDeviceBufferDeviceAddressFeatures(..)
                                                                 , BufferDeviceAddressInfo(..)
                                                                 , BufferOpaqueCaptureAddressCreateInfo(..)
                                                                 , MemoryOpaqueCaptureAddressAllocateInfo(..)
                                                                 , DeviceMemoryOpaqueCaptureAddressInfo(..)
                                                                 , StructureType(..)
                                                                 , Result(..)
                                                                 , BufferUsageFlagBits(..)
                                                                 , BufferUsageFlags
                                                                 , BufferCreateFlagBits(..)
                                                                 , BufferCreateFlags
                                                                 , MemoryAllocateFlagBits(..)
                                                                 , MemoryAllocateFlags
                                                                 ) where

import Vulkan.Internal.Utils (traceAroundEvent)
import Control.Monad (unless)
import Control.Monad.IO.Class (liftIO)
import Foreign.Marshal.Alloc (allocaBytesAligned)
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 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.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 (Word64)
import Data.Kind (Type)
import Control.Monad.Trans.Cont (ContT(..))
import Vulkan.Core10.FundamentalTypes (bool32ToBool)
import Vulkan.Core10.FundamentalTypes (boolToBool32)
import Vulkan.Core10.FundamentalTypes (Bool32)
import Vulkan.Core10.Handles (Buffer)
import Vulkan.Core10.Handles (Device)
import Vulkan.Core10.Handles (Device(..))
import Vulkan.Core10.FundamentalTypes (DeviceAddress)
import Vulkan.Dynamic (DeviceCmds(pVkGetBufferDeviceAddress))
import Vulkan.Dynamic (DeviceCmds(pVkGetBufferOpaqueCaptureAddress))
import Vulkan.Dynamic (DeviceCmds(pVkGetDeviceMemoryOpaqueCaptureAddress))
import Vulkan.Core10.Handles (DeviceMemory)
import Vulkan.Core10.Handles (Device_T)
import Vulkan.Core10.Enums.StructureType (StructureType)
import Vulkan.Core10.Enums.StructureType (StructureType(STRUCTURE_TYPE_BUFFER_DEVICE_ADDRESS_INFO))
import Vulkan.Core10.Enums.StructureType (StructureType(STRUCTURE_TYPE_BUFFER_OPAQUE_CAPTURE_ADDRESS_CREATE_INFO))
import Vulkan.Core10.Enums.StructureType (StructureType(STRUCTURE_TYPE_DEVICE_MEMORY_OPAQUE_CAPTURE_ADDRESS_INFO))
import Vulkan.Core10.Enums.StructureType (StructureType(STRUCTURE_TYPE_MEMORY_OPAQUE_CAPTURE_ADDRESS_ALLOCATE_INFO))
import Vulkan.Core10.Enums.StructureType (StructureType(STRUCTURE_TYPE_PHYSICAL_DEVICE_BUFFER_DEVICE_ADDRESS_FEATURES))
import Vulkan.Core10.Enums.BufferCreateFlagBits (BufferCreateFlagBits(..))
import Vulkan.Core10.Enums.BufferCreateFlagBits (BufferCreateFlags)
import Vulkan.Core10.Enums.BufferUsageFlagBits (BufferUsageFlagBits(..))
import Vulkan.Core10.Enums.BufferUsageFlagBits (BufferUsageFlags)
import Vulkan.Core11.Enums.MemoryAllocateFlagBits (MemoryAllocateFlagBits(..))
import Vulkan.Core11.Enums.MemoryAllocateFlagBits (MemoryAllocateFlags)
import Vulkan.Core10.Enums.Result (Result(..))
import Vulkan.Core10.Enums.StructureType (StructureType(..))
foreign import ccall
#if !defined(SAFE_FOREIGN_CALLS)
  unsafe
#endif
  "dynamic" mkVkGetBufferOpaqueCaptureAddress
  :: FunPtr (Ptr Device_T -> Ptr BufferDeviceAddressInfo -> IO Word64) -> Ptr Device_T -> Ptr BufferDeviceAddressInfo -> IO Word64

-- | vkGetBufferOpaqueCaptureAddress - Query an opaque capture address of a
-- buffer
--
-- = Description
--
-- The 64-bit return value is an opaque capture address of the start of
-- @pInfo->buffer@.
--
-- If the buffer was created with a non-zero value of
-- 'BufferOpaqueCaptureAddressCreateInfo'::@opaqueCaptureAddress@ the
-- return value /must/ be the same address.
--
-- == Valid Usage
--
-- -   #VUID-vkGetBufferOpaqueCaptureAddress-None-03326# The
--     <https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#features-bufferDeviceAddress bufferDeviceAddress>
--     feature /must/ be enabled
--
-- -   #VUID-vkGetBufferOpaqueCaptureAddress-device-03327# If @device@ was
--     created with multiple physical devices, then the
--     <https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#features-bufferDeviceAddressMultiDevice bufferDeviceAddressMultiDevice>
--     feature /must/ be enabled
--
-- == Valid Usage (Implicit)
--
-- -   #VUID-vkGetBufferOpaqueCaptureAddress-device-parameter# @device@
--     /must/ be a valid 'Vulkan.Core10.Handles.Device' handle
--
-- -   #VUID-vkGetBufferOpaqueCaptureAddress-pInfo-parameter# @pInfo@
--     /must/ be a valid pointer to a valid 'BufferDeviceAddressInfo'
--     structure
--
-- = See Also
--
-- 'BufferDeviceAddressInfo', 'Vulkan.Core10.Handles.Device'
getBufferOpaqueCaptureAddress :: forall io
                               . (MonadIO io)
                              => -- | @device@ is the logical device that the buffer was created on.
                                 Device
                              -> -- | @pInfo@ is a pointer to a 'BufferDeviceAddressInfo' structure specifying
                                 -- the buffer to retrieve an address for.
                                 BufferDeviceAddressInfo
                              -> io (Word64)
getBufferOpaqueCaptureAddress :: Device -> BufferDeviceAddressInfo -> io Word64
getBufferOpaqueCaptureAddress device :: Device
device info :: BufferDeviceAddressInfo
info = IO Word64 -> io Word64
forall (m :: * -> *) a. MonadIO m => IO a -> m a
liftIO (IO Word64 -> io Word64)
-> (ContT Word64 IO Word64 -> IO Word64)
-> ContT Word64 IO Word64
-> io Word64
forall b c a. (b -> c) -> (a -> b) -> a -> c
. ContT Word64 IO Word64 -> IO Word64
forall (m :: * -> *) r. Monad m => ContT r m r -> m r
evalContT (ContT Word64 IO Word64 -> io Word64)
-> ContT Word64 IO Word64 -> io Word64
forall a b. (a -> b) -> a -> b
$ do
  let vkGetBufferOpaqueCaptureAddressPtr :: FunPtr
  (Ptr Device_T
   -> ("pInfo" ::: Ptr BufferDeviceAddressInfo) -> IO Word64)
vkGetBufferOpaqueCaptureAddressPtr = DeviceCmds
-> FunPtr
     (Ptr Device_T
      -> ("pInfo" ::: Ptr BufferDeviceAddressInfo) -> IO Word64)
pVkGetBufferOpaqueCaptureAddress (Device -> DeviceCmds
deviceCmds (Device
device :: Device))
  IO () -> ContT Word64 IO ()
forall (t :: (* -> *) -> * -> *) (m :: * -> *) a.
(MonadTrans t, Monad m) =>
m a -> t m a
lift (IO () -> ContT Word64 IO ()) -> IO () -> ContT Word64 IO ()
forall a b. (a -> b) -> a -> b
$ Bool -> IO () -> IO ()
forall (f :: * -> *). Applicative f => Bool -> f () -> f ()
unless (FunPtr
  (Ptr Device_T
   -> ("pInfo" ::: Ptr BufferDeviceAddressInfo) -> IO Word64)
vkGetBufferOpaqueCaptureAddressPtr FunPtr
  (Ptr Device_T
   -> ("pInfo" ::: Ptr BufferDeviceAddressInfo) -> IO Word64)
-> FunPtr
     (Ptr Device_T
      -> ("pInfo" ::: Ptr BufferDeviceAddressInfo) -> IO Word64)
-> Bool
forall a. Eq a => a -> a -> Bool
/= FunPtr
  (Ptr Device_T
   -> ("pInfo" ::: Ptr BufferDeviceAddressInfo) -> IO Word64)
forall a. FunPtr a
nullFunPtr) (IO () -> IO ()) -> IO () -> IO ()
forall a b. (a -> b) -> a -> b
$
    IOException -> IO ()
forall e a. Exception e => e -> IO a
throwIO (IOException -> IO ()) -> IOException -> IO ()
forall a b. (a -> b) -> a -> b
$ Maybe Handle
-> IOErrorType
-> String
-> String
-> Maybe CInt
-> Maybe String
-> IOException
IOError Maybe Handle
forall a. Maybe a
Nothing IOErrorType
InvalidArgument "" "The function pointer for vkGetBufferOpaqueCaptureAddress is null" Maybe CInt
forall a. Maybe a
Nothing Maybe String
forall a. Maybe a
Nothing
  let vkGetBufferOpaqueCaptureAddress' :: Ptr Device_T
-> ("pInfo" ::: Ptr BufferDeviceAddressInfo) -> IO Word64
vkGetBufferOpaqueCaptureAddress' = FunPtr
  (Ptr Device_T
   -> ("pInfo" ::: Ptr BufferDeviceAddressInfo) -> IO Word64)
-> Ptr Device_T
-> ("pInfo" ::: Ptr BufferDeviceAddressInfo)
-> IO Word64
mkVkGetBufferOpaqueCaptureAddress FunPtr
  (Ptr Device_T
   -> ("pInfo" ::: Ptr BufferDeviceAddressInfo) -> IO Word64)
vkGetBufferOpaqueCaptureAddressPtr
  "pInfo" ::: Ptr BufferDeviceAddressInfo
pInfo <- ((("pInfo" ::: Ptr BufferDeviceAddressInfo) -> IO Word64)
 -> IO Word64)
-> ContT Word64 IO ("pInfo" ::: Ptr BufferDeviceAddressInfo)
forall k (r :: k) (m :: k -> *) a.
((a -> m r) -> m r) -> ContT r m a
ContT (((("pInfo" ::: Ptr BufferDeviceAddressInfo) -> IO Word64)
  -> IO Word64)
 -> ContT Word64 IO ("pInfo" ::: Ptr BufferDeviceAddressInfo))
-> ((("pInfo" ::: Ptr BufferDeviceAddressInfo) -> IO Word64)
    -> IO Word64)
-> ContT Word64 IO ("pInfo" ::: Ptr BufferDeviceAddressInfo)
forall a b. (a -> b) -> a -> b
$ BufferDeviceAddressInfo
-> (("pInfo" ::: Ptr BufferDeviceAddressInfo) -> IO Word64)
-> IO Word64
forall a b. ToCStruct a => a -> (Ptr a -> IO b) -> IO b
withCStruct (BufferDeviceAddressInfo
info)
  Word64
r <- IO Word64 -> ContT Word64 IO Word64
forall (t :: (* -> *) -> * -> *) (m :: * -> *) a.
(MonadTrans t, Monad m) =>
m a -> t m a
lift (IO Word64 -> ContT Word64 IO Word64)
-> IO Word64 -> ContT Word64 IO Word64
forall a b. (a -> b) -> a -> b
$ String -> IO Word64 -> IO Word64
forall a. String -> IO a -> IO a
traceAroundEvent "vkGetBufferOpaqueCaptureAddress" (Ptr Device_T
-> ("pInfo" ::: Ptr BufferDeviceAddressInfo) -> IO Word64
vkGetBufferOpaqueCaptureAddress' (Device -> Ptr Device_T
deviceHandle (Device
device)) "pInfo" ::: Ptr BufferDeviceAddressInfo
pInfo)
  Word64 -> ContT Word64 IO Word64
forall (f :: * -> *) a. Applicative f => a -> f a
pure (Word64 -> ContT Word64 IO Word64)
-> Word64 -> ContT Word64 IO Word64
forall a b. (a -> b) -> a -> b
$ (Word64
r)


foreign import ccall
#if !defined(SAFE_FOREIGN_CALLS)
  unsafe
#endif
  "dynamic" mkVkGetBufferDeviceAddress
  :: FunPtr (Ptr Device_T -> Ptr BufferDeviceAddressInfo -> IO DeviceAddress) -> Ptr Device_T -> Ptr BufferDeviceAddressInfo -> IO DeviceAddress

-- | vkGetBufferDeviceAddress - Query an address of a buffer
--
-- = Description
--
-- The 64-bit return value is an address of the start of @pInfo->buffer@.
-- The address range starting at this value and whose size is the size of
-- the buffer /can/ be used in a shader to access the memory bound to that
-- buffer, using the @SPV_KHR_physical_storage_buffer@ extension or the
-- equivalent @SPV_EXT_physical_storage_buffer@ extension and the
-- @PhysicalStorageBuffer@ storage class. For example, this value /can/ be
-- stored in a uniform buffer, and the shader /can/ read the value from the
-- uniform buffer and use it to do a dependent read\/write to this buffer.
-- A value of zero is reserved as a “null” pointer and /must/ not be
-- returned as a valid buffer device address. All loads, stores, and
-- atomics in a shader through @PhysicalStorageBuffer@ pointers /must/
-- access addresses in the address range of some buffer.
--
-- If the buffer was created with a non-zero value of
-- 'BufferOpaqueCaptureAddressCreateInfo'::@opaqueCaptureAddress@ or
-- 'Vulkan.Extensions.VK_EXT_buffer_device_address.BufferDeviceAddressCreateInfoEXT'::@deviceAddress@
-- the return value will be the same address that was returned at capture
-- time.
--
-- == Valid Usage
--
-- -   #VUID-vkGetBufferDeviceAddress-bufferDeviceAddress-03324# The
--     <https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#features-bufferDeviceAddress bufferDeviceAddress>
--     or
--     <https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#features-bufferDeviceAddressEXT ::bufferDeviceAddress>
--     feature /must/ be enabled
--
-- -   #VUID-vkGetBufferDeviceAddress-device-03325# If @device@ was created
--     with multiple physical devices, then the
--     <https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#features-bufferDeviceAddressMultiDevice bufferDeviceAddressMultiDevice>
--     or
--     <https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#features-bufferDeviceAddressMultiDeviceEXT ::bufferDeviceAddressMultiDevice>
--     feature /must/ be enabled
--
-- == Valid Usage (Implicit)
--
-- -   #VUID-vkGetBufferDeviceAddress-device-parameter# @device@ /must/ be
--     a valid 'Vulkan.Core10.Handles.Device' handle
--
-- -   #VUID-vkGetBufferDeviceAddress-pInfo-parameter# @pInfo@ /must/ be a
--     valid pointer to a valid 'BufferDeviceAddressInfo' structure
--
-- = See Also
--
-- 'BufferDeviceAddressInfo', 'Vulkan.Core10.Handles.Device'
getBufferDeviceAddress :: forall io
                        . (MonadIO io)
                       => -- | @device@ is the logical device that the buffer was created on.
                          Device
                       -> -- | @pInfo@ is a pointer to a 'BufferDeviceAddressInfo' structure specifying
                          -- the buffer to retrieve an address for.
                          BufferDeviceAddressInfo
                       -> io (DeviceAddress)
getBufferDeviceAddress :: Device -> BufferDeviceAddressInfo -> io Word64
getBufferDeviceAddress device :: Device
device info :: BufferDeviceAddressInfo
info = IO Word64 -> io Word64
forall (m :: * -> *) a. MonadIO m => IO a -> m a
liftIO (IO Word64 -> io Word64)
-> (ContT Word64 IO Word64 -> IO Word64)
-> ContT Word64 IO Word64
-> io Word64
forall b c a. (b -> c) -> (a -> b) -> a -> c
. ContT Word64 IO Word64 -> IO Word64
forall (m :: * -> *) r. Monad m => ContT r m r -> m r
evalContT (ContT Word64 IO Word64 -> io Word64)
-> ContT Word64 IO Word64 -> io Word64
forall a b. (a -> b) -> a -> b
$ do
  let vkGetBufferDeviceAddressPtr :: FunPtr
  (Ptr Device_T
   -> ("pInfo" ::: Ptr BufferDeviceAddressInfo) -> IO Word64)
vkGetBufferDeviceAddressPtr = DeviceCmds
-> FunPtr
     (Ptr Device_T
      -> ("pInfo" ::: Ptr BufferDeviceAddressInfo) -> IO Word64)
pVkGetBufferDeviceAddress (Device -> DeviceCmds
deviceCmds (Device
device :: Device))
  IO () -> ContT Word64 IO ()
forall (t :: (* -> *) -> * -> *) (m :: * -> *) a.
(MonadTrans t, Monad m) =>
m a -> t m a
lift (IO () -> ContT Word64 IO ()) -> IO () -> ContT Word64 IO ()
forall a b. (a -> b) -> a -> b
$ Bool -> IO () -> IO ()
forall (f :: * -> *). Applicative f => Bool -> f () -> f ()
unless (FunPtr
  (Ptr Device_T
   -> ("pInfo" ::: Ptr BufferDeviceAddressInfo) -> IO Word64)
vkGetBufferDeviceAddressPtr FunPtr
  (Ptr Device_T
   -> ("pInfo" ::: Ptr BufferDeviceAddressInfo) -> IO Word64)
-> FunPtr
     (Ptr Device_T
      -> ("pInfo" ::: Ptr BufferDeviceAddressInfo) -> IO Word64)
-> Bool
forall a. Eq a => a -> a -> Bool
/= FunPtr
  (Ptr Device_T
   -> ("pInfo" ::: Ptr BufferDeviceAddressInfo) -> IO Word64)
forall a. FunPtr a
nullFunPtr) (IO () -> IO ()) -> IO () -> IO ()
forall a b. (a -> b) -> a -> b
$
    IOException -> IO ()
forall e a. Exception e => e -> IO a
throwIO (IOException -> IO ()) -> IOException -> IO ()
forall a b. (a -> b) -> a -> b
$ Maybe Handle
-> IOErrorType
-> String
-> String
-> Maybe CInt
-> Maybe String
-> IOException
IOError Maybe Handle
forall a. Maybe a
Nothing IOErrorType
InvalidArgument "" "The function pointer for vkGetBufferDeviceAddress is null" Maybe CInt
forall a. Maybe a
Nothing Maybe String
forall a. Maybe a
Nothing
  let vkGetBufferDeviceAddress' :: Ptr Device_T
-> ("pInfo" ::: Ptr BufferDeviceAddressInfo) -> IO Word64
vkGetBufferDeviceAddress' = FunPtr
  (Ptr Device_T
   -> ("pInfo" ::: Ptr BufferDeviceAddressInfo) -> IO Word64)
-> Ptr Device_T
-> ("pInfo" ::: Ptr BufferDeviceAddressInfo)
-> IO Word64
mkVkGetBufferDeviceAddress FunPtr
  (Ptr Device_T
   -> ("pInfo" ::: Ptr BufferDeviceAddressInfo) -> IO Word64)
vkGetBufferDeviceAddressPtr
  "pInfo" ::: Ptr BufferDeviceAddressInfo
pInfo <- ((("pInfo" ::: Ptr BufferDeviceAddressInfo) -> IO Word64)
 -> IO Word64)
-> ContT Word64 IO ("pInfo" ::: Ptr BufferDeviceAddressInfo)
forall k (r :: k) (m :: k -> *) a.
((a -> m r) -> m r) -> ContT r m a
ContT (((("pInfo" ::: Ptr BufferDeviceAddressInfo) -> IO Word64)
  -> IO Word64)
 -> ContT Word64 IO ("pInfo" ::: Ptr BufferDeviceAddressInfo))
-> ((("pInfo" ::: Ptr BufferDeviceAddressInfo) -> IO Word64)
    -> IO Word64)
-> ContT Word64 IO ("pInfo" ::: Ptr BufferDeviceAddressInfo)
forall a b. (a -> b) -> a -> b
$ BufferDeviceAddressInfo
-> (("pInfo" ::: Ptr BufferDeviceAddressInfo) -> IO Word64)
-> IO Word64
forall a b. ToCStruct a => a -> (Ptr a -> IO b) -> IO b
withCStruct (BufferDeviceAddressInfo
info)
  Word64
r <- IO Word64 -> ContT Word64 IO Word64
forall (t :: (* -> *) -> * -> *) (m :: * -> *) a.
(MonadTrans t, Monad m) =>
m a -> t m a
lift (IO Word64 -> ContT Word64 IO Word64)
-> IO Word64 -> ContT Word64 IO Word64
forall a b. (a -> b) -> a -> b
$ String -> IO Word64 -> IO Word64
forall a. String -> IO a -> IO a
traceAroundEvent "vkGetBufferDeviceAddress" (Ptr Device_T
-> ("pInfo" ::: Ptr BufferDeviceAddressInfo) -> IO Word64
vkGetBufferDeviceAddress' (Device -> Ptr Device_T
deviceHandle (Device
device)) "pInfo" ::: Ptr BufferDeviceAddressInfo
pInfo)
  Word64 -> ContT Word64 IO Word64
forall (f :: * -> *) a. Applicative f => a -> f a
pure (Word64 -> ContT Word64 IO Word64)
-> Word64 -> ContT Word64 IO Word64
forall a b. (a -> b) -> a -> b
$ (Word64
r)


foreign import ccall
#if !defined(SAFE_FOREIGN_CALLS)
  unsafe
#endif
  "dynamic" mkVkGetDeviceMemoryOpaqueCaptureAddress
  :: FunPtr (Ptr Device_T -> Ptr DeviceMemoryOpaqueCaptureAddressInfo -> IO Word64) -> Ptr Device_T -> Ptr DeviceMemoryOpaqueCaptureAddressInfo -> IO Word64

-- | vkGetDeviceMemoryOpaqueCaptureAddress - Query an opaque capture address
-- of a memory object
--
-- = Description
--
-- The 64-bit return value is an opaque address representing the start of
-- @pInfo->memory@.
--
-- If the memory object was allocated with a non-zero value of
-- 'MemoryOpaqueCaptureAddressAllocateInfo'::@opaqueCaptureAddress@, the
-- return value /must/ be the same address.
--
-- Note
--
-- The expected usage for these opaque addresses is only for trace
-- capture\/replay tools to store these addresses in a trace and
-- subsequently specify them during replay.
--
-- == Valid Usage
--
-- -   #VUID-vkGetDeviceMemoryOpaqueCaptureAddress-None-03334# The
--     <https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#features-bufferDeviceAddress bufferDeviceAddress>
--     feature /must/ be enabled
--
-- -   #VUID-vkGetDeviceMemoryOpaqueCaptureAddress-device-03335# If
--     @device@ was created with multiple physical devices, then the
--     <https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#features-bufferDeviceAddressMultiDevice bufferDeviceAddressMultiDevice>
--     feature /must/ be enabled
--
-- == Valid Usage (Implicit)
--
-- -   #VUID-vkGetDeviceMemoryOpaqueCaptureAddress-device-parameter#
--     @device@ /must/ be a valid 'Vulkan.Core10.Handles.Device' handle
--
-- -   #VUID-vkGetDeviceMemoryOpaqueCaptureAddress-pInfo-parameter# @pInfo@
--     /must/ be a valid pointer to a valid
--     'DeviceMemoryOpaqueCaptureAddressInfo' structure
--
-- = See Also
--
-- 'Vulkan.Core10.Handles.Device', 'DeviceMemoryOpaqueCaptureAddressInfo'
getDeviceMemoryOpaqueCaptureAddress :: forall io
                                     . (MonadIO io)
                                    => -- | @device@ is the logical device that the memory object was allocated on.
                                       Device
                                    -> -- | @pInfo@ is a pointer to a 'DeviceMemoryOpaqueCaptureAddressInfo'
                                       -- structure specifying the memory object to retrieve an address for.
                                       DeviceMemoryOpaqueCaptureAddressInfo
                                    -> io (Word64)
getDeviceMemoryOpaqueCaptureAddress :: Device -> DeviceMemoryOpaqueCaptureAddressInfo -> io Word64
getDeviceMemoryOpaqueCaptureAddress device :: Device
device info :: DeviceMemoryOpaqueCaptureAddressInfo
info = IO Word64 -> io Word64
forall (m :: * -> *) a. MonadIO m => IO a -> m a
liftIO (IO Word64 -> io Word64)
-> (ContT Word64 IO Word64 -> IO Word64)
-> ContT Word64 IO Word64
-> io Word64
forall b c a. (b -> c) -> (a -> b) -> a -> c
. ContT Word64 IO Word64 -> IO Word64
forall (m :: * -> *) r. Monad m => ContT r m r -> m r
evalContT (ContT Word64 IO Word64 -> io Word64)
-> ContT Word64 IO Word64 -> io Word64
forall a b. (a -> b) -> a -> b
$ do
  let vkGetDeviceMemoryOpaqueCaptureAddressPtr :: FunPtr
  (Ptr Device_T
   -> ("pInfo" ::: Ptr DeviceMemoryOpaqueCaptureAddressInfo)
   -> IO Word64)
vkGetDeviceMemoryOpaqueCaptureAddressPtr = DeviceCmds
-> FunPtr
     (Ptr Device_T
      -> ("pInfo" ::: Ptr DeviceMemoryOpaqueCaptureAddressInfo)
      -> IO Word64)
pVkGetDeviceMemoryOpaqueCaptureAddress (Device -> DeviceCmds
deviceCmds (Device
device :: Device))
  IO () -> ContT Word64 IO ()
forall (t :: (* -> *) -> * -> *) (m :: * -> *) a.
(MonadTrans t, Monad m) =>
m a -> t m a
lift (IO () -> ContT Word64 IO ()) -> IO () -> ContT Word64 IO ()
forall a b. (a -> b) -> a -> b
$ Bool -> IO () -> IO ()
forall (f :: * -> *). Applicative f => Bool -> f () -> f ()
unless (FunPtr
  (Ptr Device_T
   -> ("pInfo" ::: Ptr DeviceMemoryOpaqueCaptureAddressInfo)
   -> IO Word64)
vkGetDeviceMemoryOpaqueCaptureAddressPtr FunPtr
  (Ptr Device_T
   -> ("pInfo" ::: Ptr DeviceMemoryOpaqueCaptureAddressInfo)
   -> IO Word64)
-> FunPtr
     (Ptr Device_T
      -> ("pInfo" ::: Ptr DeviceMemoryOpaqueCaptureAddressInfo)
      -> IO Word64)
-> Bool
forall a. Eq a => a -> a -> Bool
/= FunPtr
  (Ptr Device_T
   -> ("pInfo" ::: Ptr DeviceMemoryOpaqueCaptureAddressInfo)
   -> IO Word64)
forall a. FunPtr a
nullFunPtr) (IO () -> IO ()) -> IO () -> IO ()
forall a b. (a -> b) -> a -> b
$
    IOException -> IO ()
forall e a. Exception e => e -> IO a
throwIO (IOException -> IO ()) -> IOException -> IO ()
forall a b. (a -> b) -> a -> b
$ Maybe Handle
-> IOErrorType
-> String
-> String
-> Maybe CInt
-> Maybe String
-> IOException
IOError Maybe Handle
forall a. Maybe a
Nothing IOErrorType
InvalidArgument "" "The function pointer for vkGetDeviceMemoryOpaqueCaptureAddress is null" Maybe CInt
forall a. Maybe a
Nothing Maybe String
forall a. Maybe a
Nothing
  let vkGetDeviceMemoryOpaqueCaptureAddress' :: Ptr Device_T
-> ("pInfo" ::: Ptr DeviceMemoryOpaqueCaptureAddressInfo)
-> IO Word64
vkGetDeviceMemoryOpaqueCaptureAddress' = FunPtr
  (Ptr Device_T
   -> ("pInfo" ::: Ptr DeviceMemoryOpaqueCaptureAddressInfo)
   -> IO Word64)
-> Ptr Device_T
-> ("pInfo" ::: Ptr DeviceMemoryOpaqueCaptureAddressInfo)
-> IO Word64
mkVkGetDeviceMemoryOpaqueCaptureAddress FunPtr
  (Ptr Device_T
   -> ("pInfo" ::: Ptr DeviceMemoryOpaqueCaptureAddressInfo)
   -> IO Word64)
vkGetDeviceMemoryOpaqueCaptureAddressPtr
  "pInfo" ::: Ptr DeviceMemoryOpaqueCaptureAddressInfo
pInfo <- ((("pInfo" ::: Ptr DeviceMemoryOpaqueCaptureAddressInfo)
  -> IO Word64)
 -> IO Word64)
-> ContT
     Word64 IO ("pInfo" ::: Ptr DeviceMemoryOpaqueCaptureAddressInfo)
forall k (r :: k) (m :: k -> *) a.
((a -> m r) -> m r) -> ContT r m a
ContT (((("pInfo" ::: Ptr DeviceMemoryOpaqueCaptureAddressInfo)
   -> IO Word64)
  -> IO Word64)
 -> ContT
      Word64 IO ("pInfo" ::: Ptr DeviceMemoryOpaqueCaptureAddressInfo))
-> ((("pInfo" ::: Ptr DeviceMemoryOpaqueCaptureAddressInfo)
     -> IO Word64)
    -> IO Word64)
-> ContT
     Word64 IO ("pInfo" ::: Ptr DeviceMemoryOpaqueCaptureAddressInfo)
forall a b. (a -> b) -> a -> b
$ DeviceMemoryOpaqueCaptureAddressInfo
-> (("pInfo" ::: Ptr DeviceMemoryOpaqueCaptureAddressInfo)
    -> IO Word64)
-> IO Word64
forall a b. ToCStruct a => a -> (Ptr a -> IO b) -> IO b
withCStruct (DeviceMemoryOpaqueCaptureAddressInfo
info)
  Word64
r <- IO Word64 -> ContT Word64 IO Word64
forall (t :: (* -> *) -> * -> *) (m :: * -> *) a.
(MonadTrans t, Monad m) =>
m a -> t m a
lift (IO Word64 -> ContT Word64 IO Word64)
-> IO Word64 -> ContT Word64 IO Word64
forall a b. (a -> b) -> a -> b
$ String -> IO Word64 -> IO Word64
forall a. String -> IO a -> IO a
traceAroundEvent "vkGetDeviceMemoryOpaqueCaptureAddress" (Ptr Device_T
-> ("pInfo" ::: Ptr DeviceMemoryOpaqueCaptureAddressInfo)
-> IO Word64
vkGetDeviceMemoryOpaqueCaptureAddress' (Device -> Ptr Device_T
deviceHandle (Device
device)) "pInfo" ::: Ptr DeviceMemoryOpaqueCaptureAddressInfo
pInfo)
  Word64 -> ContT Word64 IO Word64
forall (f :: * -> *) a. Applicative f => a -> f a
pure (Word64 -> ContT Word64 IO Word64)
-> Word64 -> ContT Word64 IO Word64
forall a b. (a -> b) -> a -> b
$ (Word64
r)


-- | VkPhysicalDeviceBufferDeviceAddressFeatures - Structure describing
-- buffer address features that can be supported by an implementation
--
-- = Members
--
-- The members of the 'PhysicalDeviceBufferDeviceAddressFeatures' structure
-- describe the following features:
--
-- = Description
--
-- Note
--
-- @bufferDeviceAddressMultiDevice@ exists to allow certain legacy
-- platforms to be able to support @bufferDeviceAddress@ without needing to
-- support shared GPU virtual addresses for multi-device configurations.
--
-- See 'getBufferDeviceAddress' for more information.
--
-- If the 'PhysicalDeviceBufferDeviceAddressFeatures' structure is included
-- in the @pNext@ chain of
-- 'Vulkan.Core11.Promoted_From_VK_KHR_get_physical_device_properties2.PhysicalDeviceFeatures2',
-- it is filled with values indicating whether the feature is supported.
-- 'PhysicalDeviceBufferDeviceAddressFeatures' /can/ also be included in
-- the @pNext@ chain of 'Vulkan.Core10.Device.DeviceCreateInfo' to enable
-- features.
--
-- == Valid Usage (Implicit)
--
-- = See Also
--
-- 'Vulkan.Core10.FundamentalTypes.Bool32',
-- 'Vulkan.Core10.Enums.StructureType.StructureType'
data PhysicalDeviceBufferDeviceAddressFeatures = PhysicalDeviceBufferDeviceAddressFeatures
  { -- | #extension-features-bufferDeviceAddress# @bufferDeviceAddress@ indicates
    -- that the implementation supports accessing buffer memory in shaders as
    -- storage buffers via an address queried from 'getBufferDeviceAddress'.
    PhysicalDeviceBufferDeviceAddressFeatures -> Bool
bufferDeviceAddress :: Bool
  , -- | #extension-features-bufferDeviceAddressCaptureReplay#
    -- @bufferDeviceAddressCaptureReplay@ indicates that the implementation
    -- supports saving and reusing buffer and device addresses, e.g. for trace
    -- capture and replay.
    PhysicalDeviceBufferDeviceAddressFeatures -> Bool
bufferDeviceAddressCaptureReplay :: Bool
  , -- | #extension-features-bufferDeviceAddressMultiDevice#
    -- @bufferDeviceAddressMultiDevice@ indicates that the implementation
    -- supports the @bufferDeviceAddress@ , @rayTracingPipeline@ and @rayQuery@
    -- features for logical devices created with multiple physical devices. If
    -- this feature is not supported, buffer and acceleration structure
    -- addresses /must/ not be queried on a logical device created with more
    -- than one physical device.
    PhysicalDeviceBufferDeviceAddressFeatures -> Bool
bufferDeviceAddressMultiDevice :: Bool
  }
  deriving (Typeable, PhysicalDeviceBufferDeviceAddressFeatures
-> PhysicalDeviceBufferDeviceAddressFeatures -> Bool
(PhysicalDeviceBufferDeviceAddressFeatures
 -> PhysicalDeviceBufferDeviceAddressFeatures -> Bool)
-> (PhysicalDeviceBufferDeviceAddressFeatures
    -> PhysicalDeviceBufferDeviceAddressFeatures -> Bool)
-> Eq PhysicalDeviceBufferDeviceAddressFeatures
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: PhysicalDeviceBufferDeviceAddressFeatures
-> PhysicalDeviceBufferDeviceAddressFeatures -> Bool
$c/= :: PhysicalDeviceBufferDeviceAddressFeatures
-> PhysicalDeviceBufferDeviceAddressFeatures -> Bool
== :: PhysicalDeviceBufferDeviceAddressFeatures
-> PhysicalDeviceBufferDeviceAddressFeatures -> Bool
$c== :: PhysicalDeviceBufferDeviceAddressFeatures
-> PhysicalDeviceBufferDeviceAddressFeatures -> Bool
Eq)
#if defined(GENERIC_INSTANCES)
deriving instance Generic (PhysicalDeviceBufferDeviceAddressFeatures)
#endif
deriving instance Show PhysicalDeviceBufferDeviceAddressFeatures

instance ToCStruct PhysicalDeviceBufferDeviceAddressFeatures where
  withCStruct :: PhysicalDeviceBufferDeviceAddressFeatures
-> (Ptr PhysicalDeviceBufferDeviceAddressFeatures -> IO b) -> IO b
withCStruct x :: PhysicalDeviceBufferDeviceAddressFeatures
x f :: Ptr PhysicalDeviceBufferDeviceAddressFeatures -> IO b
f = Int
-> Int
-> (Ptr PhysicalDeviceBufferDeviceAddressFeatures -> IO b)
-> IO b
forall a b. Int -> Int -> (Ptr a -> IO b) -> IO b
allocaBytesAligned 32 8 ((Ptr PhysicalDeviceBufferDeviceAddressFeatures -> IO b) -> IO b)
-> (Ptr PhysicalDeviceBufferDeviceAddressFeatures -> IO b) -> IO b
forall a b. (a -> b) -> a -> b
$ \p :: Ptr PhysicalDeviceBufferDeviceAddressFeatures
p -> Ptr PhysicalDeviceBufferDeviceAddressFeatures
-> PhysicalDeviceBufferDeviceAddressFeatures -> IO b -> IO b
forall a b. ToCStruct a => Ptr a -> a -> IO b -> IO b
pokeCStruct Ptr PhysicalDeviceBufferDeviceAddressFeatures
p PhysicalDeviceBufferDeviceAddressFeatures
x (Ptr PhysicalDeviceBufferDeviceAddressFeatures -> IO b
f Ptr PhysicalDeviceBufferDeviceAddressFeatures
p)
  pokeCStruct :: Ptr PhysicalDeviceBufferDeviceAddressFeatures
-> PhysicalDeviceBufferDeviceAddressFeatures -> IO b -> IO b
pokeCStruct p :: Ptr PhysicalDeviceBufferDeviceAddressFeatures
p PhysicalDeviceBufferDeviceAddressFeatures{..} f :: IO b
f = do
    Ptr StructureType -> StructureType -> IO ()
forall a. Storable a => Ptr a -> a -> IO ()
poke ((Ptr PhysicalDeviceBufferDeviceAddressFeatures
p Ptr PhysicalDeviceBufferDeviceAddressFeatures
-> Int -> Ptr StructureType
forall a b. Ptr a -> Int -> Ptr b
`plusPtr` 0 :: Ptr StructureType)) (StructureType
STRUCTURE_TYPE_PHYSICAL_DEVICE_BUFFER_DEVICE_ADDRESS_FEATURES)
    Ptr (Ptr ()) -> Ptr () -> IO ()
forall a. Storable a => Ptr a -> a -> IO ()
poke ((Ptr PhysicalDeviceBufferDeviceAddressFeatures
p Ptr PhysicalDeviceBufferDeviceAddressFeatures
-> Int -> Ptr (Ptr ())
forall a b. Ptr a -> Int -> Ptr b
`plusPtr` 8 :: Ptr (Ptr ()))) (Ptr ()
forall a. Ptr a
nullPtr)
    Ptr Bool32 -> Bool32 -> IO ()
forall a. Storable a => Ptr a -> a -> IO ()
poke ((Ptr PhysicalDeviceBufferDeviceAddressFeatures
p Ptr PhysicalDeviceBufferDeviceAddressFeatures -> Int -> Ptr Bool32
forall a b. Ptr a -> Int -> Ptr b
`plusPtr` 16 :: Ptr Bool32)) (Bool -> Bool32
boolToBool32 (Bool
bufferDeviceAddress))
    Ptr Bool32 -> Bool32 -> IO ()
forall a. Storable a => Ptr a -> a -> IO ()
poke ((Ptr PhysicalDeviceBufferDeviceAddressFeatures
p Ptr PhysicalDeviceBufferDeviceAddressFeatures -> Int -> Ptr Bool32
forall a b. Ptr a -> Int -> Ptr b
`plusPtr` 20 :: Ptr Bool32)) (Bool -> Bool32
boolToBool32 (Bool
bufferDeviceAddressCaptureReplay))
    Ptr Bool32 -> Bool32 -> IO ()
forall a. Storable a => Ptr a -> a -> IO ()
poke ((Ptr PhysicalDeviceBufferDeviceAddressFeatures
p Ptr PhysicalDeviceBufferDeviceAddressFeatures -> Int -> Ptr Bool32
forall a b. Ptr a -> Int -> Ptr b
`plusPtr` 24 :: Ptr Bool32)) (Bool -> Bool32
boolToBool32 (Bool
bufferDeviceAddressMultiDevice))
    IO b
f
  cStructSize :: Int
cStructSize = 32
  cStructAlignment :: Int
cStructAlignment = 8
  pokeZeroCStruct :: Ptr PhysicalDeviceBufferDeviceAddressFeatures -> IO b -> IO b
pokeZeroCStruct p :: Ptr PhysicalDeviceBufferDeviceAddressFeatures
p f :: IO b
f = do
    Ptr StructureType -> StructureType -> IO ()
forall a. Storable a => Ptr a -> a -> IO ()
poke ((Ptr PhysicalDeviceBufferDeviceAddressFeatures
p Ptr PhysicalDeviceBufferDeviceAddressFeatures
-> Int -> Ptr StructureType
forall a b. Ptr a -> Int -> Ptr b
`plusPtr` 0 :: Ptr StructureType)) (StructureType
STRUCTURE_TYPE_PHYSICAL_DEVICE_BUFFER_DEVICE_ADDRESS_FEATURES)
    Ptr (Ptr ()) -> Ptr () -> IO ()
forall a. Storable a => Ptr a -> a -> IO ()
poke ((Ptr PhysicalDeviceBufferDeviceAddressFeatures
p Ptr PhysicalDeviceBufferDeviceAddressFeatures
-> Int -> Ptr (Ptr ())
forall a b. Ptr a -> Int -> Ptr b
`plusPtr` 8 :: Ptr (Ptr ()))) (Ptr ()
forall a. Ptr a
nullPtr)
    Ptr Bool32 -> Bool32 -> IO ()
forall a. Storable a => Ptr a -> a -> IO ()
poke ((Ptr PhysicalDeviceBufferDeviceAddressFeatures
p Ptr PhysicalDeviceBufferDeviceAddressFeatures -> Int -> Ptr Bool32
forall a b. Ptr a -> Int -> Ptr b
`plusPtr` 16 :: Ptr Bool32)) (Bool -> Bool32
boolToBool32 (Bool
forall a. Zero a => a
zero))
    Ptr Bool32 -> Bool32 -> IO ()
forall a. Storable a => Ptr a -> a -> IO ()
poke ((Ptr PhysicalDeviceBufferDeviceAddressFeatures
p Ptr PhysicalDeviceBufferDeviceAddressFeatures -> Int -> Ptr Bool32
forall a b. Ptr a -> Int -> Ptr b
`plusPtr` 20 :: Ptr Bool32)) (Bool -> Bool32
boolToBool32 (Bool
forall a. Zero a => a
zero))
    Ptr Bool32 -> Bool32 -> IO ()
forall a. Storable a => Ptr a -> a -> IO ()
poke ((Ptr PhysicalDeviceBufferDeviceAddressFeatures
p Ptr PhysicalDeviceBufferDeviceAddressFeatures -> Int -> Ptr Bool32
forall a b. Ptr a -> Int -> Ptr b
`plusPtr` 24 :: Ptr Bool32)) (Bool -> Bool32
boolToBool32 (Bool
forall a. Zero a => a
zero))
    IO b
f

instance FromCStruct PhysicalDeviceBufferDeviceAddressFeatures where
  peekCStruct :: Ptr PhysicalDeviceBufferDeviceAddressFeatures
-> IO PhysicalDeviceBufferDeviceAddressFeatures
peekCStruct p :: Ptr PhysicalDeviceBufferDeviceAddressFeatures
p = do
    Bool32
bufferDeviceAddress <- Ptr Bool32 -> IO Bool32
forall a. Storable a => Ptr a -> IO a
peek @Bool32 ((Ptr PhysicalDeviceBufferDeviceAddressFeatures
p Ptr PhysicalDeviceBufferDeviceAddressFeatures -> Int -> Ptr Bool32
forall a b. Ptr a -> Int -> Ptr b
`plusPtr` 16 :: Ptr Bool32))
    Bool32
bufferDeviceAddressCaptureReplay <- Ptr Bool32 -> IO Bool32
forall a. Storable a => Ptr a -> IO a
peek @Bool32 ((Ptr PhysicalDeviceBufferDeviceAddressFeatures
p Ptr PhysicalDeviceBufferDeviceAddressFeatures -> Int -> Ptr Bool32
forall a b. Ptr a -> Int -> Ptr b
`plusPtr` 20 :: Ptr Bool32))
    Bool32
bufferDeviceAddressMultiDevice <- Ptr Bool32 -> IO Bool32
forall a. Storable a => Ptr a -> IO a
peek @Bool32 ((Ptr PhysicalDeviceBufferDeviceAddressFeatures
p Ptr PhysicalDeviceBufferDeviceAddressFeatures -> Int -> Ptr Bool32
forall a b. Ptr a -> Int -> Ptr b
`plusPtr` 24 :: Ptr Bool32))
    PhysicalDeviceBufferDeviceAddressFeatures
-> IO PhysicalDeviceBufferDeviceAddressFeatures
forall (f :: * -> *) a. Applicative f => a -> f a
pure (PhysicalDeviceBufferDeviceAddressFeatures
 -> IO PhysicalDeviceBufferDeviceAddressFeatures)
-> PhysicalDeviceBufferDeviceAddressFeatures
-> IO PhysicalDeviceBufferDeviceAddressFeatures
forall a b. (a -> b) -> a -> b
$ Bool -> Bool -> Bool -> PhysicalDeviceBufferDeviceAddressFeatures
PhysicalDeviceBufferDeviceAddressFeatures
             (Bool32 -> Bool
bool32ToBool Bool32
bufferDeviceAddress) (Bool32 -> Bool
bool32ToBool Bool32
bufferDeviceAddressCaptureReplay) (Bool32 -> Bool
bool32ToBool Bool32
bufferDeviceAddressMultiDevice)

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

instance Zero PhysicalDeviceBufferDeviceAddressFeatures where
  zero :: PhysicalDeviceBufferDeviceAddressFeatures
zero = Bool -> Bool -> Bool -> PhysicalDeviceBufferDeviceAddressFeatures
PhysicalDeviceBufferDeviceAddressFeatures
           Bool
forall a. Zero a => a
zero
           Bool
forall a. Zero a => a
zero
           Bool
forall a. Zero a => a
zero


-- | VkBufferDeviceAddressInfo - Structure specifying the buffer to query an
-- address for
--
-- == Valid Usage
--
-- -   #VUID-VkBufferDeviceAddressInfo-buffer-02600# If @buffer@ is
--     non-sparse and was not created with the
--     'Vulkan.Core10.Enums.BufferCreateFlagBits.BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT'
--     flag, then it /must/ be bound completely and contiguously to a
--     single 'Vulkan.Core10.Handles.DeviceMemory' object
--
-- -   #VUID-VkBufferDeviceAddressInfo-buffer-02601# @buffer@ /must/ have
--     been created with
--     'Vulkan.Core10.Enums.BufferUsageFlagBits.BUFFER_USAGE_SHADER_DEVICE_ADDRESS_BIT'
--
-- == Valid Usage (Implicit)
--
-- -   #VUID-VkBufferDeviceAddressInfo-sType-sType# @sType@ /must/ be
--     'Vulkan.Core10.Enums.StructureType.STRUCTURE_TYPE_BUFFER_DEVICE_ADDRESS_INFO'
--
-- -   #VUID-VkBufferDeviceAddressInfo-pNext-pNext# @pNext@ /must/ be
--     @NULL@
--
-- -   #VUID-VkBufferDeviceAddressInfo-buffer-parameter# @buffer@ /must/ be
--     a valid 'Vulkan.Core10.Handles.Buffer' handle
--
-- = See Also
--
-- 'Vulkan.Core10.Handles.Buffer',
-- 'Vulkan.Core10.Enums.StructureType.StructureType',
-- 'getBufferDeviceAddress',
-- 'Vulkan.Extensions.VK_EXT_buffer_device_address.getBufferDeviceAddressEXT',
-- 'Vulkan.Extensions.VK_KHR_buffer_device_address.getBufferDeviceAddressKHR',
-- 'getBufferOpaqueCaptureAddress',
-- 'Vulkan.Extensions.VK_KHR_buffer_device_address.getBufferOpaqueCaptureAddressKHR'
data BufferDeviceAddressInfo = BufferDeviceAddressInfo
  { -- | @buffer@ specifies the buffer whose address is being queried.
    BufferDeviceAddressInfo -> Buffer
buffer :: Buffer }
  deriving (Typeable, BufferDeviceAddressInfo -> BufferDeviceAddressInfo -> Bool
(BufferDeviceAddressInfo -> BufferDeviceAddressInfo -> Bool)
-> (BufferDeviceAddressInfo -> BufferDeviceAddressInfo -> Bool)
-> Eq BufferDeviceAddressInfo
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: BufferDeviceAddressInfo -> BufferDeviceAddressInfo -> Bool
$c/= :: BufferDeviceAddressInfo -> BufferDeviceAddressInfo -> Bool
== :: BufferDeviceAddressInfo -> BufferDeviceAddressInfo -> Bool
$c== :: BufferDeviceAddressInfo -> BufferDeviceAddressInfo -> Bool
Eq)
#if defined(GENERIC_INSTANCES)
deriving instance Generic (BufferDeviceAddressInfo)
#endif
deriving instance Show BufferDeviceAddressInfo

instance ToCStruct BufferDeviceAddressInfo where
  withCStruct :: BufferDeviceAddressInfo
-> (("pInfo" ::: Ptr BufferDeviceAddressInfo) -> IO b) -> IO b
withCStruct x :: BufferDeviceAddressInfo
x f :: ("pInfo" ::: Ptr BufferDeviceAddressInfo) -> IO b
f = Int
-> Int
-> (("pInfo" ::: Ptr BufferDeviceAddressInfo) -> IO b)
-> IO b
forall a b. Int -> Int -> (Ptr a -> IO b) -> IO b
allocaBytesAligned 24 8 ((("pInfo" ::: Ptr BufferDeviceAddressInfo) -> IO b) -> IO b)
-> (("pInfo" ::: Ptr BufferDeviceAddressInfo) -> IO b) -> IO b
forall a b. (a -> b) -> a -> b
$ \p :: "pInfo" ::: Ptr BufferDeviceAddressInfo
p -> ("pInfo" ::: Ptr BufferDeviceAddressInfo)
-> BufferDeviceAddressInfo -> IO b -> IO b
forall a b. ToCStruct a => Ptr a -> a -> IO b -> IO b
pokeCStruct "pInfo" ::: Ptr BufferDeviceAddressInfo
p BufferDeviceAddressInfo
x (("pInfo" ::: Ptr BufferDeviceAddressInfo) -> IO b
f "pInfo" ::: Ptr BufferDeviceAddressInfo
p)
  pokeCStruct :: ("pInfo" ::: Ptr BufferDeviceAddressInfo)
-> BufferDeviceAddressInfo -> IO b -> IO b
pokeCStruct p :: "pInfo" ::: Ptr BufferDeviceAddressInfo
p BufferDeviceAddressInfo{..} f :: IO b
f = do
    Ptr StructureType -> StructureType -> IO ()
forall a. Storable a => Ptr a -> a -> IO ()
poke (("pInfo" ::: Ptr BufferDeviceAddressInfo
p ("pInfo" ::: Ptr BufferDeviceAddressInfo)
-> Int -> Ptr StructureType
forall a b. Ptr a -> Int -> Ptr b
`plusPtr` 0 :: Ptr StructureType)) (StructureType
STRUCTURE_TYPE_BUFFER_DEVICE_ADDRESS_INFO)
    Ptr (Ptr ()) -> Ptr () -> IO ()
forall a. Storable a => Ptr a -> a -> IO ()
poke (("pInfo" ::: Ptr BufferDeviceAddressInfo
p ("pInfo" ::: Ptr BufferDeviceAddressInfo) -> Int -> Ptr (Ptr ())
forall a b. Ptr a -> Int -> Ptr b
`plusPtr` 8 :: Ptr (Ptr ()))) (Ptr ()
forall a. Ptr a
nullPtr)
    Ptr Buffer -> Buffer -> IO ()
forall a. Storable a => Ptr a -> a -> IO ()
poke (("pInfo" ::: Ptr BufferDeviceAddressInfo
p ("pInfo" ::: Ptr BufferDeviceAddressInfo) -> Int -> Ptr Buffer
forall a b. Ptr a -> Int -> Ptr b
`plusPtr` 16 :: Ptr Buffer)) (Buffer
buffer)
    IO b
f
  cStructSize :: Int
cStructSize = 24
  cStructAlignment :: Int
cStructAlignment = 8
  pokeZeroCStruct :: ("pInfo" ::: Ptr BufferDeviceAddressInfo) -> IO b -> IO b
pokeZeroCStruct p :: "pInfo" ::: Ptr BufferDeviceAddressInfo
p f :: IO b
f = do
    Ptr StructureType -> StructureType -> IO ()
forall a. Storable a => Ptr a -> a -> IO ()
poke (("pInfo" ::: Ptr BufferDeviceAddressInfo
p ("pInfo" ::: Ptr BufferDeviceAddressInfo)
-> Int -> Ptr StructureType
forall a b. Ptr a -> Int -> Ptr b
`plusPtr` 0 :: Ptr StructureType)) (StructureType
STRUCTURE_TYPE_BUFFER_DEVICE_ADDRESS_INFO)
    Ptr (Ptr ()) -> Ptr () -> IO ()
forall a. Storable a => Ptr a -> a -> IO ()
poke (("pInfo" ::: Ptr BufferDeviceAddressInfo
p ("pInfo" ::: Ptr BufferDeviceAddressInfo) -> Int -> Ptr (Ptr ())
forall a b. Ptr a -> Int -> Ptr b
`plusPtr` 8 :: Ptr (Ptr ()))) (Ptr ()
forall a. Ptr a
nullPtr)
    Ptr Buffer -> Buffer -> IO ()
forall a. Storable a => Ptr a -> a -> IO ()
poke (("pInfo" ::: Ptr BufferDeviceAddressInfo
p ("pInfo" ::: Ptr BufferDeviceAddressInfo) -> Int -> Ptr Buffer
forall a b. Ptr a -> Int -> Ptr b
`plusPtr` 16 :: Ptr Buffer)) (Buffer
forall a. Zero a => a
zero)
    IO b
f

instance FromCStruct BufferDeviceAddressInfo where
  peekCStruct :: ("pInfo" ::: Ptr BufferDeviceAddressInfo)
-> IO BufferDeviceAddressInfo
peekCStruct p :: "pInfo" ::: Ptr BufferDeviceAddressInfo
p = do
    Buffer
buffer <- Ptr Buffer -> IO Buffer
forall a. Storable a => Ptr a -> IO a
peek @Buffer (("pInfo" ::: Ptr BufferDeviceAddressInfo
p ("pInfo" ::: Ptr BufferDeviceAddressInfo) -> Int -> Ptr Buffer
forall a b. Ptr a -> Int -> Ptr b
`plusPtr` 16 :: Ptr Buffer))
    BufferDeviceAddressInfo -> IO BufferDeviceAddressInfo
forall (f :: * -> *) a. Applicative f => a -> f a
pure (BufferDeviceAddressInfo -> IO BufferDeviceAddressInfo)
-> BufferDeviceAddressInfo -> IO BufferDeviceAddressInfo
forall a b. (a -> b) -> a -> b
$ Buffer -> BufferDeviceAddressInfo
BufferDeviceAddressInfo
             Buffer
buffer

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

instance Zero BufferDeviceAddressInfo where
  zero :: BufferDeviceAddressInfo
zero = Buffer -> BufferDeviceAddressInfo
BufferDeviceAddressInfo
           Buffer
forall a. Zero a => a
zero


-- | VkBufferOpaqueCaptureAddressCreateInfo - Request a specific address for
-- a buffer
--
-- = Description
--
-- If @opaqueCaptureAddress@ is zero, no specific address is requested.
--
-- If @opaqueCaptureAddress@ is not zero, then it /should/ be an address
-- retrieved from 'getBufferOpaqueCaptureAddress' for an identically
-- created buffer on the same implementation.
--
-- If this structure is not present, it is as if @opaqueCaptureAddress@ is
-- zero.
--
-- Apps /should/ avoid creating buffers with app-provided addresses and
-- implementation-provided addresses in the same process, to reduce the
-- likelihood of
-- 'Vulkan.Core10.Enums.Result.ERROR_INVALID_OPAQUE_CAPTURE_ADDRESS'
-- errors.
--
-- Note
--
-- The expected usage for this is that a trace capture\/replay tool will
-- add the
-- 'Vulkan.Core10.Enums.BufferCreateFlagBits.BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT'
-- flag to all buffers that use
-- 'Vulkan.Core10.Enums.BufferUsageFlagBits.BUFFER_USAGE_SHADER_DEVICE_ADDRESS_BIT',
-- and during capture will save the queried opaque device addresses in the
-- trace. During replay, the buffers will be created specifying the
-- original address so any address values stored in the trace data will
-- remain valid.
--
-- Implementations are expected to separate such buffers in the GPU address
-- space so normal allocations will avoid using these addresses.
-- Apps\/tools should avoid mixing app-provided and implementation-provided
-- addresses for buffers created with
-- 'Vulkan.Core10.Enums.BufferCreateFlagBits.BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT',
-- to avoid address space allocation conflicts.
--
-- == Valid Usage (Implicit)
--
-- = See Also
--
-- 'Vulkan.Core10.Enums.StructureType.StructureType'
data BufferOpaqueCaptureAddressCreateInfo = BufferOpaqueCaptureAddressCreateInfo
  { -- | @opaqueCaptureAddress@ is the opaque capture address requested for the
    -- buffer.
    BufferOpaqueCaptureAddressCreateInfo -> Word64
opaqueCaptureAddress :: Word64 }
  deriving (Typeable, BufferOpaqueCaptureAddressCreateInfo
-> BufferOpaqueCaptureAddressCreateInfo -> Bool
(BufferOpaqueCaptureAddressCreateInfo
 -> BufferOpaqueCaptureAddressCreateInfo -> Bool)
-> (BufferOpaqueCaptureAddressCreateInfo
    -> BufferOpaqueCaptureAddressCreateInfo -> Bool)
-> Eq BufferOpaqueCaptureAddressCreateInfo
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: BufferOpaqueCaptureAddressCreateInfo
-> BufferOpaqueCaptureAddressCreateInfo -> Bool
$c/= :: BufferOpaqueCaptureAddressCreateInfo
-> BufferOpaqueCaptureAddressCreateInfo -> Bool
== :: BufferOpaqueCaptureAddressCreateInfo
-> BufferOpaqueCaptureAddressCreateInfo -> Bool
$c== :: BufferOpaqueCaptureAddressCreateInfo
-> BufferOpaqueCaptureAddressCreateInfo -> Bool
Eq)
#if defined(GENERIC_INSTANCES)
deriving instance Generic (BufferOpaqueCaptureAddressCreateInfo)
#endif
deriving instance Show BufferOpaqueCaptureAddressCreateInfo

instance ToCStruct BufferOpaqueCaptureAddressCreateInfo where
  withCStruct :: BufferOpaqueCaptureAddressCreateInfo
-> (Ptr BufferOpaqueCaptureAddressCreateInfo -> IO b) -> IO b
withCStruct x :: BufferOpaqueCaptureAddressCreateInfo
x f :: Ptr BufferOpaqueCaptureAddressCreateInfo -> IO b
f = Int
-> Int
-> (Ptr BufferOpaqueCaptureAddressCreateInfo -> IO b)
-> IO b
forall a b. Int -> Int -> (Ptr a -> IO b) -> IO b
allocaBytesAligned 24 8 ((Ptr BufferOpaqueCaptureAddressCreateInfo -> IO b) -> IO b)
-> (Ptr BufferOpaqueCaptureAddressCreateInfo -> IO b) -> IO b
forall a b. (a -> b) -> a -> b
$ \p :: Ptr BufferOpaqueCaptureAddressCreateInfo
p -> Ptr BufferOpaqueCaptureAddressCreateInfo
-> BufferOpaqueCaptureAddressCreateInfo -> IO b -> IO b
forall a b. ToCStruct a => Ptr a -> a -> IO b -> IO b
pokeCStruct Ptr BufferOpaqueCaptureAddressCreateInfo
p BufferOpaqueCaptureAddressCreateInfo
x (Ptr BufferOpaqueCaptureAddressCreateInfo -> IO b
f Ptr BufferOpaqueCaptureAddressCreateInfo
p)
  pokeCStruct :: Ptr BufferOpaqueCaptureAddressCreateInfo
-> BufferOpaqueCaptureAddressCreateInfo -> IO b -> IO b
pokeCStruct p :: Ptr BufferOpaqueCaptureAddressCreateInfo
p BufferOpaqueCaptureAddressCreateInfo{..} f :: IO b
f = do
    Ptr StructureType -> StructureType -> IO ()
forall a. Storable a => Ptr a -> a -> IO ()
poke ((Ptr BufferOpaqueCaptureAddressCreateInfo
p Ptr BufferOpaqueCaptureAddressCreateInfo
-> Int -> Ptr StructureType
forall a b. Ptr a -> Int -> Ptr b
`plusPtr` 0 :: Ptr StructureType)) (StructureType
STRUCTURE_TYPE_BUFFER_OPAQUE_CAPTURE_ADDRESS_CREATE_INFO)
    Ptr (Ptr ()) -> Ptr () -> IO ()
forall a. Storable a => Ptr a -> a -> IO ()
poke ((Ptr BufferOpaqueCaptureAddressCreateInfo
p Ptr BufferOpaqueCaptureAddressCreateInfo -> Int -> Ptr (Ptr ())
forall a b. Ptr a -> Int -> Ptr b
`plusPtr` 8 :: Ptr (Ptr ()))) (Ptr ()
forall a. Ptr a
nullPtr)
    Ptr Word64 -> Word64 -> IO ()
forall a. Storable a => Ptr a -> a -> IO ()
poke ((Ptr BufferOpaqueCaptureAddressCreateInfo
p Ptr BufferOpaqueCaptureAddressCreateInfo -> Int -> Ptr Word64
forall a b. Ptr a -> Int -> Ptr b
`plusPtr` 16 :: Ptr Word64)) (Word64
opaqueCaptureAddress)
    IO b
f
  cStructSize :: Int
cStructSize = 24
  cStructAlignment :: Int
cStructAlignment = 8
  pokeZeroCStruct :: Ptr BufferOpaqueCaptureAddressCreateInfo -> IO b -> IO b
pokeZeroCStruct p :: Ptr BufferOpaqueCaptureAddressCreateInfo
p f :: IO b
f = do
    Ptr StructureType -> StructureType -> IO ()
forall a. Storable a => Ptr a -> a -> IO ()
poke ((Ptr BufferOpaqueCaptureAddressCreateInfo
p Ptr BufferOpaqueCaptureAddressCreateInfo
-> Int -> Ptr StructureType
forall a b. Ptr a -> Int -> Ptr b
`plusPtr` 0 :: Ptr StructureType)) (StructureType
STRUCTURE_TYPE_BUFFER_OPAQUE_CAPTURE_ADDRESS_CREATE_INFO)
    Ptr (Ptr ()) -> Ptr () -> IO ()
forall a. Storable a => Ptr a -> a -> IO ()
poke ((Ptr BufferOpaqueCaptureAddressCreateInfo
p Ptr BufferOpaqueCaptureAddressCreateInfo -> Int -> Ptr (Ptr ())
forall a b. Ptr a -> Int -> Ptr b
`plusPtr` 8 :: Ptr (Ptr ()))) (Ptr ()
forall a. Ptr a
nullPtr)
    Ptr Word64 -> Word64 -> IO ()
forall a. Storable a => Ptr a -> a -> IO ()
poke ((Ptr BufferOpaqueCaptureAddressCreateInfo
p Ptr BufferOpaqueCaptureAddressCreateInfo -> Int -> Ptr Word64
forall a b. Ptr a -> Int -> Ptr b
`plusPtr` 16 :: Ptr Word64)) (Word64
forall a. Zero a => a
zero)
    IO b
f

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

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

instance Zero BufferOpaqueCaptureAddressCreateInfo where
  zero :: BufferOpaqueCaptureAddressCreateInfo
zero = Word64 -> BufferOpaqueCaptureAddressCreateInfo
BufferOpaqueCaptureAddressCreateInfo
           Word64
forall a. Zero a => a
zero


-- | VkMemoryOpaqueCaptureAddressAllocateInfo - Request a specific address
-- for a memory allocation
--
-- = Description
--
-- If @opaqueCaptureAddress@ is zero, no specific address is requested.
--
-- If @opaqueCaptureAddress@ is not zero, it /should/ be an address
-- retrieved from 'getDeviceMemoryOpaqueCaptureAddress' on an identically
-- created memory allocation on the same implementation.
--
-- Note
--
-- In most cases, it is expected that a non-zero @opaqueAddress@ is an
-- address retrieved from 'getDeviceMemoryOpaqueCaptureAddress' on an
-- identically created memory allocation. If this is not the case, it
-- likely that
-- 'Vulkan.Core10.Enums.Result.ERROR_INVALID_OPAQUE_CAPTURE_ADDRESS' errors
-- will occur.
--
-- This is, however, not a strict requirement because trace capture\/replay
-- tools may need to adjust memory allocation parameters for imported
-- memory.
--
-- If this structure is not present, it is as if @opaqueCaptureAddress@ is
-- zero.
--
-- == Valid Usage (Implicit)
--
-- = See Also
--
-- 'Vulkan.Core10.Enums.StructureType.StructureType'
data MemoryOpaqueCaptureAddressAllocateInfo = MemoryOpaqueCaptureAddressAllocateInfo
  { -- | @opaqueCaptureAddress@ is the opaque capture address requested for the
    -- memory allocation.
    MemoryOpaqueCaptureAddressAllocateInfo -> Word64
opaqueCaptureAddress :: Word64 }
  deriving (Typeable, MemoryOpaqueCaptureAddressAllocateInfo
-> MemoryOpaqueCaptureAddressAllocateInfo -> Bool
(MemoryOpaqueCaptureAddressAllocateInfo
 -> MemoryOpaqueCaptureAddressAllocateInfo -> Bool)
-> (MemoryOpaqueCaptureAddressAllocateInfo
    -> MemoryOpaqueCaptureAddressAllocateInfo -> Bool)
-> Eq MemoryOpaqueCaptureAddressAllocateInfo
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: MemoryOpaqueCaptureAddressAllocateInfo
-> MemoryOpaqueCaptureAddressAllocateInfo -> Bool
$c/= :: MemoryOpaqueCaptureAddressAllocateInfo
-> MemoryOpaqueCaptureAddressAllocateInfo -> Bool
== :: MemoryOpaqueCaptureAddressAllocateInfo
-> MemoryOpaqueCaptureAddressAllocateInfo -> Bool
$c== :: MemoryOpaqueCaptureAddressAllocateInfo
-> MemoryOpaqueCaptureAddressAllocateInfo -> Bool
Eq)
#if defined(GENERIC_INSTANCES)
deriving instance Generic (MemoryOpaqueCaptureAddressAllocateInfo)
#endif
deriving instance Show MemoryOpaqueCaptureAddressAllocateInfo

instance ToCStruct MemoryOpaqueCaptureAddressAllocateInfo where
  withCStruct :: MemoryOpaqueCaptureAddressAllocateInfo
-> (Ptr MemoryOpaqueCaptureAddressAllocateInfo -> IO b) -> IO b
withCStruct x :: MemoryOpaqueCaptureAddressAllocateInfo
x f :: Ptr MemoryOpaqueCaptureAddressAllocateInfo -> IO b
f = Int
-> Int
-> (Ptr MemoryOpaqueCaptureAddressAllocateInfo -> IO b)
-> IO b
forall a b. Int -> Int -> (Ptr a -> IO b) -> IO b
allocaBytesAligned 24 8 ((Ptr MemoryOpaqueCaptureAddressAllocateInfo -> IO b) -> IO b)
-> (Ptr MemoryOpaqueCaptureAddressAllocateInfo -> IO b) -> IO b
forall a b. (a -> b) -> a -> b
$ \p :: Ptr MemoryOpaqueCaptureAddressAllocateInfo
p -> Ptr MemoryOpaqueCaptureAddressAllocateInfo
-> MemoryOpaqueCaptureAddressAllocateInfo -> IO b -> IO b
forall a b. ToCStruct a => Ptr a -> a -> IO b -> IO b
pokeCStruct Ptr MemoryOpaqueCaptureAddressAllocateInfo
p MemoryOpaqueCaptureAddressAllocateInfo
x (Ptr MemoryOpaqueCaptureAddressAllocateInfo -> IO b
f Ptr MemoryOpaqueCaptureAddressAllocateInfo
p)
  pokeCStruct :: Ptr MemoryOpaqueCaptureAddressAllocateInfo
-> MemoryOpaqueCaptureAddressAllocateInfo -> IO b -> IO b
pokeCStruct p :: Ptr MemoryOpaqueCaptureAddressAllocateInfo
p MemoryOpaqueCaptureAddressAllocateInfo{..} f :: IO b
f = do
    Ptr StructureType -> StructureType -> IO ()
forall a. Storable a => Ptr a -> a -> IO ()
poke ((Ptr MemoryOpaqueCaptureAddressAllocateInfo
p Ptr MemoryOpaqueCaptureAddressAllocateInfo
-> Int -> Ptr StructureType
forall a b. Ptr a -> Int -> Ptr b
`plusPtr` 0 :: Ptr StructureType)) (StructureType
STRUCTURE_TYPE_MEMORY_OPAQUE_CAPTURE_ADDRESS_ALLOCATE_INFO)
    Ptr (Ptr ()) -> Ptr () -> IO ()
forall a. Storable a => Ptr a -> a -> IO ()
poke ((Ptr MemoryOpaqueCaptureAddressAllocateInfo
p Ptr MemoryOpaqueCaptureAddressAllocateInfo -> Int -> Ptr (Ptr ())
forall a b. Ptr a -> Int -> Ptr b
`plusPtr` 8 :: Ptr (Ptr ()))) (Ptr ()
forall a. Ptr a
nullPtr)
    Ptr Word64 -> Word64 -> IO ()
forall a. Storable a => Ptr a -> a -> IO ()
poke ((Ptr MemoryOpaqueCaptureAddressAllocateInfo
p Ptr MemoryOpaqueCaptureAddressAllocateInfo -> Int -> Ptr Word64
forall a b. Ptr a -> Int -> Ptr b
`plusPtr` 16 :: Ptr Word64)) (Word64
opaqueCaptureAddress)
    IO b
f
  cStructSize :: Int
cStructSize = 24
  cStructAlignment :: Int
cStructAlignment = 8
  pokeZeroCStruct :: Ptr MemoryOpaqueCaptureAddressAllocateInfo -> IO b -> IO b
pokeZeroCStruct p :: Ptr MemoryOpaqueCaptureAddressAllocateInfo
p f :: IO b
f = do
    Ptr StructureType -> StructureType -> IO ()
forall a. Storable a => Ptr a -> a -> IO ()
poke ((Ptr MemoryOpaqueCaptureAddressAllocateInfo
p Ptr MemoryOpaqueCaptureAddressAllocateInfo
-> Int -> Ptr StructureType
forall a b. Ptr a -> Int -> Ptr b
`plusPtr` 0 :: Ptr StructureType)) (StructureType
STRUCTURE_TYPE_MEMORY_OPAQUE_CAPTURE_ADDRESS_ALLOCATE_INFO)
    Ptr (Ptr ()) -> Ptr () -> IO ()
forall a. Storable a => Ptr a -> a -> IO ()
poke ((Ptr MemoryOpaqueCaptureAddressAllocateInfo
p Ptr MemoryOpaqueCaptureAddressAllocateInfo -> Int -> Ptr (Ptr ())
forall a b. Ptr a -> Int -> Ptr b
`plusPtr` 8 :: Ptr (Ptr ()))) (Ptr ()
forall a. Ptr a
nullPtr)
    Ptr Word64 -> Word64 -> IO ()
forall a. Storable a => Ptr a -> a -> IO ()
poke ((Ptr MemoryOpaqueCaptureAddressAllocateInfo
p Ptr MemoryOpaqueCaptureAddressAllocateInfo -> Int -> Ptr Word64
forall a b. Ptr a -> Int -> Ptr b
`plusPtr` 16 :: Ptr Word64)) (Word64
forall a. Zero a => a
zero)
    IO b
f

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

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

instance Zero MemoryOpaqueCaptureAddressAllocateInfo where
  zero :: MemoryOpaqueCaptureAddressAllocateInfo
zero = Word64 -> MemoryOpaqueCaptureAddressAllocateInfo
MemoryOpaqueCaptureAddressAllocateInfo
           Word64
forall a. Zero a => a
zero


-- | VkDeviceMemoryOpaqueCaptureAddressInfo - Structure specifying the memory
-- object to query an address for
--
-- == Valid Usage (Implicit)
--
-- = See Also
--
-- 'Vulkan.Core10.Handles.DeviceMemory',
-- 'Vulkan.Core10.Enums.StructureType.StructureType',
-- 'getDeviceMemoryOpaqueCaptureAddress',
-- 'Vulkan.Extensions.VK_KHR_buffer_device_address.getDeviceMemoryOpaqueCaptureAddressKHR'
data DeviceMemoryOpaqueCaptureAddressInfo = DeviceMemoryOpaqueCaptureAddressInfo
  { -- | @memory@ specifies the memory whose address is being queried.
    --
    -- #VUID-VkDeviceMemoryOpaqueCaptureAddressInfo-memory-03336# @memory@
    -- /must/ have been allocated with
    -- 'Vulkan.Core11.Enums.MemoryAllocateFlagBits.MEMORY_ALLOCATE_DEVICE_ADDRESS_BIT'
    --
    -- #VUID-VkDeviceMemoryOpaqueCaptureAddressInfo-memory-parameter# @memory@
    -- /must/ be a valid 'Vulkan.Core10.Handles.DeviceMemory' handle
    DeviceMemoryOpaqueCaptureAddressInfo -> DeviceMemory
memory :: DeviceMemory }
  deriving (Typeable, DeviceMemoryOpaqueCaptureAddressInfo
-> DeviceMemoryOpaqueCaptureAddressInfo -> Bool
(DeviceMemoryOpaqueCaptureAddressInfo
 -> DeviceMemoryOpaqueCaptureAddressInfo -> Bool)
-> (DeviceMemoryOpaqueCaptureAddressInfo
    -> DeviceMemoryOpaqueCaptureAddressInfo -> Bool)
-> Eq DeviceMemoryOpaqueCaptureAddressInfo
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: DeviceMemoryOpaqueCaptureAddressInfo
-> DeviceMemoryOpaqueCaptureAddressInfo -> Bool
$c/= :: DeviceMemoryOpaqueCaptureAddressInfo
-> DeviceMemoryOpaqueCaptureAddressInfo -> Bool
== :: DeviceMemoryOpaqueCaptureAddressInfo
-> DeviceMemoryOpaqueCaptureAddressInfo -> Bool
$c== :: DeviceMemoryOpaqueCaptureAddressInfo
-> DeviceMemoryOpaqueCaptureAddressInfo -> Bool
Eq)
#if defined(GENERIC_INSTANCES)
deriving instance Generic (DeviceMemoryOpaqueCaptureAddressInfo)
#endif
deriving instance Show DeviceMemoryOpaqueCaptureAddressInfo

instance ToCStruct DeviceMemoryOpaqueCaptureAddressInfo where
  withCStruct :: DeviceMemoryOpaqueCaptureAddressInfo
-> (("pInfo" ::: Ptr DeviceMemoryOpaqueCaptureAddressInfo) -> IO b)
-> IO b
withCStruct x :: DeviceMemoryOpaqueCaptureAddressInfo
x f :: ("pInfo" ::: Ptr DeviceMemoryOpaqueCaptureAddressInfo) -> IO b
f = Int
-> Int
-> (("pInfo" ::: Ptr DeviceMemoryOpaqueCaptureAddressInfo) -> IO b)
-> IO b
forall a b. Int -> Int -> (Ptr a -> IO b) -> IO b
allocaBytesAligned 24 8 ((("pInfo" ::: Ptr DeviceMemoryOpaqueCaptureAddressInfo) -> IO b)
 -> IO b)
-> (("pInfo" ::: Ptr DeviceMemoryOpaqueCaptureAddressInfo) -> IO b)
-> IO b
forall a b. (a -> b) -> a -> b
$ \p :: "pInfo" ::: Ptr DeviceMemoryOpaqueCaptureAddressInfo
p -> ("pInfo" ::: Ptr DeviceMemoryOpaqueCaptureAddressInfo)
-> DeviceMemoryOpaqueCaptureAddressInfo -> IO b -> IO b
forall a b. ToCStruct a => Ptr a -> a -> IO b -> IO b
pokeCStruct "pInfo" ::: Ptr DeviceMemoryOpaqueCaptureAddressInfo
p DeviceMemoryOpaqueCaptureAddressInfo
x (("pInfo" ::: Ptr DeviceMemoryOpaqueCaptureAddressInfo) -> IO b
f "pInfo" ::: Ptr DeviceMemoryOpaqueCaptureAddressInfo
p)
  pokeCStruct :: ("pInfo" ::: Ptr DeviceMemoryOpaqueCaptureAddressInfo)
-> DeviceMemoryOpaqueCaptureAddressInfo -> IO b -> IO b
pokeCStruct p :: "pInfo" ::: Ptr DeviceMemoryOpaqueCaptureAddressInfo
p DeviceMemoryOpaqueCaptureAddressInfo{..} f :: IO b
f = do
    Ptr StructureType -> StructureType -> IO ()
forall a. Storable a => Ptr a -> a -> IO ()
poke (("pInfo" ::: Ptr DeviceMemoryOpaqueCaptureAddressInfo
p ("pInfo" ::: Ptr DeviceMemoryOpaqueCaptureAddressInfo)
-> Int -> Ptr StructureType
forall a b. Ptr a -> Int -> Ptr b
`plusPtr` 0 :: Ptr StructureType)) (StructureType
STRUCTURE_TYPE_DEVICE_MEMORY_OPAQUE_CAPTURE_ADDRESS_INFO)
    Ptr (Ptr ()) -> Ptr () -> IO ()
forall a. Storable a => Ptr a -> a -> IO ()
poke (("pInfo" ::: Ptr DeviceMemoryOpaqueCaptureAddressInfo
p ("pInfo" ::: Ptr DeviceMemoryOpaqueCaptureAddressInfo)
-> Int -> Ptr (Ptr ())
forall a b. Ptr a -> Int -> Ptr b
`plusPtr` 8 :: Ptr (Ptr ()))) (Ptr ()
forall a. Ptr a
nullPtr)
    Ptr DeviceMemory -> DeviceMemory -> IO ()
forall a. Storable a => Ptr a -> a -> IO ()
poke (("pInfo" ::: Ptr DeviceMemoryOpaqueCaptureAddressInfo
p ("pInfo" ::: Ptr DeviceMemoryOpaqueCaptureAddressInfo)
-> Int -> Ptr DeviceMemory
forall a b. Ptr a -> Int -> Ptr b
`plusPtr` 16 :: Ptr DeviceMemory)) (DeviceMemory
memory)
    IO b
f
  cStructSize :: Int
cStructSize = 24
  cStructAlignment :: Int
cStructAlignment = 8
  pokeZeroCStruct :: ("pInfo" ::: Ptr DeviceMemoryOpaqueCaptureAddressInfo)
-> IO b -> IO b
pokeZeroCStruct p :: "pInfo" ::: Ptr DeviceMemoryOpaqueCaptureAddressInfo
p f :: IO b
f = do
    Ptr StructureType -> StructureType -> IO ()
forall a. Storable a => Ptr a -> a -> IO ()
poke (("pInfo" ::: Ptr DeviceMemoryOpaqueCaptureAddressInfo
p ("pInfo" ::: Ptr DeviceMemoryOpaqueCaptureAddressInfo)
-> Int -> Ptr StructureType
forall a b. Ptr a -> Int -> Ptr b
`plusPtr` 0 :: Ptr StructureType)) (StructureType
STRUCTURE_TYPE_DEVICE_MEMORY_OPAQUE_CAPTURE_ADDRESS_INFO)
    Ptr (Ptr ()) -> Ptr () -> IO ()
forall a. Storable a => Ptr a -> a -> IO ()
poke (("pInfo" ::: Ptr DeviceMemoryOpaqueCaptureAddressInfo
p ("pInfo" ::: Ptr DeviceMemoryOpaqueCaptureAddressInfo)
-> Int -> Ptr (Ptr ())
forall a b. Ptr a -> Int -> Ptr b
`plusPtr` 8 :: Ptr (Ptr ()))) (Ptr ()
forall a. Ptr a
nullPtr)
    Ptr DeviceMemory -> DeviceMemory -> IO ()
forall a. Storable a => Ptr a -> a -> IO ()
poke (("pInfo" ::: Ptr DeviceMemoryOpaqueCaptureAddressInfo
p ("pInfo" ::: Ptr DeviceMemoryOpaqueCaptureAddressInfo)
-> Int -> Ptr DeviceMemory
forall a b. Ptr a -> Int -> Ptr b
`plusPtr` 16 :: Ptr DeviceMemory)) (DeviceMemory
forall a. Zero a => a
zero)
    IO b
f

instance FromCStruct DeviceMemoryOpaqueCaptureAddressInfo where
  peekCStruct :: ("pInfo" ::: Ptr DeviceMemoryOpaqueCaptureAddressInfo)
-> IO DeviceMemoryOpaqueCaptureAddressInfo
peekCStruct p :: "pInfo" ::: Ptr DeviceMemoryOpaqueCaptureAddressInfo
p = do
    DeviceMemory
memory <- Ptr DeviceMemory -> IO DeviceMemory
forall a. Storable a => Ptr a -> IO a
peek @DeviceMemory (("pInfo" ::: Ptr DeviceMemoryOpaqueCaptureAddressInfo
p ("pInfo" ::: Ptr DeviceMemoryOpaqueCaptureAddressInfo)
-> Int -> Ptr DeviceMemory
forall a b. Ptr a -> Int -> Ptr b
`plusPtr` 16 :: Ptr DeviceMemory))
    DeviceMemoryOpaqueCaptureAddressInfo
-> IO DeviceMemoryOpaqueCaptureAddressInfo
forall (f :: * -> *) a. Applicative f => a -> f a
pure (DeviceMemoryOpaqueCaptureAddressInfo
 -> IO DeviceMemoryOpaqueCaptureAddressInfo)
-> DeviceMemoryOpaqueCaptureAddressInfo
-> IO DeviceMemoryOpaqueCaptureAddressInfo
forall a b. (a -> b) -> a -> b
$ DeviceMemory -> DeviceMemoryOpaqueCaptureAddressInfo
DeviceMemoryOpaqueCaptureAddressInfo
             DeviceMemory
memory

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

instance Zero DeviceMemoryOpaqueCaptureAddressInfo where
  zero :: DeviceMemoryOpaqueCaptureAddressInfo
zero = DeviceMemory -> DeviceMemoryOpaqueCaptureAddressInfo
DeviceMemoryOpaqueCaptureAddressInfo
           DeviceMemory
forall a. Zero a => a
zero