{-# language CPP #-}
-- | = Name
--
-- VK_KHR_shader_quad_control - device extension
--
-- = VK_KHR_shader_quad_control
--
-- [__Name String__]
--     @VK_KHR_shader_quad_control@
--
-- [__Extension Type__]
--     Device extension
--
-- [__Registered Extension Number__]
--     236
--
-- [__Revision__]
--     1
--
-- [__Ratification Status__]
--     Ratified
--
-- [__Extension and Version Dependencies__]
--             
--     <https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#versions-1.1 Vulkan Version 1.1>
--              and
--             
--     <https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#VK_KHR_vulkan_memory_model VK_KHR_vulkan_memory_model>
--          or
--         
--     <https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#versions-1.2 Vulkan Version 1.2>
--     and
--     <https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#VK_KHR_shader_maximal_reconvergence VK_KHR_shader_maximal_reconvergence>
--
-- [__SPIR-V Dependencies__]
--
--     -   <https://htmlpreview.github.io/?https://github.com/KhronosGroup/SPIRV-Registry/blob/master/extensions/KHR/SPV_KHR_quad_control.html SPV_KHR_quad_control>
--
-- [__Contact__]
--
--     -   Tobias Hector
--         <https://github.com/KhronosGroup/Vulkan-Docs/issues/new?body=[VK_KHR_shader_quad_control] @tobski%0A*Here describe the issue or question you have about the VK_KHR_shader_quad_control extension* >
--
-- [__Extension Proposal__]
--     <https://github.com/KhronosGroup/Vulkan-Docs/tree/main/proposals/VK_KHR_shader_quad_control.adoc VK_KHR_shader_quad_control>
--
-- == Other Extension Metadata
--
-- [__Last Modified Date__]
--     2023-11-01
--
-- [__IP Status__]
--     No known IP claims.
--
-- [__Contributors__]
--
--     -   Tobias Hector, AMD
--
--     -   Bill Licea-Kane, Qualcomm
--
--     -   Graeme Leese, Broadcom
--
--     -   Jan-Harald Fredriksen, Arm
--
--     -   Nicolai Hähnle, AMD
--
--     -   Jeff Bolz, NVidia
--
--     -   Alan Baker, Google
--
--     -   Hans-Kristian Arntzen, Valve
--
-- == Description
--
-- This extension adds new quad any\/all operations, requires that
-- derivatives are well-defined in quad-uniform control flow, and adds the
-- ability to require helper invocations participate in group operations.
--
-- == New Structures
--
-- -   Extending
--     'Vulkan.Core11.Promoted_From_VK_KHR_get_physical_device_properties2.PhysicalDeviceFeatures2',
--     'Vulkan.Core10.Device.DeviceCreateInfo':
--
--     -   'PhysicalDeviceShaderQuadControlFeaturesKHR'
--
-- == New Enum Constants
--
-- -   'KHR_SHADER_QUAD_CONTROL_EXTENSION_NAME'
--
-- -   'KHR_SHADER_QUAD_CONTROL_SPEC_VERSION'
--
-- -   Extending 'Vulkan.Core10.Enums.StructureType.StructureType':
--
--     -   'Vulkan.Core10.Enums.StructureType.STRUCTURE_TYPE_PHYSICAL_DEVICE_SHADER_QUAD_CONTROL_FEATURES_KHR'
--
-- == New SPIR-V Capabilities
--
-- -   <https://registry.khronos.org/vulkan/specs/latest/html/vkspec.html#spirvenv-capabilities-table-QuadControlKHR QuadControlKHR>
--
-- == Version History
--
-- -   Revision 1, 2023-11-01 (Tobias Hector)
--
--     -   Initial draft
--
-- == See Also
--
-- No cross-references are available
--
-- == Document Notes
--
-- For more information, see the
-- <https://registry.khronos.org/vulkan/specs/latest/html/vkspec.html#VK_KHR_shader_quad_control 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_shader_quad_control  ( PhysicalDeviceShaderQuadControlFeaturesKHR(..)
                                                     , KHR_SHADER_QUAD_CONTROL_SPEC_VERSION
                                                     , pattern KHR_SHADER_QUAD_CONTROL_SPEC_VERSION
                                                     , KHR_SHADER_QUAD_CONTROL_EXTENSION_NAME
                                                     , pattern KHR_SHADER_QUAD_CONTROL_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_SHADER_QUAD_CONTROL_FEATURES_KHR))
