color: update wp_color_management_output_v1.get_image_description

Update how the object must be created so it has an explicit interface
version. This might not be strictly necessary here because the inherited
version would be likely correct, but it's done for consistency.

Take into account that if wp_image_description_v1 interface does need
extending, old versions of it may not be sufficient for describing
outputs.

Signed-off-by: Pekka Paalanen <pekka.paalanen@collabora.com>
This commit is contained in:
Pekka Paalanen 2022-12-01 14:10:19 +02:00 committed by Sebastian Wick
parent 38af0b4a1f
commit ca4f7f951e

View file

@ -154,13 +154,23 @@
destroyed, the wp_color_management_output_v1 object becomes inert.
</description>
<enum name="error">
<description summary="protocol errors"/>
<entry name="bad_object" value="2" summary="invalid interface or version for new_id"/>
</enum>
<event name="image_description_changed">
<description summary="image description changed">
The image_description_changed event is sent whenever the image description of the
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.
This is not an initial event.
If the client wants to use the updated image description, it needs
to do get_image_description again, because image description objects
are immutable.
</description>
</event>
@ -178,10 +188,20 @@
The resulting image description object allows get_information request.
See the wp_image_description_v1 interface for more details.
The argument image_description must have the interface
"wp_image_description_v1" and a version supported by the compositor.
Otherwise the protocol error bad_object is raised.
The compositor shall support all versions from 1 up to and including
the version number of wp_color_manager_v1 global interface.
If the chosen interface version is inadequate for the output's image
description, meaning that the client does not support all the
events needed to deliver all the information, the resulting image
description object shall immediately deliver the
wp_image_description_v1.failed event with the low_version cause.
</description>
<arg name="id" type="new_id" interface="wp_image_description_v1"/>
<arg name="image_description" type="new_id" summary="wp_image_description_v1"/>
</request>
<!-- TODO: HDR capabilities event -->