protocol: add note about wl_output.done in events

Mention that geometry, mode and scale wl_output events are followed
by a done event.

Signed-off-by: Simon Ser <contact@emersion.fr>
This commit is contained in:
Simon Ser 2021-09-28 15:36:14 +02:00
parent 0cdd2a5c54
commit aa88321517

View file

@ -2560,6 +2560,9 @@
The physical size can be set to zero if it doesn't make sense for this The physical size can be set to zero if it doesn't make sense for this
output (e.g. for projectors or virtual outputs). output (e.g. for projectors or virtual outputs).
The geometry event will be followed by a done event (starting from
version 2).
Note: wl_output only advertises partial information about the output Note: wl_output only advertises partial information about the output
position and identification. Some compositors, for instance those not position and identification. Some compositors, for instance those not
implementing a desktop-style output layout or those exposing virtual implementing a desktop-style output layout or those exposing virtual
@ -2621,6 +2624,9 @@
The vertical refresh rate can be set to zero if it doesn't make The vertical refresh rate can be set to zero if it doesn't make
sense for this output (e.g. for virtual outputs). sense for this output (e.g. for virtual outputs).
The mode event will be followed by a done event (starting from
version 2).
Clients should not use the refresh rate to schedule frames. Instead, Clients should not use the refresh rate to schedule frames. Instead,
they should use the wl_surface.frame event or the presentation-time they should use the wl_surface.frame event or the presentation-time
protocol. protocol.
@ -2667,6 +2673,8 @@
the scale of the output. That way the compositor can the scale of the output. That way the compositor can
avoid scaling the surface, and the client can supply avoid scaling the surface, and the client can supply
a higher detail image. a higher detail image.
The scale event will be followed by a done event.
</description> </description>
<arg name="factor" type="int" summary="scaling factor of output"/> <arg name="factor" type="int" summary="scaling factor of output"/>
</event> </event>