DRM database property: SIZE_HINTS

Back to index

Details

Name
SIZE_HINTS
Flags
immutable
Type
blob
Attached to
plane
Specification
<none>

Documentation

Blob property which contains the set of recommended plane size
which can used for simple "cursor like" use cases (eg. no scaling).
Using these hints frees userspace from extensive probing of
supported plane sizes through atomic/setcursor ioctls.

The blob contains an array of struct drm_plane_size_hint, in
order of preference. For optimal usage userspace should pick
the first size that satisfies its own requirements.

Drivers should only attach this property to planes that
support a very limited set of sizes.

Note that property value 0 (ie. no blob) is reserved for potential
future use. Current userspace is expected to ignore the property
if the value is 0, and fall back to some other means (eg.
&DRM_CAP_CURSOR_WIDTH and &DRM_CAP_CURSOR_HEIGHT) to determine
the appropriate plane size to use.

Driver support

adp
amdgpu
apple
ast
bochs-drm
drm-rp1-dsi
evdi
exynos
gma500
i915
imx-dcss
imx-drm
imx-lcdif
kirin
mediatek
meson
msm
mxsfb-drm
nouveau
nvidia-drm
omapdrm
panel-mipi-dbi
pvr
qxl
radeon
rcar-du
rockchip
simpledrm
starfive
sun4i-drm
sunxi-drm
tegra
tilcdc
vboxvideo
vc4
virtio_gpu
vkms
vmwgfx
vs-drm
xe
xlnx