summaryrefslogtreecommitdiff
path: root/protocol
diff options
context:
space:
mode:
authorSimon Ser <contact@emersion.fr>2021-09-28 15:36:14 +0200
committerSimon Ser <contact@emersion.fr>2021-10-28 14:03:04 +0000
commitaa883215174f0b389c1b7999b6a19c2be2c05c99 (patch)
treeb688987446c559c03a0d77623c4daa6b74eddc57 /protocol
parent0cdd2a5c54771d18dc3ec9d690b7fbb754b90dfd (diff)
downloadwayland-aa883215174f0b389c1b7999b6a19c2be2c05c99.tar.gz
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>
Diffstat (limited to 'protocol')
-rw-r--r--protocol/wayland.xml8
1 files changed, 8 insertions, 0 deletions
diff --git a/protocol/wayland.xml b/protocol/wayland.xml
index 675c102..6001adc 100644
--- a/protocol/wayland.xml
+++ b/protocol/wayland.xml
@@ -2560,6 +2560,9 @@
The physical size can be set to zero if it doesn't make sense for this
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
position and identification. Some compositors, for instance those not
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
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,
they should use the wl_surface.frame event or the presentation-time
protocol.
@@ -2667,6 +2673,8 @@
the scale of the output. That way the compositor can
avoid scaling the surface, and the client can supply
a higher detail image.
+
+ The scale event will be followed by a done event.
</description>
<arg name="factor" type="int" summary="scaling factor of output"/>
</event>