{-# language CPP #-}
-- | = Name
--
-- VK_EXT_present_mode_fifo_latest_ready - device extension
--
-- = VK_EXT_present_mode_fifo_latest_ready
--
-- [__Name String__]
--     @VK_EXT_present_mode_fifo_latest_ready@
--
-- [__Extension Type__]
--     Device extension
--
-- [__Registered Extension Number__]
--     362
--
-- [__Revision__]
--     1
--
-- [__Ratification Status__]
--     Ratified
--
-- [__Extension and Version Dependencies__]
--     <https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#VK_KHR_swapchain VK_KHR_swapchain>
--
-- [__Contact__]
--
--     -   Lionel Duc
--         <https://github.com/KhronosGroup/Vulkan-Docs/issues/new?body=[VK_EXT_present_mode_fifo_latest_ready] @nvlduc%0A*Here describe the issue or question you have about the VK_EXT_present_mode_fifo_latest_ready extension* >
--
-- [__Extension Proposal__]
--     <https://github.com/KhronosGroup/Vulkan-Docs/tree/main/proposals/VK_EXT_present_mode_fifo_latest_ready.adoc VK_EXT_present_mode_fifo_latest_ready>
--
-- == Other Extension Metadata
--
-- [__Last Modified Date__]
--     2024-05-28
--
-- [__IP Status__]
--     No known IP claims.
--
-- [__Contributors__]
--
--     -   James Jones, NVIDIA
--
--     -   Lionel Duc, NVIDIA
--
-- == Description
--
-- This device extension adds a new present mode,
-- 'Vulkan.Extensions.VK_KHR_surface.PRESENT_MODE_FIFO_LATEST_READY_EXT'.
--
-- This tear-free present mode behaves much like
-- 'Vulkan.Extensions.VK_KHR_surface.PRESENT_MODE_FIFO_KHR', except that
-- each vertical blanking period dequeues consecutive present requests
-- until the latest ready is found to update the current image.
--
-- While this seems similar in concept to
-- 'Vulkan.Extensions.VK_KHR_surface.PRESENT_MODE_MAILBOX_KHR', the
-- fundamental difference is that the processing of the present requests is
-- done during vblank. From the application perspective, this means for
-- example, that in a flip-based model, a single vblank /may/ cause
-- multiple swapchain images to be released at once, while
-- 'Vulkan.Extensions.VK_KHR_surface.PRESENT_MODE_MAILBOX_KHR' /may/
-- continuously be releasing images as new requests become ready.
--
-- This additional present mode is useful when using a time-based present
-- API.
--
-- == New Structures
--
-- -   Extending
--     'Vulkan.Core11.Promoted_From_VK_KHR_get_physical_device_properties2.PhysicalDeviceFeatures2',
--     'Vulkan.Core10.Device.DeviceCreateInfo':
--
--     -   'PhysicalDevicePresentModeFifoLatestReadyFeaturesEXT'
--
-- == New Enum Constants
--
-- -   'EXT_PRESENT_MODE_FIFO_LATEST_READY_EXTENSION_NAME'
--
-- -   'EXT_PRESENT_MODE_FIFO_LATEST_READY_SPEC_VERSION'
--
-- -   Extending 'Vulkan.Extensions.VK_KHR_surface.PresentModeKHR':
--
--     -   'Vulkan.Extensions.VK_KHR_surface.PRESENT_MODE_FIFO_LATEST_READY_EXT'
--
-- -   Extending 'Vulkan.Core10.Enums.StructureType.StructureType':
--
--     -   'Vulkan.Core10.Enums.StructureType.STRUCTURE_TYPE_PHYSICAL_DEVICE_PRESENT_MODE_FIFO_LATEST_READY_FEATURES_EXT'
--
-- == Version History
--
-- -   Revision 1, 2024-05-28 (Lionel Duc)
--
--     -   Internal revisions
--
-- == See Also
--
-- No cross-references are available
--
-- == Document Notes
--
-- For more information, see the
-- <https://registry.khronos.org/vulkan/specs/1.3-extensions/html/vkspec.html#VK_EXT_present_mode_fifo_latest_ready 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_present_mode_fifo_latest_ready  ( PhysicalDevicePresentModeFifoLatestReadyFeaturesEXT(..)
                                                                , EXT_PRESENT_MODE_FIFO_LATEST_READY_SPEC_VERSION
                                                                , pattern EXT_PRESENT_MODE_FIFO_LATEST_READY_SPEC_VERSION
                                                                , EXT_PRESENT_MODE_FIFO_LATEST_READY_EXTENSION_NAME
                                                                , pattern EXT_PRESENT_MODE_FIFO_LATEST_READY_EXTENSION_NAME
                                                                , PresentModeKHR(..)
                                                                ) 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_PRESENT_MODE_FIFO_LATEST_READY_FEATURES_EXT))
