content: {-# language CPP #-}
  -- | = Name
  --
  -- VK_FUCHSIA_imagepipe_surface - instance extension
  --
  -- == VK_FUCHSIA_imagepipe_surface
  --
  -- [__Name String__]
  --     @VK_FUCHSIA_imagepipe_surface@
  --
  -- [__Extension Type__]
  --     Instance extension
  --
  -- [__Registered Extension Number__]
  --     215
  --
  -- [__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_surface VK_KHR_surface>
  --
  -- [__Contact__]
  --
  --     -   Craig Stout
  --         <https://github.com/KhronosGroup/Vulkan-Docs/issues/new?body=[VK_FUCHSIA_imagepipe_surface] @cdotstout%0A*Here describe the issue or question you have about the VK_FUCHSIA_imagepipe_surface extension* >
  --
  -- == Other Extension Metadata
  --
  -- [__Last Modified Date__]
  --     2018-07-27
  --
  -- [__IP Status__]
  --     No known IP claims.
  --
  -- [__Contributors__]
  --
  --     -   Craig Stout, Google
  --
  --     -   Ian Elliott, Google
  --
  --     -   Jesse Hall, Google
  --
  -- == Description
  --
  -- The @VK_FUCHSIA_imagepipe_surface@ extension is an instance extension.
  -- It provides a mechanism to create a
  -- 'Vulkan.Extensions.Handles.SurfaceKHR' object (defined by the
  -- @VK_KHR_surface@ extension) that refers to a Fuchsia @imagePipeHandle@.
  --
  -- == New Commands
  --
  -- -   'createImagePipeSurfaceFUCHSIA'
  --
  -- == New Structures
  --
  -- -   'ImagePipeSurfaceCreateInfoFUCHSIA'
  --
  -- == New Bitmasks
  --
  -- -   'ImagePipeSurfaceCreateFlagsFUCHSIA'
  --
  -- == New Enum Constants
  --
  -- -   'FUCHSIA_IMAGEPIPE_SURFACE_EXTENSION_NAME'
  --
  -- -   'FUCHSIA_IMAGEPIPE_SURFACE_SPEC_VERSION'
  --
  -- -   Extending 'Vulkan.Core10.Enums.StructureType.StructureType':
  --
  --     -   'Vulkan.Core10.Enums.StructureType.STRUCTURE_TYPE_IMAGEPIPE_SURFACE_CREATE_INFO_FUCHSIA'
  --
  -- == Version History
  --
  -- -   Revision 1, 2018-07-27 (Craig Stout)
  --
  --     -   Initial draft.
  --
  -- == See Also
  --
  -- 'ImagePipeSurfaceCreateFlagsFUCHSIA',
  -- 'ImagePipeSurfaceCreateInfoFUCHSIA', 'createImagePipeSurfaceFUCHSIA'
  --
  -- == Document Notes
  --
  -- For more information, see the
  -- <https://registry.khronos.org/vulkan/specs/1.3-extensions/html/vkspec.html#VK_FUCHSIA_imagepipe_surface Vulkan Specification>
  --
  -- This page is a generated document. Fixes and changes should be made to
  -- the generator scripts, not directly.
  module Vulkan.Extensions.VK_FUCHSIA_imagepipe_surface  ( createImagePipeSurfaceFUCHSIA
                                                         , ImagePipeSurfaceCreateInfoFUCHSIA(..)
                                                         , ImagePipeSurfaceCreateFlagsFUCHSIA(..)
                                                         , FUCHSIA_IMAGEPIPE_SURFACE_SPEC_VERSION
                                                         , pattern FUCHSIA_IMAGEPIPE_SURFACE_SPEC_VERSION
                                                         , FUCHSIA_IMAGEPIPE_SURFACE_EXTENSION_NAME
                                                         , pattern FUCHSIA_IMAGEPIPE_SURFACE_EXTENSION_NAME
                                                         , Zx_handle_t
                                                         , SurfaceKHR(..)
                                                         ) where
  
  import Data.Bits (Bits)
  import Data.Bits (FiniteBits)
  import Vulkan.Internal.Utils (enumReadPrec)
  import Vulkan.Internal.Utils (enumShowsPrec)
  import Vulkan.Internal.Utils (traceAroundEvent)
  import Control.Exception.Base (bracket)
  import Control.Monad (unless)
  import Control.Monad.IO.Class (liftIO)
  import Foreign.Marshal.Alloc (allocaBytes)
  import Foreign.Marshal.Alloc (callocBytes)
  import Foreign.Marshal.Alloc (free)
  import GHC.Base (when)
  import GHC.IO (throwIO)
  import GHC.Ptr (nullFunPtr)
  import Foreign.Ptr (nullPtr)
  import Foreign.Ptr (plusPtr)
  import GHC.Show (showString)
  import Numeric (showHex)
  import Control.Monad.Trans.Class (lift)
  import Control.Monad.Trans.Cont (evalContT)
  import Vulkan.CStruct (FromCStruct)
  import Vulkan.CStruct (FromCStruct(..))
  import Vulkan.CStruct (ToCStruct)
  import Vulkan.CStruct (ToCStruct(..))
  import Vulkan.Zero (Zero)
  import Vulkan.Zero (Zero(..))
  import Control.Monad.IO.Class (MonadIO)
  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 GHC.IO.Exception (IOErrorType(..))
  import GHC.IO.Exception (IOException(..))
  import Foreign.Ptr (FunPtr)
  import Foreign.Ptr (Ptr)
  import GHC.Read (Read(readPrec))
  import GHC.Show (Show(showsPrec))
  import Data.Word (Word32)
  import Data.Kind (Type)
  import Control.Monad.Trans.Cont (ContT(..))
  import Vulkan.NamedType ((:::))
  import Vulkan.Core10.AllocationCallbacks (AllocationCallbacks)
  import Vulkan.Core10.FundamentalTypes (Flags)
  import Vulkan.Core10.Handles (Instance)
  import Vulkan.Core10.Handles (Instance(..))
  import Vulkan.Core10.Handles (Instance(Instance))
  import Vulkan.Dynamic (InstanceCmds(pVkCreateImagePipeSurfaceFUCHSIA))
  import Vulkan.Core10.Handles (Instance_T)
  import Vulkan.Core10.Enums.Result (Result)
  import Vulkan.Core10.Enums.Result (Result(..))
  import Vulkan.Core10.Enums.StructureType (StructureType)
  import Vulkan.Extensions.Handles (SurfaceKHR)
  import Vulkan.Extensions.Handles (SurfaceKHR(..))
  import Vulkan.Exception (VulkanException(..))
  import Vulkan.Core10.Enums.StructureType (StructureType(STRUCTURE_TYPE_IMAGEPIPE_SURFACE_CREATE_INFO_FUCHSIA))
  import Vulkan.Core10.Enums.Result (Result(SUCCESS))
  import Vulkan.Extensions.Handles (SurfaceKHR(..))
  foreign import ccall
  #if !defined(SAFE_FOREIGN_CALLS)
    unsafe
  #endif
    "dynamic" mkVkCreateImagePipeSurfaceFUCHSIA
    :: FunPtr (Ptr Instance_T -> Ptr ImagePipeSurfaceCreateInfoFUCHSIA -> Ptr AllocationCallbacks -> Ptr SurfaceKHR -> IO Result) -> Ptr Instance_T -> Ptr ImagePipeSurfaceCreateInfoFUCHSIA -> Ptr AllocationCallbacks -> Ptr SurfaceKHR -> IO Result
  
  -- | vkCreateImagePipeSurfaceFUCHSIA - Create a
  -- 'Vulkan.Extensions.Handles.SurfaceKHR' object for a Fuchsia ImagePipe
  --
  -- == Valid Usage (Implicit)
  --
  -- -   #VUID-vkCreateImagePipeSurfaceFUCHSIA-instance-parameter# @instance@
  --     /must/ be a valid 'Vulkan.Core10.Handles.Instance' handle
  --
  -- -   #VUID-vkCreateImagePipeSurfaceFUCHSIA-pCreateInfo-parameter#
  --     @pCreateInfo@ /must/ be a valid pointer to a valid
  --     'ImagePipeSurfaceCreateInfoFUCHSIA' structure
  --
  -- -   #VUID-vkCreateImagePipeSurfaceFUCHSIA-pAllocator-parameter# If
  --     @pAllocator@ is not @NULL@, @pAllocator@ /must/ be a valid pointer
  --     to a valid 'Vulkan.Core10.AllocationCallbacks.AllocationCallbacks'
  --     structure
  --
  -- -   #VUID-vkCreateImagePipeSurfaceFUCHSIA-pSurface-parameter# @pSurface@
  --     /must/ be a valid pointer to a
  --     'Vulkan.Extensions.Handles.SurfaceKHR' handle
  --
  -- == Return Codes
  --
  -- [<https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#fundamentals-successcodes Success>]
  --
  --     -   'Vulkan.Core10.Enums.Result.SUCCESS'
  --
  -- [<https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#fundamentals-errorcodes Failure>]
  --
  --     -   'Vulkan.Core10.Enums.Result.ERROR_OUT_OF_HOST_MEMORY'
  --
  --     -   'Vulkan.Core10.Enums.Result.ERROR_OUT_OF_DEVICE_MEMORY'
  --
  -- = See Also
  --
  -- <https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#VK_FUCHSIA_imagepipe_surface VK_FUCHSIA_imagepipe_surface>,
  -- 'Vulkan.Core10.AllocationCallbacks.AllocationCallbacks',
  -- 'ImagePipeSurfaceCreateInfoFUCHSIA', 'Vulkan.Core10.Handles.Instance',
  -- 'Vulkan.Extensions.Handles.SurfaceKHR'
  createImagePipeSurfaceFUCHSIA :: forall io
                                 . (MonadIO io)
                                => -- | @instance@ is the instance to associate with the surface.
                                   Instance
                                -> -- | @pCreateInfo@ is a pointer to a 'ImagePipeSurfaceCreateInfoFUCHSIA'
                                   -- structure containing parameters affecting the creation of the surface
                                   -- object.
                                   ImagePipeSurfaceCreateInfoFUCHSIA
                                -> -- | @pAllocator@ is the allocator used for host memory allocated for the
                                   -- surface object when there is no more specific allocator available (see
                                   -- <https://registry.khronos.org/vulkan/specs/1.3-extensions/html/vkspec.html#memory-allocation Memory Allocation>).
                                   ("allocator" ::: Maybe AllocationCallbacks)
                                -> io (SurfaceKHR)
  createImagePipeSurfaceFUCHSIA instance'
                                  createInfo
                                  allocator = liftIO . evalContT $ do
    let vkCreateImagePipeSurfaceFUCHSIAPtr = pVkCreateImagePipeSurfaceFUCHSIA (case instance' of Instance{instanceCmds} -> instanceCmds)
    lift $ unless (vkCreateImagePipeSurfaceFUCHSIAPtr /= nullFunPtr) $
      throwIO $ IOError Nothing InvalidArgument "" "The function pointer for vkCreateImagePipeSurfaceFUCHSIA is null" Nothing Nothing
    let vkCreateImagePipeSurfaceFUCHSIA' = mkVkCreateImagePipeSurfaceFUCHSIA vkCreateImagePipeSurfaceFUCHSIAPtr
    pCreateInfo <- ContT $ withCStruct (createInfo)
    pAllocator <- case (allocator) of
      Nothing -> pure nullPtr
      Just j -> ContT $ withCStruct (j)
    pPSurface <- ContT $ bracket (callocBytes @SurfaceKHR 8) free
    r <- lift $ traceAroundEvent "vkCreateImagePipeSurfaceFUCHSIA" (vkCreateImagePipeSurfaceFUCHSIA'
                                                                      (instanceHandle (instance'))
                                                                      pCreateInfo
                                                                      pAllocator
                                                                      (pPSurface))
    lift $ when (r < SUCCESS) (throwIO (VulkanException r))
    pSurface <- lift $ peek @SurfaceKHR pPSurface
    pure $ (pSurface)
  
  
  -- | VkImagePipeSurfaceCreateInfoFUCHSIA - Structure specifying parameters of
  -- a newly created ImagePipe surface object
  --
  -- == Valid Usage (Implicit)
  --
  -- = See Also
  --
  -- <https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#VK_FUCHSIA_imagepipe_surface VK_FUCHSIA_imagepipe_surface>,
  -- 'ImagePipeSurfaceCreateFlagsFUCHSIA',
  -- 'Vulkan.Core10.Enums.StructureType.StructureType',
  -- 'createImagePipeSurfaceFUCHSIA'
  data ImagePipeSurfaceCreateInfoFUCHSIA = ImagePipeSurfaceCreateInfoFUCHSIA
    { -- | @flags@ is reserved for future use.
      --
      -- #VUID-VkImagePipeSurfaceCreateInfoFUCHSIA-flags-zerobitmask# @flags@
      -- /must/ be @0@
      flags :: ImagePipeSurfaceCreateFlagsFUCHSIA
    , -- | @imagePipeHandle@ is a @zx_handle_t@ referring to the ImagePipe to
      -- associate with the surface.
      --
      -- #VUID-VkImagePipeSurfaceCreateInfoFUCHSIA-imagePipeHandle-04863#
      -- @imagePipeHandle@ /must/ be a valid @zx_handle_t@
      imagePipeHandle :: Zx_handle_t
    }
    deriving (Typeable, Eq)
  #if defined(GENERIC_INSTANCES)
  deriving instance Generic (ImagePipeSurfaceCreateInfoFUCHSIA)
  #endif
  deriving instance Show ImagePipeSurfaceCreateInfoFUCHSIA
  
  instance ToCStruct ImagePipeSurfaceCreateInfoFUCHSIA where
    withCStruct x f = allocaBytes 24 $ \p -> pokeCStruct p x (f p)
    pokeCStruct p ImagePipeSurfaceCreateInfoFUCHSIA{..} f = do
      poke ((p `plusPtr` 0 :: Ptr StructureType)) (STRUCTURE_TYPE_IMAGEPIPE_SURFACE_CREATE_INFO_FUCHSIA)
      poke ((p `plusPtr` 8 :: Ptr (Ptr ()))) (nullPtr)
      poke ((p `plusPtr` 16 :: Ptr ImagePipeSurfaceCreateFlagsFUCHSIA)) (flags)
      poke ((p `plusPtr` 20 :: Ptr Zx_handle_t)) (imagePipeHandle)
      f
    cStructSize = 24
    cStructAlignment = 8
    pokeZeroCStruct p f = do
      poke ((p `plusPtr` 0 :: Ptr StructureType)) (STRUCTURE_TYPE_IMAGEPIPE_SURFACE_CREATE_INFO_FUCHSIA)
      poke ((p `plusPtr` 8 :: Ptr (Ptr ()))) (nullPtr)
      poke ((p `plusPtr` 20 :: Ptr Zx_handle_t)) (zero)
      f
  
  instance FromCStruct ImagePipeSurfaceCreateInfoFUCHSIA where
    peekCStruct p = do
      flags <- peek @ImagePipeSurfaceCreateFlagsFUCHSIA ((p `plusPtr` 16 :: Ptr ImagePipeSurfaceCreateFlagsFUCHSIA))
      imagePipeHandle <- peek @Zx_handle_t ((p `plusPtr` 20 :: Ptr Zx_handle_t))
      pure $ ImagePipeSurfaceCreateInfoFUCHSIA
               flags imagePipeHandle
  
  instance Storable ImagePipeSurfaceCreateInfoFUCHSIA where
    sizeOf ~_ = 24
    alignment ~_ = 8
    peek = peekCStruct
    poke ptr poked = pokeCStruct ptr poked (pure ())
  
  instance Zero ImagePipeSurfaceCreateInfoFUCHSIA where
    zero = ImagePipeSurfaceCreateInfoFUCHSIA
             zero
             zero
  
  
  -- | VkImagePipeSurfaceCreateFlagsFUCHSIA - Reserved for future use
  --
  -- = Description
  --
  -- 'ImagePipeSurfaceCreateFlagsFUCHSIA' is a bitmask type for setting a
  -- mask, but is currently reserved for future use.
  --
  -- = See Also
  --
  -- <https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#VK_FUCHSIA_imagepipe_surface VK_FUCHSIA_imagepipe_surface>,
  -- 'ImagePipeSurfaceCreateInfoFUCHSIA'
  newtype ImagePipeSurfaceCreateFlagsFUCHSIA = ImagePipeSurfaceCreateFlagsFUCHSIA Flags
    deriving newtype (Eq, Ord, Storable, Zero, Bits, FiniteBits)
  
  conNameImagePipeSurfaceCreateFlagsFUCHSIA :: String
  conNameImagePipeSurfaceCreateFlagsFUCHSIA = "ImagePipeSurfaceCreateFlagsFUCHSIA"
  
  enumPrefixImagePipeSurfaceCreateFlagsFUCHSIA :: String
  enumPrefixImagePipeSurfaceCreateFlagsFUCHSIA = ""
  
  showTableImagePipeSurfaceCreateFlagsFUCHSIA :: [(ImagePipeSurfaceCreateFlagsFUCHSIA, String)]
  showTableImagePipeSurfaceCreateFlagsFUCHSIA = []
  
  instance Show ImagePipeSurfaceCreateFlagsFUCHSIA where
    showsPrec =
      enumShowsPrec
        enumPrefixImagePipeSurfaceCreateFlagsFUCHSIA
        showTableImagePipeSurfaceCreateFlagsFUCHSIA
        conNameImagePipeSurfaceCreateFlagsFUCHSIA
        (\(ImagePipeSurfaceCreateFlagsFUCHSIA x) -> x)
        (\x -> showString "0x" . showHex x)
  
  instance Read ImagePipeSurfaceCreateFlagsFUCHSIA where
    readPrec =
      enumReadPrec
        enumPrefixImagePipeSurfaceCreateFlagsFUCHSIA
        showTableImagePipeSurfaceCreateFlagsFUCHSIA
        conNameImagePipeSurfaceCreateFlagsFUCHSIA
        ImagePipeSurfaceCreateFlagsFUCHSIA
  
  type FUCHSIA_IMAGEPIPE_SURFACE_SPEC_VERSION = 1
  
  -- No documentation found for TopLevel "VK_FUCHSIA_IMAGEPIPE_SURFACE_SPEC_VERSION"
  pattern FUCHSIA_IMAGEPIPE_SURFACE_SPEC_VERSION :: forall a . Integral a => a
  pattern FUCHSIA_IMAGEPIPE_SURFACE_SPEC_VERSION = 1
  
  
  type FUCHSIA_IMAGEPIPE_SURFACE_EXTENSION_NAME = "VK_FUCHSIA_imagepipe_surface"
  
  -- No documentation found for TopLevel "VK_FUCHSIA_IMAGEPIPE_SURFACE_EXTENSION_NAME"
  pattern FUCHSIA_IMAGEPIPE_SURFACE_EXTENSION_NAME :: forall a . (Eq a, IsString a) => a
  pattern FUCHSIA_IMAGEPIPE_SURFACE_EXTENSION_NAME = "VK_FUCHSIA_imagepipe_surface"
  
  
  type Zx_handle_t = Word32
  
  