vulkan-2.0.0.1: Bindings to the Vulkan graphics API.

Safe HaskellNone
LanguageHaskell2010

Graphics.Vulkan.Extensions.VK_KHR_wayland_surface

Synopsis

Documentation

data Wl_display Source #

Opaque data

data Wl_surface Source #

Opaque data

newtype VkWaylandSurfaceCreateFlagsKHR Source #

Instances
Eq VkWaylandSurfaceCreateFlagsKHR Source # 
Instance details
Ord VkWaylandSurfaceCreateFlagsKHR Source # 
Instance details
Read VkWaylandSurfaceCreateFlagsKHR Source # 
Instance details
Show VkWaylandSurfaceCreateFlagsKHR Source # 
Instance details
Storable VkWaylandSurfaceCreateFlagsKHR Source # 
Instance details
Bits VkWaylandSurfaceCreateFlagsKHR Source # 
Instance details

Methods

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

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

xor :: VkWaylandSurfaceCreateFlagsKHR -> VkWaylandSurfaceCreateFlagsKHR -> VkWaylandSurfaceCreateFlagsKHR #

complement :: VkWaylandSurfaceCreateFlagsKHR -> VkWaylandSurfaceCreateFlagsKHR #

shift :: VkWaylandSurfaceCreateFlagsKHR -> Int -> VkWaylandSurfaceCreateFlagsKHR #

rotate :: VkWaylandSurfaceCreateFlagsKHR -> Int -> VkWaylandSurfaceCreateFlagsKHR #

zeroBits :: VkWaylandSurfaceCreateFlagsKHR #

bit :: Int -> VkWaylandSurfaceCreateFlagsKHR #

setBit :: VkWaylandSurfaceCreateFlagsKHR -> Int -> VkWaylandSurfaceCreateFlagsKHR #

clearBit :: VkWaylandSurfaceCreateFlagsKHR -> Int -> VkWaylandSurfaceCreateFlagsKHR #

complementBit :: VkWaylandSurfaceCreateFlagsKHR -> Int -> VkWaylandSurfaceCreateFlagsKHR #

testBit :: VkWaylandSurfaceCreateFlagsKHR -> Int -> Bool #

bitSizeMaybe :: VkWaylandSurfaceCreateFlagsKHR -> Maybe Int #

bitSize :: VkWaylandSurfaceCreateFlagsKHR -> Int #

isSigned :: VkWaylandSurfaceCreateFlagsKHR -> Bool #

shiftL :: VkWaylandSurfaceCreateFlagsKHR -> Int -> VkWaylandSurfaceCreateFlagsKHR #

unsafeShiftL :: VkWaylandSurfaceCreateFlagsKHR -> Int -> VkWaylandSurfaceCreateFlagsKHR #

shiftR :: VkWaylandSurfaceCreateFlagsKHR -> Int -> VkWaylandSurfaceCreateFlagsKHR #

unsafeShiftR :: VkWaylandSurfaceCreateFlagsKHR -> Int -> VkWaylandSurfaceCreateFlagsKHR #

rotateL :: VkWaylandSurfaceCreateFlagsKHR -> Int -> VkWaylandSurfaceCreateFlagsKHR #

rotateR :: VkWaylandSurfaceCreateFlagsKHR -> Int -> VkWaylandSurfaceCreateFlagsKHR #

popCount :: VkWaylandSurfaceCreateFlagsKHR -> Int #

FiniteBits VkWaylandSurfaceCreateFlagsKHR Source # 
Instance details

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

vkCreateWaylandSurfaceKHR - Create a VkSurfaceKHR object for a Wayland window

Parameters

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

vkGetPhysicalDeviceWaylandPresentationSupportKHR :: ("physicalDevice" ::: VkPhysicalDevice) -> ("queueFamilyIndex" ::: Word32) -> ("display" ::: Ptr Wl_display) -> IO VkBool32 Source #

vkGetPhysicalDeviceWaylandPresentationSupportKHR - Query physical device for presentation to Wayland

Parameters

  • physicalDevice is the physical device.
  • queueFamilyIndex is the queue family index.
  • display is a pointer to the wl_display associated with a Wayland compositor.

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

See Also

VkPhysicalDevice

data VkWaylandSurfaceCreateInfoKHR Source #

VkWaylandSurfaceCreateInfoKHR - Structure specifying parameters of a newly created Wayland surface object

Valid Usage

  • display must point to a valid Wayland wl_display.
  • surface must point to a valid Wayland wl_surface.

Valid Usage (Implicit)

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

See Also

VkStructureType, VkWaylandSurfaceCreateFlagsKHR, vkCreateWaylandSurfaceKHR

Constructors

VkWaylandSurfaceCreateInfoKHR 

Fields