Vulkan.Extensions.VK_KHR_wayland_surface

Documentation

createWaylandSurfaceKHR

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

• pCreateInfo must be a valid pointer to a valid WaylandSurfaceCreateInfoKHR 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

See Also

AllocationCallbacks, Instance, SurfaceKHR, WaylandSurfaceCreateInfoKHR

getPhysicalDeviceWaylandPresentationSupportKHR

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

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

Valid Usage (Implicit)

See Also

StructureType, WaylandSurfaceCreateFlagsKHR, createWaylandSurfaceKHR

Constructors

WaylandSurfaceCreateInfoKHR

Fields

• flags :: WaylandSurfaceCreateFlagsKHR

  flags is reserved for future use.

  flags must be 0

• display :: Ptr Wl_display

  display and surface are pointers to the Wayland wl_display and wl_surface to associate the surface with.

  display must point to a valid Wayland wl_display

• surface :: Ptr Wl_surface

  surface must point to a valid Wayland wl_surface

Instances

Eq WaylandSurfaceCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_wayland_surface

Methods

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

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

Show WaylandSurfaceCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_wayland_surface

Methods

showsPrec :: Int -> WaylandSurfaceCreateInfoKHR -> ShowS

show :: WaylandSurfaceCreateInfoKHR -> String

showList :: [WaylandSurfaceCreateInfoKHR] -> ShowS

Generic WaylandSurfaceCreateInfoKHR

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

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

Defined in Vulkan.Extensions.VK_KHR_wayland_surface

Methods

peekCStruct :: Ptr WaylandSurfaceCreateInfoKHR -> IO WaylandSurfaceCreateInfoKHR

ToCStruct WaylandSurfaceCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_wayland_surface

Methods

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

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

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

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

cStructSize :: Int

cStructAlignment :: Int

Zero WaylandSurfaceCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_wayland_surface

Methods

zero :: WaylandSurfaceCreateInfoKHR

type Rep WaylandSurfaceCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_wayland_surface

type Rep WaylandSurfaceCreateInfoKHR = D1 ('MetaData "WaylandSurfaceCreateInfoKHR" "Vulkan.Extensions.VK_KHR_wayland_surface" "vulkan-3.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

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

Eq WaylandSurfaceCreateFlagsKHR

Defined in Vulkan.Extensions.VK_KHR_wayland_surface

Methods

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

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

Ord WaylandSurfaceCreateFlagsKHR

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

Defined in Vulkan.Extensions.VK_KHR_wayland_surface

Methods

readsPrec :: Int -> ReadS WaylandSurfaceCreateFlagsKHR

readList :: ReadS [WaylandSurfaceCreateFlagsKHR]

readPrec :: ReadPrec WaylandSurfaceCreateFlagsKHR

readListPrec :: ReadPrec [WaylandSurfaceCreateFlagsKHR]

Show WaylandSurfaceCreateFlagsKHR

Defined in Vulkan.Extensions.VK_KHR_wayland_surface

Methods

showsPrec :: Int -> WaylandSurfaceCreateFlagsKHR -> ShowS

show :: WaylandSurfaceCreateFlagsKHR -> String

showList :: [WaylandSurfaceCreateFlagsKHR] -> ShowS

Storable WaylandSurfaceCreateFlagsKHR

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

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

Defined in Vulkan.Extensions.VK_KHR_wayland_surface

Methods

zero :: WaylandSurfaceCreateFlagsKHR

type KHR_WAYLAND_SURFACE_SPEC_VERSION = 6

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

type KHR_WAYLAND_SURFACE_EXTENSION_NAME = "VK_KHR_wayland_surface"

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

data Wl_display

data Wl_surface

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