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

Vulkan.Extensions.VK_KHR_xcb_surface

Synopsis

Documentation

createXcbSurfaceKHR Source #

Arguments

:: forall io. MonadIO io 
=> Instance

instance is the instance to associate the surface with.

-> XcbSurfaceCreateInfoKHR

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

vkCreateXcbSurfaceKHR - Create a SurfaceKHR object for a X11 window, using the XCB client-side library

Valid Usage (Implicit)

  • instance must be a valid Instance handle

Return Codes

Success
Failure

See Also

AllocationCallbacks, Instance, SurfaceKHR, XcbSurfaceCreateInfoKHR

getPhysicalDeviceXcbPresentationSupportKHR 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 Xcb_connection_t

connection is a pointer to an xcb_connection_t to the X server.

connection must be a valid pointer to an xcb_connection_t value

-> ("visual_id" ::: Xcb_visualid_t)

visual_id is an X11 visual (xcb_visualid_t).

-> io Bool 

vkGetPhysicalDeviceXcbPresentationSupportKHR - Query physical device for presentation to X11 server using XCB

Description

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

Valid Usage (Implicit)

See Also

PhysicalDevice

data XcbSurfaceCreateInfoKHR Source #

VkXcbSurfaceCreateInfoKHR - Structure specifying parameters of a newly created Xcb surface object

Valid Usage (Implicit)

See Also

StructureType, XcbSurfaceCreateFlagsKHR, createXcbSurfaceKHR

Constructors

XcbSurfaceCreateInfoKHR 

Fields

Instances

Instances details
Eq XcbSurfaceCreateInfoKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_xcb_surface

Methods

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

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

Show XcbSurfaceCreateInfoKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_xcb_surface

Methods

showsPrec :: Int -> XcbSurfaceCreateInfoKHR -> ShowS #

show :: XcbSurfaceCreateInfoKHR -> String #

showList :: [XcbSurfaceCreateInfoKHR] -> ShowS #

Generic XcbSurfaceCreateInfoKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_xcb_surface

Associated Types

type Rep XcbSurfaceCreateInfoKHR :: Type -> Type #

Methods

from :: XcbSurfaceCreateInfoKHR -> Rep XcbSurfaceCreateInfoKHR x #

to :: Rep XcbSurfaceCreateInfoKHR x -> XcbSurfaceCreateInfoKHR #

Storable XcbSurfaceCreateInfoKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_xcb_surface

Methods

sizeOf :: XcbSurfaceCreateInfoKHR -> Int #

alignment :: XcbSurfaceCreateInfoKHR -> Int #

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

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

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

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

peek :: Ptr XcbSurfaceCreateInfoKHR -> IO XcbSurfaceCreateInfoKHR #

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

FromCStruct XcbSurfaceCreateInfoKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_xcb_surface

Methods

peekCStruct :: Ptr XcbSurfaceCreateInfoKHR -> IO XcbSurfaceCreateInfoKHR Source #

ToCStruct XcbSurfaceCreateInfoKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_xcb_surface

Methods

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

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

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

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

cStructSize :: Int Source #

cStructAlignment :: Int Source #

Zero XcbSurfaceCreateInfoKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_xcb_surface

Methods

zero :: XcbSurfaceCreateInfoKHR Source #

type Rep XcbSurfaceCreateInfoKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_xcb_surface