import Vulkan.Extensions.VK_KHR_surface (PresentModeKHR(..))
-- | VkPhysicalDevicePresentModeFifoLatestReadyFeaturesEXT - Structure
-- describing support for VK_PRESENT_MODE_FIFO_LATEST_READY_EXT
--
-- = Description
--
-- If the 'PhysicalDevicePresentModeFifoLatestReadyFeaturesEXT' 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. 'PhysicalDevicePresentModeFifoLatestReadyFeaturesEXT' /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_present_mode_fifo_latest_ready VK_EXT_present_mode_fifo_latest_ready>,
-- 'Vulkan.Core10.FundamentalTypes.Bool32',
-- 'Vulkan.Core10.Enums.StructureType.StructureType'
data PhysicalDevicePresentModeFifoLatestReadyFeaturesEXT = PhysicalDevicePresentModeFifoLatestReadyFeaturesEXT
  { -- | #features-presentModeFifoLatestReady# @presentModeFifoLatestReady@
    -- specifies whether the implementation supports the
    -- 'Vulkan.Extensions.VK_KHR_surface.PRESENT_MODE_FIFO_LATEST_READY_EXT'
    -- present mode.
    PhysicalDevicePresentModeFifoLatestReadyFeaturesEXT -> Bool
presentModeFifoLatestReady :: Bool }
  deriving (Typeable, PhysicalDevicePresentModeFifoLatestReadyFeaturesEXT
-> PhysicalDevicePresentModeFifoLatestReadyFeaturesEXT -> Bool
(PhysicalDevicePresentModeFifoLatestReadyFeaturesEXT
 -> PhysicalDevicePresentModeFifoLatestReadyFeaturesEXT -> Bool)
-> (PhysicalDevicePresentModeFifoLatestReadyFeaturesEXT
    -> PhysicalDevicePresentModeFifoLatestReadyFeaturesEXT -> Bool)
-> Eq PhysicalDevicePresentModeFifoLatestReadyFeaturesEXT
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
$c== :: PhysicalDevicePresentModeFifoLatestReadyFeaturesEXT
-> PhysicalDevicePresentModeFifoLatestReadyFeaturesEXT -> Bool
== :: PhysicalDevicePresentModeFifoLatestReadyFeaturesEXT
-> PhysicalDevicePresentModeFifoLatestReadyFeaturesEXT -> Bool
$c/= :: PhysicalDevicePresentModeFifoLatestReadyFeaturesEXT
-> PhysicalDevicePresentModeFifoLatestReadyFeaturesEXT -> Bool
/= :: PhysicalDevicePresentModeFifoLatestReadyFeaturesEXT
-> PhysicalDevicePresentModeFifoLatestReadyFeaturesEXT -> Bool
Eq)
#if defined(GENERIC_INSTANCES)
deriving instance Generic (PhysicalDevicePresentModeFifoLatestReadyFeaturesEXT)
#endif
deriving instance Show PhysicalDevicePresentModeFifoLatestReadyFeaturesEXT

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

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

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


type EXT_PRESENT_MODE_FIFO_LATEST_READY_SPEC_VERSION = 1

-- No documentation found for TopLevel "VK_EXT_PRESENT_MODE_FIFO_LATEST_READY_SPEC_VERSION"
pattern EXT_PRESENT_MODE_FIFO_LATEST_READY_SPEC_VERSION :: forall a . Integral a => a
pattern $mEXT_PRESENT_MODE_FIFO_LATEST_READY_SPEC_VERSION :: forall {r} {a}.
Integral a =>
a -> ((# #) -> r) -> ((# #) -> r) -> r
$bEXT_PRESENT_MODE_FIFO_LATEST_READY_SPEC_VERSION :: forall a. Integral a => a
EXT_PRESENT_MODE_FIFO_LATEST_READY_SPEC_VERSION = 1


type EXT_PRESENT_MODE_FIFO_LATEST_READY_EXTENSION_NAME = "VK_EXT_present_mode_fifo_latest_ready"

-- No documentation found for TopLevel "VK_EXT_PRESENT_MODE_FIFO_LATEST_READY_EXTENSION_NAME"
pattern EXT_PRESENT_MODE_FIFO_LATEST_READY_EXTENSION_NAME :: forall a . (Eq a, IsString a) => a
pattern $mEXT_PRESENT_MODE_FIFO_LATEST_READY_EXTENSION_NAME :: forall {r} {a}.
(Eq a, IsString a) =>
a -> ((# #) -> r) -> ((# #) -> r) -> r
$bEXT_PRESENT_MODE_FIFO_LATEST_READY_EXTENSION_NAME :: forall a. (Eq a, IsString a) => a
EXT_PRESENT_MODE_FIFO_LATEST_READY_EXTENSION_NAME = "VK_EXT_present_mode_fifo_latest_ready"