{-# language CPP #-}
-- | = Name
--
-- VK_EXT_pipeline_library_group_handles - device extension
--
-- == VK_EXT_pipeline_library_group_handles
--
-- [__Name String__]
--     @VK_EXT_pipeline_library_group_handles@
--
-- [__Extension Type__]
--     Device extension
--
-- [__Registered Extension Number__]
--     499
--
-- [__Revision__]
--     1
--
-- [__Ratification Status__]
--     Not ratified
--
-- [__Extension and Version Dependencies__]
--     <https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#VK_KHR_ray_tracing_pipeline VK_KHR_ray_tracing_pipeline>
--     and
--     <https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#VK_KHR_pipeline_library VK_KHR_pipeline_library>
--
-- [__Contact__]
--
--     -   Hans-Kristian Arntzen
--         <https://github.com/KhronosGroup/Vulkan-Docs/issues/new?body=[VK_EXT_pipeline_library_group_handles] @HansKristian-Work%0A*Here describe the issue or question you have about the VK_EXT_pipeline_library_group_handles extension* >
--
-- [__Extension Proposal__]
--     <https://github.com/KhronosGroup/Vulkan-Docs/tree/main/proposals/VK_EXT_pipeline_library_group_handles.adoc VK_EXT_pipeline_library_group_handles>
--
-- == Other Extension Metadata
--
-- [__Last Modified Date__]
--     2023-01-25
--
-- [__IP Status__]
--     No known IP claims.
--
-- [__Contributors__]
--
--     -   Hans-Kristian Arntzen, Valve
--
--     -   Stuart Smith, AMD
--
--     -   Ricardo Garcia, Igalia
--
--     -   Lionel Landwerlin, Intel
--
--     -   Eric Werness, NVIDIA
--
--     -   Daniel Koch, NVIDIA
--
-- == Description
--
-- When using pipeline libraries in ray tracing pipelines, a library might
-- get linked into different pipelines in an incremental way. An
-- application can have a strategy where a ray tracing pipeline is
-- comprised of N pipeline libraries and is later augumented by creating a
-- new pipeline with N + 1 libraries. Without this extension, all group
-- handles must be re-queried as the group handle is tied to the pipeline,
-- not the library. This is problematic for applications which aim to
-- decouple construction of record buffers and the linkage of ray tracing
-- pipelines.
--
-- To aid in this, this extension enables support for querying group
-- handles directly from pipeline libraries. Group handles obtained from a
-- library /must/ remain bitwise identical in any
-- 'Vulkan.Core10.Handles.Pipeline' that links to the library.
--
-- With this feature, the extension also improves compatibility with DXR
-- 1.1 AddToStateObject(), which guarantees that group handles returned
-- remain bitwise identical between parent and child pipelines. In
-- addition, querying group handles from COLLECTION objects is also
-- supported with that API.
--
-- == New Structures
--
-- -   Extending
--     'Vulkan.Core11.Promoted_From_VK_KHR_get_physical_device_properties2.PhysicalDeviceFeatures2',
--     'Vulkan.Core10.Device.DeviceCreateInfo':
--
--     -   'PhysicalDevicePipelineLibraryGroupHandlesFeaturesEXT'
--
-- == New Enum Constants
--
-- -   'EXT_PIPELINE_LIBRARY_GROUP_HANDLES_EXTENSION_NAME'
--
-- -   'EXT_PIPELINE_LIBRARY_GROUP_HANDLES_SPEC_VERSION'
--
-- -   Extending 'Vulkan.Core10.Enums.StructureType.StructureType':
--
--     -   'Vulkan.Core10.Enums.StructureType.STRUCTURE_TYPE_PHYSICAL_DEVICE_PIPELINE_LIBRARY_GROUP_HANDLES_FEATURES_EXT'
--
-- == Version History
--
-- -   Revision 1, 2023-01-25 (Hans-Kristian Arntzen)
--
--     -   Initial draft
--
-- == See Also
--
-- 'PhysicalDevicePipelineLibraryGroupHandlesFeaturesEXT'
--
-- == Document Notes
--
-- For more information, see the
-- <https://registry.khronos.org/vulkan/specs/1.3-extensions/html/vkspec.html#VK_EXT_pipeline_library_group_handles Vulkan Specification>
--
-- This page is a generated document. Fixes and changes should be made to
-- the generator scripts, not directly.
module Vulkan.Extensions.VK_EXT_pipeline_library_group_handles  ( PhysicalDevicePipelineLibraryGroupHandlesFeaturesEXT(..)
                                                                , EXT_PIPELINE_LIBRARY_GROUP_HANDLES_SPEC_VERSION
                                                                , pattern EXT_PIPELINE_LIBRARY_GROUP_HANDLES_SPEC_VERSION
                                                                , EXT_PIPELINE_LIBRARY_GROUP_HANDLES_EXTENSION_NAME
                                                                , pattern EXT_PIPELINE_LIBRARY_GROUP_HANDLES_EXTENSION_NAME
                                                                ) where

import Foreign.Marshal.Alloc (allocaBytes)
import Foreign.Ptr (nullPtr)
import Foreign.Ptr (plusPtr)
import Vulkan.CStruct (FromCStruct)
import Vulkan.CStruct (FromCStruct(..))
import Vulkan.CStruct (ToCStruct)
import Vulkan.CStruct (ToCStruct(..))
import Vulkan.Zero (Zero(..))
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 Foreign.Ptr (Ptr)
import Data.Kind (Type)
import Vulkan.Core10.FundamentalTypes (bool32ToBool)
import Vulkan.Core10.FundamentalTypes (boolToBool32)
import Vulkan.Core10.FundamentalTypes (Bool32)
import Vulkan.Core10.Enums.StructureType (StructureType)
import Vulkan.Core10.Enums.StructureType (StructureType(STRUCTURE_TYPE_PHYSICAL_DEVICE_PIPELINE_LIBRARY_GROUP_HANDLES_FEATURES_EXT))
-- | VkPhysicalDevicePipelineLibraryGroupHandlesFeaturesEXT - Structure
-- describing whether querying shader group handles from a pipeline library
-- is supported by the implementation
--
-- = Members
--
-- This structure describes the following features:
--
-- = Description
--
-- If the 'PhysicalDevicePipelineLibraryGroupHandlesFeaturesEXT' structure
-- is included in the @pNext@ chain of the
-- 'Vulkan.Core11.Promoted_From_VK_KHR_get_physical_device_properties2.PhysicalDeviceFeatures2'
-- structure passed to
-- 'Vulkan.Core11.Promoted_From_VK_KHR_get_physical_device_properties2.getPhysicalDeviceFeatures2',
-- it is filled in to indicate whether each corresponding feature is
-- supported. 'PhysicalDevicePipelineLibraryGroupHandlesFeaturesEXT' /can/
-- also be used in the @pNext@ chain of
-- 'Vulkan.Core10.Device.DeviceCreateInfo' to selectively enable these
-- features.
--
-- == Valid Usage (Implicit)
--
-- = See Also
--
-- <https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#VK_EXT_pipeline_library_group_handles VK_EXT_pipeline_library_group_handles>,
-- 'Vulkan.Core10.FundamentalTypes.Bool32',
-- 'Vulkan.Core10.Enums.StructureType.StructureType'
data PhysicalDevicePipelineLibraryGroupHandlesFeaturesEXT = PhysicalDevicePipelineLibraryGroupHandlesFeaturesEXT
  { -- | #features-pipelineLibraryGroupHandles# @pipelineLibraryGroupHandles@
    -- indicates whether the implementation supports querying group handles
    -- directly from a ray tracing pipeline library, and guarantees bitwise
    -- identical group handles for such libraries when linked into other
    -- pipelines.
    PhysicalDevicePipelineLibraryGroupHandlesFeaturesEXT -> Bool
pipelineLibraryGroupHandles :: Bool }
  deriving (Typeable, PhysicalDevicePipelineLibraryGroupHandlesFeaturesEXT
-> PhysicalDevicePipelineLibraryGroupHandlesFeaturesEXT -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: PhysicalDevicePipelineLibraryGroupHandlesFeaturesEXT
-> PhysicalDevicePipelineLibraryGroupHandlesFeaturesEXT -> Bool
$c/= :: PhysicalDevicePipelineLibraryGroupHandlesFeaturesEXT
-> PhysicalDevicePipelineLibraryGroupHandlesFeaturesEXT -> Bool
== :: PhysicalDevicePipelineLibraryGroupHandlesFeaturesEXT
-> PhysicalDevicePipelineLibraryGroupHandlesFeaturesEXT -> Bool
$c== :: PhysicalDevicePipelineLibraryGroupHandlesFeaturesEXT
-> PhysicalDevicePipelineLibraryGroupHandlesFeaturesEXT -> Bool
Eq)
#if defined(GENERIC_INSTANCES)
deriving instance Generic (PhysicalDevicePipelineLibraryGroupHandlesFeaturesEXT)
#endif
deriving instance Show PhysicalDevicePipelineLibraryGroupHandlesFeaturesEXT

instance ToCStruct PhysicalDevicePipelineLibraryGroupHandlesFeaturesEXT where
  withCStruct :: forall b.
PhysicalDevicePipelineLibraryGroupHandlesFeaturesEXT
-> (Ptr PhysicalDevicePipelineLibraryGroupHandlesFeaturesEXT
    -> IO b)
-> IO b
withCStruct PhysicalDevicePipelineLibraryGroupHandlesFeaturesEXT
x Ptr PhysicalDevicePipelineLibraryGroupHandlesFeaturesEXT -> IO b
f = forall a b. Int -> (Ptr a -> IO b) -> IO b
allocaBytes Int
24 forall a b. (a -> b) -> a -> b
$ \Ptr PhysicalDevicePipelineLibraryGroupHandlesFeaturesEXT
p -> forall a b. ToCStruct a => Ptr a -> a -> IO b -> IO b
pokeCStruct Ptr PhysicalDevicePipelineLibraryGroupHandlesFeaturesEXT
p PhysicalDevicePipelineLibraryGroupHandlesFeaturesEXT
x (Ptr PhysicalDevicePipelineLibraryGroupHandlesFeaturesEXT -> IO b
f Ptr PhysicalDevicePipelineLibraryGroupHandlesFeaturesEXT
p)
  pokeCStruct :: forall b.
Ptr PhysicalDevicePipelineLibraryGroupHandlesFeaturesEXT
-> PhysicalDevicePipelineLibraryGroupHandlesFeaturesEXT
-> IO b
-> IO b
pokeCStruct Ptr PhysicalDevicePipelineLibraryGroupHandlesFeaturesEXT
p PhysicalDevicePipelineLibraryGroupHandlesFeaturesEXT{Bool
pipelineLibraryGroupHandles :: Bool
$sel:pipelineLibraryGroupHandles:PhysicalDevicePipelineLibraryGroupHandlesFeaturesEXT :: PhysicalDevicePipelineLibraryGroupHandlesFeaturesEXT -> Bool
..} IO b
f = do
    forall a. Storable a => Ptr a -> a -> IO ()
poke ((Ptr PhysicalDevicePipelineLibraryGroupHandlesFeaturesEXT
p forall a b. Ptr a -> Int -> Ptr b
`plusPtr` Int
0 :: Ptr StructureType)) (StructureType
STRUCTURE_TYPE_PHYSICAL_DEVICE_PIPELINE_LIBRARY_GROUP_HANDLES_FEATURES_EXT)
    forall a. Storable a => Ptr a -> a -> IO ()
poke ((Ptr PhysicalDevicePipelineLibraryGroupHandlesFeaturesEXT
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 PhysicalDevicePipelineLibraryGroupHandlesFeaturesEXT
p forall a b. Ptr a -> Int -> Ptr b
`plusPtr` Int
16 :: Ptr Bool32)) (Bool -> Bool32
boolToBool32 (Bool
pipelineLibraryGroupHandles))
    IO b
f
  cStructSize :: Int
cStructSize = Int
24
  cStructAlignment :: Int
cStructAlignment = Int
8
  pokeZeroCStruct :: forall b.
Ptr PhysicalDevicePipelineLibraryGroupHandlesFeaturesEXT
-> IO b -> IO b
pokeZeroCStruct Ptr PhysicalDevicePipelineLibraryGroupHandlesFeaturesEXT
p IO b
f = do
    forall a. Storable a => Ptr a -> a -> IO ()
poke ((Ptr PhysicalDevicePipelineLibraryGroupHandlesFeaturesEXT
p forall a b. Ptr a -> Int -> Ptr b
`plusPtr` Int
0 :: Ptr StructureType)) (StructureType
STRUCTURE_TYPE_PHYSICAL_DEVICE_PIPELINE_LIBRARY_GROUP_HANDLES_FEATURES_EXT)
    forall a. Storable a => Ptr a -> a -> IO ()
poke ((Ptr PhysicalDevicePipelineLibraryGroupHandlesFeaturesEXT
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 PhysicalDevicePipelineLibraryGroupHandlesFeaturesEXT
p forall a b. Ptr a -> Int -> Ptr b
`plusPtr` Int
16 :: Ptr Bool32)) (Bool -> Bool32
boolToBool32 (forall a. Zero a => a
zero))
    IO b
f

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

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

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


type EXT_PIPELINE_LIBRARY_GROUP_HANDLES_SPEC_VERSION = 1

-- No documentation found for TopLevel "VK_EXT_PIPELINE_LIBRARY_GROUP_HANDLES_SPEC_VERSION"
pattern EXT_PIPELINE_LIBRARY_GROUP_HANDLES_SPEC_VERSION :: forall a . Integral a => a
pattern $bEXT_PIPELINE_LIBRARY_GROUP_HANDLES_SPEC_VERSION :: forall a. Integral a => a
$mEXT_PIPELINE_LIBRARY_GROUP_HANDLES_SPEC_VERSION :: forall {r} {a}.
Integral a =>
a -> ((# #) -> r) -> ((# #) -> r) -> r
EXT_PIPELINE_LIBRARY_GROUP_HANDLES_SPEC_VERSION = 1


type EXT_PIPELINE_LIBRARY_GROUP_HANDLES_EXTENSION_NAME = "VK_EXT_pipeline_library_group_handles"

-- No documentation found for TopLevel "VK_EXT_PIPELINE_LIBRARY_GROUP_HANDLES_EXTENSION_NAME"
pattern EXT_PIPELINE_LIBRARY_GROUP_HANDLES_EXTENSION_NAME :: forall a . (Eq a, IsString a) => a
pattern $bEXT_PIPELINE_LIBRARY_GROUP_HANDLES_EXTENSION_NAME :: forall a. (Eq a, IsString a) => a
$mEXT_PIPELINE_LIBRARY_GROUP_HANDLES_EXTENSION_NAME :: forall {r} {a}.
(Eq a, IsString a) =>
a -> ((# #) -> r) -> ((# #) -> r) -> r
EXT_PIPELINE_LIBRARY_GROUP_HANDLES_EXTENSION_NAME = "VK_EXT_pipeline_library_group_handles"