/* Generated by wayland-scanner 1.26.0 */ #ifndef COLOR_MANAGEMENT_V1_SERVER_PROTOCOL_H #define COLOR_MANAGEMENT_V1_SERVER_PROTOCOL_H #include #include #include "wayland-server.h" #ifdef __cplusplus extern "C" { #endif struct wl_client; struct wl_resource; /** * @page page_color_management_v1 The color_management_v1 protocol * color management protocol * * @section page_desc_color_management_v1 Description * * 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. * * @section page_ifaces_color_management_v1 Interfaces * - @subpage page_iface_wp_color_manager_v1 - color manager singleton * - @subpage page_iface_wp_color_management_output_v1 - output color properties * - @subpage page_iface_wp_color_management_surface_v1 - color management extension to a surface * - @subpage page_iface_wp_color_management_surface_feedback_v1 - color management extension to a surface * - @subpage page_iface_wp_image_description_creator_icc_v1 - holder of image description ICC information * - @subpage page_iface_wp_image_description_creator_params_v1 - holder of image description parameters * - @subpage page_iface_wp_image_description_v1 - Colorimetric image description * - @subpage page_iface_wp_image_description_info_v1 - Colorimetric image description information * - @subpage page_iface_wp_image_description_reference_v1 - Reference to an image description * @section page_copyright_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.
 *
