Vulkan.Extensions.VK_EXT_metal_surface

Documentation

createMetalSurfaceEXT

Arguments

:: forall io. MonadIO io

=> Instance

instance is the instance with which to associate the surface.

-> MetalSurfaceCreateInfoEXT

pCreateInfo is a pointer to a MetalSurfaceCreateInfoEXT structure specifying parameters affecting the creation of the surface object.

-> ("allocator" ::: Maybe AllocationCallbacks)

pAllocator is the allocator used for host memory allocated for the surface object when there is no more specific allocator available (see Memory Allocation).

-> io SurfaceKHR

vkCreateMetalSurfaceEXT - Create a VkSurfaceKHR object for CAMetalLayer

Valid Usage (Implicit)

• instance must be a valid Instance handle

• pCreateInfo must be a valid pointer to a valid MetalSurfaceCreateInfoEXT 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, Instance, MetalSurfaceCreateInfoEXT, SurfaceKHR

data MetalSurfaceCreateInfoEXT

VkMetalSurfaceCreateInfoEXT - Structure specifying parameters of a newly created Metal surface object

Valid Usage (Implicit)

See Also

MetalSurfaceCreateFlagsEXT, StructureType, createMetalSurfaceEXT

Constructors

MetalSurfaceCreateInfoEXT

Fields

• flags :: MetalSurfaceCreateFlagsEXT

  flags is reserved for future use.

  flags must be 0

• layer :: Ptr CAMetalLayer

  pLayer is a reference to a CAMetalLayer object representing a renderable surface.

Instances

Eq MetalSurfaceCreateInfoEXT

Defined in Vulkan.Extensions.VK_EXT_metal_surface

Methods

(==) :: MetalSurfaceCreateInfoEXT -> MetalSurfaceCreateInfoEXT -> Bool

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

Show MetalSurfaceCreateInfoEXT

Defined in Vulkan.Extensions.VK_EXT_metal_surface

Methods

showsPrec :: Int -> MetalSurfaceCreateInfoEXT -> ShowS

show :: MetalSurfaceCreateInfoEXT -> String

showList :: [MetalSurfaceCreateInfoEXT] -> ShowS

Generic MetalSurfaceCreateInfoEXT

Defined in Vulkan.Extensions.VK_EXT_metal_surface

Associated Types

type Rep MetalSurfaceCreateInfoEXT :: Type -> Type

Methods

from :: MetalSurfaceCreateInfoEXT -> Rep MetalSurfaceCreateInfoEXT x

to :: Rep MetalSurfaceCreateInfoEXT x -> MetalSurfaceCreateInfoEXT

Storable MetalSurfaceCreateInfoEXT

Defined in Vulkan.Extensions.VK_EXT_metal_surface

Methods

sizeOf :: MetalSurfaceCreateInfoEXT -> Int

alignment :: MetalSurfaceCreateInfoEXT -> Int

peekElemOff :: Ptr MetalSurfaceCreateInfoEXT -> Int -> IO MetalSurfaceCreateInfoEXT

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

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

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

peek :: Ptr MetalSurfaceCreateInfoEXT -> IO MetalSurfaceCreateInfoEXT

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

FromCStruct MetalSurfaceCreateInfoEXT

Defined in Vulkan.Extensions.VK_EXT_metal_surface

Methods

peekCStruct :: Ptr MetalSurfaceCreateInfoEXT -> IO MetalSurfaceCreateInfoEXT

ToCStruct MetalSurfaceCreateInfoEXT

Defined in Vulkan.Extensions.VK_EXT_metal_surface

Methods

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

pokeCStruct :: Ptr MetalSurfaceCreateInfoEXT -> MetalSurfaceCreateInfoEXT -> IO b -> IO b

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

pokeZeroCStruct :: Ptr MetalSurfaceCreateInfoEXT -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero MetalSurfaceCreateInfoEXT

Defined in Vulkan.Extensions.VK_EXT_metal_surface

Methods

zero :: MetalSurfaceCreateInfoEXT

type Rep MetalSurfaceCreateInfoEXT

Defined in Vulkan.Extensions.VK_EXT_metal_surface

