{-# language CPP #-}
-- | = Name
--
-- VK_KHR_shader_subgroup_rotate - device extension
--
-- = VK_KHR_shader_subgroup_rotate
--
-- [__Name String__]
--     @VK_KHR_shader_subgroup_rotate@
--
-- [__Extension Type__]
--     Device extension
--
-- [__Registered Extension Number__]
--     417
--
-- [__Revision__]
--     2
--
-- [__Ratification Status__]
--     Ratified
--
-- [__Extension and Version Dependencies__]
--     None
--
-- [__SPIR-V Dependencies__]
--
--     -   <https://htmlpreview.github.io/?https://github.com/KhronosGroup/SPIRV-Registry/blob/master/extensions/KHR/SPV_KHR_subgroup_rotate.html SPV_KHR_subgroup_rotate>
--
-- [__Contact__]
--
--     -   Kevin Petit
--         <https://github.com/KhronosGroup/Vulkan-Docs/issues/new?body=[VK_KHR_shader_subgroup_rotate] @kpet%0A*Here describe the issue or question you have about the VK_KHR_shader_subgroup_rotate extension* >
--
-- [__Extension Proposal__]
--     <https://github.com/KhronosGroup/Vulkan-Docs/tree/main/proposals/VK_KHR_shader_subgroup_rotate.adoc VK_KHR_shader_subgroup_rotate>
--
-- [__Last Modified Date__]
--     2024-01-29
--
-- [__IP Status__]
--     No known IP claims.
--
-- [__Contributors__]
--
--     -   Kévin Petit, Arm Ltd.
--
--     -   Tobias Hector, AMD
--
--     -   John Leech, Khronos
--
--     -   Matthew Netsch, Qualcomm
--
--     -   Jan-Harald Fredriksen, Arm Ltd.
--
--     -   Graeme Leese, Broadcom
--
--     -   Tom Olson, Arm Ltd.
--
--     -   Spencer Fricke, LunarG Inc.
--
-- This extension adds support for the subgroup rotate instruction defined
-- in SPV_KHR_subgroup_rotate.
--
-- == New Structures
--
-- -   Extending
--     'Vulkan.Core11.Promoted_From_VK_KHR_get_physical_device_properties2.PhysicalDeviceFeatures2',
--     'Vulkan.Core10.Device.DeviceCreateInfo':
--
--     -   'PhysicalDeviceShaderSubgroupRotateFeaturesKHR'
--
-- == New Enum Constants
--
-- -   'KHR_SHADER_SUBGROUP_ROTATE_EXTENSION_NAME'
--
-- -   'KHR_SHADER_SUBGROUP_ROTATE_SPEC_VERSION'
--
-- -   Extending 'Vulkan.Core10.Enums.StructureType.StructureType':
--
--     -   'Vulkan.Core10.Enums.StructureType.STRUCTURE_TYPE_PHYSICAL_DEVICE_SHADER_SUBGROUP_ROTATE_FEATURES_KHR'
--
-- -   Extending
--     'Vulkan.Core11.Enums.SubgroupFeatureFlagBits.SubgroupFeatureFlagBits':
--
--     -   'Vulkan.Core11.Enums.SubgroupFeatureFlagBits.SUBGROUP_FEATURE_ROTATE_BIT_KHR'
--
--     -   'Vulkan.Core11.Enums.SubgroupFeatureFlagBits.SUBGROUP_FEATURE_ROTATE_CLUSTERED_BIT_KHR'
--
-- == New SPIR-V Capabilities
--
-- -   <https://registry.khronos.org/vulkan/specs/1.3-extensions/html/vkspec.html#spirvenv-capabilities-table-GroupNonUniformRotateKHR GroupNonUniformRotateKHR>
--
-- == Version History
--
-- -   Revision 2, 2024-01-29 (Kévin Petit)
--
--     -   Add
--         'Vulkan.Core11.Enums.SubgroupFeatureFlagBits.SUBGROUP_FEATURE_ROTATE_BIT_KHR'
--         and
--         'Vulkan.Core11.Enums.SubgroupFeatureFlagBits.SUBGROUP_FEATURE_ROTATE_CLUSTERED_BIT_KHR'
--
-- -   Revision 1, 2023-06-20 (Kévin Petit)
--
--     -   Initial revision
--
-- == See Also
--
-- No cross-references are available
--
-- == Document Notes
--
-- For more information, see the
-- <https://registry.khronos.org/vulkan/specs/1.3-extensions/html/vkspec.html#VK_KHR_shader_subgroup_rotate 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_subgroup_rotate  ( PhysicalDeviceShaderSubgroupRotateFeaturesKHR(..)
                                                        , KHR_SHADER_SUBGROUP_ROTATE_SPEC_VERSION
                                                        , pattern KHR_SHADER_SUBGROUP_ROTATE_SPEC_VERSION
                                                        , KHR_SHADER_SUBGROUP_ROTATE_EXTENSION_NAME
                                                        , pattern KHR_SHADER_SUBGROUP_ROTATE_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_SUBGROUP_ROTATE_FEATURES_KHR))
