vulkan-2.1.0.0: Bindings to the Vulkan graphics API.

Safe HaskellNone
LanguageHaskell2010

Graphics.Vulkan.Extensions.VK_MVK_macos_surface

Synopsis

Documentation

newtype VkMacOSSurfaceCreateFlagsMVK Source #

Constructors

VkMacOSSurfaceCreateFlagsMVK VkFlags 
Instances
Eq VkMacOSSurfaceCreateFlagsMVK Source # 
Instance details

Methods

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

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

Ord VkMacOSSurfaceCreateFlagsMVK Source # 
Instance details

Methods

compare :: VkMacOSSurfaceCreateFlagsMVK -> VkMacOSSurfaceCreateFlagsMVK -> Ordering #

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

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

(>) :: VkMacOSSurfaceCreateFlagsMVK -> VkMacOSSurfaceCreateFlagsMVK -> Bool #

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

max :: VkMacOSSurfaceCreateFlagsMVK -> VkMacOSSurfaceCreateFlagsMVK -> VkMacOSSurfaceCreateFlagsMVK #

min :: VkMacOSSurfaceCreateFlagsMVK -> VkMacOSSurfaceCreateFlagsMVK -> VkMacOSSurfaceCreateFlagsMVK #

Read VkMacOSSurfaceCreateFlagsMVK Source # 
Instance details

Methods

readsPrec :: Int -> ReadS VkMacOSSurfaceCreateFlagsMVK #

readList :: ReadS [VkMacOSSurfaceCreateFlagsMVK] #

readPrec :: ReadPrec VkMacOSSurfaceCreateFlagsMVK #

readListPrec :: ReadPrec [VkMacOSSurfaceCreateFlagsMVK] #

Show VkMacOSSurfaceCreateFlagsMVK Source # 
Instance details

Methods

showsPrec :: Int -> VkMacOSSurfaceCreateFlagsMVK -> ShowS #

show :: VkMacOSSurfaceCreateFlagsMVK -> String #

showList :: [VkMacOSSurfaceCreateFlagsMVK] -> ShowS #

Storable VkMacOSSurfaceCreateFlagsMVK Source # 
Instance details

Methods

sizeOf :: VkMacOSSurfaceCreateFlagsMVK -> Int #

alignment :: VkMacOSSurfaceCreateFlagsMVK -> Int #

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

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

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

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

peek :: Ptr VkMacOSSurfaceCreateFlagsMVK -> IO VkMacOSSurfaceCreateFlagsMVK #

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

Bits VkMacOSSurfaceCreateFlagsMVK Source # 
Instance details

Methods

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

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

xor :: VkMacOSSurfaceCreateFlagsMVK -> VkMacOSSurfaceCreateFlagsMVK -> VkMacOSSurfaceCreateFlagsMVK #

complement :: VkMacOSSurfaceCreateFlagsMVK -> VkMacOSSurfaceCreateFlagsMVK #

shift :: VkMacOSSurfaceCreateFlagsMVK -> Int -> VkMacOSSurfaceCreateFlagsMVK #

rotate :: VkMacOSSurfaceCreateFlagsMVK -> Int -> VkMacOSSurfaceCreateFlagsMVK #

zeroBits :: VkMacOSSurfaceCreateFlagsMVK #

bit :: Int -> VkMacOSSurfaceCreateFlagsMVK #

setBit :: VkMacOSSurfaceCreateFlagsMVK -> Int -> VkMacOSSurfaceCreateFlagsMVK #

clearBit :: VkMacOSSurfaceCreateFlagsMVK -> Int -> VkMacOSSurfaceCreateFlagsMVK #

complementBit :: VkMacOSSurfaceCreateFlagsMVK -> Int -> VkMacOSSurfaceCreateFlagsMVK #

testBit :: VkMacOSSurfaceCreateFlagsMVK -> Int -> Bool #

bitSizeMaybe :: VkMacOSSurfaceCreateFlagsMVK -> Maybe Int #

bitSize :: VkMacOSSurfaceCreateFlagsMVK -> Int #

isSigned :: VkMacOSSurfaceCreateFlagsMVK -> Bool #

shiftL :: VkMacOSSurfaceCreateFlagsMVK -> Int -> VkMacOSSurfaceCreateFlagsMVK #