*/ struct wl_output; struct wl_surface; struct wp_color_management_output_v1; struct wp_color_management_surface_feedback_v1; struct wp_color_management_surface_v1; struct wp_color_manager_v1; struct wp_image_description_creator_icc_v1; struct wp_image_description_creator_params_v1; struct wp_image_description_info_v1; struct wp_image_description_reference_v1; struct wp_image_description_v1; #ifndef WP_COLOR_MANAGER_V1_INTERFACE #define WP_COLOR_MANAGER_V1_INTERFACE /** * @page page_iface_wp_color_manager_v1 wp_color_manager_v1 * @section page_iface_wp_color_manager_v1_desc Description * * 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. * @section page_iface_wp_color_manager_v1_api API * See @ref iface_wp_color_manager_v1. */ /** * @defgroup iface_wp_color_manager_v1 The wp_color_manager_v1 interface * * 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. */ extern const struct wl_interface wp_color_manager_v1_interface; #endif #ifndef WP_COLOR_MANAGEMENT_OUTPUT_V1_INTERFACE #define WP_COLOR_MANAGEMENT_OUTPUT_V1_INTERFACE /** * @page page_iface_wp_color_management_output_v1 wp_color_management_output_v1 * @section page_iface_wp_color_management_output_v1_desc Description * * 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. * @section page_iface_wp_color_management_output_v1_api API * See @ref iface_wp_color_management_output_v1. */ /** * @defgroup iface_wp_color_management_output_v1 The wp_color_management_output_v1 interface * * 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. */ extern const struct wl_interface wp_color_management_output_v1_interface; #endif #ifndef WP_COLOR_MANAGEMENT_SURFACE_V1_INTERFACE #define WP_COLOR_MANAGEMENT_SURFACE_V1_INTERFACE /** * @page page_iface_wp_color_management_surface_v1 wp_color_management_surface_v1 * @section page_iface_wp_color_management_surface_v1_desc Description * * 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. * @section page_iface_wp_color_management_surface_v1_api API * See @ref iface_wp_color_management_surface_v1. */ /** * @defgroup iface_wp_color_management_surface_v1 The wp_color_management_surface_v1 interface * * 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. */ extern const struct wl_interface wp_color_management_surface_v1_interface; #endif #ifndef WP_COLOR_MANAGEMENT_SURFACE_FEEDBACK_V1_INTERFACE #define WP_COLOR_MANAGEMENT_SURFACE_FEEDBACK_V1_INTERFACE /** * @page page_iface_wp_color_management_surface_feedback_v1 wp_color_management_surface_feedback_v1 * @section page_iface_wp_color_management_surface_feedback_v1_desc Description * * 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. * @section page_iface_wp_color_management_surface_feedback_v1_api API * See @ref iface_wp_color_management_surface_feedback_v1. */ /** * @defgroup iface_wp_color_management_surface_feedback_v1 The wp_color_management_surface_feedback_v1 interface * * 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. */ extern const struct wl_interface wp_color_management_surface_feedback_v1_interface; #endif #ifndef WP_IMAGE_DESCRIPTION_CREATOR_ICC_V1_INTERFACE #define WP_IMAGE_DESCRIPTION_CREATOR_ICC_V1_INTERFACE /** * @page page_iface_wp_image_description_creator_icc_v1 wp_image_description_creator_icc_v1 * @section page_iface_wp_image_description_creator_icc_v1_desc Description * * 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. * @section page_iface_wp_image_description_creator_icc_v1_api API * See @ref iface_wp_image_description_creator_icc_v1. */ /** * @defgroup iface_wp_image_description_creator_icc_v1 The wp_image_description_creator_icc_v1 interface * * 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. */ extern const struct wl_interface wp_image_description_creator_icc_v1_interface; #endif #ifndef WP_IMAGE_DESCRIPTION_CREATOR_PARAMS_V1_INTERFACE #define WP_IMAGE_DESCRIPTION_CREATOR_PARAMS_V1_INTERFACE /** * @page page_iface_wp_image_description_creator_params_v1 wp_image_description_creator_params_v1 * @section page_iface_wp_image_description_creator_params_v1_desc Description * * 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. * @section page_iface_wp_image_description_creator_params_v1_api API * See @ref iface_wp_image_description_creator_params_v1. */ /** * @defgroup iface_wp_image_description_creator_params_v1 The wp_image_description_creator_params_v1 interface * * 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. */ extern const struct wl_interface wp_image_description_creator_params_v1_interface; #endif #ifndef WP_IMAGE_DESCRIPTION_V1_INTERFACE #define WP_IMAGE_DESCRIPTION_V1_INTERFACE /** * @page page_iface_wp_image_description_v1 wp_image_description_v1 * @section page_iface_wp_image_description_v1_desc 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. * @section page_iface_wp_image_description_v1_api API * See @ref iface_wp_image_description_v1. */ /** * @defgroup iface_wp_image_description_v1 The wp_image_description_v1 interface * * 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. */ extern const struct wl_interface wp_image_description_v1_interface; #endif #ifndef WP_IMAGE_DESCRIPTION_INFO_V1_INTERFACE #define WP_IMAGE_DESCRIPTION_INFO_V1_INTERFACE /** * @page page_iface_wp_image_description_info_v1 wp_image_description_info_v1 * @section page_iface_wp_image_description_info_v1_desc Description * * 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. * @section page_iface_wp_image_description_info_v1_api API * See @ref iface_wp_image_description_info_v1. */ /** * @defgroup iface_wp_image_description_info_v1 The wp_image_description_info_v1 interface * * 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. */ extern const struct wl_interface wp_image_description_info_v1_interface; #endif #ifndef WP_IMAGE_DESCRIPTION_REFERENCE_V1_INTERFACE #define WP_IMAGE_DESCRIPTION_REFERENCE_V1_INTERFACE /** * @page page_iface_wp_image_description_reference_v1 wp_image_description_reference_v1 * @section page_iface_wp_image_description_reference_v1_desc 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. * @section page_iface_wp_image_description_reference_v1_api API * See @ref iface_wp_image_description_reference_v1. */ /** * @defgroup iface_wp_image_description_reference_v1 The wp_image_description_reference_v1 interface * * 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. */ extern const struct wl_interface wp_image_description_reference_v1_interface; #endif #ifndef WP_COLOR_MANAGER_V1_ERROR_ENUM #define WP_COLOR_MANAGER_V1_ERROR_ENUM enum wp_color_manager_v1_error { /** * request not supported */ WP_COLOR_MANAGER_V1_ERROR_UNSUPPORTED_FEATURE = 0, /** * color management surface exists already */ WP_COLOR_MANAGER_V1_ERROR_SURFACE_EXISTS = 1, }; #endif /* WP_COLOR_MANAGER_V1_ERROR_ENUM */ #ifndef WP_COLOR_MANAGER_V1_ERROR_ENUM_IS_VALID #define WP_COLOR_MANAGER_V1_ERROR_ENUM_IS_VALID /** * @ingroup iface_wp_color_manager_v1 * Validate a wp_color_manager_v1 error value. * * @return true on success, false on error. * @ref wp_color_manager_v1_error */ static inline bool wp_color_manager_v1_error_is_valid(uint32_t value, uint32_t version) { switch (value) { case WP_COLOR_MANAGER_V1_ERROR_UNSUPPORTED_FEATURE: return version >= 1; case WP_COLOR_MANAGER_V1_ERROR_SURFACE_EXISTS: return version >= 1; default: return false; } } #endif /* WP_COLOR_MANAGER_V1_ERROR_ENUM_IS_VALID */ #ifndef WP_COLOR_MANAGER_V1_RENDER_INTENT_ENUM #define WP_COLOR_MANAGER_V1_RENDER_INTENT_ENUM /** * @ingroup iface_wp_color_manager_v1 * 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. */ enum wp_color_manager_v1_render_intent { /** * perceptual */ WP_COLOR_MANAGER_V1_RENDER_INTENT_PERCEPTUAL = 0, /** * media-relative colorimetric */ WP_COLOR_MANAGER_V1_RENDER_INTENT_RELATIVE = 1, /** * saturation */ WP_COLOR_MANAGER_V1_RENDER_INTENT_SATURATION = 2, /** * ICC-absolute colorimetric */ WP_COLOR_MANAGER_V1_RENDER_INTENT_ABSOLUTE = 3, /** * media-relative colorimetric + black point compensation */ WP_COLOR_MANAGER_V1_RENDER_INTENT_RELATIVE_BPC = 4, /** * 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. * @since 2 */ WP_COLOR_MANAGER_V1_RENDER_INTENT_ABSOLUTE_NO_ADAPTATION = 5, }; /** * @ingroup iface_wp_color_manager_v1 */ #define WP_COLOR_MANAGER_V1_RENDER_INTENT_ABSOLUTE_NO_ADAPTATION_SINCE_VERSION 2 #endif /* WP_COLOR_MANAGER_V1_RENDER_INTENT_ENUM */ #ifndef WP_COLOR_MANAGER_V1_RENDER_INTENT_ENUM_IS_VALID #define WP_COLOR_MANAGER_V1_RENDER_INTENT_ENUM_IS_VALID /** * @ingroup iface_wp_color_manager_v1 * Validate a wp_color_manager_v1 render_intent value. * * @return true on success, false on error. * @ref wp_color_manager_v1_render_intent */ static inline bool wp_color_manager_v1_render_intent_is_valid(uint32_t value, uint32_t version) { switch (value) { case WP_COLOR_MANAGER_V1_RENDER_INTENT_PERCEPTUAL: return version >= 1; case WP_COLOR_MANAGER_V1_RENDER_INTENT_RELATIVE: return version >= 1; case WP_COLOR_MANAGER_V1_RENDER_INTENT_SATURATION: return version >= 1; case WP_COLOR_MANAGER_V1_RENDER_INTENT_ABSOLUTE: return version >= 1; case WP_COLOR_MANAGER_V1_RENDER_INTENT_RELATIVE_BPC: return version >= 1; case WP_COLOR_MANAGER_V1_RENDER_INTENT_ABSOLUTE_NO_ADAPTATION: return version >= 2; default: return false; } } #endif /* WP_COLOR_MANAGER_V1_RENDER_INTENT_ENUM_IS_VALID */ #ifndef WP_COLOR_MANAGER_V1_FEATURE_ENUM #define WP_COLOR_MANAGER_V1_FEATURE_ENUM /** * @ingroup iface_wp_color_manager_v1 * compositor supported features */ enum wp_color_manager_v1_feature { /** * create_icc_creator request */ WP_COLOR_MANAGER_V1_FEATURE_ICC_V2_V4 = 0, /** * create_parametric_creator request */ WP_COLOR_MANAGER_V1_FEATURE_PARAMETRIC = 1, /** * parametric set_primaries request */ WP_COLOR_MANAGER_V1_FEATURE_SET_PRIMARIES = 2, /** * parametric set_tf_power request */ WP_COLOR_MANAGER_V1_FEATURE_SET_TF_POWER = 3, /** * parametric set_luminances request */ WP_COLOR_MANAGER_V1_FEATURE_SET_LUMINANCES = 4, /** * 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. */ WP_COLOR_MANAGER_V1_FEATURE_SET_MASTERING_DISPLAY_PRIMARIES = 5, /** * 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. */ WP_COLOR_MANAGER_V1_FEATURE_EXTENDED_TARGET_VOLUME = 6, /** * create_windows_scrgb request */ WP_COLOR_MANAGER_V1_FEATURE_WINDOWS_SCRGB = 7, /** * create_windows_bt2100 request */ WP_COLOR_MANAGER_V1_FEATURE_WINDOWS_BT2100 = 8, }; #endif /* WP_COLOR_MANAGER_V1_FEATURE_ENUM */ #ifndef WP_COLOR_MANAGER_V1_FEATURE_ENUM_IS_VALID #define WP_COLOR_MANAGER_V1_FEATURE_ENUM_IS_VALID /** * @ingroup iface_wp_color_manager_v1 * Validate a wp_color_manager_v1 feature value. * * @return true on success, false on error. * @ref wp_color_manager_v1_feature */ static inline bool wp_color_manager_v1_feature_is_valid(uint32_t value, uint32_t version) { switch (value) { case WP_COLOR_MANAGER_V1_FEATURE_ICC_V2_V4: return version >= 1; case WP_COLOR_MANAGER_V1_FEATURE_PARAMETRIC: return version >= 1; case WP_COLOR_MANAGER_V1_FEATURE_SET_PRIMARIES: return version >= 1; case WP_COLOR_MANAGER_V1_FEATURE_SET_TF_POWER: return version >= 1; case WP_COLOR_MANAGER_V1_FEATURE_SET_LUMINANCES: return version >= 1; case WP_COLOR_MANAGER_V1_FEATURE_SET_MASTERING_DISPLAY_PRIMARIES: return version >= 1; case WP_COLOR_MANAGER_V1_FEATURE_EXTENDED_TARGET_VOLUME: return version >= 1; case WP_COLOR_MANAGER_V1_FEATURE_WINDOWS_SCRGB: return version >= 1; case WP_COLOR_MANAGER_V1_FEATURE_WINDOWS_BT2100: return version >= 1; default: return false; } } #endif /* WP_COLOR_MANAGER_V1_FEATURE_ENUM_IS_VALID */ #ifndef WP_COLOR_MANAGER_V1_PRIMARIES_ENUM #define WP_COLOR_MANAGER_V1_PRIMARIES_ENUM /** * @ingroup iface_wp_color_manager_v1 * 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. */ enum wp_color_manager_v1_primaries { /** * 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 */ WP_COLOR_MANAGER_V1_PRIMARIES_SRGB = 1, /** * 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) */ WP_COLOR_MANAGER_V1_PRIMARIES_PAL_M = 2, /** * 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 */ WP_COLOR_MANAGER_V1_PRIMARIES_PAL = 3, /** * 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) */ WP_COLOR_MANAGER_V1_PRIMARIES_NTSC = 4, /** * 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". */ WP_COLOR_MANAGER_V1_PRIMARIES_GENERIC_FILM = 5, /** * 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 */ WP_COLOR_MANAGER_V1_PRIMARIES_BT2020 = 6, /** * 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) */ WP_COLOR_MANAGER_V1_PRIMARIES_CIE1931_XYZ = 7, /** * 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). */ WP_COLOR_MANAGER_V1_PRIMARIES_DCI_P3 = 8, /** * 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). */ WP_COLOR_MANAGER_V1_PRIMARIES_DISPLAY_P3 = 9, /** * 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). */ WP_COLOR_MANAGER_V1_PRIMARIES_ADOBE_RGB = 10, }; #endif /* WP_COLOR_MANAGER_V1_PRIMARIES_ENUM */ #ifndef WP_COLOR_MANAGER_V1_PRIMARIES_ENUM_IS_VALID #define WP_COLOR_MANAGER_V1_PRIMARIES_ENUM_IS_VALID /** * @ingroup iface_wp_color_manager_v1 * Validate a wp_color_manager_v1 primaries value. * * @return true on success, false on error. * @ref wp_color_manager_v1_primaries */ static inline bool wp_color_manager_v1_primaries_is_valid(uint32_t value, uint32_t version) { switch (value) { case WP_COLOR_MANAGER_V1_PRIMARIES_SRGB: return version >= 1; case WP_COLOR_MANAGER_V1_PRIMARIES_PAL_M: return version >= 1; case WP_COLOR_MANAGER_V1_PRIMARIES_PAL: return version >= 1; case WP_COLOR_MANAGER_V1_PRIMARIES_NTSC: return version >= 1; case WP_COLOR_MANAGER_V1_PRIMARIES_GENERIC_FILM: return version >= 1; case WP_COLOR_MANAGER_V1_PRIMARIES_BT2020: return version >= 1; case WP_COLOR_MANAGER_V1_PRIMARIES_CIE1931_XYZ: return version >= 1; case WP_COLOR_MANAGER_V1_PRIMARIES_DCI_P3: return version >= 1; case WP_COLOR_MANAGER_V1_PRIMARIES_DISPLAY_P3: return version >= 1; case WP_COLOR_MANAGER_V1_PRIMARIES_ADOBE_RGB: return version >= 1; default: return false; } } #endif /* WP_COLOR_MANAGER_V1_PRIMARIES_ENUM_IS_VALID */ #ifndef WP_COLOR_MANAGER_V1_TRANSFER_FUNCTION_ENUM #define WP_COLOR_MANAGER_V1_TRANSFER_FUNCTION_ENUM /** * @ingroup iface_wp_color_manager_v1 * 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. */ enum wp_color_manager_v1_transfer_function { /** * 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² */ WP_COLOR_MANAGER_V1_TRANSFER_FUNCTION_BT1886 = 1, /** * 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) */ WP_COLOR_MANAGER_V1_TRANSFER_FUNCTION_GAMMA22 = 2, /** * Assumed display gamma 2.8 transfer function * * Transfer characteristics as defined by - Rec. ITU-R BT.470-6 * System B, G (historical) */ WP_COLOR_MANAGER_V1_TRANSFER_FUNCTION_GAMMA28 = 3, /** * SMPTE ST 240 transfer function * * Transfer characteristics as defined by - SMPTE ST 240 (1999) */ WP_COLOR_MANAGER_V1_TRANSFER_FUNCTION_ST240 = 4, /** * extended linear transfer function * * Linear transfer function defined over all real numbers. * Normalised electrical values are equal the normalised optical * values. */ WP_COLOR_MANAGER_V1_TRANSFER_FUNCTION_EXT_LINEAR = 5, /** * logarithmic 100:1 transfer function * * Logarithmic transfer characteristic (100:1 range). */ WP_COLOR_MANAGER_V1_TRANSFER_FUNCTION_LOG_100 = 6, /** * logarithmic (100*Sqrt(10) : 1) transfer function * * Logarithmic transfer characteristic (100 * Sqrt(10) : 1 * range). */ WP_COLOR_MANAGER_V1_TRANSFER_FUNCTION_LOG_316 = 7, /** * IEC 61966-2-4 transfer function * * Transfer characteristics as defined by - IEC 61966-2-4 */ WP_COLOR_MANAGER_V1_TRANSFER_FUNCTION_XVYCC = 8, /** * 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. * @deprecated Deprecated since version 2 */ WP_COLOR_MANAGER_V1_TRANSFER_FUNCTION_SRGB = 9, /** * Deprecated (Extended sRGB piece-wise transfer function) * * Transfer characteristics as defined by - IEC 61966-2-1 sYCC * @deprecated Deprecated since version 2 */ WP_COLOR_MANAGER_V1_TRANSFER_FUNCTION_EXT_SRGB = 10, /** * 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. */ WP_COLOR_MANAGER_V1_TRANSFER_FUNCTION_ST2084_PQ = 11, /** * SMPTE ST 428 transfer function * * Transfer characteristics as defined by - SMPTE ST 428-1 (2019) */ WP_COLOR_MANAGER_V1_TRANSFER_FUNCTION_ST428 = 12, /** * 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. */ WP_COLOR_MANAGER_V1_TRANSFER_FUNCTION_HLG = 13, /** * IEC 61966-2-1 encoding function * * Encoding characteristics as defined by IEC 61966-2-1, for * displays that invert the encoding function. * @since 2 */ WP_COLOR_MANAGER_V1_TRANSFER_FUNCTION_COMPOUND_POWER_2_4 = 14, }; /** * @ingroup iface_wp_color_manager_v1 */ #define WP_COLOR_MANAGER_V1_TRANSFER_FUNCTION_COMPOUND_POWER_2_4_SINCE_VERSION 2 #endif /* WP_COLOR_MANAGER_V1_TRANSFER_FUNCTION_ENUM */ #ifndef WP_COLOR_MANAGER_V1_TRANSFER_FUNCTION_ENUM_IS_VALID #define WP_COLOR_MANAGER_V1_TRANSFER_FUNCTION_ENUM_IS_VALID /** * @ingroup iface_wp_color_manager_v1 * Validate a wp_color_manager_v1 transfer_function value. * * @return true on success, false on error. * @ref wp_color_manager_v1_transfer_function */ static inline bool wp_color_manager_v1_transfer_function_is_valid(uint32_t value, uint32_t version) { switch (value) { case WP_COLOR_MANAGER_V1_TRANSFER_FUNCTION_BT1886: return version >= 1; case WP_COLOR_MANAGER_V1_TRANSFER_FUNCTION_GAMMA22: return version >= 1; case WP_COLOR_MANAGER_V1_TRANSFER_FUNCTION_GAMMA28: return version >= 1; case WP_COLOR_MANAGER_V1_TRANSFER_FUNCTION_ST240: return version >= 1; case WP_COLOR_MANAGER_V1_TRANSFER_FUNCTION_EXT_LINEAR: return version >= 1; case WP_COLOR_MANAGER_V1_TRANSFER_FUNCTION_LOG_100: return version >= 1; case WP_COLOR_MANAGER_V1_TRANSFER_FUNCTION_LOG_316: return version >= 1; case WP_COLOR_MANAGER_V1_TRANSFER_FUNCTION_XVYCC: return version >= 1; case WP_COLOR_MANAGER_V1_TRANSFER_FUNCTION_SRGB: return version >= 1; case WP_COLOR_MANAGER_V1_TRANSFER_FUNCTION_EXT_SRGB: return version >= 1; case WP_COLOR_MANAGER_V1_TRANSFER_FUNCTION_ST2084_PQ: return version >= 1; case WP_COLOR_MANAGER_V1_TRANSFER_FUNCTION_ST428: return version >= 1; case WP_COLOR_MANAGER_V1_TRANSFER_FUNCTION_HLG: return version >= 1; case WP_COLOR_MANAGER_V1_TRANSFER_FUNCTION_COMPOUND_POWER_2_4: return version >= 2; default: return false; } } #endif /* WP_COLOR_MANAGER_V1_TRANSFER_FUNCTION_ENUM_IS_VALID */ /** * @ingroup iface_wp_color_manager_v1 * @struct wp_color_manager_v1_interface */ struct wp_color_manager_v1_interface { /** * destroy the color manager * * Destroy the wp_color_manager_v1 object. This does not affect * any other objects in any way. */ void (*destroy)(struct wl_client *client, struct wl_resource *resource); /** * 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. */ void (*get_output)(struct wl_client *client, struct wl_resource *resource, uint32_t id, struct wl_resource *output); /** * 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. */ void (*get_surface)(struct wl_client *client, struct wl_resource *resource, uint32_t id, struct wl_resource *surface); /** * 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. */ void (*get_surface_feedback)(struct wl_client *client, struct wl_resource *resource, uint32_t id, struct wl_resource *surface); /** * 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. * @param obj the new creator object */ void (*create_icc_creator)(struct wl_client *client, struct wl_resource *resource, uint32_t obj); /** * 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. * @param obj the new creator object */ void (*create_parametric_creator)(struct wl_client *client, struct wl_resource *resource, uint32_t obj); /** * 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. */ void (*create_windows_scrgb)(struct wl_client *client, struct wl_resource *resource, uint32_t image_description); /** * 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. * @since 2 */ void (*get_image_description)(struct wl_client *client, struct wl_resource *resource, uint32_t image_description, struct wl_resource *reference); /** * 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. * @since 3 */ void (*create_windows_bt2100)(struct wl_client *client, struct wl_resource *resource, uint32_t image_description); }; #define WP_COLOR_MANAGER_V1_SUPPORTED_INTENT 0 #define WP_COLOR_MANAGER_V1_SUPPORTED_FEATURE 1 #define WP_COLOR_MANAGER_V1_SUPPORTED_TF_NAMED 2 #define WP_COLOR_MANAGER_V1_SUPPORTED_PRIMARIES_NAMED 3 #define WP_COLOR_MANAGER_V1_DONE 4 /** * @ingroup iface_wp_color_manager_v1 */ #define WP_COLOR_MANAGER_V1_SUPPORTED_INTENT_SINCE_VERSION 1 /** * @ingroup iface_wp_color_manager_v1 */ #define WP_COLOR_MANAGER_V1_SUPPORTED_FEATURE_SINCE_VERSION 1 /** * @ingroup iface_wp_color_manager_v1 */ #define WP_COLOR_MANAGER_V1_SUPPORTED_TF_NAMED_SINCE_VERSION 1 /** * @ingroup iface_wp_color_manager_v1 */ #define WP_COLOR_MANAGER_V1_SUPPORTED_PRIMARIES_NAMED_SINCE_VERSION 1 /** * @ingroup iface_wp_color_manager_v1 */ #define WP_COLOR_MANAGER_V1_DONE_SINCE_VERSION 1 /** * @ingroup iface_wp_color_manager_v1 */ #define WP_COLOR_MANAGER_V1_DESTROY_SINCE_VERSION 1 /** * @ingroup iface_wp_color_manager_v1 */ #define WP_COLOR_MANAGER_V1_GET_OUTPUT_SINCE_VERSION 1 /** * @ingroup iface_wp_color_manager_v1 */ #define WP_COLOR_MANAGER_V1_GET_SURFACE_SINCE_VERSION 1 /** * @ingroup iface_wp_color_manager_v1 */ #define WP_COLOR_MANAGER_V1_GET_SURFACE_FEEDBACK_SINCE_VERSION 1 /** * @ingroup iface_wp_color_manager_v1 */ #define WP_COLOR_MANAGER_V1_CREATE_ICC_CREATOR_SINCE_VERSION 1 /** * @ingroup iface_wp_color_manager_v1 */ #define WP_COLOR_MANAGER_V1_CREATE_PARAMETRIC_CREATOR_SINCE_VERSION 1 /** * @ingroup iface_wp_color_manager_v1 */ #define WP_COLOR_MANAGER_V1_CREATE_WINDOWS_SCRGB_SINCE_VERSION 1 /** * @ingroup iface_wp_color_manager_v1 */ #define WP_COLOR_MANAGER_V1_GET_IMAGE_DESCRIPTION_SINCE_VERSION 2 /** * @ingroup iface_wp_color_manager_v1 */ #define WP_COLOR_MANAGER_V1_CREATE_WINDOWS_BT2100_SINCE_VERSION 3 /** * @ingroup iface_wp_color_manager_v1 * Sends an supported_intent event to the client owning the resource. * @param resource_ The client's resource * @param render_intent rendering intent */ static inline void wp_color_manager_v1_send_supported_intent(struct wl_resource *resource_, uint32_t render_intent) { wl_resource_post_event(resource_, WP_COLOR_MANAGER_V1_SUPPORTED_INTENT, render_intent); } /** * @ingroup iface_wp_color_manager_v1 * Sends an supported_feature event to the client owning the resource. * @param resource_ The client's resource * @param feature supported feature */ static inline void wp_color_manager_v1_send_supported_feature(struct wl_resource *resource_, uint32_t feature) { wl_resource_post_event(resource_, WP_COLOR_MANAGER_V1_SUPPORTED_FEATURE, feature); } /** * @ingroup iface_wp_color_manager_v1 * Sends an supported_tf_named event to the client owning the resource. * @param resource_ The client's resource * @param tf Named transfer function */ static inline void wp_color_manager_v1_send_supported_tf_named(struct wl_resource *resource_, uint32_t tf) { wl_resource_post_event(resource_, WP_COLOR_MANAGER_V1_SUPPORTED_TF_NAMED, tf); } /** * @ingroup iface_wp_color_manager_v1 * Sends an supported_primaries_named event to the client owning the resource. * @param resource_ The client's resource * @param primaries Named color primaries */ static inline void wp_color_manager_v1_send_supported_primaries_named(struct wl_resource *resource_, uint32_t primaries) { wl_resource_post_event(resource_, WP_COLOR_MANAGER_V1_SUPPORTED_PRIMARIES_NAMED, primaries); } /** * @ingroup iface_wp_color_manager_v1 * Sends an done event to the client owning the resource. * @param resource_ The client's resource */ static inline void wp_color_manager_v1_send_done(struct wl_resource *resource_) { wl_resource_post_event(resource_, WP_COLOR_MANAGER_V1_DONE); } /** * @ingroup iface_wp_color_management_output_v1 * @struct wp_color_management_output_v1_interface */ struct wp_color_management_output_v1_interface { /** * destroy the color management output * * Destroy the color wp_color_management_output_v1 object. This * does not affect any remaining protocol objects. */ void (*destroy)(struct wl_client *client, struct wl_resource *resource); /** * 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. */ void (*get_image_description)(struct wl_client *client, struct wl_resource *resource, uint32_t image_description); }; #define WP_COLOR_MANAGEMENT_OUTPUT_V1_IMAGE_DESCRIPTION_CHANGED 0 /** * @ingroup iface_wp_color_management_output_v1 */ #define WP_COLOR_MANAGEMENT_OUTPUT_V1_IMAGE_DESCRIPTION_CHANGED_SINCE_VERSION 1 /** * @ingroup iface_wp_color_management_output_v1 */ #define WP_COLOR_MANAGEMENT_OUTPUT_V1_DESTROY_SINCE_VERSION 1 /** * @ingroup iface_wp_color_management_output_v1 */ #define WP_COLOR_MANAGEMENT_OUTPUT_V1_GET_IMAGE_DESCRIPTION_SINCE_VERSION 1 /** * @ingroup iface_wp_color_management_output_v1 * Sends an image_description_changed event to the client owning the resource. * @param resource_ The client's resource */ static inline void wp_color_management_output_v1_send_image_description_changed(struct wl_resource *resource_) { wl_resource_post_event(resource_, WP_COLOR_MANAGEMENT_OUTPUT_V1_IMAGE_DESCRIPTION_CHANGED); } #ifndef WP_COLOR_MANAGEMENT_SURFACE_V1_ERROR_ENUM #define WP_COLOR_MANAGEMENT_SURFACE_V1_ERROR_ENUM /** * @ingroup iface_wp_color_management_surface_v1 * protocol errors */ enum wp_color_management_surface_v1_error { /** * unsupported rendering intent */ WP_COLOR_MANAGEMENT_SURFACE_V1_ERROR_RENDER_INTENT = 0, /** * invalid image description */ WP_COLOR_MANAGEMENT_SURFACE_V1_ERROR_IMAGE_DESCRIPTION = 1, /** * forbidden request on inert object */ WP_COLOR_MANAGEMENT_SURFACE_V1_ERROR_INERT = 2, }; #endif /* WP_COLOR_MANAGEMENT_SURFACE_V1_ERROR_ENUM */ #ifndef WP_COLOR_MANAGEMENT_SURFACE_V1_ERROR_ENUM_IS_VALID #define WP_COLOR_MANAGEMENT_SURFACE_V1_ERROR_ENUM_IS_VALID /** * @ingroup iface_wp_color_management_surface_v1 * Validate a wp_color_management_surface_v1 error value. * * @return true on success, false on error. * @ref wp_color_management_surface_v1_error */ static inline bool wp_color_management_surface_v1_error_is_valid(uint32_t value, uint32_t version) { switch (value) { case WP_COLOR_MANAGEMENT_SURFACE_V1_ERROR_RENDER_INTENT: return version >= 1; case WP_COLOR_MANAGEMENT_SURFACE_V1_ERROR_IMAGE_DESCRIPTION: return version >= 1; case WP_COLOR_MANAGEMENT_SURFACE_V1_ERROR_INERT: return version >= 1; default: return false; } } #endif /* WP_COLOR_MANAGEMENT_SURFACE_V1_ERROR_ENUM_IS_VALID */ /** * @ingroup iface_wp_color_management_surface_v1 * @struct wp_color_management_surface_v1_interface */ struct wp_color_management_surface_v1_interface { /** * destroy the color management interface for a surface * * Destroy the wp_color_management_surface_v1 object and do the * same as unset_image_description. */ void (*destroy)(struct wl_client *client, struct wl_resource *resource); /** * 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. * @param render_intent rendering intent */ void (*set_image_description)(struct wl_client *client, struct wl_resource *resource, struct wl_resource *image_description, uint32_t render_intent); /** * 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. */ void (*unset_image_description)(struct wl_client *client, struct wl_resource *resource); }; /** * @ingroup iface_wp_color_management_surface_v1 */ #define WP_COLOR_MANAGEMENT_SURFACE_V1_DESTROY_SINCE_VERSION 1 /** * @ingroup iface_wp_color_management_surface_v1 */ #define WP_COLOR_MANAGEMENT_SURFACE_V1_SET_IMAGE_DESCRIPTION_SINCE_VERSION 1 /** * @ingroup iface_wp_color_management_surface_v1 */ #define WP_COLOR_MANAGEMENT_SURFACE_V1_UNSET_IMAGE_DESCRIPTION_SINCE_VERSION 1 #ifndef WP_COLOR_MANAGEMENT_SURFACE_FEEDBACK_V1_ERROR_ENUM #define WP_COLOR_MANAGEMENT_SURFACE_FEEDBACK_V1_ERROR_ENUM /** * @ingroup iface_wp_color_management_surface_feedback_v1 * protocol errors */ enum wp_color_management_surface_feedback_v1_error { /** * forbidden request on inert object */ WP_COLOR_MANAGEMENT_SURFACE_FEEDBACK_V1_ERROR_INERT = 0, /** * attempted to use an unsupported feature */ WP_COLOR_MANAGEMENT_SURFACE_FEEDBACK_V1_ERROR_UNSUPPORTED_FEATURE = 1, }; #endif /* WP_COLOR_MANAGEMENT_SURFACE_FEEDBACK_V1_ERROR_ENUM */ #ifndef WP_COLOR_MANAGEMENT_SURFACE_FEEDBACK_V1_ERROR_ENUM_IS_VALID #define WP_COLOR_MANAGEMENT_SURFACE_FEEDBACK_V1_ERROR_ENUM_IS_VALID /** * @ingroup iface_wp_color_management_surface_feedback_v1 * Validate a wp_color_management_surface_feedback_v1 error value. * * @return true on success, false on error. * @ref wp_color_management_surface_feedback_v1_error */ static inline bool wp_color_management_surface_feedback_v1_error_is_valid(uint32_t value, uint32_t version) { switch (value) { case WP_COLOR_MANAGEMENT_SURFACE_FEEDBACK_V1_ERROR_INERT: return version >= 1; case WP_COLOR_MANAGEMENT_SURFACE_FEEDBACK_V1_ERROR_UNSUPPORTED_FEATURE: return version >= 1; default: return false; } } #endif /* WP_COLOR_MANAGEMENT_SURFACE_FEEDBACK_V1_ERROR_ENUM_IS_VALID */ /** * @ingroup iface_wp_color_management_surface_feedback_v1 * @struct wp_color_management_surface_feedback_v1_interface */ struct wp_color_management_surface_feedback_v1_interface { /** * destroy the color management interface for a surface * * Destroy the wp_color_management_surface_feedback_v1 object. */ void (*destroy)(struct wl_client *client, struct wl_resource *resource); /** * 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. */ void (*get_preferred)(struct wl_client *client, struct wl_resource *resource, uint32_t image_description); /** * 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. */ void (*get_preferred_parametric)(struct wl_client *client, struct wl_resource *resource, uint32_t image_description); }; #define WP_COLOR_MANAGEMENT_SURFACE_FEEDBACK_V1_PREFERRED_CHANGED 0 #define WP_COLOR_MANAGEMENT_SURFACE_FEEDBACK_V1_PREFERRED_CHANGED2 1 /** * @ingroup iface_wp_color_management_surface_feedback_v1 */ #define WP_COLOR_MANAGEMENT_SURFACE_FEEDBACK_V1_PREFERRED_CHANGED_SINCE_VERSION 1 /** * @ingroup iface_wp_color_management_surface_feedback_v1 */ #define WP_COLOR_MANAGEMENT_SURFACE_FEEDBACK_V1_PREFERRED_CHANGED2_SINCE_VERSION 2 /** * @ingroup iface_wp_color_management_surface_feedback_v1 */ #define WP_COLOR_MANAGEMENT_SURFACE_FEEDBACK_V1_DESTROY_SINCE_VERSION 1 /** * @ingroup iface_wp_color_management_surface_feedback_v1 */ #define WP_COLOR_MANAGEMENT_SURFACE_FEEDBACK_V1_GET_PREFERRED_SINCE_VERSION 1 /** * @ingroup iface_wp_color_management_surface_feedback_v1 */ #define WP_COLOR_MANAGEMENT_SURFACE_FEEDBACK_V1_GET_PREFERRED_PARAMETRIC_SINCE_VERSION 1 /** * @ingroup iface_wp_color_management_surface_feedback_v1 * Sends an preferred_changed event to the client owning the resource. * @param resource_ The client's resource * @param identity the 32-bit image description id number */ static inline void wp_color_management_surface_feedback_v1_send_preferred_changed(struct wl_resource *resource_, uint32_t identity) { wl_resource_post_event(resource_, WP_COLOR_MANAGEMENT_SURFACE_FEEDBACK_V1_PREFERRED_CHANGED, identity); } /** * @ingroup iface_wp_color_management_surface_feedback_v1 * Sends an preferred_changed2 event to the client owning the resource. * @param resource_ The client's resource * @param identity_hi high 32 bits of the 64-bit image description id number * @param identity_lo low 32 bits of the 64-bit image description id number */ static inline void wp_color_management_surface_feedback_v1_send_preferred_changed2(struct wl_resource *resource_, uint32_t identity_hi, uint32_t identity_lo) { wl_resource_post_event(resource_, WP_COLOR_MANAGEMENT_SURFACE_FEEDBACK_V1_PREFERRED_CHANGED2, identity_hi, identity_lo); } #ifndef WP_IMAGE_DESCRIPTION_CREATOR_ICC_V1_ERROR_ENUM #define WP_IMAGE_DESCRIPTION_CREATOR_ICC_V1_ERROR_ENUM /** * @ingroup iface_wp_image_description_creator_icc_v1 * protocol errors */ enum wp_image_description_creator_icc_v1_error { /** * incomplete parameter set */ WP_IMAGE_DESCRIPTION_CREATOR_ICC_V1_ERROR_INCOMPLETE_SET = 0, /** * property already set */ WP_IMAGE_DESCRIPTION_CREATOR_ICC_V1_ERROR_ALREADY_SET = 1, /** * fd not seekable and readable */ WP_IMAGE_DESCRIPTION_CREATOR_ICC_V1_ERROR_BAD_FD = 2, /** * no or too much data */ WP_IMAGE_DESCRIPTION_CREATOR_ICC_V1_ERROR_BAD_SIZE = 3, /** * offset + length exceeds file size */ WP_IMAGE_DESCRIPTION_CREATOR_ICC_V1_ERROR_OUT_OF_FILE = 4, }; #endif /* WP_IMAGE_DESCRIPTION_CREATOR_ICC_V1_ERROR_ENUM */ #ifndef WP_IMAGE_DESCRIPTION_CREATOR_ICC_V1_ERROR_ENUM_IS_VALID #define WP_IMAGE_DESCRIPTION_CREATOR_ICC_V1_ERROR_ENUM_IS_VALID /** * @ingroup iface_wp_image_description_creator_icc_v1 * Validate a wp_image_description_creator_icc_v1 error value. * * @return true on success, false on error. * @ref wp_image_description_creator_icc_v1_error */ static inline bool wp_image_description_creator_icc_v1_error_is_valid(uint32_t value, uint32_t version) { switch (value) { case WP_IMAGE_DESCRIPTION_CREATOR_ICC_V1_ERROR_INCOMPLETE_SET: return version >= 1; case WP_IMAGE_DESCRIPTION_CREATOR_ICC_V1_ERROR_ALREADY_SET: return version >= 1; case WP_IMAGE_DESCRIPTION_CREATOR_ICC_V1_ERROR_BAD_FD: return version >= 1; case WP_IMAGE_DESCRIPTION_CREATOR_ICC_V1_ERROR_BAD_SIZE: return version >= 1; case WP_IMAGE_DESCRIPTION_CREATOR_ICC_V1_ERROR_OUT_OF_FILE: return version >= 1; default: return false; } } #endif /* WP_IMAGE_DESCRIPTION_CREATOR_ICC_V1_ERROR_ENUM_IS_VALID */ /** * @ingroup iface_wp_image_description_creator_icc_v1 * @struct wp_image_description_creator_icc_v1_interface */ struct wp_image_description_creator_icc_v1_interface { /** * 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. */ void (*create)(struct wl_client *client, struct wl_resource *resource, uint32_t image_description); /** * 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. * @param icc_profile ICC profile * @param offset byte offset in fd to start of ICC data * @param length length of ICC data in bytes */ void (*set_icc_file)(struct wl_client *client, struct wl_resource *resource, int32_t icc_profile, uint32_t offset, uint32_t length); }; /** * @ingroup iface_wp_image_description_creator_icc_v1 */ #define WP_IMAGE_DESCRIPTION_CREATOR_ICC_V1_CREATE_SINCE_VERSION 1 /** * @ingroup iface_wp_image_description_creator_icc_v1 */ #define WP_IMAGE_DESCRIPTION_CREATOR_ICC_V1_SET_ICC_FILE_SINCE_VERSION 1 #ifndef WP_IMAGE_DESCRIPTION_CREATOR_PARAMS_V1_ERROR_ENUM #define WP_IMAGE_DESCRIPTION_CREATOR_PARAMS_V1_ERROR_ENUM /** * @ingroup iface_wp_image_description_creator_params_v1 * protocol errors */ enum wp_image_description_creator_params_v1_error { /** * incomplete parameter set */ WP_IMAGE_DESCRIPTION_CREATOR_PARAMS_V1_ERROR_INCOMPLETE_SET = 0, /** * property already set */ WP_IMAGE_DESCRIPTION_CREATOR_PARAMS_V1_ERROR_ALREADY_SET = 1, /** * request not supported */ WP_IMAGE_DESCRIPTION_CREATOR_PARAMS_V1_ERROR_UNSUPPORTED_FEATURE = 2, /** * invalid transfer characteristic */ WP_IMAGE_DESCRIPTION_CREATOR_PARAMS_V1_ERROR_INVALID_TF = 3, /** * invalid primaries named */ WP_IMAGE_DESCRIPTION_CREATOR_PARAMS_V1_ERROR_INVALID_PRIMARIES_NAMED = 4, /** * invalid luminance value or range */ WP_IMAGE_DESCRIPTION_CREATOR_PARAMS_V1_ERROR_INVALID_LUMINANCE = 5, }; #endif /* WP_IMAGE_DESCRIPTION_CREATOR_PARAMS_V1_ERROR_ENUM */ #ifndef WP_IMAGE_DESCRIPTION_CREATOR_PARAMS_V1_ERROR_ENUM_IS_VALID #define WP_IMAGE_DESCRIPTION_CREATOR_PARAMS_V1_ERROR_ENUM_IS_VALID /** * @ingroup iface_wp_image_description_creator_params_v1 * Validate a wp_image_description_creator_params_v1 error value. * * @return true on success, false on error. * @ref wp_image_description_creator_params_v1_error */ static inline bool wp_image_description_creator_params_v1_error_is_valid(uint32_t value, uint32_t version) { switch (value) { case WP_IMAGE_DESCRIPTION_CREATOR_PARAMS_V1_ERROR_INCOMPLETE_SET: return version >= 1; case WP_IMAGE_DESCRIPTION_CREATOR_PARAMS_V1_ERROR_ALREADY_SET: return version >= 1; case WP_IMAGE_DESCRIPTION_CREATOR_PARAMS_V1_ERROR_UNSUPPORTED_FEATURE: return version >= 1; case WP_IMAGE_DESCRIPTION_CREATOR_PARAMS_V1_ERROR_INVALID_TF: return version >= 1; case WP_IMAGE_DESCRIPTION_CREATOR_PARAMS_V1_ERROR_INVALID_PRIMARIES_NAMED: return version >= 1; case WP_IMAGE_DESCRIPTION_CREATOR_PARAMS_V1_ERROR_INVALID_LUMINANCE: return version >= 1; default: return false; } } #endif /* WP_IMAGE_DESCRIPTION_CREATOR_PARAMS_V1_ERROR_ENUM_IS_VALID */ /** * @ingroup iface_wp_image_description_creator_params_v1 * @struct wp_image_description_creator_params_v1_interface */ struct wp_image_description_creator_params_v1_interface { /** * 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. */ void (*create)(struct wl_client *client, struct wl_resource *resource, uint32_t image_description); /** * 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. * @param tf named transfer function */ void (*set_tf_named)(struct wl_client *client, struct wl_resource *resource, uint32_t tf); /** * 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. * @param eexp the exponent * 10000 */ void (*set_tf_power)(struct wl_client *client, struct wl_resource *resource, uint32_t eexp); /** * 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. * @param primaries named primaries */ void (*set_primaries_named)(struct wl_client *client, struct wl_resource *resource, uint32_t primaries); /** * 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. * @param r_x Red x * 1M * @param r_y Red y * 1M * @param g_x Green x * 1M * @param g_y Green y * 1M * @param b_x Blue x * 1M * @param b_y Blue y * 1M * @param w_x White x * 1M * @param w_y White y * 1M */ void (*set_primaries)(struct wl_client *client, struct wl_resource *resource, int32_t r_x, int32_t r_y, int32_t g_x, int32_t g_y, int32_t b_x, int32_t b_y, int32_t w_x, int32_t w_y); /** * 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. * @param min_lum minimum luminance (cd/m²) * 10000 * @param max_lum maximum luminance (cd/m²) * @param reference_lum reference white luminance (cd/m²) */ void (*set_luminances)(struct wl_client *client, struct wl_resource *resource, uint32_t min_lum, uint32_t max_lum, uint32_t reference_lum); /** * 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. * @param r_x Red x * 1M * @param r_y Red y * 1M * @param g_x Green x * 1M * @param g_y Green y * 1M * @param b_x Blue x * 1M * @param b_y Blue y * 1M * @param w_x White x * 1M * @param w_y White y * 1M */ void (*set_mastering_display_primaries)(struct wl_client *client, struct wl_resource *resource, int32_t r_x, int32_t r_y, int32_t g_x, int32_t g_y, int32_t b_x, int32_t b_y, int32_t w_x, int32_t w_y); /** * 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. * @param min_lum min L (cd/m²) * 10000 * @param max_lum max L (cd/m²) */ void (*set_mastering_luminance)(struct wl_client *client, struct wl_resource *resource, uint32_t min_lum, uint32_t max_lum); /** * maximum content light level * * Sets the maximum content light level (max_cll) as defined by * CTA-861-H. * * max_cll is undefined by default. * @param max_cll Maximum content light level (cd/m²) */ void (*set_max_cll)(struct wl_client *client, struct wl_resource *resource, uint32_t max_cll); /** * 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. * @param max_fall Maximum frame-average light level (cd/m²) */ void (*set_max_fall)(struct wl_client *client, struct wl_resource *resource, uint32_t max_fall); }; /** * @ingroup iface_wp_image_description_creator_params_v1 */ #define WP_IMAGE_DESCRIPTION_CREATOR_PARAMS_V1_CREATE_SINCE_VERSION 1 /** * @ingroup iface_wp_image_description_creator_params_v1 */ #define WP_IMAGE_DESCRIPTION_CREATOR_PARAMS_V1_SET_TF_NAMED_SINCE_VERSION 1 /** * @ingroup iface_wp_image_description_creator_params_v1 */ #define WP_IMAGE_DESCRIPTION_CREATOR_PARAMS_V1_SET_TF_POWER_SINCE_VERSION 1 /** * @ingroup iface_wp_image_description_creator_params_v1 */ #define WP_IMAGE_DESCRIPTION_CREATOR_PARAMS_V1_SET_PRIMARIES_NAMED_SINCE_VERSION 1 /** * @ingroup iface_wp_image_description_creator_params_v1 */ #define WP_IMAGE_DESCRIPTION_CREATOR_PARAMS_V1_SET_PRIMARIES_SINCE_VERSION 1 /** * @ingroup iface_wp_image_description_creator_params_v1 */ #define WP_IMAGE_DESCRIPTION_CREATOR_PARAMS_V1_SET_LUMINANCES_SINCE_VERSION 1 /** * @ingroup iface_wp_image_description_creator_params_v1 */ #define WP_IMAGE_DESCRIPTION_CREATOR_PARAMS_V1_SET_MASTERING_DISPLAY_PRIMARIES_SINCE_VERSION 1 /** * @ingroup iface_wp_image_description_creator_params_v1 */ #define WP_IMAGE_DESCRIPTION_CREATOR_PARAMS_V1_SET_MASTERING_LUMINANCE_SINCE_VERSION 1 /** * @ingroup iface_wp_image_description_creator_params_v1 */ #define WP_IMAGE_DESCRIPTION_CREATOR_PARAMS_V1_SET_MAX_CLL_SINCE_VERSION 1 /** * @ingroup iface_wp_image_description_creator_params_v1 */ #define WP_IMAGE_DESCRIPTION_CREATOR_PARAMS_V1_SET_MAX_FALL_SINCE_VERSION 1 #ifndef WP_IMAGE_DESCRIPTION_V1_ERROR_ENUM #define WP_IMAGE_DESCRIPTION_V1_ERROR_ENUM /** * @ingroup iface_wp_image_description_v1 * protocol errors */ enum wp_image_description_v1_error { /** * attempted to use an object which is not ready */ WP_IMAGE_DESCRIPTION_V1_ERROR_NOT_READY = 0, /** * get_information not allowed */ WP_IMAGE_DESCRIPTION_V1_ERROR_NO_INFORMATION = 1, }; #endif /* WP_IMAGE_DESCRIPTION_V1_ERROR_ENUM */ #ifndef WP_IMAGE_DESCRIPTION_V1_ERROR_ENUM_IS_VALID #define WP_IMAGE_DESCRIPTION_V1_ERROR_ENUM_IS_VALID /** * @ingroup iface_wp_image_description_v1 * Validate a wp_image_description_v1 error value. * * @return true on success, false on error. * @ref wp_image_description_v1_error */ static inline bool wp_image_description_v1_error_is_valid(uint32_t value, uint32_t version) { switch (value) { case WP_IMAGE_DESCRIPTION_V1_ERROR_NOT_READY: return version >= 1; case WP_IMAGE_DESCRIPTION_V1_ERROR_NO_INFORMATION: return version >= 1; default: return false; } } #endif /* WP_IMAGE_DESCRIPTION_V1_ERROR_ENUM_IS_VALID */ #ifndef WP_IMAGE_DESCRIPTION_V1_CAUSE_ENUM #define WP_IMAGE_DESCRIPTION_V1_CAUSE_ENUM /** * @ingroup iface_wp_image_description_v1 * generic reason for failure */ enum wp_image_description_v1_cause { /** * interface version too low */ WP_IMAGE_DESCRIPTION_V1_CAUSE_LOW_VERSION = 0, /** * unsupported image description data */ WP_IMAGE_DESCRIPTION_V1_CAUSE_UNSUPPORTED = 1, /** * error independent of the client */ WP_IMAGE_DESCRIPTION_V1_CAUSE_OPERATING_SYSTEM = 2, /** * the relevant output no longer exists */ WP_IMAGE_DESCRIPTION_V1_CAUSE_NO_OUTPUT = 3, }; #endif /* WP_IMAGE_DESCRIPTION_V1_CAUSE_ENUM */ #ifndef WP_IMAGE_DESCRIPTION_V1_CAUSE_ENUM_IS_VALID #define WP_IMAGE_DESCRIPTION_V1_CAUSE_ENUM_IS_VALID /** * @ingroup iface_wp_image_description_v1 * Validate a wp_image_description_v1 cause value. * * @return true on success, false on error. * @ref wp_image_description_v1_cause */ static inline bool wp_image_description_v1_cause_is_valid(uint32_t value, uint32_t version) { switch (value) { case WP_IMAGE_DESCRIPTION_V1_CAUSE_LOW_VERSION: return version >= 1; case WP_IMAGE_DESCRIPTION_V1_CAUSE_UNSUPPORTED: return version >= 1; case WP_IMAGE_DESCRIPTION_V1_CAUSE_OPERATING_SYSTEM: return version >= 1; case WP_IMAGE_DESCRIPTION_V1_CAUSE_NO_OUTPUT: return version >= 1; default: return false; } } #endif /* WP_IMAGE_DESCRIPTION_V1_CAUSE_ENUM_IS_VALID */ /** * @ingroup iface_wp_image_description_v1 * @struct wp_image_description_v1_interface */ struct wp_image_description_v1_interface { /** * 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. */ void (*destroy)(struct wl_client *client, struct wl_resource *resource); /** * 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. */ void (*get_information)(struct wl_client *client, struct wl_resource *resource, uint32_t information); }; #define WP_IMAGE_DESCRIPTION_V1_FAILED 0 #define WP_IMAGE_DESCRIPTION_V1_READY 1 #define WP_IMAGE_DESCRIPTION_V1_READY2 2 /** * @ingroup iface_wp_image_description_v1 */ #define WP_IMAGE_DESCRIPTION_V1_FAILED_SINCE_VERSION 1 /** * @ingroup iface_wp_image_description_v1 */ #define WP_IMAGE_DESCRIPTION_V1_READY_SINCE_VERSION 1 /** * @ingroup iface_wp_image_description_v1 */ #define WP_IMAGE_DESCRIPTION_V1_READY2_SINCE_VERSION 2 /** * @ingroup iface_wp_image_description_v1 */ #define WP_IMAGE_DESCRIPTION_V1_DESTROY_SINCE_VERSION 1 /** * @ingroup iface_wp_image_description_v1 */ #define WP_IMAGE_DESCRIPTION_V1_GET_INFORMATION_SINCE_VERSION 1 /** * @ingroup iface_wp_image_description_v1 * Sends an failed event to the client owning the resource. * @param resource_ The client's resource * @param cause generic reason * @param msg ad hoc human-readable explanation */ static inline void wp_image_description_v1_send_failed(struct wl_resource *resource_, uint32_t cause, const char *msg) { wl_resource_post_event(resource_, WP_IMAGE_DESCRIPTION_V1_FAILED, cause, msg); } /** * @ingroup iface_wp_image_description_v1 * Sends an ready event to the client owning the resource. * @param resource_ The client's resource * @param identity the 32-bit image description id number */ static inline void wp_image_description_v1_send_ready(struct wl_resource *resource_, uint32_t identity) { wl_resource_post_event(resource_, WP_IMAGE_DESCRIPTION_V1_READY, identity); } /** * @ingroup iface_wp_image_description_v1 * Sends an ready2 event to the client owning the resource. * @param resource_ The client's resource * @param identity_hi high 32 bits of the 64-bit image description id number * @param identity_lo low 32 bits of the 64-bit image description id number */ static inline void wp_image_description_v1_send_ready2(struct wl_resource *resource_, uint32_t identity_hi, uint32_t identity_lo) { wl_resource_post_event(resource_, WP_IMAGE_DESCRIPTION_V1_READY2, identity_hi, identity_lo); } #define WP_IMAGE_DESCRIPTION_INFO_V1_DONE 0 #define WP_IMAGE_DESCRIPTION_INFO_V1_ICC_FILE 1 #define WP_IMAGE_DESCRIPTION_INFO_V1_PRIMARIES 2 #define WP_IMAGE_DESCRIPTION_INFO_V1_PRIMARIES_NAMED 3 #define WP_IMAGE_DESCRIPTION_INFO_V1_TF_POWER 4 #define WP_IMAGE_DESCRIPTION_INFO_V1_TF_NAMED 5 #define WP_IMAGE_DESCRIPTION_INFO_V1_LUMINANCES 6 #define WP_IMAGE_DESCRIPTION_INFO_V1_TARGET_PRIMARIES 7 #define WP_IMAGE_DESCRIPTION_INFO_V1_TARGET_LUMINANCE 8 #define WP_IMAGE_DESCRIPTION_INFO_V1_TARGET_MAX_CLL 9 #define WP_IMAGE_DESCRIPTION_INFO_V1_TARGET_MAX_FALL 10 /** * @ingroup iface_wp_image_description_info_v1 */ #define WP_IMAGE_DESCRIPTION_INFO_V1_DONE_SINCE_VERSION 1 /** * @ingroup iface_wp_image_description_info_v1 */ #define WP_IMAGE_DESCRIPTION_INFO_V1_ICC_FILE_SINCE_VERSION 1 /** * @ingroup iface_wp_image_description_info_v1 */ #define WP_IMAGE_DESCRIPTION_INFO_V1_PRIMARIES_SINCE_VERSION 1 /** * @ingroup iface_wp_image_description_info_v1 */ #define WP_IMAGE_DESCRIPTION_INFO_V1_PRIMARIES_NAMED_SINCE_VERSION 1 /** * @ingroup iface_wp_image_description_info_v1 */ #define WP_IMAGE_DESCRIPTION_INFO_V1_TF_POWER_SINCE_VERSION 1 /** * @ingroup iface_wp_image_description_info_v1 */ #define WP_IMAGE_DESCRIPTION_INFO_V1_TF_NAMED_SINCE_VERSION 1 /** * @ingroup iface_wp_image_description_info_v1 */ #define WP_IMAGE_DESCRIPTION_INFO_V1_LUMINANCES_SINCE_VERSION 1 /** * @ingroup iface_wp_image_description_info_v1 */ #define WP_IMAGE_DESCRIPTION_INFO_V1_TARGET_PRIMARIES_SINCE_VERSION 1 /** * @ingroup iface_wp_image_description_info_v1 */ #define WP_IMAGE_DESCRIPTION_INFO_V1_TARGET_LUMINANCE_SINCE_VERSION 1 /** * @ingroup iface_wp_image_description_info_v1 */ #define WP_IMAGE_DESCRIPTION_INFO_V1_TARGET_MAX_CLL_SINCE_VERSION 1 /** * @ingroup iface_wp_image_description_info_v1 */ #define WP_IMAGE_DESCRIPTION_INFO_V1_TARGET_MAX_FALL_SINCE_VERSION 1 /** * @ingroup iface_wp_image_description_info_v1 * Sends an done event to the client owning the resource. * @param resource_ The client's resource */ static inline void wp_image_description_info_v1_send_done(struct wl_resource *resource_) { wl_resource_post_event(resource_, WP_IMAGE_DESCRIPTION_INFO_V1_DONE); } /** * @ingroup iface_wp_image_description_info_v1 * Sends an icc_file event to the client owning the resource. * @param resource_ The client's resource * @param icc ICC profile file descriptor * @param icc_size ICC profile size, in bytes */ static inline void wp_image_description_info_v1_send_icc_file(struct wl_resource *resource_, int32_t icc, uint32_t icc_size) { wl_resource_post_event(resource_, WP_IMAGE_DESCRIPTION_INFO_V1_ICC_FILE, icc, icc_size); } /** * @ingroup iface_wp_image_description_info_v1 * Sends an primaries event to the client owning the resource. * @param resource_ The client's resource * @param r_x Red x * 1M * @param r_y Red y * 1M * @param g_x Green x * 1M * @param g_y Green y * 1M * @param b_x Blue x * 1M * @param b_y Blue y * 1M * @param w_x White x * 1M * @param w_y White y * 1M */ static inline void wp_image_description_info_v1_send_primaries(struct wl_resource *resource_, int32_t r_x, int32_t r_y, int32_t g_x, int32_t g_y, int32_t b_x, int32_t b_y, int32_t w_x, int32_t w_y) { wl_resource_post_event(resource_, WP_IMAGE_DESCRIPTION_INFO_V1_PRIMARIES, r_x, r_y, g_x, g_y, b_x, b_y, w_x, w_y); } /** * @ingroup iface_wp_image_description_info_v1 * Sends an primaries_named event to the client owning the resource. * @param resource_ The client's resource * @param primaries named primaries */ static inline void wp_image_description_info_v1_send_primaries_named(struct wl_resource *resource_, uint32_t primaries) { wl_resource_post_event(resource_, WP_IMAGE_DESCRIPTION_INFO_V1_PRIMARIES_NAMED, primaries); } /** * @ingroup iface_wp_image_description_info_v1 * Sends an tf_power event to the client owning the resource. * @param resource_ The client's resource * @param eexp the exponent * 10000 */ static inline void wp_image_description_info_v1_send_tf_power(struct wl_resource *resource_, uint32_t eexp) { wl_resource_post_event(resource_, WP_IMAGE_DESCRIPTION_INFO_V1_TF_POWER, eexp); } /** * @ingroup iface_wp_image_description_info_v1 * Sends an tf_named event to the client owning the resource. * @param resource_ The client's resource * @param tf named transfer function */ static inline void wp_image_description_info_v1_send_tf_named(struct wl_resource *resource_, uint32_t tf) { wl_resource_post_event(resource_, WP_IMAGE_DESCRIPTION_INFO_V1_TF_NAMED, tf); } /** * @ingroup iface_wp_image_description_info_v1 * Sends an luminances event to the client owning the resource. * @param resource_ The client's resource * @param min_lum minimum luminance (cd/m²) * 10000 * @param max_lum maximum luminance (cd/m²) * @param reference_lum reference white luminance (cd/m²) */ static inline void wp_image_description_info_v1_send_luminances(struct wl_resource *resource_, uint32_t min_lum, uint32_t max_lum, uint32_t reference_lum) { wl_resource_post_event(resource_, WP_IMAGE_DESCRIPTION_INFO_V1_LUMINANCES, min_lum, max_lum, reference_lum); } /** * @ingroup iface_wp_image_description_info_v1 * Sends an target_primaries event to the client owning the resource. * @param resource_ The client's resource * @param r_x Red x * 1M * @param r_y Red y * 1M * @param g_x Green x * 1M * @param g_y Green y * 1M * @param b_x Blue x * 1M * @param b_y Blue y * 1M * @param w_x White x * 1M * @param w_y White y * 1M */ static inline void wp_image_description_info_v1_send_target_primaries(struct wl_resource *resource_, int32_t r_x, int32_t r_y, int32_t g_x, int32_t g_y, int32_t b_x, int32_t b_y, int32_t w_x, int32_t w_y) { wl_resource_post_event(resource_, WP_IMAGE_DESCRIPTION_INFO_V1_TARGET_PRIMARIES, r_x, r_y, g_x, g_y, b_x, b_y, w_x, w_y); } /** * @ingroup iface_wp_image_description_info_v1 * Sends an target_luminance event to the client owning the resource. * @param resource_ The client's resource * @param min_lum min L (cd/m²) * 10000 * @param max_lum max L (cd/m²) */ static inline void wp_image_description_info_v1_send_target_luminance(struct wl_resource *resource_, uint32_t min_lum, uint32_t max_lum) { wl_resource_post_event(resource_, WP_IMAGE_DESCRIPTION_INFO_V1_TARGET_LUMINANCE, min_lum, max_lum); } /** * @ingroup iface_wp_image_description_info_v1 * Sends an target_max_cll event to the client owning the resource. * @param resource_ The client's resource * @param max_cll Maximum content light-level (cd/m²) */ static inline void wp_image_description_info_v1_send_target_max_cll(struct wl_resource *resource_, uint32_t max_cll) { wl_resource_post_event(resource_, WP_IMAGE_DESCRIPTION_INFO_V1_TARGET_MAX_CLL, max_cll); } /** * @ingroup iface_wp_image_description_info_v1 * Sends an target_max_fall event to the client owning the resource. * @param resource_ The client's resource * @param max_fall Maximum frame-average light level (cd/m²) */ static inline void wp_image_description_info_v1_send_target_max_fall(struct wl_resource *resource_, uint32_t max_fall) { wl_resource_post_event(resource_, WP_IMAGE_DESCRIPTION_INFO_V1_TARGET_MAX_FALL, max_fall); } /** * @ingroup iface_wp_image_description_reference_v1 * @struct wp_image_description_reference_v1_interface */ struct wp_image_description_reference_v1_interface { /** * destroy the reference * * Destroy this object. This has no effect on the referenced * image description. */ void (*destroy)(struct wl_client *client, struct wl_resource *resource); }; /** * @ingroup iface_wp_image_description_reference_v1 */ #define WP_IMAGE_DESCRIPTION_REFERENCE_V1_DESTROY_SINCE_VERSION 1 #ifdef __cplusplus } #endif #endif