{-# language CPP #-}
-- | = Name
--
-- VK_KHR_zero_initialize_workgroup_memory - device extension
--
-- == VK_KHR_zero_initialize_workgroup_memory
--
-- [__Name String__]
--     @VK_KHR_zero_initialize_workgroup_memory@
--
-- [__Extension Type__]
--     Device extension
--
-- [__Registered Extension Number__]
--     326
--
-- [__Revision__]
--     1
--
-- [__Extension and Version Dependencies__]
--
--     -   Requires Vulkan 1.0
--
--     -   Requires @VK_KHR_get_physical_device_properties2@
--
-- [__Contact__]
--
--     -   Alan Baker
--         <https://github.com/KhronosGroup/Vulkan-Docs/issues/new?title=VK_KHR_zero_initialize_workgroup_memory:%20&body=@alan-baker%20 >
--
-- == Other Extension Metadata
--
-- [__Last Modified Date__]
--     2020-11-18
--
-- [__IP Status__]
--     No known IP claims.
--
-- [__Interactions and External Dependencies__]
--     None
--
-- [__Contributors__]
--
--     -   Alan Baker, Google
--
--     -   Jeff Bolz, Nvidia
--
--     -   Jason Ekstrand, Intel
--
-- == Description
--
-- This extension allows the use of a null constant initializer on shader
-- Workgroup memory variables, allowing implementations to expose any
-- special hardware or instructions they may have. Zero initialization is
-- commonly used by applications running untrusted content (e.g. web
-- browsers) as way of defeating memory-scraping attacks.
--
-- == New Structures
--
-- -   Extending
--     'Vulkan.Core11.Promoted_From_VK_KHR_get_physical_device_properties2.PhysicalDeviceFeatures2',
--     'Vulkan.Core10.Device.DeviceCreateInfo':
--
--     -   'PhysicalDeviceZeroInitializeWorkgroupMemoryFeaturesKHR'
--
-- == New Enum Constants
--
-- -   'KHR_ZERO_INITIALIZE_WORKGROUP_MEMORY_EXTENSION_NAME'
--
-- -   'KHR_ZERO_INITIALIZE_WORKGROUP_MEMORY_SPEC_VERSION'
--
-- -   Extending 'Vulkan.Core10.Enums.StructureType.StructureType':
--
--     -   'Vulkan.Core10.Enums.StructureType.STRUCTURE_TYPE_PHYSICAL_DEVICE_ZERO_INITIALIZE_WORKGROUP_MEMORY_FEATURES_KHR'
--
-- == Version History
--
-- -   Revision 1, 2020-11-18 (Alan Baker)
--
--     -   Internal draft version
--
-- = See Also
--
-- 'PhysicalDeviceZeroInitializeWorkgroupMemoryFeaturesKHR'
--
-- = Document Notes
--
-- For more information, see the
-- <https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#VK_KHR_zero_initialize_workgroup_memory 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_zero_initialize_workgroup_memory  ( PhysicalDeviceZeroInitializeWorkgroupMemoryFeaturesKHR(..)
                                                                  , KHR_ZERO_INITIALIZE_WORKGROUP_MEMORY_SPEC_VERSION
                                                                  , pattern KHR_ZERO_INITIALIZE_WORKGROUP_MEMORY_SPEC_VERSION
                                                                  , KHR_ZERO_INITIALIZE_WORKGROUP_MEMORY_EXTENSION_NAME
                                                                  , pattern KHR_ZERO_INITIALIZE_WORKGROUP_MEMORY_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_ZERO_INITIALIZE_WORKGROUP_MEMORY_FEATURES_KHR))
