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

Vulkan.Extensions.VK_KHR_wayland_surface

Synopsis

Documentation

createWaylandSurfaceKHR Source #

Arguments

:: forall io. MonadIO io 
=> Instance

instance is the instance to associate the surface with.

-> WaylandSurfaceCreateInfoKHR

pCreateInfo is a pointer to a WaylandSurfaceCreateInfoKHR 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 

vkCreateWaylandSurfaceKHR - Create a SurfaceKHR object for a Wayland window

Valid Usage (Implicit)

  • instance must be a valid Instance handle

Return Codes

Success
Failure

See Also

AllocationCallbacks, Instance, SurfaceKHR, WaylandSurfaceCreateInfoKHR

getPhysicalDeviceWaylandPresentationSupportKHR Source #

Arguments

:: forall io. MonadIO io 
=> PhysicalDevice

physicalDevice is the physical device.

physicalDevice must be a valid PhysicalDevice handle

-> ("queueFamilyIndex" ::: Word32)

queueFamilyIndex is the queue family index.

queueFamilyIndex must be less than pQueueFamilyPropertyCount returned by getPhysicalDeviceQueueFamilyProperties for the given physicalDevice

-> Ptr Wl_display

display is a pointer to the wl_display associated with a Wayland compositor.

display must be a valid pointer to a wl_display value

-> io Bool 

vkGetPhysicalDeviceWaylandPresentationSupportKHR - Query physical device for presentation to Wayland

Description

This platform-specific function can be called prior to creating a surface.

Valid Usage (Implicit)

See Also

PhysicalDevice

data WaylandSurfaceCreateInfoKHR Source #

VkWaylandSurfaceCreateInfoKHR - Structure specifying parameters of a newly created Wayland surface object

Valid Usage (Implicit)

See Also

StructureType, WaylandSurfaceCreateFlagsKHR, createWaylandSurfaceKHR

Constructors

WaylandSurfaceCreateInfoKHR 

Fields

Instances

Instances details
Eq WaylandSurfaceCreateInfoKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_wayland_surface

Methods

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

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

Show WaylandSurfaceCreateInfoKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_wayland_surface

Methods

showsPrec :: Int -> WaylandSurfaceCreateInfoKHR -> ShowS #

show :: WaylandSurfaceCreateInfoKHR -> String #

showList :: [WaylandSurfaceCreateInfoKHR] -> ShowS #

Generic WaylandSurfaceCreateInfoKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_wayland_surface

Associated Types

type Rep WaylandSurfaceCreateInfoKHR :: Type -> Type #

Methods

from :: WaylandSurfaceCreateInfoKHR -> Rep WaylandSurfaceCreateInfoKHR x #

to :: Rep WaylandSurfaceCreateInfoKHR x -> WaylandSurfaceCreateInfoKHR #

Storable WaylandSurfaceCreateInfoKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_wayland_surface

Methods

sizeOf :: WaylandSurfaceCreateInfoKHR -> Int #

alignment :: WaylandSurfaceCreateInfoKHR -> Int #

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

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

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

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

peek :: Ptr WaylandSurfaceCreateInfoKHR -> IO WaylandSurfaceCreateInfoKHR #

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

FromCStruct WaylandSurfaceCreateInfoKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_wayland_surface

Methods

peekCStruct :: Ptr WaylandSurfaceCreateInfoKHR -> IO WaylandSurfaceCreateInfoKHR Source #

ToCStruct WaylandSurfaceCreateInfoKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_wayland_surface

Methods

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

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

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

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

cStructSize :: Int Source #

cStructAlignment :: Int Source #

Zero WaylandSurfaceCreateInfoKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_wayland_surface

Methods

zero :: WaylandSurfaceCreateInfoKHR Source #

type Rep WaylandSurfaceCreateInfoKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_wayland_surface

