vulkan-api-1.1.3.0: src-gen/Graphics/Vulkan/Ext/VK_KHR_android_surface.hs
{-# OPTIONS_GHC -fno-warn-orphans#-}
{-# OPTIONS_GHC -fno-warn-unused-imports#-}
{-# OPTIONS_HADDOCK not-home#-}
{-# LANGUAGE CPP #-}
{-# LANGUAGE DataKinds #-}
{-# LANGUAGE FlexibleInstances #-}
{-# LANGUAGE ForeignFunctionInterface #-}
{-# LANGUAGE MagicHash #-}
{-# LANGUAGE PatternSynonyms #-}
{-# LANGUAGE Strict #-}
{-# LANGUAGE TypeApplications #-}
{-# LANGUAGE TypeFamilies #-}
{-# LANGUAGE ViewPatterns #-}
module Graphics.Vulkan.Ext.VK_KHR_android_surface
(-- * Vulkan extension: @VK_KHR_android_surface@
-- |
--
-- supported: @vulkan@
--
-- contact: @Jesse Hall @critsec@
--
-- author: @KHR@
--
-- type: @instance@
--
-- platform: @android@
--
-- Extension number: @9@
--
-- Required extensions: 'VK_KHR_surface'.
--
-- ** Required extensions: 'VK_KHR_surface'.
module Graphics.Vulkan.Types.Bitmasks,
module Graphics.Vulkan.Types.Struct.PlatformAndroidKhr,
module Graphics.Vulkan.Types.BaseTypes,
module Graphics.Vulkan.Types.Enum.StructureType,
-- > #include "vk_platform.h"
VkCreateAndroidSurfaceKHR, pattern VkCreateAndroidSurfaceKHR,
HS_vkCreateAndroidSurfaceKHR, PFN_vkCreateAndroidSurfaceKHR,
vkCreateAndroidSurfaceKHR, vkCreateAndroidSurfaceKHRUnsafe,
vkCreateAndroidSurfaceKHRSafe, module Graphics.Vulkan.Marshal,
module Graphics.Vulkan.Types.Defines,
module Graphics.Vulkan.Types.Enum.InternalAllocationType,
module Graphics.Vulkan.Types.Enum.Result,
module Graphics.Vulkan.Types.Enum.SystemAllocationScope,
module Graphics.Vulkan.Types.Funcpointers,
module Graphics.Vulkan.Types.Handles,
module Graphics.Vulkan.Types.Struct.AllocationCallbacks,
VK_KHR_ANDROID_SURFACE_SPEC_VERSION,
pattern VK_KHR_ANDROID_SURFACE_SPEC_VERSION,
VK_KHR_ANDROID_SURFACE_EXTENSION_NAME,
pattern VK_KHR_ANDROID_SURFACE_EXTENSION_NAME,
pattern VK_STRUCTURE_TYPE_ANDROID_SURFACE_CREATE_INFO_KHR)
where
import GHC.Ptr (Ptr (..))
import Graphics.Vulkan.Marshal
import Graphics.Vulkan.Marshal.Proc
import Graphics.Vulkan.Types.BaseTypes
import Graphics.Vulkan.Types.Bitmasks
import Graphics.Vulkan.Types.Defines
import Graphics.Vulkan.Types.Enum.InternalAllocationType
import Graphics.Vulkan.Types.Enum.Result
import Graphics.Vulkan.Types.Enum.StructureType
import Graphics.Vulkan.Types.Enum.SystemAllocationScope
import Graphics.Vulkan.Types.Funcpointers
import Graphics.Vulkan.Types.Handles
import Graphics.Vulkan.Types.Struct.AllocationCallbacks
import Graphics.Vulkan.Types.Struct.PlatformAndroidKhr
import System.IO.Unsafe (unsafeDupablePerformIO)
pattern VkCreateAndroidSurfaceKHR :: CString
pattern VkCreateAndroidSurfaceKHR <-
(is_VkCreateAndroidSurfaceKHR -> True)
where VkCreateAndroidSurfaceKHR = _VkCreateAndroidSurfaceKHR
{-# INLINE _VkCreateAndroidSurfaceKHR #-}
_VkCreateAndroidSurfaceKHR :: CString
_VkCreateAndroidSurfaceKHR = Ptr "vkCreateAndroidSurfaceKHR\NUL"#
{-# INLINE is_VkCreateAndroidSurfaceKHR #-}
is_VkCreateAndroidSurfaceKHR :: CString -> Bool
is_VkCreateAndroidSurfaceKHR
= (EQ ==) . cmpCStrings _VkCreateAndroidSurfaceKHR
type VkCreateAndroidSurfaceKHR = "vkCreateAndroidSurfaceKHR"
-- |
-- Success codes: 'VK_SUCCESS'.
--
-- Error codes: 'VK_ERROR_OUT_OF_HOST_MEMORY', 'VK_ERROR_OUT_OF_DEVICE_MEMORY', 'VK_ERROR_NATIVE_WINDOW_IN_USE_KHR'.
--
-- > VkResult vkCreateAndroidSurfaceKHR
-- > ( VkInstance instance
-- > , const VkAndroidSurfaceCreateInfoKHR* pCreateInfo
-- > , const VkAllocationCallbacks* pAllocator
-- > , VkSurfaceKHR* pSurface
-- > )
--
-- <https://www.khronos.org/registry/vulkan/specs/1.1-extensions/html/vkspec.html#vkCreateAndroidSurfaceKHR vkCreateAndroidSurfaceKHR registry at www.khronos.org>
--
-- __Note:__ When @useNativeFFI-1-0@ cabal flag is enabled, this function is linked statically
-- as a @foreign import@ call to C Vulkan loader.
-- Otherwise, it is looked up dynamically at runtime using dlsym-like machinery (platform-dependent).
--
-- Independently of the flag setting, you can lookup the function manually at runtime:
--
-- > myCreateAndroidSurfaceKHR <- vkGetInstanceProc @VkCreateAndroidSurfaceKHR vkInstance
--
-- or less efficient:
--
-- > myCreateAndroidSurfaceKHR <- vkGetProc @VkCreateAndroidSurfaceKHR
--
-- __Note:__ @vkCreateAndroidSurfaceKHRUnsafe@ and @vkCreateAndroidSurfaceKHRSafe@ are the @unsafe@ and @safe@
-- FFI imports of this function, respectively. @vkCreateAndroidSurfaceKHR@ is an alias
-- of @vkCreateAndroidSurfaceKHRUnsafe@ when the @useUnsafeFFIDefault@ cabal flag
-- is enabled; otherwise, it is an alias of @vkCreateAndroidSurfaceKHRSafe@.
--
--
#ifdef NATIVE_FFI_VK_VERSION_1_0
foreign import ccall unsafe "vkCreateAndroidSurfaceKHR"
vkCreateAndroidSurfaceKHRUnsafe ::
VkInstance -- ^ instance
->
Ptr VkAndroidSurfaceCreateInfoKHR -- ^ pCreateInfo
->
Ptr VkAllocationCallbacks -- ^ pAllocator
-> Ptr VkSurfaceKHR -- ^ pSurface
-> IO VkResult
#else
vkCreateAndroidSurfaceKHRUnsafe ::
VkInstance -- ^ instance
->
Ptr VkAndroidSurfaceCreateInfoKHR -- ^ pCreateInfo
->
Ptr VkAllocationCallbacks -- ^ pAllocator
-> Ptr VkSurfaceKHR -- ^ pSurface
-> IO VkResult
vkCreateAndroidSurfaceKHRUnsafe
= unsafeDupablePerformIO
(vkGetProcUnsafe @VkCreateAndroidSurfaceKHR)
{-# NOINLINE vkCreateAndroidSurfaceKHRUnsafe #-}
#endif
-- |
-- Success codes: 'VK_SUCCESS'.
--
-- Error codes: 'VK_ERROR_OUT_OF_HOST_MEMORY', 'VK_ERROR_OUT_OF_DEVICE_MEMORY', 'VK_ERROR_NATIVE_WINDOW_IN_USE_KHR'.
--
-- > VkResult vkCreateAndroidSurfaceKHR
-- > ( VkInstance instance
-- > , const VkAndroidSurfaceCreateInfoKHR* pCreateInfo
-- > , const VkAllocationCallbacks* pAllocator
-- > , VkSurfaceKHR* pSurface
-- > )
--
-- <https://www.khronos.org/registry/vulkan/specs/1.1-extensions/html/vkspec.html#vkCreateAndroidSurfaceKHR vkCreateAndroidSurfaceKHR registry at www.khronos.org>
--
-- __Note:__ When @useNativeFFI-1-0@ cabal flag is enabled, this function is linked statically
-- as a @foreign import@ call to C Vulkan loader.
-- Otherwise, it is looked up dynamically at runtime using dlsym-like machinery (platform-dependent).
--
-- Independently of the flag setting, you can lookup the function manually at runtime:
--
-- > myCreateAndroidSurfaceKHR <- vkGetInstanceProc @VkCreateAndroidSurfaceKHR vkInstance
--
-- or less efficient:
--
-- > myCreateAndroidSurfaceKHR <- vkGetProc @VkCreateAndroidSurfaceKHR
--
-- __Note:__ @vkCreateAndroidSurfaceKHRUnsafe@ and @vkCreateAndroidSurfaceKHRSafe@ are the @unsafe@ and @safe@
-- FFI imports of this function, respectively. @vkCreateAndroidSurfaceKHR@ is an alias
-- of @vkCreateAndroidSurfaceKHRUnsafe@ when the @useUnsafeFFIDefault@ cabal flag
-- is enabled; otherwise, it is an alias of @vkCreateAndroidSurfaceKHRSafe@.
--
--
#ifdef NATIVE_FFI_VK_VERSION_1_0
foreign import ccall safe "vkCreateAndroidSurfaceKHR"
vkCreateAndroidSurfaceKHRSafe ::
VkInstance -- ^ instance
->
Ptr VkAndroidSurfaceCreateInfoKHR -- ^ pCreateInfo
->
Ptr VkAllocationCallbacks -- ^ pAllocator
-> Ptr VkSurfaceKHR -- ^ pSurface
-> IO VkResult
#else
vkCreateAndroidSurfaceKHRSafe ::
VkInstance -- ^ instance
->
Ptr VkAndroidSurfaceCreateInfoKHR -- ^ pCreateInfo
->
Ptr VkAllocationCallbacks -- ^ pAllocator
-> Ptr VkSurfaceKHR -- ^ pSurface
-> IO VkResult
vkCreateAndroidSurfaceKHRSafe
= unsafeDupablePerformIO (vkGetProcSafe @VkCreateAndroidSurfaceKHR)
{-# NOINLINE vkCreateAndroidSurfaceKHRSafe #-}
#endif
-- |
-- Success codes: 'VK_SUCCESS'.
--
-- Error codes: 'VK_ERROR_OUT_OF_HOST_MEMORY', 'VK_ERROR_OUT_OF_DEVICE_MEMORY', 'VK_ERROR_NATIVE_WINDOW_IN_USE_KHR'.
--
-- > VkResult vkCreateAndroidSurfaceKHR
-- > ( VkInstance instance
-- > , const VkAndroidSurfaceCreateInfoKHR* pCreateInfo
-- > , const VkAllocationCallbacks* pAllocator
-- > , VkSurfaceKHR* pSurface
-- > )
--
-- <https://www.khronos.org/registry/vulkan/specs/1.1-extensions/html/vkspec.html#vkCreateAndroidSurfaceKHR vkCreateAndroidSurfaceKHR registry at www.khronos.org>
--
-- __Note:__ When @useNativeFFI-1-0@ cabal flag is enabled, this function is linked statically
-- as a @foreign import@ call to C Vulkan loader.
-- Otherwise, it is looked up dynamically at runtime using dlsym-like machinery (platform-dependent).
--
-- Independently of the flag setting, you can lookup the function manually at runtime:
--
-- > myCreateAndroidSurfaceKHR <- vkGetInstanceProc @VkCreateAndroidSurfaceKHR vkInstance
--
-- or less efficient:
--
-- > myCreateAndroidSurfaceKHR <- vkGetProc @VkCreateAndroidSurfaceKHR
--
-- __Note:__ @vkCreateAndroidSurfaceKHRUnsafe@ and @vkCreateAndroidSurfaceKHRSafe@ are the @unsafe@ and @safe@
-- FFI imports of this function, respectively. @vkCreateAndroidSurfaceKHR@ is an alias
-- of @vkCreateAndroidSurfaceKHRUnsafe@ when the @useUnsafeFFIDefault@ cabal flag
-- is enabled; otherwise, it is an alias of @vkCreateAndroidSurfaceKHRSafe@.
--
vkCreateAndroidSurfaceKHR ::
VkInstance -- ^ instance
->
Ptr VkAndroidSurfaceCreateInfoKHR -- ^ pCreateInfo
->
Ptr VkAllocationCallbacks -- ^ pAllocator
-> Ptr VkSurfaceKHR -- ^ pSurface
-> IO VkResult
#ifdef UNSAFE_FFI_DEFAULT
vkCreateAndroidSurfaceKHR = vkCreateAndroidSurfaceKHRUnsafe
#else
vkCreateAndroidSurfaceKHR = vkCreateAndroidSurfaceKHRSafe
#endif
{-# INLINE vkCreateAndroidSurfaceKHR #-}
-- | Success codes: 'VK_SUCCESS'.
--
-- Error codes: 'VK_ERROR_OUT_OF_HOST_MEMORY', 'VK_ERROR_OUT_OF_DEVICE_MEMORY', 'VK_ERROR_NATIVE_WINDOW_IN_USE_KHR'.
--
-- > VkResult vkCreateAndroidSurfaceKHR
-- > ( VkInstance instance
-- > , const VkAndroidSurfaceCreateInfoKHR* pCreateInfo
-- > , const VkAllocationCallbacks* pAllocator
-- > , VkSurfaceKHR* pSurface
-- > )
--
-- <https://www.khronos.org/registry/vulkan/specs/1.1-extensions/html/vkspec.html#vkCreateAndroidSurfaceKHR vkCreateAndroidSurfaceKHR registry at www.khronos.org>
type HS_vkCreateAndroidSurfaceKHR =
VkInstance -- ^ instance
->
Ptr VkAndroidSurfaceCreateInfoKHR -- ^ pCreateInfo
->
Ptr VkAllocationCallbacks -- ^ pAllocator
-> Ptr VkSurfaceKHR -- ^ pSurface
-> IO VkResult
type PFN_vkCreateAndroidSurfaceKHR =
FunPtr HS_vkCreateAndroidSurfaceKHR
foreign import ccall unsafe "dynamic"
unwrapVkCreateAndroidSurfaceKHRUnsafe ::
PFN_vkCreateAndroidSurfaceKHR -> HS_vkCreateAndroidSurfaceKHR
foreign import ccall safe "dynamic"
unwrapVkCreateAndroidSurfaceKHRSafe ::
PFN_vkCreateAndroidSurfaceKHR -> HS_vkCreateAndroidSurfaceKHR
instance VulkanProc "vkCreateAndroidSurfaceKHR" where
type VkProcType "vkCreateAndroidSurfaceKHR" =
HS_vkCreateAndroidSurfaceKHR
vkProcSymbol = _VkCreateAndroidSurfaceKHR
{-# INLINE vkProcSymbol #-}
unwrapVkProcPtrUnsafe = unwrapVkCreateAndroidSurfaceKHRUnsafe
{-# INLINE unwrapVkProcPtrUnsafe #-}
unwrapVkProcPtrSafe = unwrapVkCreateAndroidSurfaceKHRSafe
{-# INLINE unwrapVkProcPtrSafe #-}
pattern VK_KHR_ANDROID_SURFACE_SPEC_VERSION :: (Num a, Eq a) => a
pattern VK_KHR_ANDROID_SURFACE_SPEC_VERSION = 6
type VK_KHR_ANDROID_SURFACE_SPEC_VERSION = 6
pattern VK_KHR_ANDROID_SURFACE_EXTENSION_NAME :: CString
pattern VK_KHR_ANDROID_SURFACE_EXTENSION_NAME <-
(is_VK_KHR_ANDROID_SURFACE_EXTENSION_NAME -> True)
where VK_KHR_ANDROID_SURFACE_EXTENSION_NAME
= _VK_KHR_ANDROID_SURFACE_EXTENSION_NAME
{-# INLINE _VK_KHR_ANDROID_SURFACE_EXTENSION_NAME #-}
_VK_KHR_ANDROID_SURFACE_EXTENSION_NAME :: CString
_VK_KHR_ANDROID_SURFACE_EXTENSION_NAME
= Ptr "VK_KHR_android_surface\NUL"#
{-# INLINE is_VK_KHR_ANDROID_SURFACE_EXTENSION_NAME #-}
is_VK_KHR_ANDROID_SURFACE_EXTENSION_NAME :: CString -> Bool
is_VK_KHR_ANDROID_SURFACE_EXTENSION_NAME
= (EQ ==) . cmpCStrings _VK_KHR_ANDROID_SURFACE_EXTENSION_NAME
type VK_KHR_ANDROID_SURFACE_EXTENSION_NAME =
"VK_KHR_android_surface"
pattern VK_STRUCTURE_TYPE_ANDROID_SURFACE_CREATE_INFO_KHR ::
VkStructureType
pattern VK_STRUCTURE_TYPE_ANDROID_SURFACE_CREATE_INFO_KHR =
VkStructureType 1000008000