vulkan-2.0.0.1: Bindings to the Vulkan graphics API.

Safe HaskellNone
LanguageHaskell2010

Graphics.Vulkan.Extensions.VK_KHR_xcb_surface

Synopsis

Documentation

data Xcb_connection_t Source #

Opaque data

type Xcb_visualid_t = Word32 Source #

type Xcb_window_t = Word32 Source #

newtype VkXcbSurfaceCreateFlagsKHR Source #

Constructors

VkXcbSurfaceCreateFlagsKHR VkFlags 
Instances
Eq VkXcbSurfaceCreateFlagsKHR Source # 
Instance details

Methods

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

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

Ord VkXcbSurfaceCreateFlagsKHR Source # 
Instance details

Methods

compare :: VkXcbSurfaceCreateFlagsKHR -> VkXcbSurfaceCreateFlagsKHR -> Ordering #

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

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

(>) :: VkXcbSurfaceCreateFlagsKHR -> VkXcbSurfaceCreateFlagsKHR -> Bool #

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

max :: VkXcbSurfaceCreateFlagsKHR -> VkXcbSurfaceCreateFlagsKHR -> VkXcbSurfaceCreateFlagsKHR #

min :: VkXcbSurfaceCreateFlagsKHR -> VkXcbSurfaceCreateFlagsKHR -> VkXcbSurfaceCreateFlagsKHR #

Read VkXcbSurfaceCreateFlagsKHR Source # 
Instance details

Methods

readsPrec :: Int -> ReadS VkXcbSurfaceCreateFlagsKHR #

readList :: ReadS [VkXcbSurfaceCreateFlagsKHR] #

readPrec :: ReadPrec VkXcbSurfaceCreateFlagsKHR #

readListPrec :: ReadPrec [VkXcbSurfaceCreateFlagsKHR] #

Show VkXcbSurfaceCreateFlagsKHR Source # 
Instance details

Methods

showsPrec :: Int -> VkXcbSurfaceCreateFlagsKHR -> ShowS #

show :: VkXcbSurfaceCreateFlagsKHR -> String #

showList :: [VkXcbSurfaceCreateFlagsKHR] -> ShowS #

Storable VkXcbSurfaceCreateFlagsKHR Source # 
Instance details

Methods

sizeOf :: VkXcbSurfaceCreateFlagsKHR -> Int #

alignment :: VkXcbSurfaceCreateFlagsKHR -> Int #

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

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

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

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

peek :: Ptr VkXcbSurfaceCreateFlagsKHR -> IO VkXcbSurfaceCreateFlagsKHR #

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

Bits VkXcbSurfaceCreateFlagsKHR Source # 
Instance details

Methods

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

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

xor :: VkXcbSurfaceCreateFlagsKHR -> VkXcbSurfaceCreateFlagsKHR -> VkXcbSurfaceCreateFlagsKHR #

complement :: VkXcbSurfaceCreateFlagsKHR -> VkXcbSurfaceCreateFlagsKHR #

shift :: VkXcbSurfaceCreateFlagsKHR -> Int -> VkXcbSurfaceCreateFlagsKHR #

rotate :: VkXcbSurfaceCreateFlagsKHR -> Int -> VkXcbSurfaceCreateFlagsKHR #

zeroBits :: VkXcbSurfaceCreateFlagsKHR #

bit :: Int -> VkXcbSurfaceCreateFlagsKHR #

setBit :: VkXcbSurfaceCreateFlagsKHR -> Int -> VkXcbSurfaceCreateFlagsKHR #

clearBit :: VkXcbSurfaceCreateFlagsKHR -> Int -> VkXcbSurfaceCreateFlagsKHR #

complementBit :: VkXcbSurfaceCreateFlagsKHR -> Int -> VkXcbSurfaceCreateFlagsKHR #

testBit :: VkXcbSurfaceCreateFlagsKHR -> Int -> Bool #

bitSizeMaybe :: VkXcbSurfaceCreateFlagsKHR -> Maybe Int #

bitSize :: VkXcbSurfaceCreateFlagsKHR -> Int #

isSigned :: VkXcbSurfaceCreateFlagsKHR -> Bool #

shiftL :: VkXcbSurfaceCreateFlagsKHR -> Int -> VkXcbSurfaceCreateFlagsKHR #

unsafeShiftL :: VkXcbSurfaceCreateFlagsKHR -> Int -> VkXcbSurfaceCreateFlagsKHR #

shiftR :: VkXcbSurfaceCreateFlagsKHR -> Int -> VkXcbSurfaceCreateFlagsKHR #

unsafeShiftR :: VkXcbSurfaceCreateFlagsKHR -> Int -> VkXcbSurfaceCreateFlagsKHR #

