summaryrefslogtreecommitdiff
path: root/protocol
diff options
context:
space:
mode:
authorNick Diego Yamane <nickdiego@igalia.com>2021-04-28 11:34:05 -0400
committerSimon Ser <contact@emersion.fr>2021-05-04 15:26:48 +0000
commit208fc99e66677fed61ba97382025f95db737696a (patch)
tree4b5f316df8f49371c481798a6e0335cd020213d6 /protocol
parented55438366e93d70867e3ba6b80978673e536fc0 (diff)
downloadwayland-208fc99e66677fed61ba97382025f95db737696a.tar.gz
Document serial param usage in wl_pointer.set_cursor
Serial is supposed to contain the latest wl_pointer.enter value received by clients but it was not even mentioned in the docs, so add it to avoid misinterpretations. Signed-off-by: Nick Diego Yamane <nickdiego@igalia.com>
Diffstat (limited to 'protocol')
-rw-r--r--protocol/wayland.xml4
1 files changed, 4 insertions, 0 deletions
diff --git a/protocol/wayland.xml b/protocol/wayland.xml
index 61e0366..9955d24 100644
--- a/protocol/wayland.xml
+++ b/protocol/wayland.xml
@@ -1905,6 +1905,10 @@
wl_surface is no longer used as the cursor. When the use as a
cursor ends, the current and pending input regions become
undefined, and the wl_surface is unmapped.
+
+ The serial parameter must match the latest wl_pointer.enter
+ serial number sent to the client. Otherwise the request will be
+ ignored.
</description>
<arg name="serial" type="uint" summary="serial number of the enter event"/>
<arg name="surface" type="object" interface="wl_surface" allow-null="true"