{-# language CPP #-}
-- | = Name
--
-- VK_EXT_primitive_topology_list_restart - device extension
--
-- == VK_EXT_primitive_topology_list_restart
--
-- [__Name String__]
--     @VK_EXT_primitive_topology_list_restart@
--
-- [__Extension Type__]
--     Device extension
--
-- [__Registered Extension Number__]
--     357
--
-- [__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>
--
-- [__Special Use__]
--
--     -   <https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#extendingvulkan-compatibility-specialuse OpenGL \/ ES support>
--
-- [__Contact__]
--
--     -   Shahbaz Youssefi
--         <https://github.com/KhronosGroup/Vulkan-Docs/issues/new?body=[VK_EXT_primitive_topology_list_restart] @syoussefi%0A*Here describe the issue or question you have about the VK_EXT_primitive_topology_list_restart extension* >
--
-- == Other Extension Metadata
--
-- [__Last Modified Date__]
--     2021-01-11
--
-- [__IP Status__]
--     No known IP claims.
--
-- [__Contributors__]
--
--     -   Courtney Goeltzenleuchter, Google
--
--     -   Shahbaz Youssefi, Google
--
-- == Description
--
-- This extension allows list primitives to use the primitive restart index
-- value. This provides a more efficient implementation when layering
-- OpenGL functionality on Vulkan by avoiding emulation which incurs data
-- copies.
--
-- == New Structures
--
-- -   Extending
--     'Vulkan.Core11.Promoted_From_VK_KHR_get_physical_device_properties2.PhysicalDeviceFeatures2',
--     'Vulkan.Core10.Device.DeviceCreateInfo':
--
--     -   'PhysicalDevicePrimitiveTopologyListRestartFeaturesEXT'
--
-- == New Enum Constants
--
-- -   'EXT_PRIMITIVE_TOPOLOGY_LIST_RESTART_EXTENSION_NAME'
--
-- -   'EXT_PRIMITIVE_TOPOLOGY_LIST_RESTART_SPEC_VERSION'
--
-- -   Extending 'Vulkan.Core10.Enums.StructureType.StructureType':
--
--     -   'Vulkan.Core10.Enums.StructureType.STRUCTURE_TYPE_PHYSICAL_DEVICE_PRIMITIVE_TOPOLOGY_LIST_RESTART_FEATURES_EXT'
--
-- == Version History
--
-- -   Revision 0, 2020-09-14 (Courtney Goeltzenleuchter)
--
--     -   Internal revisions
--
-- -   Revision 1, 2021-01-11 (Shahbaz Youssefi)
--
--     -   Add the @primitiveTopologyPatchListRestart@ feature
--
--     -   Internal revisions
--
-- == See Also
--
-- 'PhysicalDevicePrimitiveTopologyListRestartFeaturesEXT'
--
-- == Document Notes
--
-- For more information, see the
-- <https://registry.khronos.org/vulkan/specs/1.3-extensions/html/vkspec.html#VK_EXT_primitive_topology_list_restart 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_primitive_topology_list_restart  ( PhysicalDevicePrimitiveTopologyListRestartFeaturesEXT(..)
                                                                 , EXT_PRIMITIVE_TOPOLOGY_LIST_RESTART_SPEC_VERSION
                                                                 , pattern EXT_PRIMITIVE_TOPOLOGY_LIST_RESTART_SPEC_VERSION
                                                                 , EXT_PRIMITIVE_TOPOLOGY_LIST_RESTART_EXTENSION_NAME
                                                                 , pattern EXT_PRIMITIVE_TOPOLOGY_LIST_RESTART_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_PRIMITIVE_TOPOLOGY_LIST_RESTART_FEATURES_EXT))
