{-# language CPP #-}
-- | = Name
--
-- VK_KHR_ray_tracing_position_fetch - device extension
--
-- == VK_KHR_ray_tracing_position_fetch
--
-- [__Name String__]
--     @VK_KHR_ray_tracing_position_fetch@
--
-- [__Extension Type__]
--     Device extension
--
-- [__Registered Extension Number__]
--     482
--
-- [__Revision__]
--     1
--
-- [__Ratification Status__]
--     Ratified
--
-- [__Extension and Version Dependencies__]
--     <https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#VK_KHR_acceleration_structure VK_KHR_acceleration_structure>
--
-- [__SPIR-V Dependencies__]
--
--     -   <https://htmlpreview.github.io/?https://github.com/KhronosGroup/SPIRV-Registry/blob/master/extensions/KHR/SPV_KHR_ray_tracing_position_fetch.html SPV_KHR_ray_tracing_position_fetch>
--
-- [__Contact__]
--
--     -   Eric Werness
--
-- [__Extension Proposal__]
--     <https://github.com/KhronosGroup/Vulkan-Docs/tree/main/proposals/VK_KHR_ray_tracing_position_fetch.adoc VK_KHR_ray_tracing_position_fetch>
--
-- == Other Extension Metadata
--
-- [__Last Modified Date__]
--     2023-02-17
--
-- [__Interactions and External Dependencies__]
--
--     -   This extension provides API support for
--         <https://github.com/KhronosGroup/GLSL/blob/master/extensions/ext/GLSL_EXT_ray_tracing_position_fetch.txt GLSL_EXT_ray_tracing_position_fetch>
--
--     -   Interacts with @VK_KHR_ray_tracing_pipeline@
--
--     -   Interacts with @VK_KHR_ray_query@
--
-- [__Contributors__]
--
--     -   Eric Werness, NVIDIA
--
--     -   Stu Smith, AMD
--
--     -   Yuriy O’Donnell, Epic Games
--
--     -   Ralph Potter, Samsung
--
--     -   Joshua Barczak, Intel
--
--     -   Lionel Landwerlin, Intel
--
--     -   Andrew Garrard, Imagination Technologies
--
--     -   Alex Bourd, Qualcomm
--
--     -   Yunpeng Zhu, Huawei Technologies
--
--     -   Marius Bjorge, Arm
--
--     -   Daniel Koch, NVIDIA
--
-- == Description
--
-- @VK_KHR_ray_tracing_position_fetch@ adds the ability to fetch the vertex
-- positions in the shader from a hit triangle as stored in the
-- acceleration structure.
--
-- An application adds
-- 'Vulkan.Extensions.VK_KHR_acceleration_structure.BUILD_ACCELERATION_STRUCTURE_ALLOW_DATA_ACCESS_KHR'
-- to the acceleration structure at build time. Then, if the hit is a
-- triangle geometry, the shader (any-hit or closest hit for ray pipelines
-- or using ray query) /can/ fetch the three, three-component vertex
-- positions in object space, of the triangle which was hit.
--
-- == New Structures
--
-- -   Extending
--     'Vulkan.Core11.Promoted_From_VK_KHR_get_physical_device_properties2.PhysicalDeviceFeatures2',
--     'Vulkan.Core10.Device.DeviceCreateInfo':
--
--     -   'PhysicalDeviceRayTracingPositionFetchFeaturesKHR'
--
-- == New Enum Constants
--
-- -   'KHR_RAY_TRACING_POSITION_FETCH_EXTENSION_NAME'
--
-- -   'KHR_RAY_TRACING_POSITION_FETCH_SPEC_VERSION'
--
-- -   Extending
--     'Vulkan.Extensions.VK_KHR_acceleration_structure.BuildAccelerationStructureFlagBitsKHR':
--
--     -   'Vulkan.Extensions.VK_KHR_acceleration_structure.BUILD_ACCELERATION_STRUCTURE_ALLOW_DATA_ACCESS_KHR'
--
-- -   Extending 'Vulkan.Core10.Enums.StructureType.StructureType':
--
--     -   'Vulkan.Core10.Enums.StructureType.STRUCTURE_TYPE_PHYSICAL_DEVICE_RAY_TRACING_POSITION_FETCH_FEATURES_KHR'
--
-- == New Built-In Variables
--
-- -   <https://registry.khronos.org/vulkan/specs/1.3-extensions/html/vkspec.html#interfaces-builtin-variables-hittrianglevertexpositions HitTriangleVertexPositionsKHR>
--
-- == New SPIR-V Capabilities
--
-- -   <https://registry.khronos.org/vulkan/specs/1.3-extensions/html/vkspec.html#spirvenv-capabilities-table-RayTracingPositionFetchKHR RayTracingPositionFetchKHR>
--
-- == Issues
--
-- None Yet!
--
-- == Version History
--
-- -   Revision 1, 2023-02-17 (Eric Werness)
--
--     -   internal revisions
--
-- == See Also
--
-- 'PhysicalDeviceRayTracingPositionFetchFeaturesKHR'
--
-- == Document Notes
--
-- For more information, see the
-- <https://registry.khronos.org/vulkan/specs/1.3-extensions/html/vkspec.html#VK_KHR_ray_tracing_position_fetch Vulkan Specification>
--
-- This page is a generated document. Fixes and changes should be made to
-- the generator scripts, not directly.
module Vulkan.Extensions.VK_KHR_ray_tracing_position_fetch  ( PhysicalDeviceRayTracingPositionFetchFeaturesKHR(..)
                                                            , KHR_RAY_TRACING_POSITION_FETCH_SPEC_VERSION
                                                            , pattern KHR_RAY_TRACING_POSITION_FETCH_SPEC_VERSION
                                                            , KHR_RAY_TRACING_POSITION_FETCH_EXTENSION_NAME
                                                            , pattern KHR_RAY_TRACING_POSITION_FETCH_EXTENSION_NAME
                                                            , BuildAccelerationStructureFlagBitsKHR(..)
                                                            , BuildAccelerationStructureFlagsKHR
                                                            ) 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_RAY_TRACING_POSITION_FETCH_FEATURES_KHR))
