{-# language CPP #-}
-- | = Name
--
-- VK_EXT_dynamic_rendering_unused_attachments - device extension
--
-- == VK_EXT_dynamic_rendering_unused_attachments
--
-- [__Name String__]
--     @VK_EXT_dynamic_rendering_unused_attachments@
--
-- [__Extension Type__]
--     Device extension
--
-- [__Registered Extension Number__]
--     500
--
-- [__Revision__]
--     1
--
-- [__Ratification Status__]
--     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>
--          or
--         
--     <https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#versions-1.1 Version 1.1>
--     and
--         
--     <https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#VK_KHR_dynamic_rendering VK_KHR_dynamic_rendering>
--          or
--         
--     <https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#versions-1.3 Version 1.3>
--
-- [__Contact__]
--
--     -   Piers Daniell
--         <https://github.com/KhronosGroup/Vulkan-Docs/issues/new?body=[VK_EXT_dynamic_rendering_unused_attachments] @pdaniell-nv%0A*Here describe the issue or question you have about the VK_EXT_dynamic_rendering_unused_attachments extension* >
--
-- [__Extension Proposal__]
--     <https://github.com/KhronosGroup/Vulkan-Docs/tree/main/proposals/VK_EXT_dynamic_rendering_unused_attachments.adoc VK_EXT_dynamic_rendering_unused_attachments>
--
-- == Other Extension Metadata
--
-- [__Last Modified Date__]
--     2023-05-22
--
-- [__IP Status__]
--     No known IP claims.
--
-- [__Contributors__]
--
--     -   Daniel Story, Nintendo
--
--     -   Hans-Kristian Arntzen, Valve
--
--     -   Jan-Harald Fredriksen, Arm
--
--     -   James Fitzpatrick, Imagination Technologies
--
--     -   Pan Gao, Huawei Technologies
--
--     -   Ricardo Garcia, Igalia
--
--     -   Stu Smith, AMD
--
-- == Description
--
-- This extension lifts some restrictions in the @VK_KHR_dynamic_rendering@
-- extension to allow render pass instances and bound pipelines within
-- those render pass instances to have an unused attachment specified in
-- one but not the other. It also allows pipelines to use different formats
-- in a render pass as long the attachment is NULL.
--
-- == New Structures
--
-- -   Extending
--     'Vulkan.Core11.Promoted_From_VK_KHR_get_physical_device_properties2.PhysicalDeviceFeatures2',
--     'Vulkan.Core10.Device.DeviceCreateInfo':
--
--     -   'PhysicalDeviceDynamicRenderingUnusedAttachmentsFeaturesEXT'
--
-- == New Enum Constants
--
-- -   'EXT_DYNAMIC_RENDERING_UNUSED_ATTACHMENTS_EXTENSION_NAME'
--
-- -   'EXT_DYNAMIC_RENDERING_UNUSED_ATTACHMENTS_SPEC_VERSION'
--
-- -   Extending 'Vulkan.Core10.Enums.StructureType.StructureType':
--
--     -   'Vulkan.Core10.Enums.StructureType.STRUCTURE_TYPE_PHYSICAL_DEVICE_DYNAMIC_RENDERING_UNUSED_ATTACHMENTS_FEATURES_EXT'
--
-- == Issues
--
-- None.
--
-- == Version History
--
-- -   Revision 1, 2023-05-22 (Piers Daniell)
--
--     -   Internal revisions
--
-- == See Also
--
-- 'PhysicalDeviceDynamicRenderingUnusedAttachmentsFeaturesEXT'
--
-- == Document Notes
--
-- For more information, see the
-- <https://registry.khronos.org/vulkan/specs/1.3-extensions/html/vkspec.html#VK_EXT_dynamic_rendering_unused_attachments 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_dynamic_rendering_unused_attachments  ( PhysicalDeviceDynamicRenderingUnusedAttachmentsFeaturesEXT(..)
                                                                      , EXT_DYNAMIC_RENDERING_UNUSED_ATTACHMENTS_SPEC_VERSION
                                                                      , pattern EXT_DYNAMIC_RENDERING_UNUSED_ATTACHMENTS_SPEC_VERSION
                                                                      , EXT_DYNAMIC_RENDERING_UNUSED_ATTACHMENTS_EXTENSION_NAME
                                                                      , pattern EXT_DYNAMIC_RENDERING_UNUSED_ATTACHMENTS_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_DYNAMIC_RENDERING_UNUSED_ATTACHMENTS_FEATURES_EXT))
