{-# language CPP #-}
-- No documentation found for Chapter "Promoted_From_VK_EXT_image_robustness"
module Vulkan.Core13.Promoted_From_VK_EXT_image_robustness  ( PhysicalDeviceImageRobustnessFeatures(..)
                                                            , StructureType(..)
                                                            ) 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.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_IMAGE_ROBUSTNESS_FEATURES))
import Vulkan.Core10.Enums.StructureType (StructureType(..))
-- | VkPhysicalDeviceImageRobustnessFeatures - Structure describing the
-- out-of-bounds behavior for an implementation
--
-- = Members
--
-- This structure describes the following feature:
--
-- = Description
--
-- If the 'PhysicalDeviceImageRobustnessFeatures' 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. 'PhysicalDeviceImageRobustnessFeatures' /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_image_robustness VK_EXT_image_robustness>,
-- <https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#VK_VERSION_1_3 VK_VERSION_1_3>,
-- 'Vulkan.Core10.FundamentalTypes.Bool32',
-- 'Vulkan.Core10.Enums.StructureType.StructureType'
data PhysicalDeviceImageRobustnessFeatures = PhysicalDeviceImageRobustnessFeatures
  { -- | #extension-features-robustImageAccess# @robustImageAccess@ indicates
    -- whether image accesses are tightly bounds-checked against the dimensions
    -- of the image view.
    -- <https://registry.khronos.org/vulkan/specs/1.3-extensions/html/vkspec.html#textures-input-validation Invalid texels>
    -- resulting from out of bounds image loads will be replaced as described
    -- in
    -- <https://registry.khronos.org/vulkan/specs/1.3-extensions/html/vkspec.html#textures-texel-replacement Texel Replacement>,
    -- with either (0,0,1) or (0,0,0) values inserted for missing G, B, or A
    -- components based on the format.
    PhysicalDeviceImageRobustnessFeatures -> Bool
robustImageAccess :: Bool }
  deriving (Typeable, PhysicalDeviceImageRobustnessFeatures
-> PhysicalDeviceImageRobustnessFeatures -> Bool
(PhysicalDeviceImageRobustnessFeatures
 -> PhysicalDeviceImageRobustnessFeatures -> Bool)
-> (PhysicalDeviceImageRobustnessFeatures
    -> PhysicalDeviceImageRobustnessFeatures -> Bool)
-> Eq PhysicalDeviceImageRobustnessFeatures
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: PhysicalDeviceImageRobustnessFeatures
-> PhysicalDeviceImageRobustnessFeatures -> Bool
$c/= :: PhysicalDeviceImageRobustnessFeatures
-> PhysicalDeviceImageRobustnessFeatures -> Bool
== :: PhysicalDeviceImageRobustnessFeatures
-> PhysicalDeviceImageRobustnessFeatures -> Bool
$c== :: PhysicalDeviceImageRobustnessFeatures
-> PhysicalDeviceImageRobustnessFeatures -> Bool
Eq)
#if defined(GENERIC_INSTANCES)
deriving instance Generic (PhysicalDeviceImageRobustnessFeatures)
#endif
deriving instance Show PhysicalDeviceImageRobustnessFeatures

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

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

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