Document serial param usage in wl_pointer.set_cursor
authorNick Diego Yamane <nickdiego@igalia.com>
Wed, 28 Apr 2021 15:34:05 +0000 (11:34 -0400)
committerSimon Ser <contact@emersion.fr>
Tue, 4 May 2021 15:26:48 +0000 (15:26 +0000)
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>
protocol/wayland.xml

index 61e0366..9955d24 100644 (file)
        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"