type Rep MetalSurfaceCreateInfoEXT = D1 ('MetaData "MetalSurfaceCreateInfoEXT" "Vulkan.Extensions.VK_EXT_metal_surface" "vulkan-3.5-inplace" 'False) (C1 ('MetaCons "MetalSurfaceCreateInfoEXT" 'PrefixI 'True) (S1 ('MetaSel ('Just "flags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 MetalSurfaceCreateFlagsEXT) :*: S1 ('MetaSel ('Just "layer") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Ptr CAMetalLayer))))

newtype MetalSurfaceCreateFlagsEXT

VkMetalSurfaceCreateFlagsEXT - Reserved for future use

Description

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

See Also

MetalSurfaceCreateInfoEXT

Constructors

MetalSurfaceCreateFlagsEXT Flags

Instances

Eq MetalSurfaceCreateFlagsEXT

Defined in Vulkan.Extensions.VK_EXT_metal_surface

Methods

(==) :: MetalSurfaceCreateFlagsEXT -> MetalSurfaceCreateFlagsEXT -> Bool

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

Ord MetalSurfaceCreateFlagsEXT

Defined in Vulkan.Extensions.VK_EXT_metal_surface

Methods

compare :: MetalSurfaceCreateFlagsEXT -> MetalSurfaceCreateFlagsEXT -> Ordering

(<) :: MetalSurfaceCreateFlagsEXT -> MetalSurfaceCreateFlagsEXT -> Bool

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

(>) :: MetalSurfaceCreateFlagsEXT -> MetalSurfaceCreateFlagsEXT -> Bool

(>=) :: MetalSurfaceCreateFlagsEXT -> MetalSurfaceCreateFlagsEXT -> Bool

max :: MetalSurfaceCreateFlagsEXT -> MetalSurfaceCreateFlagsEXT -> MetalSurfaceCreateFlagsEXT

min :: MetalSurfaceCreateFlagsEXT -> MetalSurfaceCreateFlagsEXT -> MetalSurfaceCreateFlagsEXT

Read MetalSurfaceCreateFlagsEXT

Defined in Vulkan.Extensions.VK_EXT_metal_surface

Methods

readsPrec :: Int -> ReadS MetalSurfaceCreateFlagsEXT

readList :: ReadS [MetalSurfaceCreateFlagsEXT]

readPrec :: ReadPrec MetalSurfaceCreateFlagsEXT

readListPrec :: ReadPrec [MetalSurfaceCreateFlagsEXT]

Show MetalSurfaceCreateFlagsEXT

Defined in Vulkan.Extensions.VK_EXT_metal_surface

Methods

showsPrec :: Int -> MetalSurfaceCreateFlagsEXT -> ShowS

show :: MetalSurfaceCreateFlagsEXT -> String

showList :: [MetalSurfaceCreateFlagsEXT] -> ShowS

Storable MetalSurfaceCreateFlagsEXT

Defined in Vulkan.Extensions.VK_EXT_metal_surface

Methods

sizeOf :: MetalSurfaceCreateFlagsEXT -> Int

alignment :: MetalSurfaceCreateFlagsEXT -> Int

peekElemOff :: Ptr MetalSurfaceCreateFlagsEXT -> Int -> IO MetalSurfaceCreateFlagsEXT

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

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

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

peek :: Ptr MetalSurfaceCreateFlagsEXT -> IO MetalSurfaceCreateFlagsEXT

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

Bits MetalSurfaceCreateFlagsEXT

Defined in Vulkan.Extensions.VK_EXT_metal_surface

Methods

(.&.) :: MetalSurfaceCreateFlagsEXT -> MetalSurfaceCreateFlagsEXT -> MetalSurfaceCreateFlagsEXT

(.|.) :: MetalSurfaceCreateFlagsEXT -> MetalSurfaceCreateFlagsEXT -> MetalSurfaceCreateFlagsEXT

xor :: MetalSurfaceCreateFlagsEXT -> MetalSurfaceCreateFlagsEXT -> MetalSurfaceCreateFlagsEXT

complement :: MetalSurfaceCreateFlagsEXT -> MetalSurfaceCreateFlagsEXT

shift :: MetalSurfaceCreateFlagsEXT -> Int -> MetalSurfaceCreateFlagsEXT

rotate :: MetalSurfaceCreateFlagsEXT -> Int -> MetalSurfaceCreateFlagsEXT

zeroBits :: MetalSurfaceCreateFlagsEXT

bit :: Int -> MetalSurfaceCreateFlagsEXT

setBit :: MetalSurfaceCreateFlagsEXT -> Int -> MetalSurfaceCreateFlagsEXT

clearBit :: MetalSurfaceCreateFlagsEXT -> Int -> MetalSurfaceCreateFlagsEXT

complementBit :: MetalSurfaceCreateFlagsEXT -> Int -> MetalSurfaceCreateFlagsEXT

testBit :: MetalSurfaceCreateFlagsEXT -> Int -> Bool

bitSizeMaybe :: MetalSurfaceCreateFlagsEXT -> Maybe Int

bitSize :: MetalSurfaceCreateFlagsEXT -> Int

isSigned :: MetalSurfaceCreateFlagsEXT -> Bool

shiftL :: MetalSurfaceCreateFlagsEXT -> Int -> MetalSurfaceCreateFlagsEXT

unsafeShiftL :: MetalSurfaceCreateFlagsEXT -> Int -> MetalSurfaceCreateFlagsEXT

shiftR :: MetalSurfaceCreateFlagsEXT -> Int -> MetalSurfaceCreateFlagsEXT

unsafeShiftR :: MetalSurfaceCreateFlagsEXT -> Int -> MetalSurfaceCreateFlagsEXT

rotateL :: MetalSurfaceCreateFlagsEXT -> Int -> MetalSurfaceCreateFlagsEXT

rotateR :: MetalSurfaceCreateFlagsEXT -> Int -> MetalSurfaceCreateFlagsEXT

popCount :: MetalSurfaceCreateFlagsEXT -> Int

Zero MetalSurfaceCreateFlagsEXT

Defined in Vulkan.Extensions.VK_EXT_metal_surface

Methods

zero :: MetalSurfaceCreateFlagsEXT

type EXT_METAL_SURFACE_SPEC_VERSION = 1

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

type EXT_METAL_SURFACE_EXTENSION_NAME = "VK_EXT_metal_surface"

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

data CAMetalLayer

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, 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