{-# 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__] -- -- and -- -- -- [__Contact__] -- -- - Hans-Kristian Arntzen -- -- -- [__Extension Proposal__] -- -- -- == 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 -- -- -- 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 -- -- , -- '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. pipelineLibraryGroupHandles :: Bool } deriving (Typeable, Eq) #if defined(GENERIC_INSTANCES) deriving instance Generic (PhysicalDevicePipelineLibraryGroupHandlesFeaturesEXT) #endif deriving instance Show PhysicalDevicePipelineLibraryGroupHandlesFeaturesEXT instance ToCStruct PhysicalDevicePipelineLibraryGroupHandlesFeaturesEXT where withCStruct x f = allocaBytes 24 $ \p -> pokeCStruct p x (f p) pokeCStruct p PhysicalDevicePipelineLibraryGroupHandlesFeaturesEXT{..} f = do poke ((p `plusPtr` 0 :: Ptr StructureType)) (STRUCTURE_TYPE_PHYSICAL_DEVICE_PIPELINE_LIBRARY_GROUP_HANDLES_FEATURES_EXT) poke ((p `plusPtr` 8 :: Ptr (Ptr ()))) (nullPtr) poke ((p `plusPtr` 16 :: Ptr Bool32)) (boolToBool32 (pipelineLibraryGroupHandles)) f cStructSize = 24 cStructAlignment = 8 pokeZeroCStruct p f = do poke ((p `plusPtr` 0 :: Ptr StructureType)) (STRUCTURE_TYPE_PHYSICAL_DEVICE_PIPELINE_LIBRARY_GROUP_HANDLES_FEATURES_EXT) poke ((p `plusPtr` 8 :: Ptr (Ptr ()))) (nullPtr) poke ((p `plusPtr` 16 :: Ptr Bool32)) (boolToBool32 (zero)) f instance FromCStruct PhysicalDevicePipelineLibraryGroupHandlesFeaturesEXT where peekCStruct p = do pipelineLibraryGroupHandles <- peek @Bool32 ((p `plusPtr` 16 :: Ptr Bool32)) pure $ PhysicalDevicePipelineLibraryGroupHandlesFeaturesEXT (bool32ToBool pipelineLibraryGroupHandles) instance Storable PhysicalDevicePipelineLibraryGroupHandlesFeaturesEXT where sizeOf ~_ = 24 alignment ~_ = 8 peek = peekCStruct poke ptr poked = pokeCStruct ptr poked (pure ()) instance Zero PhysicalDevicePipelineLibraryGroupHandlesFeaturesEXT where zero = PhysicalDevicePipelineLibraryGroupHandlesFeaturesEXT 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 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 EXT_PIPELINE_LIBRARY_GROUP_HANDLES_EXTENSION_NAME = "VK_EXT_pipeline_library_group_handles"