{-# language CPP #-}
-- | = Name
--
-- VK_EXT_pipeline_protected_access - device extension
--
-- == VK_EXT_pipeline_protected_access
--
-- [__Name String__]
--     @VK_EXT_pipeline_protected_access@
--
-- [__Extension Type__]
--     Device extension
--
-- [__Registered Extension Number__]
--     467
--
-- [__Revision__]
--     1
--
-- [__Ratification Status__]
--     Not ratified
--
-- [__Extension and Version Dependencies__]
--     <https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#VK_KHR_get_physical_device_properties2 VK_KHR_get_physical_device_properties2>
--
-- [__Contact__]
--
--     -   Shahbaz Youssefi
--         <https://github.com/KhronosGroup/Vulkan-Docs/issues/new?body=[VK_EXT_pipeline_protected_access] @syoussefi%0A*Here describe the issue or question you have about the VK_EXT_pipeline_protected_access extension* >
--
-- [__Extension Proposal__]
--     <https://github.com/KhronosGroup/Vulkan-Docs/tree/main/proposals/VK_EXT_pipeline_protected_access.adoc VK_EXT_pipeline_protected_access>
--
-- == Other Extension Metadata
--
-- [__Last Modified Date__]
--     2022-07-28
--
-- [__Contributors__]
--
--     -   Shahbaz Youssefi, Google
--
--     -   Jörg Wagner, Arm
--
--     -   Ralph Potter, Samsung
--
--     -   Daniel Koch, NVIDIA
--
-- == Description
--
-- This extension allows protected memory access to be specified per
-- pipeline as opposed to per device. Through the usage of this extension,
-- any performance penalty paid due to access to protected memory will be
-- limited to the specific pipelines that make such accesses.
--
-- == New Structures
--
-- -   Extending
--     'Vulkan.Core11.Promoted_From_VK_KHR_get_physical_device_properties2.PhysicalDeviceFeatures2',
--     'Vulkan.Core10.Device.DeviceCreateInfo':
--
--     -   'PhysicalDevicePipelineProtectedAccessFeaturesEXT'
--
-- == New Enum Constants
--
-- -   'EXT_PIPELINE_PROTECTED_ACCESS_EXTENSION_NAME'
--
-- -   'EXT_PIPELINE_PROTECTED_ACCESS_SPEC_VERSION'
--
-- -   Extending
--     'Vulkan.Core10.Enums.PipelineCreateFlagBits.PipelineCreateFlagBits':
--
--     -   'Vulkan.Core10.Enums.PipelineCreateFlagBits.PIPELINE_CREATE_NO_PROTECTED_ACCESS_BIT_EXT'
--
--     -   'Vulkan.Core10.Enums.PipelineCreateFlagBits.PIPELINE_CREATE_PROTECTED_ACCESS_ONLY_BIT_EXT'
--
-- -   Extending 'Vulkan.Core10.Enums.StructureType.StructureType':
--
--     -   'Vulkan.Core10.Enums.StructureType.STRUCTURE_TYPE_PHYSICAL_DEVICE_PIPELINE_PROTECTED_ACCESS_FEATURES_EXT'
--
-- == Version History
--
-- -   Revision 1, 2022-07-28 (Shahbaz Youssefi)
--
--     -   Internal revisions
--
-- == See Also
--
-- 'PhysicalDevicePipelineProtectedAccessFeaturesEXT'
--
-- == Document Notes
--
-- For more information, see the
-- <https://registry.khronos.org/vulkan/specs/1.3-extensions/html/vkspec.html#VK_EXT_pipeline_protected_access Vulkan Specification>
--
-- This page is a generated document. Fixes and changes should be made to
-- the generator scripts, not directly.
module Vulkan.Extensions.VK_EXT_pipeline_protected_access  ( PhysicalDevicePipelineProtectedAccessFeaturesEXT(..)
                                                           , EXT_PIPELINE_PROTECTED_ACCESS_SPEC_VERSION
                                                           , pattern EXT_PIPELINE_PROTECTED_ACCESS_SPEC_VERSION
                                                           , EXT_PIPELINE_PROTECTED_ACCESS_EXTENSION_NAME
                                                           , pattern EXT_PIPELINE_PROTECTED_ACCESS_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_PROTECTED_ACCESS_FEATURES_EXT))
