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

Vulkan.Extensions.VK_MVK_macos_surface

Synopsis

Documentation

createMacOSSurfaceMVK Source #

Arguments

:: forall io. MonadIO io 
=> Instance

instance is the instance with which to associate the surface.

-> MacOSSurfaceCreateInfoMVK

pCreateInfo is a pointer to a MacOSSurfaceCreateInfoMVK structure containing 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 

vkCreateMacOSSurfaceMVK - Create a VkSurfaceKHR object for a macOS NSView

Valid Usage (Implicit)

  • instance must be a valid Instance handle

Return Codes

Success
Failure

See Also

AllocationCallbacks, Instance, MacOSSurfaceCreateInfoMVK, SurfaceKHR

data MacOSSurfaceCreateInfoMVK Source #

VkMacOSSurfaceCreateInfoMVK - Structure specifying parameters of a newly created macOS surface object

Valid Usage (Implicit)

See Also

MacOSSurfaceCreateFlagsMVK, StructureType, createMacOSSurfaceMVK

Constructors

MacOSSurfaceCreateInfoMVK 

Fields

  • flags :: MacOSSurfaceCreateFlagsMVK

    flags is reserved for future use.

    flags must be 0

  • view :: Ptr ()

    pView is a reference to a NSView object which will display this surface. This NSView must be backed by a CALayer instance of type CAMetalLayer.

    pView must be a valid NSView and must be backed by a CALayer instance of type CAMetalLayer

Instances

Instances details
Show MacOSSurfaceCreateInfoMVK Source # 
Instance details

Defined in Vulkan.Extensions.VK_MVK_macos_surface

Methods

showsPrec :: Int -> MacOSSurfaceCreateInfoMVK -> ShowS #

show :: MacOSSurfaceCreateInfoMVK -> String #

showList :: [MacOSSurfaceCreateInfoMVK] -> ShowS #

Generic MacOSSurfaceCreateInfoMVK Source # 
Instance details

Defined in Vulkan.Extensions.VK_MVK_macos_surface

Associated Types

type Rep MacOSSurfaceCreateInfoMVK :: Type -> Type #

Methods

from :: MacOSSurfaceCreateInfoMVK -> Rep MacOSSurfaceCreateInfoMVK x #

to :: Rep MacOSSurfaceCreateInfoMVK x -> MacOSSurfaceCreateInfoMVK #

Storable MacOSSurfaceCreateInfoMVK Source # 
Instance details

Defined in Vulkan.Extensions.VK_MVK_macos_surface

Methods

sizeOf :: MacOSSurfaceCreateInfoMVK -> Int #

alignment :: MacOSSurfaceCreateInfoMVK -> Int #

peekElemOff :: Ptr MacOSSurfaceCreateInfoMVK -> Int -> IO MacOSSurfaceCreateInfoMVK #

pokeElemOff :: Ptr MacOSSurfaceCreateInfoMVK -> Int -> MacOSSurfaceCreateInfoMVK -> IO () #

peekByteOff :: Ptr b -> Int -> IO MacOSSurfaceCreateInfoMVK #

pokeByteOff :: Ptr b -> Int -> MacOSSurfaceCreateInfoMVK -> IO () #

peek :: Ptr MacOSSurfaceCreateInfoMVK -> IO MacOSSurfaceCreateInfoMVK #

poke :: Ptr MacOSSurfaceCreateInfoMVK -> MacOSSurfaceCreateInfoMVK -> IO () #

FromCStruct MacOSSurfaceCreateInfoMVK Source # 
Instance details

Defined in Vulkan.Extensions.VK_MVK_macos_surface

Methods

peekCStruct :: Ptr MacOSSurfaceCreateInfoMVK -> IO MacOSSurfaceCreateInfoMVK Source #

ToCStruct MacOSSurfaceCreateInfoMVK Source # 
Instance details

Defined in Vulkan.Extensions.VK_MVK_macos_surface

Methods

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

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

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

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

cStructSize :: Int Source #

cStructAlignment :: Int Source #

Zero MacOSSurfaceCreateInfoMVK Source # 
Instance details

Defined in Vulkan.Extensions.VK_MVK_macos_surface

Methods

zero :: MacOSSurfaceCreateInfoMVK Source #

type Rep MacOSSurfaceCreateInfoMVK Source # 
Instance details

Defined in Vulkan.Extensions.VK_MVK_macos_surface

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

newtype MacOSSurfaceCreateFlagsMVK Source #

VkMacOSSurfaceCreateFlagsMVK - Reserved for future use

Description

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

See Also

MacOSSurfaceCreateInfoMVK

Constructors

MacOSSurfaceCreateFlagsMVK Flags 

Instances

Instances details
Eq MacOSSurfaceCreateFlagsMVK Source # 
Instance details

Defined in Vulkan.Extensions.VK_MVK_macos_surface

Methods

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

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

Ord MacOSSurfaceCreateFlagsMVK Source # 
Instance details

Defined in Vulkan.Extensions.VK_MVK_macos_surface

Methods

compare :: MacOSSurfaceCreateFlagsMVK -> MacOSSurfaceCreateFlagsMVK -> Ordering #

(<) :: MacOSSurfaceCreateFlagsMVK -> MacOSSurfaceCreateFlagsMVK -> Bool #

(<=) :: MacOSSurfaceCreateFlagsMVK -> MacOSSurfaceCreateFlagsMVK -> Bool #

(>) :: MacOSSurfaceCreateFlagsMVK -> MacOSSurfaceCreateFlagsMVK -> Bool #

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