-- | VkPhysicalDeviceDynamicRenderingUnusedAttachmentsFeaturesEXT - Structure
-- describing the dynamic rendering unused attachment features that can be
-- supported by an implementation
--
-- = Members
--
-- This structure describes the following feature:
--
-- = Description
--
-- If the 'PhysicalDeviceDynamicRenderingUnusedAttachmentsFeaturesEXT'
-- 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. 'PhysicalDeviceDynamicRenderingUnusedAttachmentsFeaturesEXT'
-- /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_dynamic_rendering_unused_attachments VK_EXT_dynamic_rendering_unused_attachments>,
-- 'Vulkan.Core10.FundamentalTypes.Bool32',
-- 'Vulkan.Core10.Enums.StructureType.StructureType'
data PhysicalDeviceDynamicRenderingUnusedAttachmentsFeaturesEXT = PhysicalDeviceDynamicRenderingUnusedAttachmentsFeaturesEXT
  { -- | #features-dynamicRenderingUnusedAttachments#
    -- @dynamicRenderingUnusedAttachments@ indicates that the implementation
    -- supports binding graphics pipelines within a render pass instance where
    -- any pipeline
    -- 'Vulkan.Core13.Promoted_From_VK_KHR_dynamic_rendering.PipelineRenderingCreateInfo'::@pColorAttachmentFormats@
    -- element with a format other than
    -- 'Vulkan.Core10.Enums.Format.FORMAT_UNDEFINED' is allowed with a
    -- corresponding
    -- 'Vulkan.Core13.Promoted_From_VK_KHR_dynamic_rendering.RenderingInfo'::@pColorAttachments@
    -- element with a @imageView@ equal to
    -- 'Vulkan.Core10.APIConstants.NULL_HANDLE', or any pipeline
    -- 'Vulkan.Core13.Promoted_From_VK_KHR_dynamic_rendering.PipelineRenderingCreateInfo'::@pColorAttachmentFormats@
    -- element with a 'Vulkan.Core10.Enums.Format.FORMAT_UNDEFINED' format is
    -- allowed with a corresponding
    -- 'Vulkan.Core13.Promoted_From_VK_KHR_dynamic_rendering.RenderingInfo'::@pColorAttachments@
    -- element with a non-'Vulkan.Core10.APIConstants.NULL_HANDLE' @imageView@.
    -- Also a
    -- 'Vulkan.Core13.Promoted_From_VK_KHR_dynamic_rendering.PipelineRenderingCreateInfo'::@depthAttachmentFormat@
    -- other than 'Vulkan.Core10.Enums.Format.FORMAT_UNDEFINED' is allowed with
    -- a 'Vulkan.Core10.APIConstants.NULL_HANDLE'
    -- 'Vulkan.Core13.Promoted_From_VK_KHR_dynamic_rendering.RenderingInfo'::@pDepthAttachment@,
    -- or a
    -- 'Vulkan.Core13.Promoted_From_VK_KHR_dynamic_rendering.PipelineRenderingCreateInfo'::@depthAttachmentFormat@
    -- of 'Vulkan.Core10.Enums.Format.FORMAT_UNDEFINED' is allowed with a
    -- non-'Vulkan.Core10.APIConstants.NULL_HANDLE'
    -- 'Vulkan.Core13.Promoted_From_VK_KHR_dynamic_rendering.RenderingInfo'::@pDepthAttachment@.
    -- Also a
    -- 'Vulkan.Core13.Promoted_From_VK_KHR_dynamic_rendering.PipelineRenderingCreateInfo'::@stencilAttachmentFormat@
    -- other than 'Vulkan.Core10.Enums.Format.FORMAT_UNDEFINED' is allowed with
    -- a 'Vulkan.Core10.APIConstants.NULL_HANDLE'
    -- 'Vulkan.Core13.Promoted_From_VK_KHR_dynamic_rendering.RenderingInfo'::@pStencilAttachment@,
    -- or a
    -- 'Vulkan.Core13.Promoted_From_VK_KHR_dynamic_rendering.PipelineRenderingCreateInfo'::@stencilAttachmentFormat@
    -- of 'Vulkan.Core10.Enums.Format.FORMAT_UNDEFINED' is allowed with a
    -- non-'Vulkan.Core10.APIConstants.NULL_HANDLE'
    -- 'Vulkan.Core13.Promoted_From_VK_KHR_dynamic_rendering.RenderingInfo'::@pStencilAttachment@.
    -- Any writes to a
    -- 'Vulkan.Core13.Promoted_From_VK_KHR_dynamic_rendering.RenderingInfo'::@pColorAttachments@,
    -- 'Vulkan.Core13.Promoted_From_VK_KHR_dynamic_rendering.RenderingInfo'::@pDepthAttachment@,
    -- or
    -- 'Vulkan.Core13.Promoted_From_VK_KHR_dynamic_rendering.RenderingInfo'::@pStencilAttachment@
    -- with 'Vulkan.Core10.APIConstants.NULL_HANDLE' are discarded.
    PhysicalDeviceDynamicRenderingUnusedAttachmentsFeaturesEXT -> Bool
dynamicRenderingUnusedAttachments :: Bool }
  deriving (Typeable, PhysicalDeviceDynamicRenderingUnusedAttachmentsFeaturesEXT
-> PhysicalDeviceDynamicRenderingUnusedAttachmentsFeaturesEXT
-> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: PhysicalDeviceDynamicRenderingUnusedAttachmentsFeaturesEXT
-> PhysicalDeviceDynamicRenderingUnusedAttachmentsFeaturesEXT
-> Bool
$c/= :: PhysicalDeviceDynamicRenderingUnusedAttachmentsFeaturesEXT
-> PhysicalDeviceDynamicRenderingUnusedAttachmentsFeaturesEXT
-> Bool
== :: PhysicalDeviceDynamicRenderingUnusedAttachmentsFeaturesEXT
-> PhysicalDeviceDynamicRenderingUnusedAttachmentsFeaturesEXT
-> Bool
$c== :: PhysicalDeviceDynamicRenderingUnusedAttachmentsFeaturesEXT
-> PhysicalDeviceDynamicRenderingUnusedAttachmentsFeaturesEXT
-> Bool
Eq)
#if defined(GENERIC_INSTANCES)
deriving instance Generic (PhysicalDeviceDynamicRenderingUnusedAttachmentsFeaturesEXT)
#endif
deriving instance Show PhysicalDeviceDynamicRenderingUnusedAttachmentsFeaturesEXT

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

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

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


