Vulkan.Extensions.VK_KHR_xlib_surface

Documentation

createXlibSurfaceKHR

Arguments

:: forall io. MonadIO io

=> Instance

instance is the instance to associate the surface with.

-> XlibSurfaceCreateInfoKHR

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

vkCreateXlibSurfaceKHR - Create a SurfaceKHR object for an X11 window, using the Xlib client-side library

Valid Usage (Implicit)

• instance must be a valid Instance handle

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

getPhysicalDeviceXlibPresentationSupportKHR

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

-> ("dpy" ::: Ptr Display)

dpy is a pointer to an Xlib Display connection to the server.

dpy must be a valid pointer to a Display value

-> VisualID

-> io Bool

vkGetPhysicalDeviceXlibPresentationSupportKHR - Query physical device for presentation to X11 server using Xlib

Description

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

Valid Usage (Implicit)

See Also

PhysicalDevice

data XlibSurfaceCreateInfoKHR

VkXlibSurfaceCreateInfoKHR - Structure specifying parameters of a newly created Xlib surface object

Valid Usage (Implicit)

See Also

StructureType, XlibSurfaceCreateFlagsKHR, createXlibSurfaceKHR

Constructors

XlibSurfaceCreateInfoKHR

Fields

• flags :: XlibSurfaceCreateFlagsKHR

  flags is reserved for future use.

  flags must be 0

• dpy :: Ptr Display

  dpy is a pointer to an Xlib Display connection to the X server.

  dpy must point to a valid Xlib Display

• window :: Window

  window is an Xlib Window to associate the surface with.

  window must be a valid Xlib Window

Instances

Eq XlibSurfaceCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_xlib_surface

Methods

(==) :: XlibSurfaceCreateInfoKHR -> XlibSurfaceCreateInfoKHR -> Bool

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

Show XlibSurfaceCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_xlib_surface

Methods

showsPrec :: Int -> XlibSurfaceCreateInfoKHR -> ShowS

show :: XlibSurfaceCreateInfoKHR -> String

showList :: [XlibSurfaceCreateInfoKHR] -> ShowS

Generic XlibSurfaceCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_xlib_surface

Associated Types

type Rep XlibSurfaceCreateInfoKHR :: Type -> Type

Methods

from :: XlibSurfaceCreateInfoKHR -> Rep XlibSurfaceCreateInfoKHR x

to :: Rep XlibSurfaceCreateInfoKHR x -> XlibSurfaceCreateInfoKHR

Storable XlibSurfaceCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_xlib_surface

Methods

sizeOf :: XlibSurfaceCreateInfoKHR -> Int

alignment :: XlibSurfaceCreateInfoKHR -> Int

peekElemOff :: Ptr XlibSurfaceCreateInfoKHR -> Int -> IO XlibSurfaceCreateInfoKHR

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

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

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

peek :: Ptr XlibSurfaceCreateInfoKHR -> IO XlibSurfaceCreateInfoKHR

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

FromCStruct XlibSurfaceCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_xlib_surface

Methods

peekCStruct :: Ptr XlibSurfaceCreateInfoKHR -> IO XlibSurfaceCreateInfoKHR

ToCStruct XlibSurfaceCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_xlib_surface

Methods

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

pokeCStruct :: Ptr XlibSurfaceCreateInfoKHR -> XlibSurfaceCreateInfoKHR -> IO b -> IO b

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

pokeZeroCStruct :: Ptr XlibSurfaceCreateInfoKHR -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero XlibSurfaceCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_xlib_surface

Methods

zero :: XlibSurfaceCreateInfoKHR

type Rep XlibSurfaceCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_xlib_surface

