package libdrm

  1. Overview
  2. Docs
On This Page
  1. Features
package libdrm
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module Drm.Client_capSource

Features supported by the application.

Sourcetype t
Sourceval set : t -> Device.t -> bool -> (unit, Unix.error) result
Sourceval set_exn : t -> Device.t -> bool -> unit

Features

Sourceval stereo_3d : t

If enabled, the DRM core will expose the stereo 3D capabilities of the monitor by advertising the supported 3D layouts in the flags of struct drm_mode_modeinfo. See "DRM_MODE_FLAG_3D_*".

This capability is always supported for all drivers starting from kernel version 3.13.

Sourceval universal_planes : t

By default, only overlay planes are exposed. Enable this to see primary and cursor planes too.

This capability has been introduced in kernel version 3.15. Starting from kernel version 3.17, this capability is always supported for all drivers.

Sourceval atomic : t

If enabled, the DRM core will expose atomic properties to userspace. This implicitly enables universal_planes and aspect_ratio.

If the driver doesn't support atomic mode-setting, enabling this capability will fail with Unix.EOPNOTSUPP.

This capability has been introduced in kernel version 4.0. Starting from kernel version 4.2, this capability is always supported for atomic-capable drivers.

Sourceval aspect_ratio : t

If enabled, the DRM core will provide aspect ratio information in modes. See "DRM_MODE_FLAG_PIC_AR_*".

This capability is always supported for all drivers starting from kernel version 4.18.

Sourceval writeback_connectors : t

If enabled, the DRM core will expose special connectors to be used for writing back to memory the scene setup in the commit. The client must enable atomic first.

This capability is always supported for atomic-capable drivers starting from kernel version 4.19.

Sourceval cursor_plane_hotspot : t

Drivers for para-virtualized hardware (e.g. vmwgfx, qxl, virtio and virtualbox) have additional restrictions for cursor planes (thus making cursor planes on those drivers not truly universal), e.g. they need cursor planes to act like one would expect from a mouse cursor and have correctly set hotspot properties. If this client cap is not set the DRM core will hide cursor planes on those virtualized drivers because not setting it implies that the client is not capable of dealing with those extra restictions. Clients which do set cursor hotspot and treat the cursor plane like a mouse cursor should set this property. The client must enable atomic first.

Setting this property on drivers which do not special case cursor planes (i.e. non-virtualized drivers) will return Unix.EOPNOTSUPP, which can be used by userspace to gauge requirements of the hardware/drivers they're running on.

This capability is always supported for atomic-capable virtualized drivers starting from kernel version 6.6.