vulkan-2.0.0.1: Bindings to the Vulkan graphics API.

Safe HaskellNone
LanguageHaskell2010

Graphics.Vulkan.Extensions.VK_KHR_xlib_surface

Synopsis

Documentation

newtype Display Source #

Constructors

Display (Ptr Display) 

type VisualID = Word64 Source #

type Window = Word64 Source #

newtype VkXlibSurfaceCreateFlagsKHR Source #

Constructors

VkXlibSurfaceCreateFlagsKHR VkFlags 
Instances
Eq VkXlibSurfaceCreateFlagsKHR Source # 
Instance details

Methods

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

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

Ord VkXlibSurfaceCreateFlagsKHR Source # 
Instance details

Methods

compare :: VkXlibSurfaceCreateFlagsKHR -> VkXlibSurfaceCreateFlagsKHR -> Ordering #

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

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

(>) :: VkXlibSurfaceCreateFlagsKHR -> VkXlibSurfaceCreateFlagsKHR -> Bool #

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

max :: VkXlibSurfaceCreateFlagsKHR -> VkXlibSurfaceCreateFlagsKHR -> VkXlibSurfaceCreateFlagsKHR #

min :: VkXlibSurfaceCreateFlagsKHR -> VkXlibSurfaceCreateFlagsKHR -> VkXlibSurfaceCreateFlagsKHR #

Read VkXlibSurfaceCreateFlagsKHR Source # 
Instance details

Methods

readsPrec :: Int -> ReadS VkXlibSurfaceCreateFlagsKHR #

readList :: ReadS [VkXlibSurfaceCreateFlagsKHR] #

readPrec :: ReadPrec VkXlibSurfaceCreateFlagsKHR #

readListPrec :: ReadPrec [VkXlibSurfaceCreateFlagsKHR] #

Show VkXlibSurfaceCreateFlagsKHR Source # 
Instance details

Methods

showsPrec :: Int -> VkXlibSurfaceCreateFlagsKHR -> ShowS #

show :: VkXlibSurfaceCreateFlagsKHR -> String #

showList :: [VkXlibSurfaceCreateFlagsKHR] -> ShowS #

Storable VkXlibSurfaceCreateFlagsKHR Source # 
Instance details

Methods

sizeOf :: VkXlibSurfaceCreateFlagsKHR -> Int #

alignment :: VkXlibSurfaceCreateFlagsKHR -> Int #

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

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

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

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

peek :: Ptr VkXlibSurfaceCreateFlagsKHR -> IO VkXlibSurfaceCreateFlagsKHR #

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

Bits VkXlibSurfaceCreateFlagsKHR Source # 
Instance details

Methods

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

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

xor :: VkXlibSurfaceCreateFlagsKHR -> VkXlibSurfaceCreateFlagsKHR -> VkXlibSurfaceCreateFlagsKHR #

complement :: VkXlibSurfaceCreateFlagsKHR -> VkXlibSurfaceCreateFlagsKHR #

shift :: VkXlibSurfaceCreateFlagsKHR -> Int -> VkXlibSurfaceCreateFlagsKHR #

rotate :: VkXlibSurfaceCreateFlagsKHR -> Int -> VkXlibSurfaceCreateFlagsKHR #

zeroBits :: VkXlibSurfaceCreateFlagsKHR #

bit :: Int -> VkXlibSurfaceCreateFlagsKHR #

setBit :: VkXlibSurfaceCreateFlagsKHR -> Int -> VkXlibSurfaceCreateFlagsKHR #

clearBit :: VkXlibSurfaceCreateFlagsKHR -> Int -> VkXlibSurfaceCreateFlagsKHR #

complementBit :: VkXlibSurfaceCreateFlagsKHR -> Int -> VkXlibSurfaceCreateFlagsKHR #

testBit :: VkXlibSurfaceCreateFlagsKHR -> Int -> Bool #