-- | VkPhysicalDeviceShaderQuadControlFeaturesKHR - Structure describing
-- whether quad scopes are supported by the implementation
--
-- = Members
--
-- This structure describes the following features:
--
-- = Description
--
-- If the 'PhysicalDeviceShaderQuadControlFeaturesKHR' 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. If the application wishes to use a
-- 'Vulkan.Core10.Handles.Device' with any features described by
-- 'PhysicalDeviceShaderQuadControlFeaturesKHR', it /must/ add an instance
-- of the structure, with the desired feature members set to
-- 'Vulkan.Core10.FundamentalTypes.TRUE', to the @pNext@ chain of
-- 'Vulkan.Core10.Device.DeviceCreateInfo' when creating the
-- 'Vulkan.Core10.Handles.Device'.
--
-- == Valid Usage (Implicit)
--
-- = See Also
--
-- <https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#VK_KHR_shader_quad_control VK_KHR_shader_quad_control>,
-- 'Vulkan.Core10.FundamentalTypes.Bool32',
-- 'Vulkan.Core10.Enums.StructureType.StructureType'
data PhysicalDeviceShaderQuadControlFeaturesKHR = PhysicalDeviceShaderQuadControlFeaturesKHR
  { -- | #features-shaderQuadControl# @shaderQuadControl@ indicates whether the
    -- implementation supports shaders with the @QuadControlKHR@ capability.
    PhysicalDeviceShaderQuadControlFeaturesKHR -> Bool
shaderQuadControl :: Bool }
  deriving (Typeable, PhysicalDeviceShaderQuadControlFeaturesKHR
-> PhysicalDeviceShaderQuadControlFeaturesKHR -> Bool
(PhysicalDeviceShaderQuadControlFeaturesKHR
 -> PhysicalDeviceShaderQuadControlFeaturesKHR -> Bool)
-> (PhysicalDeviceShaderQuadControlFeaturesKHR
    -> PhysicalDeviceShaderQuadControlFeaturesKHR -> Bool)
-> Eq PhysicalDeviceShaderQuadControlFeaturesKHR
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
$c== :: PhysicalDeviceShaderQuadControlFeaturesKHR
-> PhysicalDeviceShaderQuadControlFeaturesKHR -> Bool
== :: PhysicalDeviceShaderQuadControlFeaturesKHR
-> PhysicalDeviceShaderQuadControlFeaturesKHR -> Bool
$c/= :: PhysicalDeviceShaderQuadControlFeaturesKHR
-> PhysicalDeviceShaderQuadControlFeaturesKHR -> Bool
/= :: PhysicalDeviceShaderQuadControlFeaturesKHR
-> PhysicalDeviceShaderQuadControlFeaturesKHR -> Bool
Eq)
#if defined(GENERIC_INSTANCES)
deriving instance Generic (PhysicalDeviceShaderQuadControlFeaturesKHR)
#endif
deriving instance Show PhysicalDeviceShaderQuadControlFeaturesKHR

instance ToCStruct PhysicalDeviceShaderQuadControlFeaturesKHR where
  withCStruct :: forall b.
PhysicalDeviceShaderQuadControlFeaturesKHR
-> (Ptr PhysicalDeviceShaderQuadControlFeaturesKHR -> IO b) -> IO b
withCStruct PhysicalDeviceShaderQuadControlFeaturesKHR
x Ptr PhysicalDeviceShaderQuadControlFeaturesKHR -> IO b
f = Int
-> (Ptr PhysicalDeviceShaderQuadControlFeaturesKHR -> IO b) -> IO b
forall a b. Int -> (Ptr a -> IO b) -> IO b
allocaBytes Int
24 ((Ptr PhysicalDeviceShaderQuadControlFeaturesKHR -> IO b) -> IO b)
-> (Ptr PhysicalDeviceShaderQuadControlFeaturesKHR -> IO b) -> IO b
forall a b. (a -> b) -> a -> b
$ \Ptr PhysicalDeviceShaderQuadControlFeaturesKHR
p -> Ptr PhysicalDeviceShaderQuadControlFeaturesKHR
-> PhysicalDeviceShaderQuadControlFeaturesKHR -> IO b -> IO b
forall b.
Ptr PhysicalDeviceShaderQuadControlFeaturesKHR
-> PhysicalDeviceShaderQuadControlFeaturesKHR -> IO b -> IO b
forall a b. ToCStruct a => Ptr a -> a -> IO b -> IO b
pokeCStruct Ptr PhysicalDeviceShaderQuadControlFeaturesKHR
p PhysicalDeviceShaderQuadControlFeaturesKHR
x (Ptr PhysicalDeviceShaderQuadControlFeaturesKHR -> IO b
f Ptr PhysicalDeviceShaderQuadControlFeaturesKHR
p)
  pokeCStruct :: forall b.
Ptr PhysicalDeviceShaderQuadControlFeaturesKHR
-> PhysicalDeviceShaderQuadControlFeaturesKHR -> IO b -> IO b
pokeCStruct Ptr PhysicalDeviceShaderQuadControlFeaturesKHR
p PhysicalDeviceShaderQuadControlFeaturesKHR{Bool
shaderQuadControl :: PhysicalDeviceShaderQuadControlFeaturesKHR -> Bool
shaderQuadControl :: Bool
..} IO b
f = do
    Ptr StructureType -> StructureType -> IO ()