-- | VkPhysicalDeviceShaderSubgroupRotateFeaturesKHR - Structure describing
-- whether subgroup rotation is enabled
--
-- = Description
--
-- If the 'PhysicalDeviceShaderSubgroupRotateFeaturesKHR' 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. 'PhysicalDeviceShaderSubgroupRotateFeaturesKHR' /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_shader_subgroup_rotate VK_KHR_shader_subgroup_rotate>,
-- 'Vulkan.Core10.FundamentalTypes.Bool32',
-- 'Vulkan.Core10.Enums.StructureType.StructureType'
data PhysicalDeviceShaderSubgroupRotateFeaturesKHR = PhysicalDeviceShaderSubgroupRotateFeaturesKHR
  { -- | #features-shaderSubgroupRotate# @shaderSubgroupRotate@ specifies whether
    -- shader modules /can/ declare the @GroupNonUniformRotateKHR@ capability.
    PhysicalDeviceShaderSubgroupRotateFeaturesKHR -> Bool
shaderSubgroupRotate :: Bool
  , -- | #features-shaderSubgroupRotateClustered# @shaderSubgroupRotateClustered@
    -- specifies whether shader modules /can/ use the @ClusterSize@ operand to
    -- @OpGroupNonUniformRotateKHR@.
    PhysicalDeviceShaderSubgroupRotateFeaturesKHR -> Bool
shaderSubgroupRotateClustered :: Bool
  }
  deriving (Typeable, PhysicalDeviceShaderSubgroupRotateFeaturesKHR
-> PhysicalDeviceShaderSubgroupRotateFeaturesKHR -> Bool
(PhysicalDeviceShaderSubgroupRotateFeaturesKHR
 -> PhysicalDeviceShaderSubgroupRotateFeaturesKHR -> Bool)
-> (PhysicalDeviceShaderSubgroupRotateFeaturesKHR
    -> PhysicalDeviceShaderSubgroupRotateFeaturesKHR -> Bool)
-> Eq PhysicalDeviceShaderSubgroupRotateFeaturesKHR
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
$c== :: PhysicalDeviceShaderSubgroupRotateFeaturesKHR
-> PhysicalDeviceShaderSubgroupRotateFeaturesKHR -> Bool
== :: PhysicalDeviceShaderSubgroupRotateFeaturesKHR
-> PhysicalDeviceShaderSubgroupRotateFeaturesKHR -> Bool
$c/= :: PhysicalDeviceShaderSubgroupRotateFeaturesKHR
-> PhysicalDeviceShaderSubgroupRotateFeaturesKHR -> Bool
/= :: PhysicalDeviceShaderSubgroupRotateFeaturesKHR
-> PhysicalDeviceShaderSubgroupRotateFeaturesKHR -> Bool
Eq)
#if defined(GENERIC_INSTANCES)
deriving instance Generic (PhysicalDeviceShaderSubgroupRotateFeaturesKHR)
#endif
deriving instance Show PhysicalDeviceShaderSubgroupRotateFeaturesKHR

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

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

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

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


type KHR_SHADER_SUBGROUP_ROTATE_SPEC_VERSION = 2

-- No documentation found for TopLevel "VK_KHR_SHADER_SUBGROUP_ROTATE_SPEC_VERSION"
pattern KHR_SHADER_SUBGROUP_ROTATE_SPEC_VERSION :: forall a . Integral a => a
pattern $mKHR_SHADER_SUBGROUP_ROTATE_SPEC_VERSION :: forall {r} {a}.
Integral a =>
a -> ((# #) -> r) -> ((# #) -> r) -> r
$bKHR_SHADER_SUBGROUP_ROTATE_SPEC_VERSION :: forall a. Integral a => a
KHR_SHADER_SUBGROUP_ROTATE_SPEC_VERSION = 2


type KHR_SHADER_SUBGROUP_ROTATE_EXTENSION_NAME = "VK_KHR_shader_subgroup_rotate"

-- No documentation found for TopLevel "VK_KHR_SHADER_SUBGROUP_ROTATE_EXTENSION_NAME"
pattern KHR_SHADER_SUBGROUP_ROTATE_EXTENSION_NAME :: forall a . (Eq a, IsString a) => a
pattern $mKHR_SHADER_SUBGROUP_ROTATE_EXTENSION_NAME :: forall {r} {a}.
(Eq a, IsString a) =>
a -> ((# #) -> r) -> ((# #) -> r) -> r
$bKHR_SHADER_SUBGROUP_ROTATE_EXTENSION_NAME :: forall a. (Eq a, IsString a) => a
KHR_SHADER_SUBGROUP_ROTATE_EXTENSION_NAME = "VK_KHR_shader_subgroup_rotate"