summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorYann Dirson <ydirson@free.fr>2020-03-30 18:29:08 +0200
committerDaniel Stone <daniels@collabora.com>2020-06-03 12:49:43 +0000
commitef611a803ef7cd1bc7147bfdc453ca1ee380e095 (patch)
tree75b74b19de10abfb87b4683ffd7dd1d336ccb79a
parentReplace initial 8 spaces with a tab for all xml files (diff)
downloadwayland-ef611a803ef7cd1bc7147bfdc453ca1ee380e095.tar
wayland-ef611a803ef7cd1bc7147bfdc453ca1ee380e095.tar.gz
wayland-ef611a803ef7cd1bc7147bfdc453ca1ee380e095.tar.bz2
wayland-ef611a803ef7cd1bc7147bfdc453ca1ee380e095.tar.lz
wayland-ef611a803ef7cd1bc7147bfdc453ca1ee380e095.tar.xz
wayland-ef611a803ef7cd1bc7147bfdc453ca1ee380e095.tar.zst
wayland-ef611a803ef7cd1bc7147bfdc453ca1ee380e095.zip
doc: fix and clarify pointer image behaviour
Signed-off-by: Yann Dirson <ydirson@free.fr>
-rw-r--r--doc/publican/sources/Protocol.xml12
1 files changed, 8 insertions, 4 deletions
diff --git a/doc/publican/sources/Protocol.xml b/doc/publican/sources/Protocol.xml
index 69edd2c..a472f1d 100644
--- a/doc/publican/sources/Protocol.xml
+++ b/doc/publican/sources/Protocol.xml
@@ -401,10 +401,11 @@
set the pointer image.
</para>
<para>
+ Setting the pointer image to NULL causes the cursor to be hidden.
+ </para>
+ <para>
The compositor will revert the pointer image back to a default image
- when no surface has the pointer focus for that device. Clients can
- revert the pointer image back to the default image by setting a NULL
- image.
+ when no surface has the pointer focus for that device.
</para>
<para>
What if the pointer moves from one window which has set a special
@@ -412,7 +413,10 @@
the motion event? The new surface will be stuck with the special
pointer image. We can't just revert the pointer image on leaving a
surface, since if we immediately enter a surface that sets a different
- image, the image will flicker. Broken app, I suppose.
+ image, the image will flicker. If a client does not set a pointer image
+ when the pointer enters a surface, the pointer stays with the image set
+ by the last surface that changed it, possibly even hidden. Such a client
+ is likely just broken.
</para>
</section>
<section id="sect-Protocol-Output">