vulkan-3.26.1: Bindings to the Vulkan graphics API.
Safe HaskellSafe-Inferred
LanguageHaskell2010

Vulkan.Extensions.VK_KHR_xlib_surface

Description

Name

VK_KHR_xlib_surface - instance extension

VK_KHR_xlib_surface

Name String
VK_KHR_xlib_surface
Extension Type
Instance extension
Registered Extension Number
5
Revision
6
Ratification Status
Ratified
Extension and Version Dependencies
VK_KHR_surface
Contact

Other Extension Metadata

Last Modified Date
2015-11-28
IP Status
No known IP claims.
Contributors
  • Patrick Doane, Blizzard
  • Faith Ekstrand, Intel
  • Ian Elliott, LunarG
  • Courtney Goeltzenleuchter, LunarG
  • Jesse Hall, Google
  • James Jones, NVIDIA
  • Antoine Labour, Google
  • Jon Leech, Khronos
  • David Mao, AMD
  • Norbert Nopper, Freescale
  • Alon Or-bach, Samsung
  • Daniel Rakos, AMD
  • Graham Sellers, AMD
  • Ray Smith, ARM
  • Jeff Vigil, Qualcomm
  • Chia-I Wu, LunarG

Description

The VK_KHR_xlib_surface extension is an instance extension. It provides a mechanism to create a SurfaceKHR object (defined by the VK_KHR_surface extension) that refers to an X11 Window, using the Xlib client-side library, as well as a query to determine support for rendering via Xlib.

New Commands

New Structures

New Bitmasks

New Enum Constants

Issues

1) Does X11 need a way to query for compatibility between a particular physical device and a specific screen? This would be a more general query than getPhysicalDeviceSurfaceSupportKHR; if it returned TRUE, then the physical device could be assumed to support presentation to any window on that screen.

RESOLVED: Yes, this is needed for toolkits that want to create a Device before creating a window. To ensure the query is reliable, it must be made against a particular X visual rather than the screen in general.

Version History

  • Revision 1, 2015-09-23 (Jesse Hall)

    • Initial draft, based on the previous contents of VK_EXT_KHR_swapchain (later renamed VK_EXT_KHR_surface).

  • Revision 2, 2015-10-02 (James Jones)

    • Added presentation support query for (Display*, VisualID) pair.
    • Removed “root” parameter from CreateXlibSurfaceKHR(), as it is redundant when a window on the same screen is specified as well.
    • Added appropriate X errors.
    • Adjusted wording of issue #1 and added agreed upon resolution.

  • Revision 3, 2015-10-14 (Ian Elliott)

    • Renamed this extension from VK_EXT_KHR_x11_surface to VK_EXT_KHR_xlib_surface.

  • Revision 4, 2015-10-26 (Ian Elliott)

    • Renamed from VK_EXT_KHR_xlib_surface to VK_KHR_xlib_surface.

  • Revision 5, 2015-11-03 (Daniel Rakos)

    • Added allocation callbacks to vkCreateXlibSurfaceKHR.

  • Revision 6, 2015-11-28 (Daniel Rakos)

    • Updated the surface create function to take a pCreateInfo structure.

See Also

XlibSurfaceCreateFlagsKHR, XlibSurfaceCreateInfoKHR, createXlibSurfaceKHR, getPhysicalDeviceXlibPresentationSupportKHR

Document Notes

For more information, see the Vulkan Specification

This page is a generated document. Fixes and changes should be made to the generator scripts, not directly.

Synopsis

Documentation

createXlibSurfaceKHR Source #

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

Return Codes

Success
Failure

See Also

VK_KHR_xlib_surface, AllocationCallbacks, Instance, SurfaceKHR, XlibSurfaceCreateInfoKHR

getPhysicalDeviceXlibPresentationSupportKHR 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