rotateL :: VkXcbSurfaceCreateFlagsKHR -> Int -> VkXcbSurfaceCreateFlagsKHR #

rotateR :: VkXcbSurfaceCreateFlagsKHR -> Int -> VkXcbSurfaceCreateFlagsKHR #

popCount :: VkXcbSurfaceCreateFlagsKHR -> Int #

FiniteBits VkXcbSurfaceCreateFlagsKHR Source # 
Instance details

Methods

finiteBitSize :: VkXcbSurfaceCreateFlagsKHR -> Int #

countLeadingZeros :: VkXcbSurfaceCreateFlagsKHR -> Int #

countTrailingZeros :: VkXcbSurfaceCreateFlagsKHR -> Int #

pattern VK_STRUCTURE_TYPE_XCB_SURFACE_CREATE_INFO_KHR :: VkStructureType Source #

pattern VK_KHR_XCB_SURFACE_SPEC_VERSION :: Integral a => a Source #

pattern VK_KHR_XCB_SURFACE_EXTENSION_NAME :: (Eq a, IsString a) => a Source #

vkCreateXcbSurfaceKHR :: ("instance" ::: VkInstance) -> ("pCreateInfo" ::: Ptr VkXcbSurfaceCreateInfoKHR) -> ("pAllocator" ::: Ptr VkAllocationCallbacks) -> ("pSurface" ::: Ptr VkSurfaceKHR) -> IO VkResult Source #

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

Parameters

  • instance is the instance to associate the surface with.
  • pCreateInfo is a pointer to an instance of the VkXcbSurfaceCreateInfoKHR structure containing parameters affecting the creation of the surface object.
  • pAllocator is the allocator used for host memory allocated for the surface object when there is no more specific allocator available (see Memory Allocation).
  • pSurface points to a VkSurfaceKHR handle in which the created surface object is returned.

Valid Usage (Implicit)

  • instance must be a valid VkInstance handle
  • pCreateInfo must be a valid pointer to a valid VkXcbSurfaceCreateInfoKHR structure
  • If pAllocator is not NULL, pAllocator must be a valid pointer to a valid VkAllocationCallbacks structure
  • pSurface must be a valid pointer to a VkSurfaceKHR handle

Return Codes

[Success] - VK_SUCCESS

[Failure] - VK_ERROR_OUT_OF_HOST_MEMORY

  • VK_ERROR_OUT_OF_DEVICE_MEMORY

See Also

VkAllocationCallbacks, VkInstance, VkSurfaceKHR, VkXcbSurfaceCreateInfoKHR

vkGetPhysicalDeviceXcbPresentationSupportKHR :: ("physicalDevice" ::: VkPhysicalDevice) -> ("queueFamilyIndex" ::: Word32) -> ("connection" ::: Ptr Xcb_connection_t) -> ("visual_id" ::: Xcb_visualid_t) -> IO VkBool32 Source #

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

Parameters

  • physicalDevice is the physical device.
  • queueFamilyIndex is the queue family index.
  • connection is a pointer to an xcb_connection_t to the X server. visual_id is an X11 visual (xcb_visualid_t).

Description

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

Valid Usage

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

Valid Usage (Implicit)

  • physicalDevice must be a valid VkPhysicalDevice handle
  • connection must be a valid pointer to a xcb_connection_t value

See Also

VkPhysicalDevice

data VkXcbSurfaceCreateInfoKHR Source #

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

Valid Usage

  • connection must point to a valid X11 xcb_connection_t.
  • window must be a valid X11 xcb_window_t.

Valid Usage (Implicit)

  • sType must be VK_STRUCTURE_TYPE_XCB_SURFACE_CREATE_INFO_KHR
  • pNext must be NULL
  • flags must be 0

See Also

VkStructureType, VkXcbSurfaceCreateFlagsKHR, vkCreateXcbSurfaceKHR

Constructors

VkXcbSurfaceCreateInfoKHR 

Fields

Instances
Eq VkXcbSurfaceCreateInfoKHR Source # 
Instance details

Methods

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

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

Show VkXcbSurfaceCreateInfoKHR Source # 
Instance details

Methods

showsPrec :: Int -> VkXcbSurfaceCreateInfoKHR -> ShowS #

show :: VkXcbSurfaceCreateInfoKHR -> String #

showList :: [VkXcbSurfaceCreateInfoKHR] -> ShowS #

Storable VkXcbSurfaceCreateInfoKHR Source # 
Instance details

Methods

sizeOf :: VkXcbSurfaceCreateInfoKHR -> Int #

alignment :: VkXcbSurfaceCreateInfoKHR -> Int #

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

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

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

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

peek :: Ptr VkXcbSurfaceCreateInfoKHR -> IO VkXcbSurfaceCreateInfoKHR #

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