bitSizeMaybe :: VkXlibSurfaceCreateFlagsKHR -> Maybe Int #

bitSize :: VkXlibSurfaceCreateFlagsKHR -> Int #

isSigned :: VkXlibSurfaceCreateFlagsKHR -> Bool #

shiftL :: VkXlibSurfaceCreateFlagsKHR -> Int -> VkXlibSurfaceCreateFlagsKHR #

unsafeShiftL :: VkXlibSurfaceCreateFlagsKHR -> Int -> VkXlibSurfaceCreateFlagsKHR #

shiftR :: VkXlibSurfaceCreateFlagsKHR -> Int -> VkXlibSurfaceCreateFlagsKHR #

unsafeShiftR :: VkXlibSurfaceCreateFlagsKHR -> Int -> VkXlibSurfaceCreateFlagsKHR #

rotateL :: VkXlibSurfaceCreateFlagsKHR -> Int -> VkXlibSurfaceCreateFlagsKHR #

rotateR :: VkXlibSurfaceCreateFlagsKHR -> Int -> VkXlibSurfaceCreateFlagsKHR #

popCount :: VkXlibSurfaceCreateFlagsKHR -> Int #

FiniteBits VkXlibSurfaceCreateFlagsKHR Source # 
Instance details

Methods

finiteBitSize :: VkXlibSurfaceCreateFlagsKHR -> Int #

countLeadingZeros :: VkXlibSurfaceCreateFlagsKHR -> Int #

countTrailingZeros :: VkXlibSurfaceCreateFlagsKHR -> Int #

pattern VK_STRUCTURE_TYPE_XLIB_SURFACE_CREATE_INFO_KHR :: VkStructureType Source #

pattern VK_KHR_XLIB_SURFACE_SPEC_VERSION :: Integral a => a Source #

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

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

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

Parameters

  • instance is the instance to associate the surface with.
  • pCreateInfo is a pointer to an instance of the VkXlibSurfaceCreateInfoKHR structure containing the 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 VkXlibSurfaceCreateInfoKHR 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, VkXlibSurfaceCreateInfoKHR

vkGetPhysicalDeviceXlibPresentationSupportKHR :: ("physicalDevice" ::: VkPhysicalDevice) -> ("queueFamilyIndex" ::: Word32) -> ("dpy" ::: Ptr Display) -> ("visualID" ::: VisualID) -> IO VkBool32 Source #

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

Parameters

  • physicalDevice is the physical device.
  • queueFamilyIndex is the queue family index.
  • dpy is a pointer to an Xlib Display connection to the server.
  • visualId is an X11 visual (VisualID).

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
  • dpy must be a valid pointer to a Display value

See Also

VkPhysicalDevice

data VkXlibSurfaceCreateInfoKHR Source #

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

Valid Usage

  • dpy must point to a valid Xlib Display.
  • window must be a valid Xlib Window.

Valid Usage (Implicit)

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

See Also

VkStructureType, VkXlibSurfaceCreateFlagsKHR, vkCreateXlibSurfaceKHR

Constructors

VkXlibSurfaceCreateInfoKHR 

Fields

Instances
Eq VkXlibSurfaceCreateInfoKHR Source # 
Instance details

Methods

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

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

Show VkXlibSurfaceCreateInfoKHR Source # 
Instance details

Methods

showsPrec :: Int -> VkXlibSurfaceCreateInfoKHR -> ShowS #

show :: VkXlibSurfaceCreateInfoKHR -> String #

showList :: [VkXlibSurfaceCreateInfoKHR] -> ShowS #

Storable VkXlibSurfaceCreateInfoKHR Source # 
Instance details

Methods

sizeOf :: VkXlibSurfaceCreateInfoKHR -> Int #

alignment :: VkXlibSurfaceCreateInfoKHR -> Int #

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

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

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

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

peek :: Ptr VkXlibSurfaceCreateInfoKHR -> IO VkXlibSurfaceCreateInfoKHR #

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