Vulkan.Extensions.VK_MVK_ios_surface

Documentation

createIOSSurfaceMVK :: forall io. MonadIO io => Instance -> IOSSurfaceCreateInfoMVK -> ("allocator" ::: Maybe AllocationCallbacks) -> io SurfaceKHR

vkCreateIOSSurfaceMVK - Create a VkSurfaceKHR object for an iOS UIView

Parameters

Note

The createIOSSurfaceMVK function is considered deprecated and has been superseded by createMetalSurfaceEXT from the VK_EXT_metal_surface extension.

Description

• instance is the instance with which to associate the surface.

• pCreateInfo is a pointer to a IOSSurfaceCreateInfoMVK structure containing parameters affecting the creation of the surface object.
• pAllocator is the allocator used for host memory allocated for the surface object when there is no more specific allocator available (see Memory Allocation).
• pSurface is a pointer to a SurfaceKHR handle in which the created surface object is returned.

Valid Usage (Implicit)

• instance must be a valid Instance handle

• pCreateInfo must be a valid pointer to a valid IOSSurfaceCreateInfoMVK structure
• If pAllocator is not NULL, pAllocator must be a valid pointer to a valid AllocationCallbacks structure
• pSurface must be a valid pointer to a SurfaceKHR handle

Return Codes

Success

• SUCCESS

Failure

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY
• ERROR_NATIVE_WINDOW_IN_USE_KHR

See Also

AllocationCallbacks, IOSSurfaceCreateInfoMVK, Instance, SurfaceKHR

data IOSSurfaceCreateInfoMVK

VkIOSSurfaceCreateInfoMVK - Structure specifying parameters of a newly created iOS surface object

Valid Usage

• If pView is a CAMetalLayer object, it must be a valid CAMetalLayer.

• If pView is a UIView object, it must be a valid UIView, must be backed by a CALayer object of type CAMetalLayer, and createIOSSurfaceMVK must be called on the main thread.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_IOS_SURFACE_CREATE_INFO_MVK

• pNext must be NULL
• flags must be 0

See Also

IOSSurfaceCreateFlagsMVK, StructureType, createIOSSurfaceMVK

Constructors

IOSSurfaceCreateInfoMVK

Fields

• flags :: IOSSurfaceCreateFlagsMVK

  flags is reserved for future use.

• view :: Ptr ()

  pView is a reference to either a CAMetalLayer object or a UIView object.

Instances

Show IOSSurfaceCreateInfoMVK

Defined in Vulkan.Extensions.VK_MVK_ios_surface

Methods

showsPrec :: Int -> IOSSurfaceCreateInfoMVK -> ShowS

show :: IOSSurfaceCreateInfoMVK -> String

showList :: [IOSSurfaceCreateInfoMVK] -> ShowS

Generic IOSSurfaceCreateInfoMVK

Defined in Vulkan.Extensions.VK_MVK_ios_surface

Associated Types

type Rep IOSSurfaceCreateInfoMVK :: Type -> Type

Methods

from :: IOSSurfaceCreateInfoMVK -> Rep IOSSurfaceCreateInfoMVK x

to :: Rep IOSSurfaceCreateInfoMVK x -> IOSSurfaceCreateInfoMVK

Storable IOSSurfaceCreateInfoMVK

Defined in Vulkan.Extensions.VK_MVK_ios_surface

Methods

sizeOf :: IOSSurfaceCreateInfoMVK -> Int

alignment :: IOSSurfaceCreateInfoMVK -> Int

peekElemOff :: Ptr IOSSurfaceCreateInfoMVK -> Int -> IO IOSSurfaceCreateInfoMVK

pokeElemOff :: Ptr IOSSurfaceCreateInfoMVK -> Int -> IOSSurfaceCreateInfoMVK -> IO ()

peekByteOff :: Ptr b -> Int -> IO IOSSurfaceCreateInfoMVK

pokeByteOff :: Ptr b -> Int -> IOSSurfaceCreateInfoMVK -> IO ()

peek :: Ptr IOSSurfaceCreateInfoMVK -> IO IOSSurfaceCreateInfoMVK

