summaryrefslogtreecommitdiff
path: root/protocol
diff options
context:
space:
mode:
authorMatthias Clasen <mclasen@redhat.com>2013-03-30 14:09:24 -0400
committerKristian Høgsberg <krh@bitplanet.net>2013-04-01 21:43:17 -0400
commitc110fbcb75846aa4c8ae591e6b811f6e05382623 (patch)
tree72e3bb94d08e215aec7b4701d98a8e18344b56a2 /protocol
parentc7639228b4850ca7d91d2f39815059c3edb83d08 (diff)
docs: Document granularity of timestamps
This information is necessary to make any use of these fields.
Diffstat (limited to 'protocol')
-rw-r--r--protocol/wayland.xml20
1 files changed, 12 insertions, 8 deletions
diff --git a/protocol/wayland.xml b/protocol/wayland.xml
index 899a686..6864779 100644
--- a/protocol/wayland.xml
+++ b/protocol/wayland.xml
@@ -543,7 +543,7 @@
is provided by the x an y arguments, in surface local
coordinates.
</description>
- <arg name="time" type="uint"/>
+ <arg name="time" type="uint" summary="timestamp with millisecond granularity"/>
<arg name="x" type="fixed"/>
<arg name="y" type="fixed"/>
</event>
@@ -1248,7 +1248,7 @@
focused surface.
</description>
- <arg name="time" type="uint"/>
+ <arg name="time" type="uint" summary="timestamp with millisecond granularity"/>
<arg name="surface_x" type="fixed"/>
<arg name="surface_y" type="fixed"/>
</event>
@@ -1268,10 +1268,12 @@
The location of the click is given by the last motion or
enter event.
+ The time argument is a timestamp with millisecond
+ granularity, with an undefined base.
</description>
<arg name="serial" type="uint"/>
- <arg name="time" type="uint"/>
+ <arg name="time" type="uint" summary="timestamp with millisecond granularity"/>
<arg name="button" type="uint"/>
<arg name="state" type="uint"/>
</event>
@@ -1304,7 +1306,7 @@
scroll distance.
</description>
- <arg name="time" type="uint"/>
+ <arg name="time" type="uint" summary="timestamp with millisecond granularity"/>
<arg name="axis" type="uint"/>
<arg name="value" type="fixed"/>
</event>
@@ -1367,10 +1369,12 @@
<event name="key">
<description summary="key event">
A key was pressed or released.
+ The time argument is a timestamp with millisecond
+ granularity, with an undefined base.
</description>
<arg name="serial" type="uint"/>
- <arg name="time" type="uint"/>
+ <arg name="time" type="uint" summary="timestamp with millisecond granularity"/>
<arg name="key" type="uint"/>
<arg name="state" type="uint"/>
</event>
@@ -1407,7 +1411,7 @@
of its surfaces.
</description>
<arg name="serial" type="uint"/>
- <arg name="time" type="uint"/>
+ <arg name="time" type="uint" summary="timestamp with millisecond granularity"/>
<arg name="surface" type="object" interface="wl_surface"/>
<arg name="id" type="int" summary="ID of the touch sequence"/>
<arg name="x" type="fixed"/>
@@ -1419,7 +1423,7 @@
Notifies the client that a touch has ended.
</description>
<arg name="serial" type="uint"/>
- <arg name="time" type="uint"/>
+ <arg name="time" type="uint" summary="timestamp with millisecond granularity"/>
<arg name="id" type="int"/>
</event>
@@ -1428,7 +1432,7 @@
Notifies the client that the position of a contact point
has changed.
</description>
- <arg name="time" type="uint"/>
+ <arg name="time" type="uint" summary="timestamp with millisecond granularity"/>
<arg name="id" type="int" summary="ID of the touch sequence"/>
<arg name="x" type="fixed"/>
<arg name="y" type="fixed"/>