unsafeShiftL :: VkMacOSSurfaceCreateFlagsMVK -> Int -> VkMacOSSurfaceCreateFlagsMVK #

shiftR :: VkMacOSSurfaceCreateFlagsMVK -> Int -> VkMacOSSurfaceCreateFlagsMVK #

unsafeShiftR :: VkMacOSSurfaceCreateFlagsMVK -> Int -> VkMacOSSurfaceCreateFlagsMVK #

rotateL :: VkMacOSSurfaceCreateFlagsMVK -> Int -> VkMacOSSurfaceCreateFlagsMVK #

rotateR :: VkMacOSSurfaceCreateFlagsMVK -> Int -> VkMacOSSurfaceCreateFlagsMVK #

popCount :: VkMacOSSurfaceCreateFlagsMVK -> Int #

FiniteBits VkMacOSSurfaceCreateFlagsMVK Source # 
Instance details

Methods

finiteBitSize :: VkMacOSSurfaceCreateFlagsMVK -> Int #

countLeadingZeros :: VkMacOSSurfaceCreateFlagsMVK -> Int #

countTrailingZeros :: VkMacOSSurfaceCreateFlagsMVK -> Int #

pattern VK_STRUCTURE_TYPE_MACOS_SURFACE_CREATE_INFO_MVK :: VkStructureType Source #

pattern VK_MVK_MACOS_SURFACE_SPEC_VERSION :: Integral a => a Source #

pattern VK_MVK_MACOS_SURFACE_EXTENSION_NAME :: (Eq a, IsString a) => a Source #

vkCreateMacOSSurfaceMVK :: ("instance" ::: VkInstance) -> ("pCreateInfo" ::: Ptr VkMacOSSurfaceCreateInfoMVK) -> ("pAllocator" ::: Ptr VkAllocationCallbacks) -> ("pSurface" ::: Ptr VkSurfaceKHR) -> IO VkResult Source #

vkCreateMacOSSurfaceMVK - Create a VkSurfaceKHR object for a macOS NSView

Parameters

  • instance is the instance with which to associate the surface.
  • pCreateInfo is a pointer to an instance of the VkMacOSSurfaceCreateInfoMVK 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 points to a VkSurfaceKHR handle in which the created surface object is returned.

Valid Usage (Implicit)

  • instance must be a valid VkInstance handle
  • pCreateInfo must be a valid pointer to a valid VkMacOSSurfaceCreateInfoMVK structure
  • If pAllocator is not NULL, pAllocator must be a valid pointer to a valid VkAllocationCallbacks structure
  • pSurface must be a valid pointer to a VkSurfaceKHR handle

Return Codes

[Success] - VK_SUCCESS

[Failure] - VK_ERROR_OUT_OF_HOST_MEMORY

  • VK_ERROR_OUT_OF_DEVICE_MEMORY
  • VK_ERROR_NATIVE_WINDOW_IN_USE_KHR

See Also

VkAllocationCallbacks, VkInstance, VkMacOSSurfaceCreateInfoMVK, VkSurfaceKHR

data VkMacOSSurfaceCreateInfoMVK Source #

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

Valid Usage

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

Valid Usage (Implicit)

  • sType must be VK_STRUCTURE_TYPE_MACOS_SURFACE_CREATE_INFO_MVK
  • pNext must be NULL
  • flags must be 0

See Also

VkMacOSSurfaceCreateFlagsMVK, VkStructureType, vkCreateMacOSSurfaceMVK

Constructors

VkMacOSSurfaceCreateInfoMVK 

Fields

Instances
Eq VkMacOSSurfaceCreateInfoMVK Source # 
Instance details

Methods

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

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

Show VkMacOSSurfaceCreateInfoMVK Source # 
Instance details

Methods

showsPrec :: Int -> VkMacOSSurfaceCreateInfoMVK -> ShowS #

show :: VkMacOSSurfaceCreateInfoMVK -> String #

showList :: [VkMacOSSurfaceCreateInfoMVK] -> ShowS #

Storable VkMacOSSurfaceCreateInfoMVK Source # 
Instance details

Methods

sizeOf :: VkMacOSSurfaceCreateInfoMVK -> Int #

alignment :: VkMacOSSurfaceCreateInfoMVK -> Int #

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

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

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

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

peek :: Ptr VkMacOSSurfaceCreateInfoMVK -> IO VkMacOSSurfaceCreateInfoMVK #

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