-> ("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

VK_KHR_xlib_surface, PhysicalDevice

data XlibSurfaceCreateInfoKHR Source #

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

Valid Usage (Implicit)

See Also

VK_KHR_xlib_surface, StructureType, XlibSurfaceCreateFlagsKHR, createXlibSurfaceKHR

Constructors

XlibSurfaceCreateInfoKHR 

Fields

Instances

Instances details
Storable XlibSurfaceCreateInfoKHR Source # 
Instance details

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 () #

Show XlibSurfaceCreateInfoKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_xlib_surface

Methods

showsPrec :: Int -> XlibSurfaceCreateInfoKHR -> ShowS #

show :: XlibSurfaceCreateInfoKHR -> String #

showList :: [XlibSurfaceCreateInfoKHR] -> ShowS #

Eq XlibSurfaceCreateInfoKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_xlib_surface

Methods

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

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

FromCStruct XlibSurfaceCreateInfoKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_xlib_surface

Methods

peekCStruct :: Ptr XlibSurfaceCreateInfoKHR -> IO XlibSurfaceCreateInfoKHR Source #

ToCStruct XlibSurfaceCreateInfoKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_xlib_surface

Methods

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

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

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

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

cStructSize :: Int Source #

cStructAlignment :: Int Source #

Zero XlibSurfaceCreateInfoKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_xlib_surface

Methods

zero :: XlibSurfaceCreateInfoKHR Source #

newtype XlibSurfaceCreateFlagsKHR Source #

VkXlibSurfaceCreateFlagsKHR - Reserved for future use

Description

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

See Also

VK_KHR_xlib_surface, XlibSurfaceCreateInfoKHR

Constructors

XlibSurfaceCreateFlagsKHR Flags 

Instances

Instances details
Storable XlibSurfaceCreateFlagsKHR Source # 
Instance details

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 Source # 
Instance details

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 #

FiniteBits XlibSurfaceCreateFlagsKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_xlib_surface

Methods

finiteBitSize :: XlibSurfaceCreateFlagsKHR -> Int #

countLeadingZeros :: XlibSurfaceCreateFlagsKHR -> Int #

countTrailingZeros :: XlibSurfaceCreateFlagsKHR -> Int #

Read XlibSurfaceCreateFlagsKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_xlib_surface

Methods

readsPrec :: Int -> ReadS XlibSurfaceCreateFlagsKHR #

readList :: ReadS [XlibSurfaceCreateFlagsKHR] #

readPrec :: ReadPrec XlibSurfaceCreateFlagsKHR #

readListPrec :: ReadPrec [XlibSurfaceCreateFlagsKHR] #

Show XlibSurfaceCreateFlagsKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_xlib_surface

Methods

showsPrec :: Int -> XlibSurfaceCreateFlagsKHR -> ShowS #

show :: XlibSurfaceCreateFlagsKHR -> String #

showList :: [XlibSurfaceCreateFlagsKHR] -> ShowS #

Eq XlibSurfaceCreateFlagsKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_xlib_surface

Methods

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

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

Ord XlibSurfaceCreateFlagsKHR Source # 
Instance details

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 #

Zero XlibSurfaceCreateFlagsKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_xlib_surface

Methods

zero :: XlibSurfaceCreateFlagsKHR Source #

type KHR_XLIB_SURFACE_SPEC_VERSION = 6 Source #

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

type KHR_XLIB_SURFACE_EXTENSION_NAME = "VK_KHR_xlib_surface" Source #

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

type Display = Ptr () Source #

type VisualID = Word64 Source #

type Window = Word64 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

VK_KHR_surface, PhysicalDeviceSurfaceInfo2KHR, SwapchainCreateInfoKHR, createAndroidSurfaceKHR, createDirectFBSurfaceEXT, createDisplayPlaneSurfaceKHR, createHeadlessSurfaceEXT, createIOSSurfaceMVK, createImagePipeSurfaceFUCHSIA, createMacOSSurfaceMVK, createMetalSurfaceEXT, createScreenSurfaceQNX, createStreamDescriptorSurfaceGGP, createViSurfaceNN, createWaylandSurfaceKHR, createWin32SurfaceKHR, createXcbSurfaceKHR, createXlibSurfaceKHR, destroySurfaceKHR, getDeviceGroupSurfacePresentModesKHR, getPhysicalDevicePresentRectanglesKHR, getPhysicalDeviceSurfaceCapabilities2EXT, getPhysicalDeviceSurfaceCapabilitiesKHR, getPhysicalDeviceSurfaceFormatsKHR, getPhysicalDeviceSurfacePresentModesKHR, getPhysicalDeviceSurfaceSupportKHR

Constructors

SurfaceKHR Word64 

Instances

Instances details
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 () #

Show SurfaceKHR Source # 
Instance details

Defined in Vulkan.Extensions.Handles

Methods

showsPrec :: Int -> SurfaceKHR -> ShowS #

show :: SurfaceKHR -> String #

showList :: [SurfaceKHR] -> ShowS #

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 #

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

Zero SurfaceKHR Source # 
Instance details

Defined in Vulkan.Extensions.Handles

Methods

zero :: SurfaceKHR Source #