forall a. Storable a => Ptr a -> a -> IO ()
poke ((Ptr PhysicalDeviceShaderQuadControlFeaturesKHR
p Ptr PhysicalDeviceShaderQuadControlFeaturesKHR
-> Int -> Ptr StructureType
forall a b. Ptr a -> Int -> Ptr b
`plusPtr` Int
0 :: Ptr StructureType)) (StructureType
STRUCTURE_TYPE_PHYSICAL_DEVICE_SHADER_QUAD_CONTROL_FEATURES_KHR)
    Ptr (Ptr ()) -> Ptr () -> IO ()
forall a. Storable a => Ptr a -> a -> IO ()
poke ((Ptr PhysicalDeviceShaderQuadControlFeaturesKHR
p Ptr PhysicalDeviceShaderQuadControlFeaturesKHR
-> 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 PhysicalDeviceShaderQuadControlFeaturesKHR
p Ptr PhysicalDeviceShaderQuadControlFeaturesKHR -> Int -> Ptr Bool32
forall a b. Ptr a -> Int -> Ptr b
`plusPtr` Int
16 :: Ptr Bool32)) (Bool -> Bool32
boolToBool32 (Bool
shaderQuadControl))
    IO b
f
  cStructSize :: Int
cStructSize = Int
24
  cStructAlignment :: Int
cStructAlignment = Int
8
  pokeZeroCStruct :: forall b.
Ptr PhysicalDeviceShaderQuadControlFeaturesKHR -> IO b -> IO b
pokeZeroCStruct Ptr PhysicalDeviceShaderQuadControlFeaturesKHR
p IO b
f = do
    Ptr StructureType -> StructureType -> IO ()
forall a. Storable a => Ptr a -> a -> IO ()
poke ((Ptr PhysicalDeviceShaderQuadControlFeaturesKHR
p Ptr PhysicalDeviceShaderQuadControlFeaturesKHR
-> Int -> Ptr StructureType
forall a b. Ptr a -> Int -> Ptr b
`plusPtr` Int
0 :: Ptr StructureType)) (StructureType
STRUCTURE_TYPE_PHYSICAL_DEVICE_SHADER_QUAD_CONTROL_FEATURES_KHR)
    Ptr (Ptr ()) -> Ptr () -> IO ()
forall a. Storable a => Ptr a -> a -> IO ()
poke ((Ptr PhysicalDeviceShaderQuadControlFeaturesKHR
p Ptr PhysicalDeviceShaderQuadControlFeaturesKHR
-> 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 PhysicalDeviceShaderQuadControlFeaturesKHR
p Ptr PhysicalDeviceShaderQuadControlFeaturesKHR -> 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 PhysicalDeviceShaderQuadControlFeaturesKHR where
  peekCStruct :: Ptr PhysicalDeviceShaderQuadControlFeaturesKHR
-> IO PhysicalDeviceShaderQuadControlFeaturesKHR
peekCStruct Ptr PhysicalDeviceShaderQuadControlFeaturesKHR
p = do
    shaderQuadControl <- forall a. Storable a => Ptr a -> IO a
peek @Bool32 ((Ptr PhysicalDeviceShaderQuadControlFeaturesKHR
p Ptr PhysicalDeviceShaderQuadControlFeaturesKHR -> Int -> Ptr Bool32
forall a b. Ptr a -> Int -> Ptr b
`plusPtr` Int
16 :: Ptr Bool32))
    pure $ PhysicalDeviceShaderQuadControlFeaturesKHR
             (bool32ToBool shaderQuadControl)

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

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


type KHR_SHADER_QUAD_CONTROL_SPEC_VERSION = 1

-- No documentation found for TopLevel "VK_KHR_SHADER_QUAD_CONTROL_SPEC_VERSION"
pattern KHR_SHADER_QUAD_CONTROL_SPEC_VERSION :: forall a . Integral a => a
pattern $mKHR_SHADER_QUAD_CONTROL_SPEC_VERSION :: forall {r} {a}.
Integral a =>
a -> ((# #) -> r) -> ((# #) -> r) -> r
$bKHR_SHADER_QUAD_CONTROL_SPEC_VERSION :: forall a. Integral a => a
KHR_SHADER_QUAD_CONTROL_SPEC_VERSION = 1


type KHR_SHADER_QUAD_CONTROL_EXTENSION_NAME = "VK_KHR_shader_quad_control"

-- No documentation found for TopLevel "VK_KHR_SHADER_QUAD_CONTROL_EXTENSION_NAME"
pattern KHR_SHADER_QUAD_CONTROL_EXTENSION_NAME :: forall a . (Eq a, IsString a) => a
pattern $mKHR_SHADER_QUAD_CONTROL_EXTENSION_NAME :: forall {r} {a}.
(Eq a, IsString a) =>
a -> ((# #) -> r) -> ((# #) -> r) -> r
$bKHR_SHADER_QUAD_CONTROL_EXTENSION_NAME :: forall a. (Eq a, IsString a) => a
KHR_SHADER_QUAD_CONTROL_EXTENSION_NAME = "VK_KHR_shader_quad_control"