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

Vulkan.Extensions.VK_EXT_acquire_xlib_display

Synopsis

Documentation

acquireXlibDisplayEXT :: forall io. MonadIO io => PhysicalDevice -> ("dpy" ::: Ptr Display) -> DisplayKHR -> io () Source #

vkAcquireXlibDisplayEXT - Acquire access to a VkDisplayKHR using Xlib

Parameters

  • physicalDevice The physical device the display is on.
  • dpy A connection to the X11 server that currently owns display.
  • display The display the caller wishes to control in Vulkan.

Description

All permissions necessary to control the display are granted to the Vulkan instance associated with physicalDevice until the display is released or the X11 connection specified by dpy is terminated. Permission to access the display may be temporarily revoked during periods when the X11 server from which control was acquired itself loses access to display. During such periods, operations which require access to the display must fail with an approriate error code. If the X11 server associated with dpy does not own display, or if permission to access it has already been acquired by another entity, the call must return the error code ERROR_INITIALIZATION_FAILED.

Note

One example of when an X11 server loses access to a display is when it loses ownership of its virtual terminal.

Return Codes

Success
Failure

See Also

DisplayKHR, PhysicalDevice

getRandROutputDisplayEXT :: forall io. MonadIO io => PhysicalDevice -> ("dpy" ::: Ptr Display) -> RROutput -> io DisplayKHR Source #

vkGetRandROutputDisplayEXT - Query the VkDisplayKHR corresponding to an X11 RandR Output

Parameters

  • physicalDevice The physical device to query the display handle on.
  • dpy A connection to the X11 server from which rrOutput was queried.
  • rrOutput An X11 RandR output ID.
  • pDisplay The corresponding DisplayKHR handle will be returned here.

Description

If there is no DisplayKHR corresponding to rrOutput on physicalDevice, NULL_HANDLE must be returned in pDisplay.

Return Codes

Success

See Also

DisplayKHR, PhysicalDevice

type EXT_ACQUIRE_XLIB_DISPLAY_SPEC_VERSION = 1 Source #

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

type EXT_ACQUIRE_XLIB_DISPLAY_EXTENSION_NAME = "VK_EXT_acquire_xlib_display" Source #

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

newtype DisplayKHR Source #

VkDisplayKHR - Opaque handle to a display object

See Also

DisplayPlanePropertiesKHR, DisplayPropertiesKHR, acquireXlibDisplayEXT, createDisplayModeKHR, displayPowerControlEXT, getDisplayModeProperties2KHR, getDisplayModePropertiesKHR, getDisplayPlaneSupportedDisplaysKHR, getRandROutputDisplayEXT, registerDisplayEventEXT, releaseDisplayEXT

Constructors

DisplayKHR Word64 

Instances

Instances details
Eq DisplayKHR Source # 
Instance details

Defined in Vulkan.Extensions.Handles

Methods

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

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

Ord DisplayKHR Source # 
Instance details

Defined in Vulkan.Extensions.Handles

Methods

compare :: DisplayKHR -> DisplayKHR -> Ordering #

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

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

(>) :: DisplayKHR -> DisplayKHR -> Bool #

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

max :: DisplayKHR -> DisplayKHR -> DisplayKHR #

min :: DisplayKHR -> DisplayKHR -> DisplayKHR #

Show DisplayKHR Source # 
Instance details

Defined in Vulkan.Extensions.Handles

Methods

showsPrec :: Int -> DisplayKHR -> ShowS #

show :: DisplayKHR -> String #

showList :: [DisplayKHR] -> ShowS #

Storable DisplayKHR Source # 
Instance details

Defined in Vulkan.Extensions.Handles

Methods

sizeOf :: DisplayKHR -> Int #

alignment :: DisplayKHR -> Int #

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

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

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

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

peek :: Ptr DisplayKHR -> IO DisplayKHR #

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

Zero DisplayKHR Source # 
Instance details

Defined in Vulkan.Extensions.Handles

Methods

zero :: DisplayKHR Source #

HasObjectType DisplayKHR Source # 
Instance details

Defined in Vulkan.Extensions.Handles

Methods

objectTypeAndHandle :: DisplayKHR -> (ObjectType, Word64) Source #

IsHandle DisplayKHR Source # 
Instance details

Defined in Vulkan.Extensions.Handles

type Display = Ptr () Source #

type RROutput = Word64 Source #