-- | VkPhysicalDeviceZeroInitializeWorkgroupMemoryFeaturesKHR - Structure
-- describing support for zero initialization of workgroup memory by an
-- implementation
--
-- = Members
--
-- This structure describes the following feature:
--
-- = Description
--
-- If the 'PhysicalDeviceZeroInitializeWorkgroupMemoryFeaturesKHR'
-- 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. 'PhysicalDeviceZeroInitializeWorkgroupMemoryFeaturesKHR'
-- /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 PhysicalDeviceZeroInitializeWorkgroupMemoryFeaturesKHR = PhysicalDeviceZeroInitializeWorkgroupMemoryFeaturesKHR
  { -- | #features-shaderZeroInitializeWorkgroupMemory#
    -- @shaderZeroInitializeWorkgroupMemory@ specifies whether the
    -- implementation supports initializing a variable in Workgroup storage
    -- class.
    PhysicalDeviceZeroInitializeWorkgroupMemoryFeaturesKHR -> Bool
shaderZeroInitializeWorkgroupMemory :: Bool }
  deriving (Typeable, PhysicalDeviceZeroInitializeWorkgroupMemoryFeaturesKHR
-> PhysicalDeviceZeroInitializeWorkgroupMemoryFeaturesKHR -> Bool
(PhysicalDeviceZeroInitializeWorkgroupMemoryFeaturesKHR
 -> PhysicalDeviceZeroInitializeWorkgroupMemoryFeaturesKHR -> Bool)
-> (PhysicalDeviceZeroInitializeWorkgroupMemoryFeaturesKHR
    -> PhysicalDeviceZeroInitializeWorkgroupMemoryFeaturesKHR -> Bool)
-> Eq PhysicalDeviceZeroInitializeWorkgroupMemoryFeaturesKHR
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: PhysicalDeviceZeroInitializeWorkgroupMemoryFeaturesKHR
-> PhysicalDeviceZeroInitializeWorkgroupMemoryFeaturesKHR -> Bool
$c/= :: PhysicalDeviceZeroInitializeWorkgroupMemoryFeaturesKHR
-> PhysicalDeviceZeroInitializeWorkgroupMemoryFeaturesKHR -> Bool
== :: PhysicalDeviceZeroInitializeWorkgroupMemoryFeaturesKHR
-> PhysicalDeviceZeroInitializeWorkgroupMemoryFeaturesKHR -> Bool
$c== :: PhysicalDeviceZeroInitializeWorkgroupMemoryFeaturesKHR
-> PhysicalDeviceZeroInitializeWorkgroupMemoryFeaturesKHR -> Bool
Eq)
#if defined(GENERIC_INSTANCES)
deriving instance Generic (PhysicalDeviceZeroInitializeWorkgroupMemoryFeaturesKHR)
#endif
deriving instance Show PhysicalDeviceZeroInitializeWorkgroupMemoryFeaturesKHR

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

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

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


type KHR_ZERO_INITIALIZE_WORKGROUP_MEMORY_SPEC_VERSION = 1

-- No documentation found for TopLevel "VK_KHR_ZERO_INITIALIZE_WORKGROUP_MEMORY_SPEC_VERSION"
pattern KHR_ZERO_INITIALIZE_WORKGROUP_MEMORY_SPEC_VERSION :: forall a . Integral a => a
pattern $bKHR_ZERO_INITIALIZE_WORKGROUP_MEMORY_SPEC_VERSION :: a
$mKHR_ZERO_INITIALIZE_WORKGROUP_MEMORY_SPEC_VERSION :: forall r a. Integral a => a -> (Void# -> r) -> (Void# -> r) -> r
KHR_ZERO_INITIALIZE_WORKGROUP_MEMORY_SPEC_VERSION = 1


type KHR_ZERO_INITIALIZE_WORKGROUP_MEMORY_EXTENSION_NAME = "VK_KHR_zero_initialize_workgroup_memory"

-- No documentation found for TopLevel "VK_KHR_ZERO_INITIALIZE_WORKGROUP_MEMORY_EXTENSION_NAME"
pattern KHR_ZERO_INITIALIZE_WORKGROUP_MEMORY_EXTENSION_NAME :: forall a . (Eq a, IsString a) => a
pattern $bKHR_ZERO_INITIALIZE_WORKGROUP_MEMORY_EXTENSION_NAME :: a
$mKHR_ZERO_INITIALIZE_WORKGROUP_MEMORY_EXTENSION_NAME :: forall r a.
(Eq a, IsString a) =>
a -> (Void# -> r) -> (Void# -> r) -> r
KHR_ZERO_INITIALIZE_WORKGROUP_MEMORY_EXTENSION_NAME = "VK_KHR_zero_initialize_workgroup_memory"