fdo-mirrors/wayland-protocols
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/wayland/wayland-protocols.git synced 2025-12-20 04:40:06 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

staging/color-management: clarify the displayness

Browse source 
There have been complaints that it was not clear everything is
display-referred:
https://gitlab.freedesktop.org/wayland/wayland-protocols/-/merge_requests/442#note_3079533

The section in Wayland documentation makes it very clear, so link to it.

Mention the attention to the display explicitly.

Signed-off-by: Pekka Paalanen <pekka.paalanen@collabora.com>
This commit is contained in:
Pekka Paalanen 2025-09-02 14:07:43 +03:00 • committed by Pekka Paalanen
parent a5a33944a1
commit f3e14e4007
1 changed files with 22 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

35
staging/color-management/color-management-v1.xml
View file

@ -31,9 +31,14 @@
<description summary="color management protocol"> <description summary="color management protocol">
The aim of the color management extension is to allow clients to know The aim of the color management extension is to allow clients to know
the color properties of outputs, and to tell the compositor about the color the color properties of outputs, and to tell the compositor about the color
properties of their content on surfaces. Doing this enables a compositor properties of their content on surfaces. All surface contents must be
to perform automatic color management of content for different outputs readily intended for some display, but not necessarily for the display at
according to how content is intended to look like. hand. Doing this enables a compositor to perform automatic color management
of content for different outputs according to how content is intended to
look like.
For an introduction, see the section "Color management" in the Wayland
documentation at https://wayland.freedesktop.org/docs/html/ .
The color properties are represented as an image description object which The color properties are represented as an image description object which
is immutable after it has been created. A wl_output always has an is immutable after it has been created. A wl_output always has an
@ -43,12 +48,14 @@
description on a wl_surface to denote the color characteristics of the description on a wl_surface to denote the color characteristics of the
surface contents. surface contents.
An image description includes SDR and HDR colorimetry and encoding, HDR An image description essentially defines a display and (indirectly) its
metadata, and viewing environment parameters. An image description does viewing environment. An image description includes SDR and HDR colorimetry
not include the properties set through color-representation extension. and encoding, HDR metadata, and some parameters related to the viewing
It is expected that the color-representation extension is used in environment. An image description does not include the properties set
conjunction with the color management extension when necessary, through color-representation extension. It is expected that the
particularly with the YUV family of pixel formats. color-representation extension is used in conjunction with the
color-management extension when necessary, particularly with the YUV family
of pixel formats.
The color-and-hdr repository The color-and-hdr repository
(https://gitlab.freedesktop.org/pq/color-and-hdr) contains (https://gitlab.freedesktop.org/pq/color-and-hdr) contains
@ -241,7 +248,7 @@
<enum name="transfer_function"> <enum name="transfer_function">
<description summary="named transfer functions"> <description summary="named transfer functions">
Named transfer functions used to represent well-known transfer Named transfer functions used to represent well-known transfer
characteristics. characteristics of displays.
A value of 0 is invalid and will never be present in the list of enums. A value of 0 is invalid and will never be present in the list of enums.
</description> </description>
@ -1278,11 +1285,13 @@
<interface name="wp_image_description_v1" version="1"> <interface name="wp_image_description_v1" version="1">
<description summary="Colorimetric image description"> <description summary="Colorimetric image description">
An image description carries information about the color encoding used on An image description carries information about the pixel color encoding
a surface when attached to a wl_surface via and its intended display and viewing environment. The image description is
attached to a wl_surface via
wp_color_management_surface_v1.set_image_description. A compositor can use wp_color_management_surface_v1.set_image_description. A compositor can use
this information to decode pixel values into colorimetrically meaningful this information to decode pixel values into colorimetrically meaningful
quantities. quantities, which allows the compositor to transform the surface contents
to become suitable for various displays and viewing environments.
Note, that the wp_image_description_v1 object is not ready to be used Note, that the wp_image_description_v1 object is not ready to be used
immediately after creation. The object eventually delivers either the immediately after creation. The object eventually delivers either the