Safe Haskell	None
Language	Haskell2010

Vulkan.Extensions.VK_EXT_acquire_xlib_display

Synopsis

acquireXlibDisplayEXT :: forall io. MonadIO io => PhysicalDevice -> ("dpy" ::: Ptr Display) -> DisplayKHR -> io ()
getRandROutputDisplayEXT :: forall io. MonadIO io => PhysicalDevice -> ("dpy" ::: Ptr Display) -> RROutput -> io DisplayKHR
type EXT_ACQUIRE_XLIB_DISPLAY_SPEC_VERSION = 1
pattern EXT_ACQUIRE_XLIB_DISPLAY_SPEC_VERSION :: forall a. Integral a => a
type EXT_ACQUIRE_XLIB_DISPLAY_EXTENSION_NAME = "VK_EXT_acquire_xlib_display"
pattern EXT_ACQUIRE_XLIB_DISPLAY_EXTENSION_NAME :: forall a. (Eq a, IsString a) => a
type RROutput = Word64
newtype DisplayKHR = DisplayKHR Word64
type Display = Ptr ()

Documentation

acquireXlibDisplayEXT Source #

Arguments

:: forall io. MonadIO io
=> PhysicalDevice	`physicalDevice` The physical device the display is on. `physicalDevice` must be a valid `PhysicalDevice` handle
-> ("dpy" ::: Ptr Display)	`dpy` A connection to the X11 server that currently owns `display`. `dpy` must be a valid pointer to a `Display` value
-> DisplayKHR	`display` The display the caller wishes to control in Vulkan. `display` must be a valid `DisplayKHR` handle `display` must have been created, allocated, or retrieved from `physicalDevice`
-> io ()

vkAcquireXlibDisplayEXT - Acquire access to a VkDisplayKHR using Xlib

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

SUCCESS

Failure

Description

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

Return Codes

Success

SUCCESS

Failure

ERROR_OUT_OF_HOST_MEMORY

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 #

Documentation

Description

Return Codes

See Also

Description

Return Codes

See Also

See Also

Instances

:: forall io. MonadIO io
=> PhysicalDevice	`physicalDevice` The physical device to query the display handle on. `physicalDevice` must be a valid `PhysicalDevice` handle
-> ("dpy" ::: Ptr Display)	`dpy` A connection to the X11 server from which `rrOutput` was queried. `dpy` must be a valid pointer to a `Display` value
-> RROutput	`rrOutput` An X11 RandR output ID.
-> io DisplayKHR