max :: MacOSSurfaceCreateFlagsMVK -> MacOSSurfaceCreateFlagsMVK -> MacOSSurfaceCreateFlagsMVK #

min :: MacOSSurfaceCreateFlagsMVK -> MacOSSurfaceCreateFlagsMVK -> MacOSSurfaceCreateFlagsMVK #

Read MacOSSurfaceCreateFlagsMVK Source # 
Instance details

Defined in Vulkan.Extensions.VK_MVK_macos_surface

Methods

readsPrec :: Int -> ReadS MacOSSurfaceCreateFlagsMVK #

readList :: ReadS [MacOSSurfaceCreateFlagsMVK] #

readPrec :: ReadPrec MacOSSurfaceCreateFlagsMVK #

readListPrec :: ReadPrec [MacOSSurfaceCreateFlagsMVK] #

Show MacOSSurfaceCreateFlagsMVK Source # 
Instance details

Defined in Vulkan.Extensions.VK_MVK_macos_surface

Methods

showsPrec :: Int -> MacOSSurfaceCreateFlagsMVK -> ShowS #

show :: MacOSSurfaceCreateFlagsMVK -> String #

showList :: [MacOSSurfaceCreateFlagsMVK] -> ShowS #

Storable MacOSSurfaceCreateFlagsMVK Source # 
Instance details

Defined in Vulkan.Extensions.VK_MVK_macos_surface

Methods

sizeOf :: MacOSSurfaceCreateFlagsMVK -> Int #

alignment :: MacOSSurfaceCreateFlagsMVK -> Int #

peekElemOff :: Ptr MacOSSurfaceCreateFlagsMVK -> Int -> IO MacOSSurfaceCreateFlagsMVK #

pokeElemOff :: Ptr MacOSSurfaceCreateFlagsMVK -> Int -> MacOSSurfaceCreateFlagsMVK -> IO () #

peekByteOff :: Ptr b -> Int -> IO MacOSSurfaceCreateFlagsMVK #

pokeByteOff :: Ptr b -> Int -> MacOSSurfaceCreateFlagsMVK -> IO () #

peek :: Ptr MacOSSurfaceCreateFlagsMVK -> IO MacOSSurfaceCreateFlagsMVK #

poke :: Ptr MacOSSurfaceCreateFlagsMVK -> MacOSSurfaceCreateFlagsMVK -> IO () #

Bits MacOSSurfaceCreateFlagsMVK Source # 
Instance details

Defined in Vulkan.Extensions.VK_MVK_macos_surface

Methods

(.&.) :: MacOSSurfaceCreateFlagsMVK -> MacOSSurfaceCreateFlagsMVK -> MacOSSurfaceCreateFlagsMVK #

(.|.) :: MacOSSurfaceCreateFlagsMVK -> MacOSSurfaceCreateFlagsMVK -> MacOSSurfaceCreateFlagsMVK #

xor :: MacOSSurfaceCreateFlagsMVK -> MacOSSurfaceCreateFlagsMVK -> MacOSSurfaceCreateFlagsMVK #

complement :: MacOSSurfaceCreateFlagsMVK -> MacOSSurfaceCreateFlagsMVK #

shift :: MacOSSurfaceCreateFlagsMVK -> Int -> MacOSSurfaceCreateFlagsMVK #

rotate :: MacOSSurfaceCreateFlagsMVK -> Int -> MacOSSurfaceCreateFlagsMVK #

zeroBits :: MacOSSurfaceCreateFlagsMVK #

bit :: Int -> MacOSSurfaceCreateFlagsMVK #

setBit :: MacOSSurfaceCreateFlagsMVK -> Int -> MacOSSurfaceCreateFlagsMVK #

clearBit :: MacOSSurfaceCreateFlagsMVK -> Int -> MacOSSurfaceCreateFlagsMVK #

complementBit :: MacOSSurfaceCreateFlagsMVK -> Int -> MacOSSurfaceCreateFlagsMVK #

testBit :: MacOSSurfaceCreateFlagsMVK -> Int -> Bool #

bitSizeMaybe :: MacOSSurfaceCreateFlagsMVK -> Maybe Int #

bitSize :: MacOSSurfaceCreateFlagsMVK -> Int #

isSigned :: MacOSSurfaceCreateFlagsMVK -> Bool #

shiftL :: MacOSSurfaceCreateFlagsMVK -> Int -> MacOSSurfaceCreateFlagsMVK #

unsafeShiftL :: MacOSSurfaceCreateFlagsMVK -> Int -> MacOSSurfaceCreateFlagsMVK #

shiftR :: MacOSSurfaceCreateFlagsMVK -> Int -> MacOSSurfaceCreateFlagsMVK #

unsafeShiftR :: MacOSSurfaceCreateFlagsMVK -> Int -> MacOSSurfaceCreateFlagsMVK #

rotateL :: MacOSSurfaceCreateFlagsMVK -> Int -> MacOSSurfaceCreateFlagsMVK #

rotateR :: MacOSSurfaceCreateFlagsMVK -> Int -> MacOSSurfaceCreateFlagsMVK #

popCount :: MacOSSurfaceCreateFlagsMVK -> Int #

Zero MacOSSurfaceCreateFlagsMVK Source # 
Instance details

Defined in Vulkan.Extensions.VK_MVK_macos_surface

Methods

zero :: MacOSSurfaceCreateFlagsMVK Source #

type MVK_MACOS_SURFACE_SPEC_VERSION = 2 Source #

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

type MVK_MACOS_SURFACE_EXTENSION_NAME = "VK_MVK_macos_surface" Source #

pattern MVK_MACOS_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