Vulkan.Extensions.VK_EXT_acquire_drm_display

Name

VK_EXT_acquire_drm_display - instance extension

VK_EXT_acquire_drm_display

Name String

VK_EXT_acquire_drm_display

Extension Type

Instance extension

Registered Extension Number

286

Revision

1

Extension and Version Dependencies

• Requires Vulkan 1.0
• Requires VK_EXT_direct_mode_display

Contact

• Drew DeVault [e-mail]

Other Extension Metadata

Last Modified Date

2021-06-09

IP Status

No known IP claims.

Contributors

• Simon Zeni, Status Holdings, Ltd.

Description

This extension allows an application to take exclusive control of a display using the Direct Rendering Manager (DRM) interface. When acquired, the display will be under full control of the application until the display is either released or the connector is unplugged.

New Commands

• acquireDrmDisplayEXT

• getDrmDisplayEXT

New Enum Constants

• EXT_ACQUIRE_DRM_DISPLAY_EXTENSION_NAME

• EXT_ACQUIRE_DRM_DISPLAY_SPEC_VERSION

Issues

None.

Version History

• Revision 1, 2021-05-11 (Simon Zeni)

  • Initial draft

See Also

acquireDrmDisplayEXT, getDrmDisplayEXT

Document Notes

For more information, see the Vulkan Specification

This page is a generated document. Fixes and changes should be made to the generator scripts, not directly.

Documentation

acquireDrmDisplayEXT

Arguments

:: forall io. MonadIO io

=> PhysicalDevice

physicalDevice The physical device the display is on.

physicalDevice must be a valid PhysicalDevice handle

-> ("drmFd" ::: Int32)

drmFd DRM primary file descriptor.

-> DisplayKHR

display The display the caller wishes Vulkan to control.

display must be a valid DisplayKHR handle

display must have been created, allocated, or retrieved from physicalDevice

-> io ()

vkAcquireDrmDisplayEXT - Acquire access to a VkDisplayKHR using DRM

Description

All permissions necessary to control the display are granted to the Vulkan instance associated with the provided physicalDevice until the display is either released or the connector is unplugged. The provided drmFd must correspond to the one owned by the physicalDevice. If not, the error code ERROR_UNKNOWN must be returned. The DRM FD must have DRM master permissions. If any error is encountered during the acquisition of the display, the call must return the error code ERROR_INITIALIZATION_FAILED.

The provided DRM fd should not be closed before the display is released, attempting to do it may result in undefined behaviour.

Return Codes

Success

• SUCCESS

Failure

• ERROR_INITIALIZATION_FAILED

See Also

VK_EXT_acquire_drm_display, DisplayKHR, PhysicalDevice

getDrmDisplayEXT

Arguments

:: forall io. MonadIO io

=> PhysicalDevice

physicalDevice The physical device to query the display from.

physicalDevice must be a valid PhysicalDevice handle

-> ("drmFd" ::: Int32)

drmFd DRM primary file descriptor.

-> ("connectorId" ::: Word32)

connectorId Identifier of the specified DRM connector.

-> io DisplayKHR

vkGetDrmDisplayEXT - Query the VkDisplayKHR corresponding to a DRM connector ID

Description

If there is no DisplayKHR corresponding to the connectorId on the physicalDevice, the returning display must be set to NULL_HANDLE. The provided drmFd must correspond to the one owned by the physicalDevice. If not, the error code ERROR_UNKNOWN must be returned. Master permissions are not required, because the file descriptor is just used for information gathering purposes. The given connectorId must be a resource owned by the provided drmFd. If not, the error code ERROR_UNKNOWN must be returned. If any error is encountered during the identification of the display, the call must return the error code ERROR_INITIALIZATION_FAILED.

Return Codes

Success

• SUCCESS

Failure

• ERROR_INITIALIZATION_FAILED
• ERROR_OUT_OF_HOST_MEMORY

See Also

VK_EXT_acquire_drm_display, DisplayKHR, PhysicalDevice

type EXT_ACQUIRE_DRM_DISPLAY_SPEC_VERSION = 1

pattern EXT_ACQUIRE_DRM_DISPLAY_SPEC_VERSION :: forall a. Integral a => a

type EXT_ACQUIRE_DRM_DISPLAY_EXTENSION_NAME = "VK_EXT_acquire_drm_display"

pattern EXT_ACQUIRE_DRM_DISPLAY_EXTENSION_NAME :: forall a. (Eq a, IsString a) => a

newtype DisplayKHR

VkDisplayKHR - Opaque handle to a display object

See Also

VK_KHR_display, DisplayPlanePropertiesKHR, DisplayPropertiesKHR, acquireDrmDisplayEXT, acquireWinrtDisplayNV, acquireXlibDisplayEXT, createDisplayModeKHR, displayPowerControlEXT, getDisplayModeProperties2KHR, getDisplayModePropertiesKHR, getDisplayPlaneSupportedDisplaysKHR, getDrmDisplayEXT, getRandROutputDisplayEXT, getWinrtDisplayNV, registerDisplayEventEXT, releaseDisplayEXT

Constructors

DisplayKHR Word64

Instances

Eq DisplayKHR

Defined in Vulkan.Extensions.Handles

Methods

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

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

Ord DisplayKHR

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

Defined in Vulkan.Extensions.Handles

Methods

showsPrec :: Int -> DisplayKHR -> ShowS

show :: DisplayKHR -> String

showList :: [DisplayKHR] -> ShowS

Storable DisplayKHR

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

Defined in Vulkan.Extensions.Handles

Methods

zero :: DisplayKHR

HasObjectType DisplayKHR

Defined in Vulkan.Extensions.Handles

Methods

objectTypeAndHandle :: DisplayKHR -> (ObjectType, Word64)

IsHandle DisplayKHR

Defined in Vulkan.Extensions.Handles