summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorMatthias Clasen <mclasen@redhat.com>2013-03-30 14:09:25 -0400
committerKristian Høgsberg <krh@bitplanet.net>2013-04-01 21:43:47 -0400
commit3bda215130c245d222471e6430472d02023d0d6f (patch)
tree99ac3ca69baa45c463aa5913c202cb7ce317c7ed /doc
parentc110fbcb75846aa4c8ae591e6b811f6e05382623 (diff)
docs: Add information about serials and timestamps
Add some information about serials, timestamps and their uses to the Input section in the protocol overview.
Diffstat (limited to 'doc')
-rw-r--r--doc/Wayland/en_US/Protocol.xml16
1 files changed, 16 insertions, 0 deletions
diff --git a/doc/Wayland/en_US/Protocol.xml b/doc/Wayland/en_US/Protocol.xml
index 61dc637..d92cf6f 100644
--- a/doc/Wayland/en_US/Protocol.xml
+++ b/doc/Wayland/en_US/Protocol.xml
@@ -241,6 +241,22 @@
with a pointer grab.
</para>
<para>
+ To avoid race conditions, input events that are likely to
+ trigger further requests (such as button presses, key events,
+ pointer motions) carry serial numbers, and requests such as
+ wl_surface.set_popup require that the serial number of the
+ triggering event is specified. The server maintains a
+ monotonically increasing counter for these serial numbers.
+ </para>
+ <para>
+ Input events also carry timestamps with millisecond granularity.
+ Their base is undefined, so they can't be compared against
+ system time (as obtained with clock_gettime or gettimeofday).
+ They can be compared with each other though, and for instance
+ be used to identify sequences of button presses as double
+ or triple clicks.
+ </para>
+ <para>
See <xref linkend="protocol-spec-interface-wl_seat"/> for the
protocol description.
</para>