type Rep WaylandSurfaceCreateInfoKHR = D1 ('MetaData "WaylandSurfaceCreateInfoKHR" "Vulkan.Extensions.VK_KHR_wayland_surface" "vulkan-3.6.5-inplace" 'False) (C1 ('MetaCons "WaylandSurfaceCreateInfoKHR" 'PrefixI 'True) (S1 ('MetaSel ('Just "flags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 WaylandSurfaceCreateFlagsKHR) :*: (S1 ('MetaSel ('Just "display") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Ptr Wl_display)) :*: S1 ('MetaSel ('Just "surface") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Ptr Wl_surface)))))

newtype WaylandSurfaceCreateFlagsKHR Source #

VkWaylandSurfaceCreateFlagsKHR - Reserved for future use

Description

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

See Also

WaylandSurfaceCreateInfoKHR

Constructors

WaylandSurfaceCreateFlagsKHR Flags 

Instances

Instances details
Eq WaylandSurfaceCreateFlagsKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_wayland_surface

Methods

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

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

Ord WaylandSurfaceCreateFlagsKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_wayland_surface

Methods

compare :: WaylandSurfaceCreateFlagsKHR -> WaylandSurfaceCreateFlagsKHR -> Ordering #

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

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

(>) :: WaylandSurfaceCreateFlagsKHR -> WaylandSurfaceCreateFlagsKHR -> Bool #

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

max :: WaylandSurfaceCreateFlagsKHR -> WaylandSurfaceCreateFlagsKHR -> WaylandSurfaceCreateFlagsKHR #

min :: WaylandSurfaceCreateFlagsKHR -> WaylandSurfaceCreateFlagsKHR -> WaylandSurfaceCreateFlagsKHR #

Read WaylandSurfaceCreateFlagsKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_wayland_surface

Methods

readsPrec :: Int -> ReadS WaylandSurfaceCreateFlagsKHR #

readList :: ReadS [WaylandSurfaceCreateFlagsKHR] #

readPrec :: ReadPrec WaylandSurfaceCreateFlagsKHR #

readListPrec :: ReadPrec [WaylandSurfaceCreateFlagsKHR] #

Show WaylandSurfaceCreateFlagsKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_wayland_surface

Methods

showsPrec :: Int -> WaylandSurfaceCreateFlagsKHR -> ShowS #

show :: WaylandSurfaceCreateFlagsKHR -> String #

showList :: [WaylandSurfaceCreateFlagsKHR] -> ShowS #

Storable WaylandSurfaceCreateFlagsKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_wayland_surface

Methods

sizeOf :: WaylandSurfaceCreateFlagsKHR -> Int #

alignment :: WaylandSurfaceCreateFlagsKHR -> Int #

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

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

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

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

peek :: Ptr WaylandSurfaceCreateFlagsKHR -> IO WaylandSurfaceCreateFlagsKHR #

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

Bits WaylandSurfaceCreateFlagsKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_wayland_surface

Methods

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

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

xor :: WaylandSurfaceCreateFlagsKHR -> WaylandSurfaceCreateFlagsKHR -> WaylandSurfaceCreateFlagsKHR #

complement :: WaylandSurfaceCreateFlagsKHR -> WaylandSurfaceCreateFlagsKHR #

shift :: WaylandSurfaceCreateFlagsKHR -> Int -> WaylandSurfaceCreateFlagsKHR #

rotate :: WaylandSurfaceCreateFlagsKHR -> Int -> WaylandSurfaceCreateFlagsKHR #

zeroBits :: WaylandSurfaceCreateFlagsKHR #

bit :: Int -> WaylandSurfaceCreateFlagsKHR #

setBit :: WaylandSurfaceCreateFlagsKHR -> Int -> WaylandSurfaceCreateFlagsKHR #

clearBit :: WaylandSurfaceCreateFlagsKHR -> Int -> WaylandSurfaceCreateFlagsKHR #

complementBit :: WaylandSurfaceCreateFlagsKHR -> Int -> WaylandSurfaceCreateFlagsKHR #

testBit :: WaylandSurfaceCreateFlagsKHR -> Int -> Bool #

bitSizeMaybe :: WaylandSurfaceCreateFlagsKHR -> Maybe Int #

bitSize :: WaylandSurfaceCreateFlagsKHR -> Int #

isSigned :: WaylandSurfaceCreateFlagsKHR -> Bool #

shiftL :: WaylandSurfaceCreateFlagsKHR -> Int -> WaylandSurfaceCreateFlagsKHR #

unsafeShiftL :: WaylandSurfaceCreateFlagsKHR -> Int -> WaylandSurfaceCreateFlagsKHR #

shiftR :: WaylandSurfaceCreateFlagsKHR -> Int -> WaylandSurfaceCreateFlagsKHR #

unsafeShiftR :: WaylandSurfaceCreateFlagsKHR -> Int -> WaylandSurfaceCreateFlagsKHR #

rotateL :: WaylandSurfaceCreateFlagsKHR -> Int -> WaylandSurfaceCreateFlagsKHR #

rotateR :: WaylandSurfaceCreateFlagsKHR -> Int -> WaylandSurfaceCreateFlagsKHR #

popCount :: WaylandSurfaceCreateFlagsKHR -> Int #

Zero WaylandSurfaceCreateFlagsKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_wayland_surface

Methods

zero :: WaylandSurfaceCreateFlagsKHR Source #

type KHR_WAYLAND_SURFACE_SPEC_VERSION = 6 Source #

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

type KHR_WAYLAND_SURFACE_EXTENSION_NAME = "VK_KHR_wayland_surface" Source #

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

data Wl_display Source #

data Wl_surface 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