wp_color_management_output_v1¤
Output color properties
A wp_color_management_output_v1 describes the color properties of an output.
The wp_color_management_output_v1 is associated with the wl_output global underlying the wl_output object. Therefore the client destroying the wl_output object has no impact, but the compositor removing the output global makes the wp_color_management_output_v1 object inert.
Methods:
-
destroy–Destroy the color management output
-
get_image_description–Get the image description of the output
-
on_image_description_changed–Image description changed.
image_description_changed() -> None
Image description changed
This event is sent whenever the image description of the output changed, followed by one wl_output.done event common to output events across all extensions.
If the client wants to use the updated image description, it needs to do get_image_description again, because image description objects are immutable.
destroy() -> None
Destroy the color management output
Destroy the color wp_color_management_output_v1 object. This does not affect any remaining protocol objects.
get_image_description() -> wp_image_description_v1
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.
Returns:
-
wp_image_description_v1(wp_image_description_v1) –The created object
on_image_description_changed() -> None
Image description changed.
Override to handle wayland.wp_color_management_output_v1.events.image_description_changed.