import Vulkan.Extensions.VK_KHR_acceleration_structure (BuildAccelerationStructureFlagBitsKHR(..))
import Vulkan.Extensions.VK_KHR_acceleration_structure (BuildAccelerationStructureFlagsKHR)
-- | VkPhysicalDeviceRayTracingPositionFetchFeaturesKHR - Structure
-- describing support for fetching vertex positions of hit triangles
--
-- = Members
--
-- This structure describes the following feature:
--
-- = Description
--
-- If the 'PhysicalDeviceRayTracingPositionFetchFeaturesKHR' 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. 'PhysicalDeviceRayTracingPositionFetchFeaturesKHR' /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_KHR_ray_tracing_position_fetch VK_KHR_ray_tracing_position_fetch>,
-- 'Vulkan.Core10.FundamentalTypes.Bool32',
-- 'Vulkan.Core10.Enums.StructureType.StructureType'
data PhysicalDeviceRayTracingPositionFetchFeaturesKHR = PhysicalDeviceRayTracingPositionFetchFeaturesKHR
  { -- | #features-rayTracingPositionFetch# @rayTracingPositionFetch@ indicates
    -- that the implementation supports fetching the object space vertex
    -- positions of a hit triangle.
    PhysicalDeviceRayTracingPositionFetchFeaturesKHR -> Bool
rayTracingPositionFetch :: Bool }
  deriving (Typeable, PhysicalDeviceRayTracingPositionFetchFeaturesKHR
-> PhysicalDeviceRayTracingPositionFetchFeaturesKHR -> Bool
(PhysicalDeviceRayTracingPositionFetchFeaturesKHR
 -> PhysicalDeviceRayTracingPositionFetchFeaturesKHR -> Bool)
-> (PhysicalDeviceRayTracingPositionFetchFeaturesKHR
    -> PhysicalDeviceRayTracingPositionFetchFeaturesKHR -> Bool)
-> Eq PhysicalDeviceRayTracingPositionFetchFeaturesKHR
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
$c== :: PhysicalDeviceRayTracingPositionFetchFeaturesKHR
-> PhysicalDeviceRayTracingPositionFetchFeaturesKHR -> Bool
== :: PhysicalDeviceRayTracingPositionFetchFeaturesKHR
-> PhysicalDeviceRayTracingPositionFetchFeaturesKHR -> Bool
$c/= :: PhysicalDeviceRayTracingPositionFetchFeaturesKHR
-> PhysicalDeviceRayTracingPositionFetchFeaturesKHR -> Bool
/= :: PhysicalDeviceRayTracingPositionFetchFeaturesKHR
-> PhysicalDeviceRayTracingPositionFetchFeaturesKHR -> Bool
Eq)
#if defined(GENERIC_INSTANCES)
deriving instance Generic (PhysicalDeviceRayTracingPositionFetchFeaturesKHR)
#endif
deriving instance Show PhysicalDeviceRayTracingPositionFetchFeaturesKHR

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

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

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

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


type KHR_RAY_TRACING_POSITION_FETCH_SPEC_VERSION = 1

-- No documentation found for TopLevel "VK_KHR_RAY_TRACING_POSITION_FETCH_SPEC_VERSION"
pattern KHR_RAY_TRACING_POSITION_FETCH_SPEC_VERSION :: forall a . Integral a => a
pattern $bKHR_RAY_TRACING_POSITION_FETCH_SPEC_VERSION :: forall a. Integral a => a
$mKHR_RAY_TRACING_POSITION_FETCH_SPEC_VERSION :: forall {r} {a}.
Integral a =>
a -> ((# #) -> r) -> ((# #) -> r) -> r
KHR_RAY_TRACING_POSITION_FETCH_SPEC_VERSION = 1


type KHR_RAY_TRACING_POSITION_FETCH_EXTENSION_NAME = "VK_KHR_ray_tracing_position_fetch"

-- No documentation found for TopLevel "VK_KHR_RAY_TRACING_POSITION_FETCH_EXTENSION_NAME"
pattern KHR_RAY_TRACING_POSITION_FETCH_EXTENSION_NAME :: forall a . (Eq a, IsString a) => a
pattern $bKHR_RAY_TRACING_POSITION_FETCH_EXTENSION_NAME :: forall a. (Eq a, IsString a) => a
$mKHR_RAY_TRACING_POSITION_FETCH_EXTENSION_NAME :: forall {r} {a}.
(Eq a, IsString a) =>
a -> ((# #) -> r) -> ((# #) -> r) -> r
KHR_RAY_TRACING_POSITION_FETCH_EXTENSION_NAME = "VK_KHR_ray_tracing_position_fetch"