aboutsummaryrefslogtreecommitdiffhomepage
path: root/protocol
diff options
context:
space:
mode:
authordec05eba <dec05eba@protonmail.com>2026-07-15 15:49:39 +0200
committerdec05eba <dec05eba@protonmail.com>2026-07-15 15:49:39 +0200
commit22f38efd69911613d8438d73b8823500f2b58f04 (patch)
treeb51ee5279b674504f986560952ad8014cc148196 /protocol
parent37d282774d6d06b230aefbf0f71f0d6c0fbf32c1 (diff)
hdr capture: switch from kde output device to color management protocol
Diffstat (limited to 'protocol')
-rw-r--r--protocol/color-management-v1.xml1756
-rw-r--r--protocol/kde-output-device-v2.xml633
-rw-r--r--protocol/meson.build2
3 files changed, 1757 insertions, 634 deletions
diff --git a/protocol/color-management-v1.xml b/protocol/color-management-v1.xml
new file mode 100644
index 0000000..b47e108
--- /dev/null
+++ b/protocol/color-management-v1.xml
@@ -0,0 +1,1756 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<protocol name="color_management_v1">
+ <copyright>
+ Copyright 2019 Sebastian Wick
+ Copyright 2019 Erwin Burema
+ Copyright 2020 AMD
+ Copyright 2020-2024 Collabora, Ltd.
+ Copyright 2024 Xaver Hugl
+ Copyright 2022-2025 Red Hat, Inc.
+
+ Permission is hereby granted, free of charge, to any person obtaining a
+ copy of this software and associated documentation files (the "Software"),
+ to deal in the Software without restriction, including without limitation
+ the rights to use, copy, modify, merge, publish, distribute, sublicense,
+ and/or sell copies of the Software, and to permit persons to whom the
+ Software is furnished to do so, subject to the following conditions:
+
+ The above copyright notice and this permission notice (including the next
+ paragraph) shall be included in all copies or substantial portions of the
+ Software.
+
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+ THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+ FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+ DEALINGS IN THE SOFTWARE.
+ </copyright>
+
+ <description summary="color management protocol">
+ 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
+ properties of their content on surfaces. All surface contents must be
+ readily intended for some display, but not necessarily for the display at
+ 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
+ is immutable after it has been created. A wl_output always has an
+ associated image description that clients can observe. A wl_surface
+ always has an associated preferred image description as a hint chosen by
+ the compositor that clients can also observe. Clients can set an image
+ description on a wl_surface to denote the color characteristics of the
+ surface contents.
+
+ An image description essentially defines a display and (indirectly) its
+ viewing environment. An image description includes SDR and HDR colorimetry
+ and encoding, HDR metadata, and some parameters related to the viewing
+ environment. An image description does not include the properties set
+ through color-representation extension. It is expected that the
+ color-representation extension is used in conjunction with the
+ color-management extension when necessary, particularly with the YUV family
+ of pixel formats.
+
+ The normative appendix for this protocol is in the appendix.md file beside
+ this XML file.
+
+ The color-and-hdr repository
+ (https://gitlab.freedesktop.org/pq/color-and-hdr) contains
+ background information on the protocol design and legacy color management.
+ It also contains a glossary, learning resources for digital color, tools,
+ samples and more.
+
+ The terminology used in this protocol is based on common color science and
+ color encoding terminology where possible. The glossary in the color-and-hdr
+ repository shall be the authority on the definition of terms in this
+ protocol.
+
+ Warning! The protocol described in this file is currently in the testing
+ phase. Backward compatible changes may be added together with the
+ corresponding interface version bump. Backward incompatible changes can
+ only be done by creating a new major version of the extension.
+ </description>
+
+ <interface name="wp_color_manager_v1" version="3">
+ <description summary="color manager singleton">
+ A singleton global interface used for getting color management extensions
+ for wl_surface and wl_output objects, and for creating client defined
+ image description objects. The extension interfaces allow
+ getting the image description of outputs and setting the image
+ description of surfaces.
+
+ Compositors should never remove this global.
+ </description>
+
+ <request name="destroy" type="destructor">
+ <description summary="destroy the color manager">
+ Destroy the wp_color_manager_v1 object. This does not affect any other
+ objects in any way.
+ </description>
+ </request>
+
+ <enum name="error">
+ <entry name="unsupported_feature" value="0"
+ summary="request not supported"/>
+ <entry name="surface_exists" value="1"
+ summary="color management surface exists already"/>
+ </enum>
+
+ <enum name="render_intent">
+ <description summary="rendering intents">
+ See the ICC.1:2022 specification from the International Color Consortium
+ for more details about rendering intents.
+
+ The principles of ICC defined rendering intents apply with all types of
+ image descriptions, not only those with ICC file profiles.
+
+ Compositors must support the perceptual rendering intent. Other
+ rendering intents are optional.
+ </description>
+
+ <entry name="perceptual" value="0"
+ summary="perceptual"/>
+ <entry name="relative" value="1"
+ summary="media-relative colorimetric"/>
+ <entry name="saturation" value="2"
+ summary="saturation"/>
+ <entry name="absolute" value="3"
+ summary="ICC-absolute colorimetric"/>
+ <entry name="relative_bpc" value="4"
+ summary="media-relative colorimetric + black point compensation"/>
+ <entry name="absolute_no_adaptation" value="5" since="2">
+ <description summary="ICC-absolute colorimetric without adaptation">
+ This rendering intent is a modified absolute rendering intent that
+ assumes the viewer is not adapted to the display white point, so no
+ chromatic adaptation between surface and display is done.
+ This can be useful for color proofing applications.
+ </description>
+ </entry>
+ </enum>
+
+ <enum name="feature">
+ <description summary="compositor supported features"/>
+
+ <entry name="icc_v2_v4" value="0"
+ summary="create_icc_creator request"/>
+ <entry name="parametric" value="1"
+ summary="create_parametric_creator request"/>
+ <entry name="set_primaries" value="2"
+ summary="parametric set_primaries request"/>
+ <entry name="set_tf_power" value="3"
+ summary="parametric set_tf_power request"/>
+ <entry name="set_luminances" value="4"
+ summary="parametric set_luminances request"/>
+ <entry name="set_mastering_display_primaries" value="5">
+ <description summary="parametric set_mastering_display_primaries request">
+ The compositor supports set_mastering_display_primaries request with a
+ target color volume fully contained inside the primary color volume.
+ </description>
+ </entry>
+ <entry name="extended_target_volume" value="6">
+ <description summary="parametric target exceeds primary color volume">
+ The compositor additionally supports target color volumes that
+ extend outside of the primary color volume.
+
+ This can only be advertised if feature set_mastering_display_primaries
+ is supported as well.
+ </description>
+ </entry>
+ <entry name="windows_scrgb" value="7"
+ summary="create_windows_scrgb request"/>
+ <entry name="windows_bt2100" value="8"
+ summary="create_windows_bt2100 request"/>
+ </enum>
+
+ <enum name="primaries">
+ <description summary="named color primaries">
+ Named color primaries used to encode well-known sets of primaries.
+
+ A value of 0 is invalid and will never be present in the list of enums.
+ </description>
+
+ <entry name="srgb" value="1">
+ <description summary="Color primaries for the sRGB color space as defined by the BT.709 standard">
+ Color primaries as defined by
+ - Rec. ITU-R BT.709-6
+ - Rec. ITU-R BT.1361-0 conventional colour gamut system and extended
+ colour gamut system (historical)
+ - IEC 61966-2-1 sRGB or sYCC
+ - IEC 61966-2-4
+ - Society of Motion Picture and Television Engineers (SMPTE) RP 177
+ (1993) Annex B
+ </description>
+ </entry>
+ <entry name="pal_m" value="2">
+ <description summary="Color primaries for PAL-M as defined by the BT.470 standard">
+ Color primaries as defined by
+ - Rec. ITU-R BT.470-6 System M (historical)
+ - United States National Television System Committee 1953
+ Recommendation for transmission standards for color television
+ - United States Federal Communications Commission (2003) Title 47 Code
+ of Federal Regulations 73.682 (a)(20)
+ </description>
+ </entry>
+ <entry name="pal" value="3">
+ <description summary="Color primaries for PAL as defined by the BT.601 standard">
+ Color primaries as defined by
+ - Rec. ITU-R BT.470-6 System B, G (historical)
+ - Rec. ITU-R BT.601-7 625
+ - Rec. ITU-R BT.1358-0 625 (historical)
+ - Rec. ITU-R BT.1700-0 625 PAL and 625 SECAM
+ </description>
+ </entry>
+ <entry name="ntsc" value="4">
+ <description summary="Color primaries for NTSC as defined by the BT.601 standard">
+ Color primaries as defined by
+ - Rec. ITU-R BT.601-7 525
+ - Rec. ITU-R BT.1358-1 525 or 625 (historical)
+ - Rec. ITU-R BT.1700-0 NTSC
+ - SMPTE 170M (2004)
+ - SMPTE 240M (1999) (historical)
+ </description>
+ </entry>
+ <entry name="generic_film" value="5">
+ <description summary="Generic film with colour filters using Illuminant C">
+ Color primaries as defined by Recommendation ITU-T H.273
+ "Coding-independent code points for video signal type identification"
+ for "generic film".
+ </description>
+ </entry>
+ <entry name="bt2020" value="6">
+ <description summary="Color primaries as defined by the BT.2020 and BT.2100 standard">
+ Color primaries as defined by
+ - Rec. ITU-R BT.2020-2
+ - Rec. ITU-R BT.2100-0
+ </description>
+ </entry>
+ <entry name="cie1931_xyz" value="7">
+ <description summary="Color primaries of the full CIE 1931 XYZ color space">
+ Color primaries as defined as the maximum of the CIE 1931 XYZ color
+ space by
+ - SMPTE ST 428-1
+ - (CIE 1931 XYZ as in ISO 11664-1)
+ </description>
+ </entry>
+ <entry name="dci_p3" value="8">
+ <description summary="Color primaries of the DCI P3 color space as defined by the SMPTE RP 431 standard">
+ Color primaries as defined by Digital Cinema System and published in
+ SMPTE RP 431-2 (2011).
+ </description>
+ </entry>
+ <entry name="display_p3" value="9">
+ <description summary="Color primaries of Display P3 variant of the DCI-P3 color space as defined by the SMPTE EG 432 standard">
+ Color primaries as defined by Digital Cinema System and published in
+ SMPTE EG 432-1 (2010).
+ </description>
+ </entry>
+ <entry name="adobe_rgb" value="10">
+ <description summary="Color primaries of the Adobe RGB color space as defined by the ISO 12640 standard">
+ Color primaries as defined by Adobe as "Adobe RGB" and later published
+ by ISO 12640-4 (2011).
+ </description>
+ </entry>
+ </enum>
+
+ <enum name="transfer_function">
+ <description summary="named transfer functions">
+ Named transfer functions used to represent well-known transfer
+ characteristics of displays.
+
+ A value of 0 is invalid and will never be present in the list of enums.
+
+ See appendix.md for the formulae.
+ </description>
+
+ <entry name="bt1886" value="1">
+ <description summary="BT.1886 display transfer characteristic">
+ Rec. ITU-R BT.1886 is the display transfer characteristic assumed by
+ - Rec. ITU-R BT.601-7 525 and 625
+ - Rec. ITU-R BT.709-6
+ - Rec. ITU-R BT.2020-2
+
+ This TF implies these default luminances from Rec. ITU-R BT.2035:
+ - primary color volume minimum: 0.01 cd/m²
+ - primary color volume maximum: 100 cd/m²
+ - reference white: 100 cd/m²
+ </description>
+ </entry>
+ <entry name="gamma22" value="2">
+ <description summary="Assumed display gamma 2.2 transfer function">
+ Transfer characteristics as defined by
+ - Rec. ITU-R BT.470-6 System M (historical)
+ - United States National Television System Committee 1953
+ Recommendation for transmission standards for color television
+ - United States Federal Communications Commission (2003) Title 47 Code
+ of Federal Regulations 73.682 (a) (20)
+ - Rec. ITU-R BT.1700-0 625 PAL and 625 SECAM
+ - IEC 61966-2-1 (reference display)
+ </description>
+ </entry>
+ <entry name="gamma28" value="3">
+ <description summary="Assumed display gamma 2.8 transfer function">
+ Transfer characteristics as defined by
+ - Rec. ITU-R BT.470-6 System B, G (historical)
+ </description>
+ </entry>
+ <entry name="st240" value="4">
+ <description summary="SMPTE ST 240 transfer function">
+ Transfer characteristics as defined by
+ - SMPTE ST 240 (1999)
+ </description>
+ </entry>
+ <entry name="ext_linear" value="5">
+ <description summary="extended linear transfer function">
+ Linear transfer function defined over all real numbers.
+ Normalised electrical values are equal the normalised optical values.
+ </description>
+ </entry>
+ <entry name="log_100" value="6">
+ <description summary="logarithmic 100:1 transfer function">
+ Logarithmic transfer characteristic (100:1 range).
+ </description>
+ </entry>
+ <entry name="log_316" value="7">
+ <description summary="logarithmic (100*Sqrt(10) : 1) transfer function">
+ Logarithmic transfer characteristic (100 * Sqrt(10) : 1 range).
+ </description>
+ </entry>
+ <entry name="xvycc" value="8">
+ <description summary="IEC 61966-2-4 transfer function">
+ Transfer characteristics as defined by
+ - IEC 61966-2-4
+ </description>
+ </entry>
+ <entry name="srgb" value="9" deprecated-since="2">
+ <description summary="Deprecated (ambiguous sRGB transfer function)">
+ Transfer characteristics as defined by
+ - IEC 61966-2-1 sRGB
+
+ As a rule of thumb, use gamma22 for video, motion picture and
+ computer graphics, or compound_power_2_4 for ICC calibrated print
+ workflows.
+ </description>
+ </entry>
+ <entry name="ext_srgb" value="10" deprecated-since="2">
+ <description summary="Deprecated (Extended sRGB piece-wise transfer function)">
+ Transfer characteristics as defined by
+ - IEC 61966-2-1 sYCC
+ </description>
+ </entry>
+ <entry name="st2084_pq" value="11">
+ <description summary="perceptual quantizer transfer function">
+ Transfer characteristics as defined by
+ - SMPTE ST 2084 (2014) for 10-, 12-, 14- and 16-bit systems
+ - Rec. ITU-R BT.2100-2 perceptual quantization (PQ) system
+
+ This TF implies these default luminances
+ - primary color volume minimum: 0.005 cd/m²
+ - primary color volume maximum: 10000 cd/m²
+ - reference white: 203 cd/m²
+
+ The difference between the primary color volume minimum and maximum
+ must be approximately 10000 cd/m² as that is the swing of the EOTF
+ defined by ST 2084 and BT.2100. The default value for the
+ reference white is a protocol addition: it is suggested by
+ Report ITU-R BT.2408-7 and is not part of ST 2084 or BT.2100.
+ </description>
+ </entry>
+ <entry name="st428" value="12">
+ <description summary="SMPTE ST 428 transfer function">
+ Transfer characteristics as defined by
+ - SMPTE ST 428-1 (2019)
+ </description>
+ </entry>
+ <entry name="hlg" value="13">
+ <description summary="hybrid log-gamma transfer function">
+ Transfer characteristics as defined by
+ - ARIB STD-B67 (2015)
+ - Rec. ITU-R BT.2100-2 hybrid log-gamma (HLG) system
+
+ This TF implies these default luminances
+ - primary color volume minimum: 0.005 cd/m²
+ - primary color volume maximum: 1000 cd/m²
+ - reference white: 203 cd/m²
+
+ HLG is a relative display-referred signal with a specified
+ non-linear mapping to the display peak luminance (the HLG OOTF).
+ All absolute luminance values used here for HLG assume a 1000 cd/m²
+ peak display.
+
+ The default value for the reference white is a protocol addition:
+ it is suggested by Report ITU-R BT.2408-7 and is not part of
+ ARIB STD-B67 or BT.2100.
+ </description>
+ </entry>
+ <entry name="compound_power_2_4" value="14" since="2">
+ <description summary="IEC 61966-2-1 encoding function">
+ Encoding characteristics as defined by IEC 61966-2-1, for displays
+ that invert the encoding function.
+ </description>
+ </entry>
+ </enum>
+
+ <request name="get_output">
+ <description summary="create a color management interface for a wl_output">
+ This creates a new wp_color_management_output_v1 object for the
+ given wl_output.
+
+ See the wp_color_management_output_v1 interface for more details.
+ </description>
+
+ <arg name="id" type="new_id" interface="wp_color_management_output_v1"/>
+ <arg name="output" type="object" interface="wl_output"/>
+ </request>
+
+ <request name="get_surface">
+ <description summary="create a color management interface for a wl_surface">
+ If a wp_color_management_surface_v1 object already exists for the given
+ wl_surface, the protocol error surface_exists is raised.
+
+ This creates a new color wp_color_management_surface_v1 object for the
+ given wl_surface.
+
+ See the wp_color_management_surface_v1 interface for more details.
+ </description>
+
+ <arg name="id" type="new_id" interface="wp_color_management_surface_v1"/>
+ <arg name="surface" type="object" interface="wl_surface"/>
+ </request>
+
+ <request name="get_surface_feedback">
+ <description summary="create a color management feedback interface">
+ This creates a new color wp_color_management_surface_feedback_v1 object
+ for the given wl_surface.
+
+ See the wp_color_management_surface_feedback_v1 interface for more
+ details.
+ </description>
+
+ <arg name="id" type="new_id"
+ interface="wp_color_management_surface_feedback_v1"/>
+ <arg name="surface" type="object" interface="wl_surface"/>
+ </request>
+
+ <request name="create_icc_creator">
+ <description summary="make a new ICC-based image description creator object">
+ Makes a new ICC-based image description creator object with all
+ properties initially unset. The client can then use the object's
+ interface to define all the required properties for an image description
+ and finally create a wp_image_description_v1 object.
+
+ This request can be used when the compositor advertises
+ wp_color_manager_v1.feature.icc_v2_v4.
+ Otherwise this request raises the protocol error unsupported_feature.
+ </description>
+
+ <arg name="obj"
+ type="new_id" interface="wp_image_description_creator_icc_v1"
+ summary="the new creator object"/>
+ </request>
+
+ <request name="create_parametric_creator">
+ <description summary="make a new parametric image description creator object">
+ Makes a new parametric image description creator object with all
+ properties initially unset. The client can then use the object's
+ interface to define all the required properties for an image description
+ and finally create a wp_image_description_v1 object.
+
+ This request can be used when the compositor advertises
+ wp_color_manager_v1.feature.parametric.
+ Otherwise this request raises the protocol error unsupported_feature.
+ </description>
+
+ <arg name="obj"
+ type="new_id" interface="wp_image_description_creator_params_v1"
+ summary="the new creator object"/>
+ </request>
+
+ <request name="create_windows_scrgb">
+ <description summary="create Windows-scRGB image description object">
+ This creates a pre-defined image description for the so-called
+ Windows-scRGB stimulus encoding. This comes from the Windows 10 handling
+ of its own definition of an scRGB color space for an HDR screen
+ driven in BT.2100/PQ signalling mode.
+
+ Windows-scRGB uses sRGB (BT.709) color primaries and white point.
+ The transfer characteristic is extended linear.
+
+ The nominal color channel value range is extended, meaning it includes
+ negative and greater than 1.0 values. Negative values are used to
+ escape the sRGB color gamut boundaries. To make use of the extended
+ range, the client needs to use a pixel format that can represent those
+ values, e.g. floating-point 16 bits per channel.
+
+ Nominal color value R=G=B=0.0 corresponds to BT.2100/PQ system
+ 0 cd/m², and R=G=B=1.0 corresponds to BT.2100/PQ system 80 cd/m².
+ The maximum is R=G=B=125.0 corresponding to 10k cd/m².
+
+ Windows-scRGB is displayed by Windows 10 by converting it to
+ BT.2100/PQ, maintaining the CIE 1931 chromaticity and mapping the
+ luminance as above. No adjustment is made to the signal to account
+ for the viewing conditions.
+
+ The reference white level of Windows-scRGB is unknown. If a
+ reference white level must be assumed for compositor processing, it
+ should be R=G=B=2.5375 corresponding to 203 cd/m² of Report ITU-R
+ BT.2408-7.
+
+ The target color volume of Windows-scRGB is unknown. The color gamut
+ may be anything between sRGB and BT.2100.
+
+ Note: EGL_EXT_gl_colorspace_scrgb_linear definition differs from
+ Windows-scRGB by using R=G=B=1.0 as the reference white level, while
+ Windows-scRGB reference white level is unknown or varies. However,
+ it seems probable that Windows implements both
+ EGL_EXT_gl_colorspace_scrgb_linear and Vulkan
+ VK_COLOR_SPACE_EXTENDED_SRGB_LINEAR_EXT as Windows-scRGB.
+
+ This request can be used when the compositor advertises
+ wp_color_manager_v1.feature.windows_scrgb.
+ Otherwise this request raises the protocol error unsupported_feature.
+
+ The resulting image description object does not allow get_information
+ request. The wp_image_description_v1.ready event shall be sent.
+ </description>
+
+ <arg name="image_description"
+ type="new_id" interface="wp_image_description_v1"/>
+ </request>
+
+ <event name="supported_intent">
+ <description summary="supported rendering intent">
+ When this object is created, it shall immediately send this event once
+ for each rendering intent the compositor supports.
+
+ A compositor must not advertise intents that are deprecated in the
+ bound version of the interface.
+ </description>
+
+ <arg name="render_intent" type="uint" enum="render_intent"
+ summary="rendering intent"/>
+ </event>
+
+ <event name="supported_feature">
+ <description summary="supported features">
+ When this object is created, it shall immediately send this event once
+ for each compositor supported feature listed in the enumeration.
+
+ A compositor must not advertise features that are deprecated in the
+ bound version of the interface.
+ </description>
+
+ <arg name="feature" type="uint" enum="feature"
+ summary="supported feature"/>
+ </event>
+
+ <event name="supported_tf_named">
+ <description summary="supported named transfer characteristic">
+ When this object is created, it shall immediately send this event once
+ for each named transfer function the compositor supports with the
+ parametric image description creator.
+
+ A compositor must not advertise transfer functions that are deprecated
+ in the bound version of the interface.
+ </description>
+
+ <arg name="tf" type="uint" enum="transfer_function"
+ summary="Named transfer function"/>
+ </event>
+
+ <event name="supported_primaries_named">
+ <description summary="supported named primaries">
+ When this object is created, it shall immediately send this event once
+ for each named set of primaries the compositor supports with the
+ parametric image description creator.
+
+ A compositor must not advertise names that are deprecated in the
+ bound version of the interface.
+ </description>
+
+ <arg name="primaries" type="uint" enum="primaries"
+ summary="Named color primaries"/>
+ </event>
+
+ <event name="done">
+ <description summary="all features have been sent">
+ This event is sent when all supported rendering intents, features,
+ transfer functions and named primaries have been sent.
+ </description>
+ </event>
+
+ <request name="get_image_description" since="2">
+ <description summary="create an image description from a reference">
+ This request retrieves the image description backing a reference.
+
+ The get_information request can be used if and only if the request that
+ creates the reference allows it.
+ </description>
+
+ <arg name="image_description"
+ type="new_id" interface="wp_image_description_v1"/>
+ <arg name="reference"
+ type="object" interface="wp_image_description_reference_v1"/>
+ </request>
+
+ <request name="create_windows_bt2100" since="3">
+ <description summary="create Windows-BT.2100 image description object">
+ This creates a pre-defined image description for the so-called
+ Windows-BT.2100 stimulus encoding. This comes from the Windows 10
+ handling of its own definition of a BT.2100 color space for an HDR
+ screen driven in BT.2100/PQ signalling mode.
+
+ Windows-BT.2100 uses BT.2020 color primaries and white point.
+ The transfer characteristic is st2084_pq.
+
+ Windows-BT.2100 is generally displayed by Windows 10 without any
+ adjustments to the signal to account for viewing conditions.
+
+ The reference white level of Windows-BT.2100 is unknown. If a
+ reference white level must be assumed for compositor processing, it
+ should be 203 cd/m² of Report ITU-R BT.2408-7.
+
+ The target color volume of Windows-BT.2100 is unknown. The color gamut
+ may be anything up to BT.2100.
+
+ This request can be used when the compositor advertises
+ wp_color_manager_v1.feature.windows_bt2100.
+ Otherwise this request raises the protocol error unsupported_feature.
+
+ The resulting image description object does not allow get_information
+ request. The wp_image_description_v1.ready event shall be sent.
+ </description>
+
+ <arg name="image_description"
+ type="new_id" interface="wp_image_description_v1"/>
+ </request>
+ </interface>
+
+ <interface name="wp_color_management_output_v1" version="3">
+ <description summary="output color properties">
+ A wp_color_management_output_v1 describes the color properties of an
+ output.
+
+ The wp_color_management_output_v1 is associated with the wl_output global
+ underlying the wl_output object. Therefore the client destroying the
+ wl_output object has no impact, but the compositor removing the output
+ global makes the wp_color_management_output_v1 object inert.
+ </description>
+
+ <request name="destroy" type="destructor">
+ <description summary="destroy the color management output">
+ Destroy the color wp_color_management_output_v1 object. This does not
+ affect any remaining protocol objects.
+ </description>
+ </request>
+
+ <event name="image_description_changed">
+ <description summary="image description changed">
+ This event is sent whenever the image description of the output changed,
+ followed by one wl_output.done event common to output events across all
+ extensions.
+
+ If the client wants to use the updated image description, it needs to do
+ get_image_description again, because image description objects are
+ immutable.
+ </description>
+ </event>
+
+ <request name="get_image_description">
+ <description summary="get the image description of the output">
+ This creates a new wp_image_description_v1 object for the current image
+ description of the output. There always is exactly one image description
+ active for an output so the client should destroy the image description
+ created by earlier invocations of this request. This request is usually
+ sent as a reaction to the image_description_changed event or when
+ creating a wp_color_management_output_v1 object.
+
+ The image description of an output represents the color encoding the
+ output expects. There might be performance and power advantages, as well
+ as improved color reproduction, if a content update matches the image
+ description of the output it is being shown on. If a content update is
+ shown on any other output than the one it matches the image description
+ of, then the color reproduction on those outputs might be considerably
+ worse.
+
+ The created wp_image_description_v1 object preserves the image
+ description of the output from the time the object was created.
+
+ The resulting image description object allows get_information request.
+
+ If this protocol object is inert, the resulting image description object
+ shall immediately deliver the wp_image_description_v1.failed event with
+ the no_output cause.
+
+ If the interface version is inadequate for the output's image
+ description, meaning that the client does not support all the events
+ needed to deliver the crucial information, the resulting image
+ description object shall immediately deliver the
+ wp_image_description_v1.failed event with the low_version cause.
+
+ Otherwise the object shall immediately deliver the ready event.
+ </description>
+
+ <arg name="image_description"
+ type="new_id" interface="wp_image_description_v1"/>
+ </request>
+ </interface>
+
+ <interface name="wp_color_management_surface_v1" version="3">
+ <description summary="color management extension to a surface">
+ A wp_color_management_surface_v1 allows the client to set the color
+ space and HDR properties of a surface.
+
+ If the wl_surface associated with the wp_color_management_surface_v1 is
+ destroyed, the wp_color_management_surface_v1 object becomes inert.
+ </description>
+
+ <request name="destroy" type="destructor">
+ <description summary="destroy the color management interface for a surface">
+ Destroy the wp_color_management_surface_v1 object and do the same as
+ unset_image_description.
+ </description>
+ </request>
+
+ <enum name="error">
+ <description summary="protocol errors"/>
+ <entry name="render_intent" value="0"
+ summary="unsupported rendering intent"/>
+ <entry name="image_description" value="1"
+ summary="invalid image description"/>
+ <entry name="inert" value="2"
+ summary="forbidden request on inert object"/>
+ </enum>
+
+ <request name="set_image_description">
+ <description summary="set the surface image description">
+ If this protocol object is inert, the protocol error inert is raised.
+
+ Set the image description of the underlying surface. The image
+ description and rendering intent are double-buffered state, see
+ wl_surface.commit.
+
+ It is the client's responsibility to understand the image description
+ it sets on a surface, and to provide content that matches that image
+ description. Compositors might convert images to match their own or any
+ other image descriptions.
+
+ Image descriptions which are not ready (see wp_image_description_v1)
+ are forbidden in this request, and in such case the protocol error
+ image_description is raised.
+
+ All image descriptions which are ready (see wp_image_description_v1)
+ are allowed and must always be accepted by the compositor.
+
+ When an image description is set on a surface, it establishes an
+ explicit link between surface pixel values and surface colorimetry.
+ This link may be undefined for some pixel values, see the image
+ description creator interfaces for the conditions. Non-finite
+ floating-point values (NaN, Inf) always have an undefined colorimetry.
+
+ A rendering intent provides the client's preference on how surface
+ colorimetry should be mapped to each output. The render_intent value
+ must be one advertised by the compositor with
+ wp_color_manager_v1.render_intent event, otherwise the protocol error
+ render_intent is raised.
+
+ By default, a surface does not have an associated image description
+ nor a rendering intent. The handling of color on such surfaces is
+ compositor implementation defined. Compositors should handle such
+ surfaces as sRGB, but may handle them differently if they have specific
+ requirements.
+
+ Setting the image description has copy semantics; after this request,
+ the image description can be immediately destroyed without affecting
+ the pending state of the surface.
+ </description>
+
+ <arg name="image_description"
+ type="object" interface="wp_image_description_v1"/>
+ <arg name="render_intent"
+ type="uint" enum="wp_color_manager_v1.render_intent"
+ summary="rendering intent"/>
+ </request>
+
+ <request name="unset_image_description">
+ <description summary="remove the surface image description">
+ If this protocol object is inert, the protocol error inert is raised.
+
+ This request removes any image description from the surface. See
+ set_image_description for how a compositor handles a surface without
+ an image description. This is double-buffered state, see
+ wl_surface.commit.
+ </description>
+ </request>
+ </interface>
+
+ <interface name="wp_color_management_surface_feedback_v1" version="3">
+ <description summary="color management extension to a surface">
+ A wp_color_management_surface_feedback_v1 allows the client to get the
+ preferred image description of a surface.
+
+ If the wl_surface associated with this object is destroyed, the
+ wp_color_management_surface_feedback_v1 object becomes inert.
+ </description>
+
+ <request name="destroy" type="destructor">
+ <description summary="destroy the color management interface for a surface">
+ Destroy the wp_color_management_surface_feedback_v1 object.
+ </description>
+ </request>
+
+ <enum name="error">
+ <description summary="protocol errors"/>
+ <entry name="inert" value="0"
+ summary="forbidden request on inert object"/>
+ <entry name="unsupported_feature" value="1"
+ summary="attempted to use an unsupported feature"/>
+ </enum>
+
+ <event name="preferred_changed" deprecated-since="2">
+ <description summary="the preferred image description changed (32-bit)">
+ Starting from interface version 2, 'preferred_changed2' is sent instead
+ of this event. See the 'preferred_changed2' event for the definition.
+ </description>
+
+ <arg name="identity" type="uint"
+ summary="the 32-bit image description id number"/>
+ </event>
+
+ <request name="get_preferred">
+ <description summary="get the preferred image description">
+ If this protocol object is inert, the protocol error inert is raised.
+
+ The preferred image description represents the compositor's preferred
+ color encoding for this wl_surface at the current time. There might be
+ performance and power advantages, as well as improved color
+ reproduction, if the image description of a content update matches the
+ preferred image description.
+
+ This creates a new wp_image_description_v1 object for the currently
+ preferred image description for the wl_surface. The client should
+ stop using and destroy the image descriptions created by earlier
+ invocations of this request for the associated wl_surface.
+ This request is usually sent as a reaction to the preferred_changed
+ event or when creating a wp_color_management_surface_feedback_v1 object
+ if the client is capable of adapting to image descriptions.
+
+ The created wp_image_description_v1 object preserves the preferred image
+ description of the wl_surface from the time the object was created.
+
+ The resulting image description object allows get_information request.
+
+ If the image description is parametric, the client should set it on its
+ wl_surface only if the image description is an exact match with the
+ client content. Particularly if everything else matches, but the target
+ color volume is greater than what the client needs, the client should
+ create its own parameric image description with its exact parameters.
+
+ If the interface version is inadequate for the preferred image
+ description, meaning that the client does not support all the
+ events needed to deliver the crucial information, the resulting image
+ description object shall immediately deliver the
+ wp_image_description_v1.failed event with the low_version cause,
+ otherwise the object shall immediately deliver the ready event.
+ </description>
+
+ <arg name="image_description"
+ type="new_id" interface="wp_image_description_v1"/>
+ </request>
+
+ <request name="get_preferred_parametric">
+ <description summary="get the preferred image description">
+ The same description as for get_preferred applies, except the returned
+ image description is guaranteed to be parametric. This is meant for
+ clients that can only deal with parametric image descriptions.
+
+ If the compositor doesn't support parametric image descriptions, the
+ unsupported_feature error is emitted.
+ </description>
+
+ <arg name="image_description"
+ type="new_id" interface="wp_image_description_v1"/>
+ </request>
+
+ <!-- Version 2 additions -->
+
+ <event name="preferred_changed2" since="2">
+ <description summary="the preferred image description changed">
+ The preferred image description is the one which likely has the most
+ performance and/or quality benefits for the compositor if used by the
+ client for its wl_surface contents. This event is sent whenever the
+ compositor changes the wl_surface's preferred image description.
+
+ This event sends the identity of the new preferred state as the argument,
+ so clients who are aware of the image description already can reuse it.
+ Otherwise, if the client client wants to know what the preferred image
+ description is, it shall use the get_preferred request.
+
+ The preferred image description is not automatically used for anything.
+ It is only a hint, and clients may set any valid image description with
+ set_image_description, but there might be performance and color accuracy
+ improvements by providing the wl_surface contents in the preferred
+ image description. Therefore clients that can, should render according
+ to the preferred image description
+ </description>
+
+ <arg name="identity_hi" type="uint"
+ summary="high 32 bits of the 64-bit image description id number"/>
+ <arg name="identity_lo" type="uint"
+ summary="low 32 bits of the 64-bit image description id number"/>
+ </event>
+
+ </interface>
+
+ <interface name="wp_image_description_creator_icc_v1" version="3">
+ <description summary="holder of image description ICC information">
+ This type of object is used for collecting all the information required
+ to create a wp_image_description_v1 object from an ICC file. A complete
+ set of required parameters consists of these properties:
+ - ICC file
+
+ Each required property must be set exactly once if the client is to create
+ an image description. The set requests verify that a property was not
+ already set. The create request verifies that all required properties are
+ set. There may be several alternative requests for setting each property,
+ and in that case the client must choose one of them.
+
+ Once all properties have been set, the create request must be used to
+ create the image description object, destroying the creator in the
+ process.
+
+ The link between a pixel value (a device value in ICC) and its respective
+ colorimetry is defined by the details of the particular ICC profile.
+ Those details also determine when colorimetry becomes undefined.
+ </description>
+
+ <enum name="error">
+ <description summary="protocol errors"/>
+
+ <entry name="incomplete_set" value="0"
+ summary="incomplete parameter set"/>
+ <entry name="already_set" value="1"
+ summary="property already set"/>
+ <entry name="bad_fd" value="2"
+ summary="fd not seekable and readable"/>
+ <entry name="bad_size" value="3"
+ summary="no or too much data"/>
+ <entry name="out_of_file" value="4"
+ summary="offset + length exceeds file size"/>
+ </enum>
+
+ <request name="create" type="destructor">
+ <description summary="Create the image description object from ICC data">
+ Create an image description object based on the ICC information
+ previously set on this object. A compositor must parse the ICC data in
+ some undefined but finite amount of time.
+
+ The completeness of the parameter set is verified. If the set is not
+ complete, the protocol error incomplete_set is raised. For the
+ definition of a complete set, see the description of this interface.
+
+ If the particular combination of the information is not supported
+ by the compositor, the resulting image description object shall
+ immediately deliver the wp_image_description_v1.failed event with the
+ 'unsupported' cause. If a valid image description was created from the
+ information, the wp_image_description_v1.ready event will eventually
+ be sent instead.
+
+ This request destroys the wp_image_description_creator_icc_v1 object.
+
+ The resulting image description object does not allow get_information
+ request.
+ </description>
+
+ <arg name="image_description"
+ type="new_id" interface="wp_image_description_v1"/>
+ </request>
+
+ <request name="set_icc_file">
+ <description summary="set the ICC profile file">
+ Sets the ICC profile file to be used as the basis of the image
+ description.
+
+ The data shall be found through the given fd at the given offset, having
+ the given length. The fd must be seekable and readable. Violating these
+ requirements raises the bad_fd protocol error.
+
+ If reading the data fails due to an error independent of the client, the
+ compositor shall send the wp_image_description_v1.failed event on the
+ created wp_image_description_v1 with the 'operating_system' cause.
+
+ The maximum size of the ICC profile is 32 MB. If length is greater than
+ that or zero, the protocol error bad_size is raised. If offset + length
+ exceeds the file size, the protocol error out_of_file is raised.
+
+ A compositor may read the file at any time starting from this request
+ and only until whichever happens first:
+ - If create request was issued, the wp_image_description_v1 object
+ delivers either failed or ready event; or
+ - if create request was not issued, this
+ wp_image_description_creator_icc_v1 object is destroyed.
+
+ A compositor shall not modify the contents of the file, and the fd may
+ be sealed for writes and size changes. The client must ensure to its
+ best ability that the data does not change while the compositor is
+ reading it.
+
+ The data must represent a valid ICC profile. The ICC profile version
+ must be 2 or 4, it must be a 3 channel profile and the class must be
+ Display or ColorSpace. Violating these requirements will not result in a
+ protocol error, but will eventually send the
+ wp_image_description_v1.failed event on the created
+ wp_image_description_v1 with the 'unsupported' cause.
+
+ See the International Color Consortium specification ICC.1:2022 for more
+ details about ICC profiles.
+
+ If ICC file has already been set on this object, the protocol error
+ already_set is raised.
+ </description>
+
+ <arg name="icc_profile" type="fd"
+ summary="ICC profile"/>
+ <arg name="offset" type="uint"
+ summary="byte offset in fd to start of ICC data"/>
+ <arg name="length" type="uint"
+ summary="length of ICC data in bytes"/>
+ </request>
+ </interface>
+
+ <interface name="wp_image_description_creator_params_v1" version="3">
+ <description summary="holder of image description parameters">
+ This type of object is used for collecting all the parameters required
+ to create a wp_image_description_v1 object. A complete set of required
+ parameters consists of these properties:
+ - transfer characteristic function (tf)
+ - chromaticities of primaries and white point (primary color volume)
+
+ The following properties are optional and have a well-defined default
+ if not explicitly set:
+ - primary color volume luminance range
+ - reference white luminance level
+ - mastering display primaries and white point (target color volume)
+ - mastering luminance range
+
+ The following properties are optional and will be ignored
+ if not explicitly set:
+ - maximum content light level
+ - maximum frame-average light level
+
+ Each required property must be set exactly once if the client is to create
+ an image description. The set requests verify that a property was not
+ already set. The create request verifies that all required properties are
+ set. There may be several alternative requests for setting each property,
+ and in that case the client must choose one of them.
+
+ Once all properties have been set, the create request must be used to
+ create the image description object, destroying the creator in the
+ process.
+
+ A viewer, who is viewing the display defined by the resulting image
+ description (the viewing environment included), is assumed to be fully
+ adapted to the primary color volume's white point.
+
+ Any of the following conditions will cause the colorimetry of a pixel
+ to become undefined:
+ - Values outside of the defined range of the transfer characteristic.
+ - Tristimulus that exceeds the target color volume.
+ - If extended_target_volume is not supported: tristimulus that exceeds
+ the primary color volume.
+
+ The closest correspondence to an image description created through this
+ interface is the Display class of profiles in ICC.
+ </description>
+
+ <enum name="error">
+ <description summary="protocol errors"/>
+
+ <entry name="incomplete_set" value="0"
+ summary="incomplete parameter set"/>
+ <entry name="already_set" value="1"
+ summary="property already set"/>
+ <entry name="unsupported_feature" value="2"
+ summary="request not supported"/>
+ <entry name="invalid_tf" value="3"
+ summary="invalid transfer characteristic"/>
+ <entry name="invalid_primaries_named" value="4"
+ summary="invalid primaries named"/>
+ <entry name="invalid_luminance" value="5"
+ summary="invalid luminance value or range"/>
+ </enum>
+
+ <request name="create" type="destructor">
+ <description summary="Create the image description object using params">
+ Create an image description object based on the parameters previously
+ set on this object.
+
+ The completeness of the parameter set is verified. If the set is not
+ complete, the protocol error incomplete_set is raised. For the
+ definition of a complete set, see the description of this interface.
+
+ When both max_cll and max_fall are set, max_fall must be less or equal
+ to max_cll otherwise the invalid_luminance protocol error is raised.
+
+ In version 1, these following conditions also result in the
+ invalid_luminance protocol error. Version 2 and later do not have this
+ requirement.
+ - When max_cll is set, it must be greater than min L and less or equal
+ to max L of the mastering luminance range.
+ - When max_fall is set, it must be greater than min L and less or equal
+ to max L of the mastering luminance range.
+
+ If the particular combination of the parameter set is not supported
+ by the compositor, the resulting image description object shall
+ immediately deliver the wp_image_description_v1.failed event with the
+ 'unsupported' cause. If a valid image description was created from the
+ parameter set, the wp_image_description_v1.ready event will eventually
+ be sent instead.
+
+ This request destroys the wp_image_description_creator_params_v1
+ object.
+
+ The resulting image description object does not allow get_information
+ request.
+ </description>
+
+ <arg name="image_description"
+ type="new_id" interface="wp_image_description_v1"/>
+ </request>
+
+ <request name="set_tf_named">
+ <description summary="named transfer characteristic">
+ Sets the transfer characteristic using explicitly enumerated named
+ functions.
+
+ When the resulting image description is attached to an image, the
+ content should be decoded according to the industry standard
+ practices for the transfer characteristic.
+
+ Only names advertised with wp_color_manager_v1 event supported_tf_named
+ are allowed. Other values shall raise the protocol error invalid_tf.
+
+ If transfer characteristic has already been set on this object, the
+ protocol error already_set is raised.
+ </description>
+
+ <arg name="tf" type="uint" enum="wp_color_manager_v1.transfer_function"
+ summary="named transfer function"/>
+ </request>
+
+ <request name="set_tf_power">
+ <description summary="transfer characteristic as a power curve">
+ Sets the color component transfer characteristic to a power curve with
+ the given exponent. Negative values are handled by mirroring the
+ positive half of the curve through the origin. The valid domain and
+ range of the curve are all finite real numbers. This curve represents
+ the conversion from electrical to optical color channel values.
+
+ The curve exponent shall be multiplied by 10000 to get the argument eexp
+ value to carry the precision of 4 decimals.
+
+ The curve exponent must be at least 1.0 and at most 10.0. Otherwise the
+ protocol error invalid_tf is raised.
+
+ If transfer characteristic has already been set on this object, the
+ protocol error already_set is raised.
+
+ This request can be used when the compositor advertises
+ wp_color_manager_v1.feature.set_tf_power. Otherwise this request raises
+ the protocol error unsupported_feature.
+ </description>
+
+ <arg name="eexp" type="uint" summary="the exponent * 10000"/>
+ </request>
+
+ <request name="set_primaries_named">
+ <description summary="named primaries">
+ Sets the color primaries and white point using explicitly named sets.
+ This describes the primary color volume which is the basis for color
+ value encoding.
+
+ Only names advertised with wp_color_manager_v1 event
+ supported_primaries_named are allowed. Other values shall raise the
+ protocol error invalid_primaries_named.
+
+ If primaries have already been set on this object, the protocol error
+ already_set is raised.
+ </description>
+
+ <arg name="primaries" type="uint" enum="wp_color_manager_v1.primaries"
+ summary="named primaries"/>
+ </request>
+
+ <request name="set_primaries">
+ <description summary="primaries as chromaticity coordinates">
+ Sets the color primaries and white point using CIE 1931 xy chromaticity
+ coordinates. This describes the primary color volume which is the basis
+ for color value encoding.
+
+ Each coordinate value is multiplied by 1 million to get the argument
+ value to carry precision of 6 decimals.
+
+ If primaries have already been set on this object, the protocol error
+ already_set is raised.
+
+ This request can be used if the compositor advertises
+ wp_color_manager_v1.feature.set_primaries. Otherwise this request raises
+ the protocol error unsupported_feature.
+ </description>
+
+ <arg name="r_x" type="int" summary="Red x * 1M"/>
+ <arg name="r_y" type="int" summary="Red y * 1M"/>
+ <arg name="g_x" type="int" summary="Green x * 1M"/>
+ <arg name="g_y" type="int" summary="Green y * 1M"/>
+ <arg name="b_x" type="int" summary="Blue x * 1M"/>
+ <arg name="b_y" type="int" summary="Blue y * 1M"/>
+ <arg name="w_x" type="int" summary="White x * 1M"/>
+ <arg name="w_y" type="int" summary="White y * 1M"/>
+ </request>
+
+ <request name="set_luminances">
+ <description summary="primary color volume luminance range and reference white">
+ Sets the primary color volume luminance range and the reference white
+ luminance level. These values include the minimum display emission, but
+ not external flare. The minimum display emission is assumed to have
+ the chromaticity of the primary color volume white point.
+
+ The default luminances from
+ https://www.color.org/chardata/rgb/srgb.xalter are
+ - primary color volume minimum: 0.2 cd/m²
+ - primary color volume maximum: 80 cd/m²
+ - reference white: 80 cd/m²
+
+ Setting a named transfer characteristic can imply other default
+ luminances.
+
+ The default luminances get overwritten when this request is used.
+ With transfer_function.st2084_pq the given 'max_lum' value is ignored,
+ and 'max_lum' is taken as 'min_lum' + 10000 cd/m².
+
+ 'min_lum' and 'max_lum' specify the minimum and maximum luminances of
+ the primary color volume as reproduced by the targeted display.
+
+ 'reference_lum' specifies the luminance of the reference white as
+ reproduced by the targeted display, and reflects the targeted viewing
+ environment.
+
+ Compositors should make sure that all content is anchored, meaning that
+ an input signal level of 'reference_lum' on one image description and
+ another input signal level of 'reference_lum' on another image
+ description should produce the same output level, even though the
+ 'reference_lum' on both image representations can be different.
+
+ 'reference_lum' may be higher than 'max_lum'. In that case reaching
+ the reference white output level in image content requires the
+ 'extended_target_volume' feature support.
+
+ If 'max_lum' or 'reference_lum' are less than or equal to 'min_lum',
+ the protocol error invalid_luminance is raised.
+
+ The minimum luminance is multiplied by 10000 to get the argument
+ 'min_lum' value and carries precision of 4 decimals. The maximum
+ luminance and reference white luminance values are unscaled.
+
+ If the primary color volume luminance range and the reference white
+ luminance level have already been set on this object, the protocol error
+ already_set is raised.
+
+ This request can be used if the compositor advertises
+ wp_color_manager_v1.feature.set_luminances. Otherwise this request
+ raises the protocol error unsupported_feature.
+ </description>
+
+ <arg name="min_lum" type="uint"
+ summary="minimum luminance (cd/m²) * 10000"/>
+ <arg name="max_lum" type="uint"
+ summary="maximum luminance (cd/m²)"/>
+ <arg name="reference_lum" type="uint"
+ summary="reference white luminance (cd/m²)"/>
+ </request>
+
+ <request name="set_mastering_display_primaries">
+ <description summary="mastering display primaries as chromaticity coordinates">
+ Provides the color primaries and white point of the mastering display
+ using CIE 1931 xy chromaticity coordinates. This is compatible with the
+ SMPTE ST 2086 definition of HDR static metadata.
+
+ The mastering display primaries and mastering display luminances define
+ the target color volume.
+
+ If mastering display primaries are not explicitly set, the target color
+ volume is assumed to have the same primaries as the primary color volume.
+
+ The target color volume is defined by all tristimulus values between 0.0
+ and 1.0 (inclusive) of the color space defined by the given mastering
+ display primaries and white point. The colorimetry is identical between
+ the container color space and the mastering display color space,
+ including that no chromatic adaptation is applied even if the white
+ points differ.
+
+ The target color volume can exceed the primary color volume to allow for
+ a greater color volume with an existing color space definition (for
+ example scRGB). It can be smaller than the primary color volume to
+ minimize gamut and tone mapping distances for big color spaces (HDR
+ metadata).
+
+ To make use of the entire target color volume a suitable pixel format
+ has to be chosen (e.g. floating point to exceed the primary color
+ volume, or abusing limited quantization range as with xvYCC).
+
+ Each coordinate value is multiplied by 1 million to get the argument
+ value to carry precision of 6 decimals.
+
+ If mastering display primaries have already been set on this object, the
+ protocol error already_set is raised.
+
+ This request can be used if the compositor advertises
+ wp_color_manager_v1.feature.set_mastering_display_primaries. Otherwise
+ this request raises the protocol error unsupported_feature. The
+ advertisement implies support only for target color volumes fully
+ contained within the primary color volume.
+
+ If a compositor additionally supports target color volume exceeding the
+ primary color volume, it must advertise
+ wp_color_manager_v1.feature.extended_target_volume. If a client uses
+ target color volume exceeding the primary color volume and the
+ compositor does not support it, the result is implementation defined.
+ Compositors are recommended to detect this case and fail the image
+ description gracefully, but it may as well result in color artifacts.
+ </description>
+
+ <arg name="r_x" type="int" summary="Red x * 1M"/>
+ <arg name="r_y" type="int" summary="Red y * 1M"/>
+ <arg name="g_x" type="int" summary="Green x * 1M"/>
+ <arg name="g_y" type="int" summary="Green y * 1M"/>
+ <arg name="b_x" type="int" summary="Blue x * 1M"/>
+ <arg name="b_y" type="int" summary="Blue y * 1M"/>
+ <arg name="w_x" type="int" summary="White x * 1M"/>
+ <arg name="w_y" type="int" summary="White y * 1M"/>
+ </request>
+
+ <request name="set_mastering_luminance">
+ <description summary="display mastering luminance range">
+ Sets the luminance range that was used during the content mastering
+ process as the minimum and maximum absolute luminance L. These values
+ include the minimum display emission and ambient flare luminances,
+ assumed to be optically additive and have the chromaticity of the
+ primary color volume white point. This should be
+ compatible with the SMPTE ST 2086 definition of HDR static metadata.
+
+ The mastering display primaries and mastering display luminances define
+ the target color volume.
+
+ If mastering luminances are not explicitly set, the target color volume
+ is assumed to have the same min and max luminances as the primary color
+ volume.
+
+ If max L is less than or equal to min L, the protocol error
+ invalid_luminance is raised.
+
+ Min L value is multiplied by 10000 to get the argument min_lum value
+ and carry precision of 4 decimals. Max L value is unscaled for max_lum.
+
+ This request can be used if the compositor advertises
+ wp_color_manager_v1.feature.set_mastering_display_primaries. Otherwise
+ this request raises the protocol error unsupported_feature. The
+ advertisement implies support only for target color volumes fully
+ contained within the primary color volume.
+
+ If a compositor additionally supports target color volume exceeding the
+ primary color volume, it must advertise
+ wp_color_manager_v1.feature.extended_target_volume. If a client uses
+ target color volume exceeding the primary color volume and the
+ compositor does not support it, the result is implementation defined.
+ Compositors are recommended to detect this case and fail the image
+ description gracefully, but it may as well result in color artifacts.
+ </description>
+
+ <arg name="min_lum" type="uint" summary="min L (cd/m²) * 10000"/>
+ <arg name="max_lum" type="uint" summary="max L (cd/m²)"/>
+ </request>
+
+ <request name="set_max_cll">
+ <description summary="maximum content light level">
+ Sets the maximum content light level (max_cll) as defined by CTA-861-H.
+
+ max_cll is undefined by default.
+ </description>
+
+ <arg name="max_cll" type="uint" summary="Maximum content light level (cd/m²)"/>
+ </request>
+
+ <request name="set_max_fall">
+ <description summary="maximum frame-average light level">
+ Sets the maximum frame-average light level (max_fall) as defined by
+ CTA-861-H.
+
+ max_fall is undefined by default.
+ </description>
+
+ <arg name="max_fall" type="uint" summary="Maximum frame-average light level (cd/m²)"/>
+ </request>
+ </interface>
+
+ <interface name="wp_image_description_v1" version="3">
+ <description summary="Colorimetric image description">
+ An image description carries information about the pixel color encoding
+ 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
+ this information to decode pixel values into colorimetrically meaningful
+ 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
+ immediately after creation. The object eventually delivers either the
+ 'ready' or the 'failed' event, specified in all requests creating it. The
+ object is deemed "ready" after receiving the 'ready' event.
+
+ An object which is not ready is illegal to use, it can only be destroyed.
+ Any other request in this interface shall result in the 'not_ready'
+ protocol error. Attempts to use an object which is not ready through other
+ interfaces shall raise protocol errors defined there.
+
+ Once created and regardless of how it was created, a
+ wp_image_description_v1 object always refers to one fixed image
+ description. It cannot change after creation.
+ </description>
+
+ <request name="destroy" type="destructor">
+ <description summary="destroy the image description">
+ Destroy this object. It is safe to destroy an object which is not ready.
+
+ Destroying a wp_image_description_v1 object has no side-effects, not
+ even if a wp_color_management_surface_v1.set_image_description has not
+ yet been followed by a wl_surface.commit.
+ </description>
+ </request>
+
+ <enum name="error">
+ <description summary="protocol errors"/>
+
+ <entry name="not_ready" value="0"
+ summary="attempted to use an object which is not ready"/>
+ <entry name="no_information" value="1"
+ summary="get_information not allowed"/>
+ </enum>
+
+ <enum name="cause">
+ <description summary="generic reason for failure"/>
+
+ <entry name="low_version" value="0"
+ summary="interface version too low"/>
+ <entry name="unsupported" value="1"
+ summary="unsupported image description data"/>
+ <entry name="operating_system" value="2"
+ summary="error independent of the client"/>
+ <entry name="no_output" value="3"
+ summary="the relevant output no longer exists"/>
+ </enum>
+
+ <event name="failed">
+ <description summary="graceful error on creating the image description">
+ If creating a wp_image_description_v1 object fails for a reason that is
+ not defined as a protocol error, this event is sent.
+
+ The requests that create image description objects define whether and
+ when this can occur. Only such creation requests can trigger this event.
+ This event cannot be triggered after the image description was
+ successfully formed.
+
+ Once this event has been sent, the wp_image_description_v1 object will
+ never become ready and it can only be destroyed.
+ </description>
+
+ <arg name="cause" type="uint" enum="cause"
+ summary="generic reason"/>
+ <arg name="msg" type="string"
+ summary="ad hoc human-readable explanation"/>
+ </event>
+
+ <event name="ready" deprecated-since="2">
+ <description summary="the object is ready to be used (32-bit)">
+ Starting from interface version 2, the 'ready2' event is sent instead
+ of this event.
+
+ For the definition of this event, see the 'ready2' event. The
+ difference to this event is as follows.
+
+ The id number is valid only as long as the protocol object is alive. If
+ all protocol objects referring to the same image description record are
+ destroyed, the id number may be recycled for a different image
+ description record.
+ </description>
+
+ <arg name="identity" type="uint"
+ summary="the 32-bit image description id number"/>
+ </event>
+
+ <request name="get_information">
+ <description summary="get information about the image description">
+ Creates a wp_image_description_info_v1 object which delivers the
+ information that makes up the image description.
+
+ Not all image description protocol objects allow get_information
+ request. Whether it is allowed or not is defined by the request that
+ created the object. If get_information is not allowed, the protocol
+ error no_information is raised.
+ </description>
+
+ <arg name="information"
+ type="new_id" interface="wp_image_description_info_v1"/>
+ </request>
+
+ <!-- Version 2 additions -->
+
+ <event name="ready2" since="2">
+ <description summary="the object is ready to be used">
+ Once this event has been sent, the wp_image_description_v1 object is
+ deemed "ready". Ready objects can be used to send requests and can be
+ used through other interfaces.
+
+ Every ready wp_image_description_v1 protocol object refers to an
+ underlying image description record in the compositor. Multiple protocol
+ objects may end up referring to the same record. Clients may identify
+ these "copies" by comparing their id numbers: if the numbers from two
+ protocol objects are identical, the protocol objects refer to the same
+ image description record. Two different image description records
+ cannot have the same id number simultaneously. The id number does not
+ change during the lifetime of the image description record.
+
+ Image description id number is not a protocol object id. Zero is
+ reserved as an invalid id number. It shall not be possible for a client
+ to refer to an image description by its id number in protocol. The id
+ numbers might not be portable between Wayland connections. A compositor
+ shall not send an invalid id number.
+
+ Compositors must not recycle image description id numbers.
+
+ This identity allows clients to de-duplicate image description records
+ and avoid get_information request if they already have the image
+ description information.
+ </description>
+
+ <arg name="identity_hi" type="uint"
+ summary="high 32 bits of the 64-bit image description id number"/>
+ <arg name="identity_lo" type="uint"
+ summary="low 32 bits of the 64-bit image description id number"/>
+ </event>
+ </interface>
+
+ <interface name="wp_image_description_info_v1" version="3">
+ <description summary="Colorimetric image description information">
+ Sends all matching events describing an image description object exactly
+ once and finally sends the 'done' event.
+
+ This means
+ - if the image description is parametric, it must send
+ - primaries
+ - named_primaries, if applicable
+ - at least one of tf_power and tf_named, as applicable
+ - luminances
+ - target_primaries
+ - target_luminance
+ - if the image description is parametric, it may send, if applicable,
+ - target_max_cll
+ - target_max_fall
+ - if the image description contains an ICC profile, it must send the
+ icc_file event
+
+ Once a wp_image_description_info_v1 object has delivered a 'done' event it
+ is automatically destroyed.
+
+ Every wp_image_description_info_v1 created from the same
+ wp_image_description_v1 shall always return the exact same data.
+ </description>
+
+ <event name="done" type="destructor">
+ <description summary="end of information">
+ Signals the end of information events and destroys the object.
+ </description>
+ </event>
+
+ <event name="icc_file">
+ <description summary="ICC profile matching the image description">
+ The icc argument provides a file descriptor to the client which may be
+ memory-mapped to provide the ICC profile matching the image description.
+ The fd is read-only, and if mapped then it must be mapped with
+ MAP_PRIVATE by the client.
+
+ The ICC profile version and other details are determined by the
+ compositor. There is no provision for a client to ask for a specific
+ kind of a profile.
+ </description>
+
+ <arg name="icc" type="fd" summary="ICC profile file descriptor"/>
+ <arg name="icc_size" type="uint" summary="ICC profile size, in bytes"/>
+ <!-- Offset always 0, compositor must not expose unnecessary data. -->
+ </event>
+
+ <event name="primaries">
+ <description summary="primaries as chromaticity coordinates">
+ Delivers the primary color volume primaries and white point using CIE
+ 1931 xy chromaticity coordinates.
+
+ Each coordinate value is multiplied by 1 million to get the argument
+ value to carry precision of 6 decimals.
+ </description>
+
+ <arg name="r_x" type="int" summary="Red x * 1M"/>
+ <arg name="r_y" type="int" summary="Red y * 1M"/>
+ <arg name="g_x" type="int" summary="Green x * 1M"/>
+ <arg name="g_y" type="int" summary="Green y * 1M"/>
+ <arg name="b_x" type="int" summary="Blue x * 1M"/>
+ <arg name="b_y" type="int" summary="Blue y * 1M"/>
+ <arg name="w_x" type="int" summary="White x * 1M"/>
+ <arg name="w_y" type="int" summary="White y * 1M"/>
+ </event>
+
+ <event name="primaries_named">
+ <description summary="named primaries">
+ Delivers the primary color volume primaries and white point using an
+ explicitly enumerated named set.
+ </description>
+
+ <arg name="primaries" type="uint" enum="wp_color_manager_v1.primaries"
+ summary="named primaries"/>
+ </event>
+
+ <event name="tf_power">
+ <description summary="transfer characteristic as a power curve">
+ The color component transfer characteristic of this image description is
+ a pure power curve. This event provides the exponent of the power
+ function. This curve represents the conversion from electrical to
+ optical pixel or color values.
+
+ The curve exponent has been multiplied by 10000 to get the argument eexp
+ value to carry the precision of 4 decimals.
+ </description>
+
+ <arg name="eexp" type="uint" summary="the exponent * 10000"/>
+ </event>
+
+ <event name="tf_named">
+ <description summary="named transfer characteristic">
+ Delivers the transfer characteristic using an explicitly enumerated
+ named function.
+ </description>
+
+ <arg name="tf" type="uint" enum="wp_color_manager_v1.transfer_function"
+ summary="named transfer function"/>
+ </event>
+
+ <event name="luminances">
+ <description summary="primary color volume luminance range and reference white">
+ Delivers the primary color volume luminance range and the reference
+ white luminance level. These values include the minimum display emission
+ and ambient flare luminances, assumed to be optically additive and have
+ the chromaticity of the primary color volume white point.
+
+ The minimum luminance is multiplied by 10000 to get the argument
+ 'min_lum' value and carries precision of 4 decimals. The maximum
+ luminance and reference white luminance values are unscaled.
+ </description>
+
+ <arg name="min_lum" type="uint"
+ summary="minimum luminance (cd/m²) * 10000"/>
+ <arg name="max_lum" type="uint"
+ summary="maximum luminance (cd/m²)"/>
+ <arg name="reference_lum" type="uint"
+ summary="reference white luminance (cd/m²)"/>
+ </event>
+
+ <event name="target_primaries">
+ <description summary="target primaries as chromaticity coordinates">
+ Provides the color primaries and white point of the target color volume
+ using CIE 1931 xy chromaticity coordinates. This is compatible with the
+ SMPTE ST 2086 definition of HDR static metadata for mastering displays.
+
+ While primary color volume is about how color is encoded, the target
+ color volume is the actually displayable color volume.
+
+ Each coordinate value is multiplied by 1 million to get the argument
+ value to carry precision of 6 decimals.
+ </description>
+
+ <arg name="r_x" type="int" summary="Red x * 1M"/>
+ <arg name="r_y" type="int" summary="Red y * 1M"/>
+ <arg name="g_x" type="int" summary="Green x * 1M"/>
+ <arg name="g_y" type="int" summary="Green y * 1M"/>
+ <arg name="b_x" type="int" summary="Blue x * 1M"/>
+ <arg name="b_y" type="int" summary="Blue y * 1M"/>
+ <arg name="w_x" type="int" summary="White x * 1M"/>
+ <arg name="w_y" type="int" summary="White y * 1M"/>
+ </event>
+
+ <event name="target_luminance">
+ <description summary="target luminance range">
+ Provides the luminance range that the image description is targeting as
+ the minimum and maximum absolute luminance L. These values include the
+ minimum display emission and ambient flare luminances, assumed to be
+ optically additive and have the chromaticity of the primary color
+ volume white point. This should be compatible with the SMPTE ST 2086
+ definition of HDR static metadata.
+
+ This luminance range is only theoretical and may not correspond to the
+ luminance of light emitted on an actual display.
+
+ Min L value is multiplied by 10000 to get the argument min_lum value and
+ carry precision of 4 decimals. Max L value is unscaled for max_lum.
+ </description>
+
+ <arg name="min_lum" type="uint" summary="min L (cd/m²) * 10000"/>
+ <arg name="max_lum" type="uint" summary="max L (cd/m²)"/>
+ </event>
+
+ <event name="target_max_cll">
+ <description summary="target maximum content light level">
+ Provides the targeted max_cll of the image description. max_cll is
+ defined by CTA-861-H.
+
+ This luminance is only theoretical and may not correspond to the
+ luminance of light emitted on an actual display.
+ </description>
+
+ <arg name="max_cll" type="uint"
+ summary="Maximum content light-level (cd/m²)"/>
+ </event>
+
+ <event name="target_max_fall">
+ <description summary="target maximum frame-average light level">
+ Provides the targeted max_fall of the image description. max_fall is
+ defined by CTA-861-H.
+
+ This luminance is only theoretical and may not correspond to the
+ luminance of light emitted on an actual display.
+ </description>
+
+ <arg name="max_fall" type="uint"
+ summary="Maximum frame-average light level (cd/m²)"/>
+ </event>
+ </interface>
+
+ <interface name="wp_image_description_reference_v1" version="1" frozen="true">
+ <description summary="Reference to an image description">
+ This object is a reference to an image description. This interface is
+ frozen at version 1 to allow other protocols to create
+ wp_image_description_v1 objects.
+
+ The wp_color_manager_v1.get_image_description request can be used to
+ retrieve the underlying image description.
+ </description>
+
+ <request name="destroy" type="destructor">
+ <description summary="destroy the reference">
+ Destroy this object. This has no effect on the referenced image
+ description.
+ </description>
+ </request>
+ </interface>
+</protocol>
diff --git a/protocol/kde-output-device-v2.xml b/protocol/kde-output-device-v2.xml
deleted file mode 100644
index 405f038..0000000
--- a/protocol/kde-output-device-v2.xml
+++ /dev/null
@@ -1,633 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<protocol name="kde_output_device_v2">
- <copyright><![CDATA[
- SPDX-FileCopyrightText: 2008-2011 Kristian Høgsberg
- SPDX-FileCopyrightText: 2010-2011 Intel Corporation
- SPDX-FileCopyrightText: 2012-2013 Collabora, Ltd.
- SPDX-FileCopyrightText: 2015 Sebastian Kügler <sebas@kde.org>
- SPDX-FileCopyrightText: 2021 Méven Car <meven.car@enioka.com>
-
- SPDX-License-Identifier: MIT-CMU
- ]]></copyright>
-
- <interface name="kde_output_device_registry_v2" version="23">
- <description summary="output devices">
- This interface can be used to list output devices.
-
- If this global is bound with a version less than 21, the unsupported_version
- protocol error will be posted.
- </description>
-
- <enum name="error">
- <description summary="kde_output_device_registry_v2 error values">
- These errors can be emitted in response to some requests.
- </description>
- <entry name="unsupported_version" value="0"
- summary="the registry was bound with an unsupported version"/>
- </enum>
-
- <event name="finished" type="destructor" since="21">
- <description summary="no new output announcements">
- This event is sent in response to the stop request. The compositor will
- immediately destroy the object after sending this event.
- </description>
- </event>
-
- <request name="stop" since="21">
- <description summary="stop receiving updates">
- This request indicates that the client no longer wants to receive new
- output announcements. The compositor will send the
- kde_output_device_registry_v2.finished event in response to this request.
- The compositor may still send new output announcements after calling this
- request until the kde_output_device_registry_v2.finished event is sent.
- </description>
- </request>
-
- <event name="output" since="21">
- <description summary="new available output">
- This event is sent when a new output is connected or after binding this
- global to list all available outputs.
- </description>
- <arg name="output" type="new_id" interface="kde_output_device_v2"/>
- </event>
- </interface>
-
- <interface name="kde_output_device_v2" version="23">
- <description summary="output configuration representation">
- An output device describes a display device available to the compositor.
- output_device is similar to wl_output, but focuses on output
- configuration management.
-
- A client can query all global output_device objects to enlist all
- available display devices, even those that may currently not be
- represented by the compositor as a wl_output.
-
- The client sends configuration changes to the server through the
- outputconfiguration interface, and the server applies the configuration
- changes to the hardware and signals changes to the output devices
- accordingly.
-
- This object is published as global during start up for every available
- display devices, or when one later becomes available, for example by
- being hotplugged via a physical connector.
-
- Warning! The protocol described in this file is a desktop environment
- implementation detail. Regular clients must not use this protocol.
- Backward incompatible changes may be added without bumping the major
- version of the extension.
- </description>
-
- <enum name="subpixel">
- <description summary="subpixel geometry information">
- This enumeration describes how the physical pixels on an output are
- laid out.
- </description>
- <entry name="unknown" value="0"/>
- <entry name="none" value="1"/>
- <entry name="horizontal_rgb" value="2"/>
- <entry name="horizontal_bgr" value="3"/>
- <entry name="vertical_rgb" value="4"/>
- <entry name="vertical_bgr" value="5"/>
- </enum>
-
- <enum name="transform">
- <description summary="transform from framebuffer to output">
- This describes the transform, that a compositor will apply to a
- surface to compensate for the rotation or mirroring of an
- output device.
-
- The flipped values correspond to an initial flip around a
- vertical axis followed by rotation.
-
- The purpose is mainly to allow clients to render accordingly and
- tell the compositor, so that for fullscreen surfaces, the
- compositor is still able to scan out directly client surfaces.
- </description>
-
- <entry name="normal" value="0"/>
- <entry name="90" value="1"/>
- <entry name="180" value="2"/>
- <entry name="270" value="3"/>
- <entry name="flipped" value="4"/>
- <entry name="flipped_90" value="5"/>
- <entry name="flipped_180" value="6"/>
- <entry name="flipped_270" value="7"/>
- </enum>
-
- <event name="geometry">
- <description summary="geometric properties of the output">
- The geometry event describes geometric properties of the output.
- The event is sent when binding to the output object and whenever
- any of the properties change.
- </description>
- <arg name="x" type="int"
- summary="x position within the global compositor space"/>
- <arg name="y" type="int"
- summary="y position within the global compositor space"/>
- <arg name="physical_width" type="int"
- summary="width in millimeters of the output"/>
- <arg name="physical_height" type="int"
- summary="height in millimeters of the output"/>
- <arg name="subpixel" type="int"
- summary="subpixel orientation of the output"/>
- <arg name="make" type="string"
- summary="textual description of the manufacturer"/>
- <arg name="model" type="string"
- summary="textual description of the model"/>
- <arg name="transform" type="int"
- summary="transform that maps framebuffer to output"/>
- </event>
-
- <event name="current_mode">
- <description summary="current mode">
- This event describes the mode currently in use for this head. It is only
- sent if the output is enabled.
- </description>
- <arg name="mode" type="object" interface="kde_output_device_mode_v2"/>
- </event>
-
- <event name="mode">
- <description summary="advertise available output modes and current one">
- The mode event describes an available mode for the output.
-
- When the client binds to the output_device object, the server sends this
- event once for every available mode the output_device can be operated by.
-
- There will always be at least one event sent out on initial binding,
- which represents the current mode.
-
- Later if an output changes, its mode event is sent again for the
- eventual added modes and lastly the current mode. In other words, the
- current mode is always represented by the latest event sent with the current
- flag set.
-
- The size of a mode is given in physical hardware units of the output device.
- This is not necessarily the same as the output size in the global compositor
- space. For instance, the output may be scaled, as described in
- kde_output_device_v2.scale, or transformed, as described in
- kde_output_device_v2.transform.
- </description>
- <arg name="mode" type="new_id" interface="kde_output_device_mode_v2"/>
- </event>
-
- <event name="done">
- <description summary="sent all information about output">
- This event is sent after all other properties have been
- sent on binding to the output object as well as after any
- other output property change have been applied later on.
- This allows to see changes to the output properties as atomic,
- even if multiple events successively announce them.
- </description>
- </event>
-
- <event name="scale">
- <description summary="output scaling properties">
- This event contains scaling geometry information
- that is not in the geometry event. It may be sent after
- binding the output object or if the output scale changes
- later. If it is not sent, the client should assume a
- scale of 1.
-
- A scale larger than 1 means that the compositor will
- automatically scale surface buffers by this amount
- when rendering. This is used for high resolution
- displays where applications rendering at the native
- resolution would be too small to be legible.
-
- It is intended that scaling aware clients track the
- current output of a surface, and if it is on a scaled
- output it should use wl_surface.set_buffer_scale with
- the scale of the output. That way the compositor can
- avoid scaling the surface, and the client can supply
- a higher detail image.
- </description>
- <arg name="factor" type="fixed" summary="scaling factor of output"/>
- </event>
-
- <event name="edid">
- <description summary="advertise EDID data for the output">
- The edid event encapsulates the EDID data for the outputdevice.
-
- The event is sent when binding to the output object. The EDID
- data may be empty, in which case this event is sent anyway.
- If the EDID information is empty, you can fall back to the name
- et al. properties of the outputdevice.
- </description>
- <arg name="raw" type="string" summary="base64-encoded EDID string"/>
- </event>
-
- <event name="enabled">
- <description summary="output is enabled or disabled">
- The enabled event notifies whether this output is currently
- enabled and used for displaying content by the server.
- The event is sent when binding to the output object and
- whenever later on an output changes its state by becoming
- enabled or disabled.
- </description>
- <arg name="enabled" type="int" summary="output enabled state"/>
- </event>
-
- <event name="uuid">
- <description summary="A unique id for this outputdevice">
- The uuid can be used to identify the output. It's controlled by
- the server entirely. The server should make sure the uuid is
- persistent across restarts. An empty uuid is considered invalid.
- </description>
- <arg name="uuid" type="string" summary="output devices ID"/>
- </event>
-
- <event name="serial_number">
- <description summary="Serial Number">
- Serial ID of the monitor, sent on startup before the first done event.
- </description>
- <arg name="serialNumber" type="string"
- summary="textual representation of serial number"/>
- </event>
- <event name="eisa_id">
- <description summary="EISA ID">
- EISA ID of the monitor, sent on startup before the first done event.
- </description>
- <arg name="eisaId" type="string"
- summary="textual representation of EISA identifier"/>
- </event>
-
- <enum name="capability" bitfield="true">
- <description summary="describes capabilities of the outputdevice">
- Describes what capabilities this device has.
- </description>
- <entry name="overscan" value="0x1"
- summary="if this output_device can use overscan"/>
- <entry name="vrr" value="0x2"
- summary="if this outputdevice supports variable refresh rate"/>
- <entry name="rgb_range" value="0x4"
- summary="if setting the rgb range is possible"/>
- <entry name="high_dynamic_range" value="0x8" since="3"
- summary="if this outputdevice supports high dynamic range"/>
- <entry name="wide_color_gamut" value="0x10" since="3"
- summary="if this outputdevice supports a wide color gamut"/>
- <entry name="auto_rotate" value="0x20" since="4"
- summary="if this outputdevice supports autorotation"/>
- <entry name="icc_profile" value="0x40" since="5"
- summary="if this outputdevice supports icc profiles"/>
- <entry name="brightness" value="0x80" since="9"
- summary="if this outputdevice supports the brightness setting"/>
- <entry name="built_in_color" value="0x100" since="12"
- summary="if this outputdevice supports the built-in color profile"/>
- <entry name="ddc_ci" value="0x200" since="14"
- summary="if this outputdevice supports DDC/CI"/>
- <entry name="max_bits_per_color" value="0x400" since="15"
- summary="if this outputdevice supports setting max bpc"/>
- <entry name="edr" value="0x800" since="16"
- summary="if this outputdevice supports EDR"/>
- <entry name="sharpness" value="0x1000" since="17"
- summary="if this outputdevice supports the sharpness setting"/>
- <entry name="custom_modes" value="0x2000" since="18"
- summary="if this outputdevice supports custom modes"/>
- <entry name="auto_brightness" value = "0x4000" since="19"/>
- <entry name="hdr_icc_profile" value="0x8000" since="22"
- summary="if this outputdevice supports HDR ICC profiles"/>
- <entry name="abm_level" value="0x10000" since="23"
- summary="if this outputdevice supports the abm level setting"/>
- </enum>
-
- <event name="capabilities">
- <description summary="capability flags">
- What capabilities this device has, sent on startup before the first
- done event.
- </description>
- <arg name="flags" type="uint" enum="capability"/>
- </event>
-
- <event name="overscan">
- <description summary="overscan">
- Overscan value of the monitor in percent, sent on startup before the
- first done event.
- </description>
- <arg name="overscan" type="uint"
- summary="amount of overscan of the monitor"/>
- </event>
-
- <enum name="vrr_policy">
- <description summary="describes vrr policy">
- Describes when the compositor may employ variable refresh rate
- </description>
- <entry name="never" value="0"/>
- <entry name="always" value="1"/>
- <entry name="automatic" value="2"/>
- </enum>
-
- <event name="vrr_policy">
- <description summary="Variable Refresh Rate Policy">
- What policy the compositor will employ regarding its use of variable
- refresh rate.
- </description>
- <arg name="vrr_policy" type="uint" enum="vrr_policy"/>
- </event>
-
- <enum name="rgb_range">
- <description summary="describes RGB range policy">
- Whether full or limited color range should be used
- </description>
- <entry name="automatic" value="0"/>
- <entry name="full" value="1"/>
- <entry name="limited" value="2"/>
- </enum>
-
- <event name="rgb_range">
- <description summary="RGB range">
- What rgb range the compositor is using for this output
- </description>
- <arg name="rgb_range" type="uint" enum="rgb_range"/>
- </event>
-
- <event name="name" since="2">
- <description summary="Output's name">
- Name of the output, it's useful to cross-reference to an zxdg_output_v1 and ultimately QScreen
- </description>
- <arg name="name" type="string"/>
- </event>
-
- <event name="high_dynamic_range" since="3">
- <description summary="if HDR is enabled">
- Whether or not high dynamic range is enabled for this output
- </description>
- <arg name="hdr_enabled" type="uint" summary="1 if enabled, 0 if disabled"/>
- </event>
-
- <event name="sdr_brightness" since="3">
- <description summary="the brightness of sdr if hdr is enabled">
- If high dynamic range is used, this value defines the brightness in nits for content
- that's in standard dynamic range format. Note that while the value is in nits, that
- doesn't necessarily translate to the same brightness on the screen.
- </description>
- <arg name="sdr_brightness" type="uint"/>
- </event>
-
- <event name="wide_color_gamut" since="3">
- <description summary="if WCG is enabled">
- Whether or not the use of a wide color gamut is enabled for this output
- </description>
- <arg name="wcg_enabled" type="uint" summary="1 if enabled, 0 if disabled"/>
- </event>
-
- <enum name="auto_rotate_policy">
- <description summary="describes when auto rotate should be used"/>
- <entry name="never" value="0"/>
- <entry name="in_tablet_mode" value="1"/>
- <entry name="always" value="2"/>
- </enum>
-
- <event name="auto_rotate_policy" since="4">
- <description summary="describes when auto rotate is used"/>
- <arg name="policy" type="uint" enum="auto_rotate_policy"/>
- </event>
-
- <event name="icc_profile_path" since="5">
- <description summary="describes the path to the ICC profile used in SDR mode"/>
- <arg name="profile_path" type="string"/>
- </event>
-
- <event name="brightness_metadata" since="6">
- <description summary="metadata about the screen's brightness limits"/>
- <arg name="max_peak_brightness" type="uint" summary="in nits"/>
- <arg name="max_frame_average_brightness" type="uint" summary="in nits"/>
- <arg name="min_brightness" type="uint" summary="in 0.0001 nits"/>
- </event>
-
- <event name="brightness_overrides" since="6">
- <description summary="overrides for the screen's brightness limits"/>
- <arg name="max_peak_brightness" type="int" summary="-1 for no override, positive values are the brightness in nits"/>
- <arg name="max_average_brightness" type="int" summary="-1 for no override, positive values are the brightness in nits"/>
- <arg name="min_brightness" type="int" summary="-1 for no override, positive values are the brightness in 0.0001 nits"/>
- </event>
-
- <event name="sdr_gamut_wideness" since="6">
- <description summary="describes which gamut is assumed for sRGB applications">
- This can be used to provide the colors users assume sRGB applications should have based on the
- default experience on many modern sRGB screens.
- </description>
- <arg name="gamut_wideness" type="uint" summary="0 means rec.709 primaries, 10000 means native primaries"/>
- </event>
-
- <enum name="color_profile_source" since="7">
- <description summary="which source the compositor should use for the color profile on an output"/>
- <entry name="sRGB" value="0"/>
- <entry name="ICC" value="1"/>
- <entry name="EDID" value="2"/>
- </enum>
-
- <event name="color_profile_source" since="7">
- <description summary="describes which source the compositor uses for the color profile on an output in SDR mode"/>
- <arg name="source" type="uint" enum="color_profile_source"/>
- </event>
-
- <event name="brightness" since="8">
- <description summary="brightness multiplier">
- This is the brightness modifier of the output. It doesn't specify
- any absolute values, but is merely a multiplier on top of other
- brightness values, like sdr_brightness and brightness_metadata.
- 0 is the minimum brightness (not completely dark) and 10000 is
- the maximum brightness.
- This is currently only supported / meaningful while HDR is active.
- </description>
- <arg name="brightness" type="uint" summary="brightness in 0-10000"/>
- </event>
-
- <enum name="color_power_tradeoff">
- <description summary="tradeoff between power and accuracy">
- The compositor can do a lot of things that trade between
- performance, power and color accuracy. This setting describes
- a high level preference from the user about in which direction
- that tradeoff should be made.
- </description>
- <entry name="efficiency" value="0" summary="prefer efficiency and performance"/>
- <entry name="accuracy" value="1" summary="prefer accuracy"/>
- </enum>
-
- <event name="color_power_tradeoff" since="10">
- <description summary="the preferred color/power tradeoff"/>
- <arg name="preference" type="uint" enum="color_power_tradeoff"/>
- </event>
-
- <event name="dimming" since="11">
- <description summary="dimming multiplier">
- This is the dimming multiplier of the output. This is similar to
- the brightness setting, except it's meant to be a temporary setting
- only, not persistent and may be implemented differently depending
- on the display.
- 0 is the minimum dimming factor (not completely dark) and 10000
- means the output is not dimmed.
- </description>
- <arg name="multiplier" type="uint" summary="multiplier in 0-10000"/>
- </event>
-
- <event name="replication_source" since="13">
- <description summary="source output for mirroring"/>
- <arg name="source" type="string" summary="uuid of the source output"/>
- </event>
-
- <event name="ddc_ci_allowed" since="14">
- <description summary="if DDC/CI should be used to control brightness etc.">
- If the ddc_ci capability is present, this determines if settings
- such as brightness, contrast or others should be set using DDC/CI.
- </description>
- <arg name="allowed" type="uint" summary="1 if allowed, 0 if disabled"/>
- </event>
-
- <event name="max_bits_per_color" since="15">
- <description summary="override max bpc">
- This limits the amount of bits per color that are sent to the display.
- </description>
- <arg name="max_bpc" type="uint" summary="0 for the default / automatic"/>
- </event>
-
- <event name="max_bits_per_color_range" since="15">
- <description summary="range of max bits per color value"/>
- <arg name="min_value" type="uint" summary="the minimum supported by the driver"/>
- <arg name="max_value" type="uint" summary="the maximum supported by the driver"/>
- </event>
-
- <event name="automatic_max_bits_per_color_limit" since="15">
- <description summary="if and to what value automatic max bpc is limited"/>
- <arg name="max_bpc_limit" type="uint"
- summary="which value automatic bpc gets limited to. 0 if not limited"/>
- </event>
-
- <enum name="edr_policy" since="16">
- <description summary="when the compositor may make use of EDR"/>
- <entry name="never" value="0"/>
- <entry name="always" value="1"/>
- </enum>
-
- <event name="edr_policy" since="16">
- <description summary="when the compositor may apply EDR">
- When EDR is enabled, the compositor may increase the backlight beyond
- the user-specified setting, in order to present HDR content on displays
- without native HDR support.
- This will usually result in better visuals, but also increases battery
- usage.
- </description>
- <arg name="policy" type="uint" enum="edr_policy"/>
- </event>
-
- <event name="sharpness" since="17">
- <description summary="sharpness strength">
- This is the sharpness modifier of the output.
- 0 is sharpness disabled and 10000 is the maximum sharpness
- </description>
- <arg name="sharpness" type="uint" summary="sharpness in 0-10000"/>
- </event>
-
- <event name="priority" since="18">
- <description summary="output priority">
- Describes the position of the output in the output order list,
- with lower values being earlier in the list. There's no specific
- value the list has to start at, this value is only used in sorting
- outputs.
-
- Note that the output order protocol is not sufficient for this,
- as an output may not be in the output order if it's disabled or
- mirroring another screen.
- </description>
- <arg name="priority" type="uint" summary="priority"/>
- </event>
-
- <event name="auto_brightness" since="20">
- <description summary="whether or not automatic brightness is enabled"/>
- <arg name="enabled" type="uint" summary="1 for enabled, 0 for disabled"/>
- </event>
-
- <request name="release" type="destructor" since="21">
- <description summary="destroy the output device">
- This notifies the compositor that the client no longer wishes to use
- the kde_output_device_v2 object.
- </description>
- </request>
-
- <event name="removed" since="21">
- <description summary="the output has been removed">
- This event is sent when the output device is disconnected and no new
- updates will be sent. The client should call the kde_output_device_v2.release
- request after receiving this event.
- </description>
- </event>
-
- <event name="hdr_icc_profile_path" since="22">
- <description summary="describes the path to the ICC profile used in HDR mode"/>
- <arg name="profile_path" type="string"/>
- </event>
-
- <event name="hdr_color_profile_source" since="22">
- <description summary="describes which source the compositor uses for the color profile on an output in HDR mode"/>
- <arg name="source" type="uint" enum="color_profile_source"/>
- </event>
-
- <event name="abm_level" since="23">
- <description summary="allowed level of adaptive backlight modulation">
- Adaptive backlight modulation is a feature that reduces the backlight
- and increases contrast of colors on the screen to improve power usage.
- </description>
- <arg name="level" type="uint" summary="0 is off, 4 is the maximum level"/>
- </event>
- </interface>
-
- <interface name="kde_output_device_mode_v2" version="22">
- <description summary="output mode">
- This object describes an output mode.
-
- Some heads don't support output modes, in which case modes won't be
- advertised.
-
- Properties sent via this interface are applied atomically via the
- kde_output_device.done event. No guarantees are made regarding the order
- in which properties are sent.
- </description>
-
- <event name="size">
- <description summary="mode size">
- This event describes the mode size. The size is given in physical
- hardware units of the output device. This is not necessarily the same as
- the output size in the global compositor space. For instance, the output
- may be scaled or transformed.
- </description>
- <arg name="width" type="int" summary="width of the mode in hardware units"/>
- <arg name="height" type="int" summary="height of the mode in hardware units"/>
- </event>
-
- <event name="refresh">
- <description summary="mode refresh rate">
- This event describes the mode's fixed vertical refresh rate. It is only
- sent if the mode has a fixed refresh rate.
- </description>
- <arg name="refresh" type="int" summary="vertical refresh rate in mHz"/>
- </event>
-
- <event name="preferred">
- <description summary="mode is preferred">
- This event advertises this mode as preferred.
- </description>
- </event>
-
- <event name="removed">
- <description summary="the mode has been destroyed">
- The compositor will destroy the object immediately after sending this
- event, so it will become invalid and the client should release any
- resources associated with it.
- </description>
- </event>
-
- <enum name="flags">
- <description summary="mode flags"/>
- <entry name="custom" value="0x1"/>
- <entry name="reduced_blanking" value="0x2"/>
- </enum>
-
- <event name="flags" since="19">
- <description summary="mode flags">
- This event describes the mode's flags.
- </description>
- <arg name="flags" type="uint" enum="flags"/>
- </event>
- </interface>
-
-</protocol>
diff --git a/protocol/meson.build b/protocol/meson.build
index da3b184..296c057 100644
--- a/protocol/meson.build
+++ b/protocol/meson.build
@@ -16,7 +16,7 @@ wayland_scanner_client = generator(
protocols = [
'xdg-output-unstable-v1.xml',
- 'kde-output-device-v2.xml',
+ 'color-management-v1.xml',
]
protocol_src = []