type EXT_DYNAMIC_RENDERING_UNUSED_ATTACHMENTS_SPEC_VERSION = 1

-- No documentation found for TopLevel "VK_EXT_DYNAMIC_RENDERING_UNUSED_ATTACHMENTS_SPEC_VERSION"
pattern EXT_DYNAMIC_RENDERING_UNUSED_ATTACHMENTS_SPEC_VERSION :: forall a . Integral a => a
pattern $bEXT_DYNAMIC_RENDERING_UNUSED_ATTACHMENTS_SPEC_VERSION :: forall a. Integral a => a
$mEXT_DYNAMIC_RENDERING_UNUSED_ATTACHMENTS_SPEC_VERSION :: forall {r} {a}.
Integral a =>
a -> ((# #) -> r) -> ((# #) -> r) -> r
EXT_DYNAMIC_RENDERING_UNUSED_ATTACHMENTS_SPEC_VERSION = 1


type EXT_DYNAMIC_RENDERING_UNUSED_ATTACHMENTS_EXTENSION_NAME = "VK_EXT_dynamic_rendering_unused_attachments"

-- No documentation found for TopLevel "VK_EXT_DYNAMIC_RENDERING_UNUSED_ATTACHMENTS_EXTENSION_NAME"
pattern EXT_DYNAMIC_RENDERING_UNUSED_ATTACHMENTS_EXTENSION_NAME :: forall a . (Eq a, IsString a) => a
pattern $bEXT_DYNAMIC_RENDERING_UNUSED_ATTACHMENTS_EXTENSION_NAME :: forall a. (Eq a, IsString a) => a
$mEXT_DYNAMIC_RENDERING_UNUSED_ATTACHMENTS_EXTENSION_NAME :: forall {r} {a}.
(Eq a, IsString a) =>
a -> ((# #) -> r) -> ((# #) -> r) -> r
EXT_DYNAMIC_RENDERING_UNUSED_ATTACHMENTS_EXTENSION_NAME = "VK_EXT_dynamic_rendering_unused_attachments"