-- | VkPhysicalDevicePipelineProtectedAccessFeaturesEXT - Structure
-- describing support for specifying protected access on individual
-- pipelines
--
-- = Members
--
-- This structure describes the following feature:
--
-- = Description
--
-- If the 'PhysicalDevicePipelineProtectedAccessFeaturesEXT' 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. 'PhysicalDevicePipelineProtectedAccessFeaturesEXT' /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_EXT_pipeline_protected_access VK_EXT_pipeline_protected_access>,
-- 'Vulkan.Core10.FundamentalTypes.Bool32',
-- 'Vulkan.Core10.Enums.StructureType.StructureType'
data PhysicalDevicePipelineProtectedAccessFeaturesEXT = PhysicalDevicePipelineProtectedAccessFeaturesEXT
  { -- | #features-pipelineProtectedAccess# @pipelineProtectedAccess@ indicates
    -- whether the implementation supports specifying protected access on
    -- individual pipelines.
    PhysicalDevicePipelineProtectedAccessFeaturesEXT -> Bool
pipelineProtectedAccess :: Bool }
  deriving (Typeable, PhysicalDevicePipelineProtectedAccessFeaturesEXT
-> PhysicalDevicePipelineProtectedAccessFeaturesEXT -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: PhysicalDevicePipelineProtectedAccessFeaturesEXT
-> PhysicalDevicePipelineProtectedAccessFeaturesEXT -> Bool
$c/= :: PhysicalDevicePipelineProtectedAccessFeaturesEXT
-> PhysicalDevicePipelineProtectedAccessFeaturesEXT -> Bool
== :: PhysicalDevicePipelineProtectedAccessFeaturesEXT
-> PhysicalDevicePipelineProtectedAccessFeaturesEXT -> Bool
$c== :: PhysicalDevicePipelineProtectedAccessFeaturesEXT
-> PhysicalDevicePipelineProtectedAccessFeaturesEXT -> Bool
Eq)
#if defined(GENERIC_INSTANCES)
deriving instance Generic (PhysicalDevicePipelineProtectedAccessFeaturesEXT)
#endif
deriving instance Show PhysicalDevicePipelineProtectedAccessFeaturesEXT

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

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

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

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


type EXT_PIPELINE_PROTECTED_ACCESS_SPEC_VERSION = 1

-- No documentation found for TopLevel "VK_EXT_PIPELINE_PROTECTED_ACCESS_SPEC_VERSION"
pattern EXT_PIPELINE_PROTECTED_ACCESS_SPEC_VERSION :: forall a . Integral a => a
pattern $bEXT_PIPELINE_PROTECTED_ACCESS_SPEC_VERSION :: forall a. Integral a => a
$mEXT_PIPELINE_PROTECTED_ACCESS_SPEC_VERSION :: forall {r} {a}.
Integral a =>
a -> ((# #) -> r) -> ((# #) -> r) -> r
EXT_PIPELINE_PROTECTED_ACCESS_SPEC_VERSION = 1


type EXT_PIPELINE_PROTECTED_ACCESS_EXTENSION_NAME = "VK_EXT_pipeline_protected_access"

-- No documentation found for TopLevel "VK_EXT_PIPELINE_PROTECTED_ACCESS_EXTENSION_NAME"
pattern EXT_PIPELINE_PROTECTED_ACCESS_EXTENSION_NAME :: forall a . (Eq a, IsString a) => a
pattern $bEXT_PIPELINE_PROTECTED_ACCESS_EXTENSION_NAME :: forall a. (Eq a, IsString a) => a
$mEXT_PIPELINE_PROTECTED_ACCESS_EXTENSION_NAME :: forall {r} {a}.
(Eq a, IsString a) =>
a -> ((# #) -> r) -> ((# #) -> r) -> r
EXT_PIPELINE_PROTECTED_ACCESS_EXTENSION_NAME = "VK_EXT_pipeline_protected_access"