vulkan-3.8.1: Bindings to the Vulkan graphics API.
Safe HaskellNone
LanguageHaskell2010

Vulkan.Extensions.VK_MVK_ios_surface

Description

Name

VK_MVK_ios_surface - instance extension

VK_MVK_ios_surface

Name String
VK_MVK_ios_surface
Extension Type
Instance extension
Registered Extension Number
123
Revision
3
Extension and Version Dependencies
  • Requires Vulkan 1.0
  • Requires VK_KHR_surface
Deprecation state
  • Deprecated by VK_EXT_metal_surface extension
Contact

Other Extension Metadata

Last Modified Date
2020-07-31
IP Status
No known IP claims.
Contributors
  • Bill Hollings, The Brenwill Workshop Ltd.

Description

The VK_MVK_ios_surface extension is an instance extension. It provides a mechanism to create a SurfaceKHR object (defined by the VK_KHR_surface extension) based on a UIView, the native surface type of iOS, which is underpinned by a CAMetalLayer, to support rendering to the surface using Apple’s Metal framework.

Deprecation by VK_EXT_metal_surface

The VK_MVK_ios_surface extension is considered deprecated and has been superseded by the VK_EXT_metal_surface extension.

New Commands

New Structures

New Bitmasks

New Enum Constants

Version History

  • Revision 1, 2017-02-15 (Bill Hollings)

    • Initial draft.

  • Revision 2, 2017-02-24 (Bill Hollings)

    • Minor syntax fix to emphasize firm requirement for UIView to be backed by a CAMetalLayer.

  • Revision 3, 2020-07-31 (Bill Hollings)

    • Update documentation on requirements for UIView.
    • Mark as deprecated by VK_EXT_metal_surface.

See Also

IOSSurfaceCreateFlagsMVK, IOSSurfaceCreateInfoMVK, createIOSSurfaceMVK

Document Notes

For more information, see the Vulkan Specification

This page is a generated document. Fixes and changes should be made to the generator scripts, not directly.

Synopsis

Documentation

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

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

Return Codes

Success
Failure

See Also

AllocationCallbacks, IOSSurfaceCreateInfoMVK, Instance, SurfaceKHR

data IOSSurfaceCreateInfoMVK Source #

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

Valid Usage

  • 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)

  • pNext must be NULL
  • flags must be 0

See Also

IOSSurfaceCreateFlagsMVK, StructureType, createIOSSurfaceMVK

Constructors

IOSSurfaceCreateInfoMVK 

Fields

Instances

Instances details
Show IOSSurfaceCreateInfoMVK Source # 
Instance details

Defined in Vulkan.Extensions.VK_MVK_ios_surface

Methods

showsPrec :: Int -> IOSSurfaceCreateInfoMVK -> ShowS #

show :: IOSSurfaceCreateInfoMVK -> String #

showList :: [IOSSurfaceCreateInfoMVK] -> ShowS #

Storable IOSSurfaceCreateInfoMVK Source # 
Instance details

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 Source # 
Instance details

Defined in Vulkan.Extensions.VK_MVK_ios_surface

Methods

peekCStruct :: Ptr IOSSurfaceCreateInfoMVK -> IO IOSSurfaceCreateInfoMVK Source #

ToCStruct IOSSurfaceCreateInfoMVK Source # 
Instance details

Defined in Vulkan.Extensions.VK_MVK_ios_surface

Methods

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

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

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

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

cStructSize :: Int Source #

cStructAlignment :: Int Source #

Zero IOSSurfaceCreateInfoMVK Source # 
Instance details

Defined in Vulkan.Extensions.VK_MVK_ios_surface

Methods

zero :: IOSSurfaceCreateInfoMVK Source #

newtype IOSSurfaceCreateFlagsMVK Source #

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

Instances details
Eq IOSSurfaceCreateFlagsMVK Source # 
Instance details

Defined in Vulkan.Extensions.VK_MVK_ios_surface

Methods

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

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

Ord IOSSurfaceCreateFlagsMVK Source # 
Instance details

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 Source # 
Instance details

Defined in Vulkan.Extensions.VK_MVK_ios_surface

Methods

readsPrec :: Int -> ReadS IOSSurfaceCreateFlagsMVK #

readList :: ReadS [IOSSurfaceCreateFlagsMVK] #

readPrec :: ReadPrec IOSSurfaceCreateFlagsMVK #

readListPrec :: ReadPrec [IOSSurfaceCreateFlagsMVK] #

Show IOSSurfaceCreateFlagsMVK Source # 
Instance details

Defined in Vulkan.Extensions.VK_MVK_ios_surface

Methods

showsPrec :: Int -> IOSSurfaceCreateFlagsMVK -> ShowS #

show :: IOSSurfaceCreateFlagsMVK -> String #

showList :: [IOSSurfaceCreateFlagsMVK] -> ShowS #

Storable IOSSurfaceCreateFlagsMVK Source # 
Instance details

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 Source # 
Instance details

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 #

FiniteBits IOSSurfaceCreateFlagsMVK Source # 
Instance details

Defined in Vulkan.Extensions.VK_MVK_ios_surface

Methods

finiteBitSize :: IOSSurfaceCreateFlagsMVK -> Int #

countLeadingZeros :: IOSSurfaceCreateFlagsMVK -> Int #

countTrailingZeros :: IOSSurfaceCreateFlagsMVK -> Int #

Zero IOSSurfaceCreateFlagsMVK Source # 
Instance details

Defined in Vulkan.Extensions.VK_MVK_ios_surface

Methods

zero :: IOSSurfaceCreateFlagsMVK Source #

type MVK_IOS_SURFACE_SPEC_VERSION = 3 Source #

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

type MVK_IOS_SURFACE_EXTENSION_NAME = "VK_MVK_ios_surface" Source #

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

newtype SurfaceKHR Source #

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

Instances details
Eq SurfaceKHR Source # 
Instance details

Defined in Vulkan.Extensions.Handles

Methods

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

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

Ord SurfaceKHR Source # 
Instance details

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 Source # 
Instance details

Defined in Vulkan.Extensions.Handles

Methods

showsPrec :: Int -> SurfaceKHR -> ShowS #

show :: SurfaceKHR -> String #

showList :: [SurfaceKHR] -> ShowS #

Storable SurfaceKHR Source # 
Instance details

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 Source # 
Instance details

Defined in Vulkan.Extensions.Handles

Methods

zero :: SurfaceKHR Source #

HasObjectType SurfaceKHR Source # 
Instance details

Defined in Vulkan.Extensions.Handles

Methods

objectTypeAndHandle :: SurfaceKHR -> (ObjectType, Word64) Source #

IsHandle SurfaceKHR Source # 
Instance details

Defined in Vulkan.Extensions.Handles