poke :: Ptr IOSSurfaceCreateInfoMVK -> IOSSurfaceCreateInfoMVK -> IO ()

FromCStruct IOSSurfaceCreateInfoMVK

Defined in Vulkan.Extensions.VK_MVK_ios_surface

Methods

peekCStruct :: Ptr IOSSurfaceCreateInfoMVK -> IO IOSSurfaceCreateInfoMVK

ToCStruct IOSSurfaceCreateInfoMVK

Defined in Vulkan.Extensions.VK_MVK_ios_surface

Methods

withCStruct :: IOSSurfaceCreateInfoMVK -> (Ptr IOSSurfaceCreateInfoMVK -> IO b) -> IO b

pokeCStruct :: Ptr IOSSurfaceCreateInfoMVK -> IOSSurfaceCreateInfoMVK -> IO b -> IO b

withZeroCStruct :: (Ptr IOSSurfaceCreateInfoMVK -> IO b) -> IO b

pokeZeroCStruct :: Ptr IOSSurfaceCreateInfoMVK -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero IOSSurfaceCreateInfoMVK

Defined in Vulkan.Extensions.VK_MVK_ios_surface

Methods

zero :: IOSSurfaceCreateInfoMVK

type Rep IOSSurfaceCreateInfoMVK

Defined in Vulkan.Extensions.VK_MVK_ios_surface