-- | VkPhysicalDevicePrimitiveTopologyListRestartFeaturesEXT - Structure
-- describing whether list type primitives can support primitive restart
--
-- = Members
--
-- This structure describes the following features:
--
-- = Description
--
-- If the 'PhysicalDevicePrimitiveTopologyListRestartFeaturesEXT' 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. 'PhysicalDevicePrimitiveTopologyListRestartFeaturesEXT' /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_primitive_topology_list_restart VK_EXT_primitive_topology_list_restart>,
-- 'Vulkan.Core10.FundamentalTypes.Bool32',
-- 'Vulkan.Core10.Enums.StructureType.StructureType'
data PhysicalDevicePrimitiveTopologyListRestartFeaturesEXT = PhysicalDevicePrimitiveTopologyListRestartFeaturesEXT
  { -- | #features-primitiveTopologyListRestart# @primitiveTopologyListRestart@
    -- indicates that list type primitives,
    -- 'Vulkan.Core10.Enums.PrimitiveTopology.PRIMITIVE_TOPOLOGY_POINT_LIST',
    -- 'Vulkan.Core10.Enums.PrimitiveTopology.PRIMITIVE_TOPOLOGY_LINE_LIST',
    -- 'Vulkan.Core10.Enums.PrimitiveTopology.PRIMITIVE_TOPOLOGY_TRIANGLE_LIST',
    -- 'Vulkan.Core10.Enums.PrimitiveTopology.PRIMITIVE_TOPOLOGY_LINE_LIST_WITH_ADJACENCY'
    -- and
    -- 'Vulkan.Core10.Enums.PrimitiveTopology.PRIMITIVE_TOPOLOGY_TRIANGLE_LIST_WITH_ADJACENCY',
    -- /can/ use the primitive restart index value in index buffers.
    PhysicalDevicePrimitiveTopologyListRestartFeaturesEXT -> Bool
primitiveTopologyListRestart :: Bool
  , -- | #features-primitiveTopologyPatchListRestart#
    -- @primitiveTopologyPatchListRestart@ indicates that the
    -- 'Vulkan.Core10.Enums.PrimitiveTopology.PRIMITIVE_TOPOLOGY_PATCH_LIST'
    -- topology /can/ use the primitive restart index value in index buffers.
    PhysicalDevicePrimitiveTopologyListRestartFeaturesEXT -> Bool
primitiveTopologyPatchListRestart :: Bool
  }
  deriving (Typeable, PhysicalDevicePrimitiveTopologyListRestartFeaturesEXT
-> PhysicalDevicePrimitiveTopologyListRestartFeaturesEXT -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: PhysicalDevicePrimitiveTopologyListRestartFeaturesEXT
-> PhysicalDevicePrimitiveTopologyListRestartFeaturesEXT -> Bool
$c/= :: PhysicalDevicePrimitiveTopologyListRestartFeaturesEXT
-> PhysicalDevicePrimitiveTopologyListRestartFeaturesEXT -> Bool
== :: PhysicalDevicePrimitiveTopologyListRestartFeaturesEXT
-> PhysicalDevicePrimitiveTopologyListRestartFeaturesEXT -> Bool
$c== :: PhysicalDevicePrimitiveTopologyListRestartFeaturesEXT
-> PhysicalDevicePrimitiveTopologyListRestartFeaturesEXT -> Bool
Eq)
#if defined(GENERIC_INSTANCES)
deriving instance Generic (PhysicalDevicePrimitiveTopologyListRestartFeaturesEXT)
#endif
deriving instance Show PhysicalDevicePrimitiveTopologyListRestartFeaturesEXT

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

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

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

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


type EXT_PRIMITIVE_TOPOLOGY_LIST_RESTART_SPEC_VERSION = 1

-- No documentation found for TopLevel "VK_EXT_PRIMITIVE_TOPOLOGY_LIST_RESTART_SPEC_VERSION"
pattern EXT_PRIMITIVE_TOPOLOGY_LIST_RESTART_SPEC_VERSION :: forall a . Integral a => a
pattern $bEXT_PRIMITIVE_TOPOLOGY_LIST_RESTART_SPEC_VERSION :: forall a. Integral a => a
$mEXT_PRIMITIVE_TOPOLOGY_LIST_RESTART_SPEC_VERSION :: forall {r} {a}.
Integral a =>
a -> ((# #) -> r) -> ((# #) -> r) -> r
EXT_PRIMITIVE_TOPOLOGY_LIST_RESTART_SPEC_VERSION = 1


type EXT_PRIMITIVE_TOPOLOGY_LIST_RESTART_EXTENSION_NAME = "VK_EXT_primitive_topology_list_restart"

-- No documentation found for TopLevel "VK_EXT_PRIMITIVE_TOPOLOGY_LIST_RESTART_EXTENSION_NAME"
pattern EXT_PRIMITIVE_TOPOLOGY_LIST_RESTART_EXTENSION_NAME :: forall a . (Eq a, IsString a) => a
pattern $bEXT_PRIMITIVE_TOPOLOGY_LIST_RESTART_EXTENSION_NAME :: forall a. (Eq a, IsString a) => a
$mEXT_PRIMITIVE_TOPOLOGY_LIST_RESTART_EXTENSION_NAME :: forall {r} {a}.
(Eq a, IsString a) =>
a -> ((# #) -> r) -> ((# #) -> r) -> r
EXT_PRIMITIVE_TOPOLOGY_LIST_RESTART_EXTENSION_NAME = "VK_EXT_primitive_topology_list_restart"