type Rep XlibSurfaceCreateInfoKHR = D1 ('MetaData "XlibSurfaceCreateInfoKHR" "Vulkan.Extensions.VK_KHR_xlib_surface" "vulkan-3.6.5-inplace" 'False) (C1 ('MetaCons "XlibSurfaceCreateInfoKHR" 'PrefixI 'True) (S1 ('MetaSel ('Just "flags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 XlibSurfaceCreateFlagsKHR) :*: (S1 ('MetaSel ('Just "dpy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Ptr Display)) :*: S1 ('MetaSel ('Just "window") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Window))))

newtype XlibSurfaceCreateFlagsKHR

VkXlibSurfaceCreateFlagsKHR - Reserved for future use

Description

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

See Also

XlibSurfaceCreateInfoKHR

Constructors

XlibSurfaceCreateFlagsKHR Flags

Instances

Eq XlibSurfaceCreateFlagsKHR

Defined in Vulkan.Extensions.VK_KHR_xlib_surface

Methods

(==) :: XlibSurfaceCreateFlagsKHR -> XlibSurfaceCreateFlagsKHR -> Bool

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

Ord XlibSurfaceCreateFlagsKHR

Defined in Vulkan.Extensions.VK_KHR_xlib_surface

Methods

compare :: XlibSurfaceCreateFlagsKHR -> XlibSurfaceCreateFlagsKHR -> Ordering

(<) :: XlibSurfaceCreateFlagsKHR -> XlibSurfaceCreateFlagsKHR -> Bool

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

(>) :: XlibSurfaceCreateFlagsKHR -> XlibSurfaceCreateFlagsKHR -> Bool

(>=) :: XlibSurfaceCreateFlagsKHR -> XlibSurfaceCreateFlagsKHR -> Bool

max :: XlibSurfaceCreateFlagsKHR -> XlibSurfaceCreateFlagsKHR -> XlibSurfaceCreateFlagsKHR

min :: XlibSurfaceCreateFlagsKHR -> XlibSurfaceCreateFlagsKHR -> XlibSurfaceCreateFlagsKHR

Read XlibSurfaceCreateFlagsKHR

Defined in Vulkan.Extensions.VK_KHR_xlib_surface

Methods

readsPrec :: Int -> ReadS XlibSurfaceCreateFlagsKHR

readList :: ReadS [XlibSurfaceCreateFlagsKHR]

readPrec :: ReadPrec XlibSurfaceCreateFlagsKHR

readListPrec :: ReadPrec [XlibSurfaceCreateFlagsKHR]

Show XlibSurfaceCreateFlagsKHR

Defined in Vulkan.Extensions.VK_KHR_xlib_surface

Methods

showsPrec :: Int -> XlibSurfaceCreateFlagsKHR -> ShowS

show :: XlibSurfaceCreateFlagsKHR -> String

showList :: [XlibSurfaceCreateFlagsKHR] -> ShowS

Storable XlibSurfaceCreateFlagsKHR

Defined in Vulkan.Extensions.VK_KHR_xlib_surface

Methods

sizeOf :: XlibSurfaceCreateFlagsKHR -> Int

alignment :: XlibSurfaceCreateFlagsKHR -> Int

peekElemOff :: Ptr XlibSurfaceCreateFlagsKHR -> Int -> IO XlibSurfaceCreateFlagsKHR

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

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

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

peek :: Ptr XlibSurfaceCreateFlagsKHR -> IO XlibSurfaceCreateFlagsKHR

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

Bits XlibSurfaceCreateFlagsKHR

Defined in Vulkan.Extensions.VK_KHR_xlib_surface

Methods

(.&.) :: XlibSurfaceCreateFlagsKHR -> XlibSurfaceCreateFlagsKHR -> XlibSurfaceCreateFlagsKHR

(.|.) :: XlibSurfaceCreateFlagsKHR -> XlibSurfaceCreateFlagsKHR -> XlibSurfaceCreateFlagsKHR

xor :: XlibSurfaceCreateFlagsKHR -> XlibSurfaceCreateFlagsKHR -> XlibSurfaceCreateFlagsKHR

complement :: XlibSurfaceCreateFlagsKHR -> XlibSurfaceCreateFlagsKHR

shift :: XlibSurfaceCreateFlagsKHR -> Int -> XlibSurfaceCreateFlagsKHR

rotate :: XlibSurfaceCreateFlagsKHR -> Int -> XlibSurfaceCreateFlagsKHR

zeroBits :: XlibSurfaceCreateFlagsKHR

bit :: Int -> XlibSurfaceCreateFlagsKHR

setBit :: XlibSurfaceCreateFlagsKHR -> Int -> XlibSurfaceCreateFlagsKHR

clearBit :: XlibSurfaceCreateFlagsKHR -> Int -> XlibSurfaceCreateFlagsKHR

complementBit :: XlibSurfaceCreateFlagsKHR -> Int -> XlibSurfaceCreateFlagsKHR

testBit :: XlibSurfaceCreateFlagsKHR -> Int -> Bool

bitSizeMaybe :: XlibSurfaceCreateFlagsKHR -> Maybe Int

bitSize :: XlibSurfaceCreateFlagsKHR -> Int

isSigned :: XlibSurfaceCreateFlagsKHR -> Bool

shiftL :: XlibSurfaceCreateFlagsKHR -> Int -> XlibSurfaceCreateFlagsKHR

unsafeShiftL :: XlibSurfaceCreateFlagsKHR -> Int -> XlibSurfaceCreateFlagsKHR

shiftR :: XlibSurfaceCreateFlagsKHR -> Int -> XlibSurfaceCreateFlagsKHR

unsafeShiftR :: XlibSurfaceCreateFlagsKHR -> Int -> XlibSurfaceCreateFlagsKHR

rotateL :: XlibSurfaceCreateFlagsKHR -> Int -> XlibSurfaceCreateFlagsKHR

rotateR :: XlibSurfaceCreateFlagsKHR -> Int -> XlibSurfaceCreateFlagsKHR

popCount :: XlibSurfaceCreateFlagsKHR -> Int

Zero XlibSurfaceCreateFlagsKHR

Defined in Vulkan.Extensions.VK_KHR_xlib_surface

Methods

zero :: XlibSurfaceCreateFlagsKHR

type KHR_XLIB_SURFACE_SPEC_VERSION = 6

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

type KHR_XLIB_SURFACE_EXTENSION_NAME = "VK_KHR_xlib_surface"

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

type Display = Ptr ()

type VisualID = Word64

type Window = Word64

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

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