type Rep IOSSurfaceCreateInfoMVK = D1 ('MetaData "IOSSurfaceCreateInfoMVK" "Vulkan.Extensions.VK_MVK_ios_surface" "vulkan-3.6.4-inplace" 'False) (C1 ('MetaCons "IOSSurfaceCreateInfoMVK" 'PrefixI 'True) (S1 ('MetaSel ('Just "flags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 IOSSurfaceCreateFlagsMVK) :*: S1 ('MetaSel ('Just "view") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Ptr ()))))

newtype IOSSurfaceCreateFlagsMVK

VkIOSSurfaceCreateFlagsMVK - Reserved for future use

Description

IOSSurfaceCreateFlagsMVK is a bitmask type for setting a mask, but is currently reserved for future use.

See Also

IOSSurfaceCreateInfoMVK

Constructors

IOSSurfaceCreateFlagsMVK Flags

Instances

Eq IOSSurfaceCreateFlagsMVK

Defined in Vulkan.Extensions.VK_MVK_ios_surface

Methods

(==) :: IOSSurfaceCreateFlagsMVK -> IOSSurfaceCreateFlagsMVK -> Bool

(/=) :: IOSSurfaceCreateFlagsMVK -> IOSSurfaceCreateFlagsMVK -> Bool

Ord IOSSurfaceCreateFlagsMVK

Defined in Vulkan.Extensions.VK_MVK_ios_surface

Methods

compare :: IOSSurfaceCreateFlagsMVK -> IOSSurfaceCreateFlagsMVK -> Ordering

(<) :: IOSSurfaceCreateFlagsMVK -> IOSSurfaceCreateFlagsMVK -> Bool

(<=) :: IOSSurfaceCreateFlagsMVK -> IOSSurfaceCreateFlagsMVK -> Bool

(>) :: IOSSurfaceCreateFlagsMVK -> IOSSurfaceCreateFlagsMVK -> Bool

(>=) :: IOSSurfaceCreateFlagsMVK -> IOSSurfaceCreateFlagsMVK -> Bool

max :: IOSSurfaceCreateFlagsMVK -> IOSSurfaceCreateFlagsMVK -> IOSSurfaceCreateFlagsMVK

min :: IOSSurfaceCreateFlagsMVK -> IOSSurfaceCreateFlagsMVK -> IOSSurfaceCreateFlagsMVK

Read IOSSurfaceCreateFlagsMVK

Defined in Vulkan.Extensions.VK_MVK_ios_surface

Methods

readsPrec :: Int -> ReadS IOSSurfaceCreateFlagsMVK

readList :: ReadS [IOSSurfaceCreateFlagsMVK]

readPrec :: ReadPrec IOSSurfaceCreateFlagsMVK

readListPrec :: ReadPrec [IOSSurfaceCreateFlagsMVK]

Show IOSSurfaceCreateFlagsMVK

Defined in Vulkan.Extensions.VK_MVK_ios_surface

Methods

showsPrec :: Int -> IOSSurfaceCreateFlagsMVK -> ShowS

show :: IOSSurfaceCreateFlagsMVK -> String

showList :: [IOSSurfaceCreateFlagsMVK] -> ShowS

Storable IOSSurfaceCreateFlagsMVK

Defined in Vulkan.Extensions.VK_MVK_ios_surface

Methods

sizeOf :: IOSSurfaceCreateFlagsMVK -> Int

alignment :: IOSSurfaceCreateFlagsMVK -> Int

peekElemOff :: Ptr IOSSurfaceCreateFlagsMVK -> Int -> IO IOSSurfaceCreateFlagsMVK

pokeElemOff :: Ptr IOSSurfaceCreateFlagsMVK -> Int -> IOSSurfaceCreateFlagsMVK -> IO ()

peekByteOff :: Ptr b -> Int -> IO IOSSurfaceCreateFlagsMVK

pokeByteOff :: Ptr b -> Int -> IOSSurfaceCreateFlagsMVK -> IO ()

peek :: Ptr IOSSurfaceCreateFlagsMVK -> IO IOSSurfaceCreateFlagsMVK

poke :: Ptr IOSSurfaceCreateFlagsMVK -> IOSSurfaceCreateFlagsMVK -> IO ()

Bits IOSSurfaceCreateFlagsMVK

Defined in Vulkan.Extensions.VK_MVK_ios_surface

Methods

(.&.) :: IOSSurfaceCreateFlagsMVK -> IOSSurfaceCreateFlagsMVK -> IOSSurfaceCreateFlagsMVK

(.|.) :: IOSSurfaceCreateFlagsMVK -> IOSSurfaceCreateFlagsMVK -> IOSSurfaceCreateFlagsMVK

xor :: IOSSurfaceCreateFlagsMVK -> IOSSurfaceCreateFlagsMVK -> IOSSurfaceCreateFlagsMVK

complement :: IOSSurfaceCreateFlagsMVK -> IOSSurfaceCreateFlagsMVK

shift :: IOSSurfaceCreateFlagsMVK -> Int -> IOSSurfaceCreateFlagsMVK

rotate :: IOSSurfaceCreateFlagsMVK -> Int -> IOSSurfaceCreateFlagsMVK

zeroBits :: IOSSurfaceCreateFlagsMVK

bit :: Int -> IOSSurfaceCreateFlagsMVK

setBit :: IOSSurfaceCreateFlagsMVK -> Int -> IOSSurfaceCreateFlagsMVK

clearBit :: IOSSurfaceCreateFlagsMVK -> Int -> IOSSurfaceCreateFlagsMVK

complementBit :: IOSSurfaceCreateFlagsMVK -> Int -> IOSSurfaceCreateFlagsMVK

testBit :: IOSSurfaceCreateFlagsMVK -> Int -> Bool

bitSizeMaybe :: IOSSurfaceCreateFlagsMVK -> Maybe Int

bitSize :: IOSSurfaceCreateFlagsMVK -> Int

isSigned :: IOSSurfaceCreateFlagsMVK -> Bool

shiftL :: IOSSurfaceCreateFlagsMVK -> Int -> IOSSurfaceCreateFlagsMVK

unsafeShiftL :: IOSSurfaceCreateFlagsMVK -> Int -> IOSSurfaceCreateFlagsMVK

shiftR :: IOSSurfaceCreateFlagsMVK -> Int -> IOSSurfaceCreateFlagsMVK

unsafeShiftR :: IOSSurfaceCreateFlagsMVK -> Int -> IOSSurfaceCreateFlagsMVK

rotateL :: IOSSurfaceCreateFlagsMVK -> Int -> IOSSurfaceCreateFlagsMVK

rotateR :: IOSSurfaceCreateFlagsMVK -> Int -> IOSSurfaceCreateFlagsMVK

popCount :: IOSSurfaceCreateFlagsMVK -> Int

Zero IOSSurfaceCreateFlagsMVK

Defined in Vulkan.Extensions.VK_MVK_ios_surface

Methods

zero :: IOSSurfaceCreateFlagsMVK

type MVK_IOS_SURFACE_SPEC_VERSION = 3

pattern MVK_IOS_SURFACE_SPEC_VERSION :: forall a. Integral a => a

type MVK_IOS_SURFACE_EXTENSION_NAME = "VK_MVK_ios_surface"

pattern MVK_IOS_SURFACE_EXTENSION_NAME :: forall a. (Eq a, IsString a) => a

newtype SurfaceKHR

VkSurfaceKHR - Opaque handle to a surface object

Description

The VK_KHR_surface extension declares the SurfaceKHR object, and provides a function for destroying SurfaceKHR objects. Separate platform-specific extensions each provide a function for creating a SurfaceKHR object for the respective platform. From the application’s perspective this is an opaque handle, just like the handles of other Vulkan objects.

See Also

PhysicalDeviceSurfaceInfo2KHR, SwapchainCreateInfoKHR, createAndroidSurfaceKHR, createDirectFBSurfaceEXT, createDisplayPlaneSurfaceKHR, createHeadlessSurfaceEXT, createIOSSurfaceMVK, createImagePipeSurfaceFUCHSIA, createMacOSSurfaceMVK, createMetalSurfaceEXT, createStreamDescriptorSurfaceGGP, createViSurfaceNN, createWaylandSurfaceKHR, createWin32SurfaceKHR, createXcbSurfaceKHR, createXlibSurfaceKHR, destroySurfaceKHR, getDeviceGroupSurfacePresentModesKHR, getPhysicalDevicePresentRectanglesKHR, getPhysicalDeviceSurfaceCapabilities2EXT, getPhysicalDeviceSurfaceCapabilitiesKHR, getPhysicalDeviceSurfaceFormatsKHR, getPhysicalDeviceSurfacePresentModesKHR, getPhysicalDeviceSurfaceSupportKHR

Constructors

SurfaceKHR Word64

Instances

Eq SurfaceKHR

Defined in Vulkan.Extensions.Handles

Methods

(==) :: SurfaceKHR -> SurfaceKHR -> Bool

(/=) :: SurfaceKHR -> SurfaceKHR -> Bool

Ord SurfaceKHR

Defined in Vulkan.Extensions.Handles

Methods

compare :: SurfaceKHR -> SurfaceKHR -> Ordering

(<) :: SurfaceKHR -> SurfaceKHR -> Bool

(<=) :: SurfaceKHR -> SurfaceKHR -> Bool

(>) :: SurfaceKHR -> SurfaceKHR -> Bool

(>=) :: SurfaceKHR -> SurfaceKHR -> Bool

max :: SurfaceKHR -> SurfaceKHR -> SurfaceKHR

min :: SurfaceKHR -> SurfaceKHR -> SurfaceKHR

Show SurfaceKHR

Defined in Vulkan.Extensions.Handles

Methods

showsPrec :: Int -> SurfaceKHR -> ShowS

show :: SurfaceKHR -> String

showList :: [SurfaceKHR] -> ShowS

Storable SurfaceKHR

Defined in Vulkan.Extensions.Handles

Methods

sizeOf :: SurfaceKHR -> Int

alignment :: SurfaceKHR -> Int

peekElemOff :: Ptr SurfaceKHR -> Int -> IO SurfaceKHR

pokeElemOff :: Ptr SurfaceKHR -> Int -> SurfaceKHR -> IO ()

peekByteOff :: Ptr b -> Int -> IO SurfaceKHR

pokeByteOff :: Ptr b -> Int -> SurfaceKHR -> IO ()

peek :: Ptr SurfaceKHR -> IO SurfaceKHR

poke :: Ptr SurfaceKHR -> SurfaceKHR -> IO ()

Zero SurfaceKHR

Defined in Vulkan.Extensions.Handles

Methods

zero :: SurfaceKHR

HasObjectType SurfaceKHR

Defined in Vulkan.Extensions.Handles

Methods

objectTypeAndHandle :: SurfaceKHR -> (ObjectType, Word64)

IsHandle SurfaceKHR

Defined in Vulkan.Extensions.Handles