type Rep XcbSurfaceCreateInfoKHR = D1 ('MetaData "XcbSurfaceCreateInfoKHR" "Vulkan.Extensions.VK_KHR_xcb_surface" "vulkan-3.4-inplace" 'False) (C1 ('MetaCons "XcbSurfaceCreateInfoKHR" 'PrefixI 'True) (S1 ('MetaSel ('Just "flags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 XcbSurfaceCreateFlagsKHR) :*: (S1 ('MetaSel ('Just "connection") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Ptr Xcb_connection_t)) :*: S1 ('MetaSel ('Just "window") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Xcb_window_t))))

newtype XcbSurfaceCreateFlagsKHR Source #

VkXcbSurfaceCreateFlagsKHR - Reserved for future use

Description

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

See Also

XcbSurfaceCreateInfoKHR

Constructors

XcbSurfaceCreateFlagsKHR Flags 

Instances

Instances details
Eq XcbSurfaceCreateFlagsKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_xcb_surface

Methods

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

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

Ord XcbSurfaceCreateFlagsKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_xcb_surface

Methods

compare :: XcbSurfaceCreateFlagsKHR -> XcbSurfaceCreateFlagsKHR -> Ordering #

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

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

(>) :: XcbSurfaceCreateFlagsKHR -> XcbSurfaceCreateFlagsKHR -> Bool #

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

max :: XcbSurfaceCreateFlagsKHR -> XcbSurfaceCreateFlagsKHR -> XcbSurfaceCreateFlagsKHR #

min :: XcbSurfaceCreateFlagsKHR -> XcbSurfaceCreateFlagsKHR -> XcbSurfaceCreateFlagsKHR #

Read XcbSurfaceCreateFlagsKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_xcb_surface

Methods

readsPrec :: Int -> ReadS XcbSurfaceCreateFlagsKHR #

readList :: ReadS [XcbSurfaceCreateFlagsKHR] #

readPrec :: ReadPrec XcbSurfaceCreateFlagsKHR #

readListPrec :: ReadPrec [XcbSurfaceCreateFlagsKHR] #

Show XcbSurfaceCreateFlagsKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_xcb_surface

Methods

showsPrec :: Int -> XcbSurfaceCreateFlagsKHR -> ShowS #

show :: XcbSurfaceCreateFlagsKHR -> String #

showList :: [XcbSurfaceCreateFlagsKHR] -> ShowS #

Storable XcbSurfaceCreateFlagsKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_xcb_surface

Methods

sizeOf :: XcbSurfaceCreateFlagsKHR -> Int #

alignment :: XcbSurfaceCreateFlagsKHR -> Int #

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

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

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

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

peek :: Ptr XcbSurfaceCreateFlagsKHR -> IO XcbSurfaceCreateFlagsKHR #

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

Bits XcbSurfaceCreateFlagsKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_xcb_surface

Methods

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

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

xor :: XcbSurfaceCreateFlagsKHR -> XcbSurfaceCreateFlagsKHR -> XcbSurfaceCreateFlagsKHR #

complement :: XcbSurfaceCreateFlagsKHR -> XcbSurfaceCreateFlagsKHR #

shift :: XcbSurfaceCreateFlagsKHR -> Int -> XcbSurfaceCreateFlagsKHR #

rotate :: XcbSurfaceCreateFlagsKHR -> Int -> XcbSurfaceCreateFlagsKHR #

zeroBits :: XcbSurfaceCreateFlagsKHR #

bit :: Int -> XcbSurfaceCreateFlagsKHR #

setBit :: XcbSurfaceCreateFlagsKHR -> Int -> XcbSurfaceCreateFlagsKHR #

clearBit :: XcbSurfaceCreateFlagsKHR -> Int -> XcbSurfaceCreateFlagsKHR #

complementBit :: XcbSurfaceCreateFlagsKHR -> Int -> XcbSurfaceCreateFlagsKHR #

testBit :: XcbSurfaceCreateFlagsKHR -> Int -> Bool #

bitSizeMaybe :: XcbSurfaceCreateFlagsKHR -> Maybe Int #

bitSize :: XcbSurfaceCreateFlagsKHR -> Int #

isSigned :: XcbSurfaceCreateFlagsKHR -> Bool #

shiftL :: XcbSurfaceCreateFlagsKHR -> Int -> XcbSurfaceCreateFlagsKHR #

unsafeShiftL :: XcbSurfaceCreateFlagsKHR -> Int -> XcbSurfaceCreateFlagsKHR #

shiftR :: XcbSurfaceCreateFlagsKHR -> Int -> XcbSurfaceCreateFlagsKHR #

unsafeShiftR :: XcbSurfaceCreateFlagsKHR -> Int -> XcbSurfaceCreateFlagsKHR #

rotateL :: XcbSurfaceCreateFlagsKHR -> Int -> XcbSurfaceCreateFlagsKHR #

rotateR :: XcbSurfaceCreateFlagsKHR -> Int -> XcbSurfaceCreateFlagsKHR #

popCount :: XcbSurfaceCreateFlagsKHR -> Int #

Zero XcbSurfaceCreateFlagsKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_xcb_surface

Methods

zero :: XcbSurfaceCreateFlagsKHR Source #

type KHR_XCB_SURFACE_SPEC_VERSION = 6 Source #

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

type KHR_XCB_SURFACE_EXTENSION_NAME = "VK_KHR_xcb_surface" Source #

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

type Xcb_visualid_t = Word32 Source #

type Xcb_window_t = Word32 Source #

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