diff options
| author | Matthias Clasen <mclasen@redhat.com> | 2013-03-30 01:11:43 -0400 |
|---|---|---|
| committer | Kristian Høgsberg <krh@bitplanet.net> | 2013-04-01 19:58:06 -0400 |
| commit | 27eacf423afcefa6c85a383f305db1e0d350805f (patch) | |
| tree | 480ed680efe6404fbcc272fe9fd90a97640b6c23 /protocol | |
| parent | 608d81bfd59df9b1467fbea96ce532dce8559df1 (diff) | |
docs: Improve wl_touch protocol docs
Some descriptions were missing here.
Diffstat (limited to 'protocol')
| -rw-r--r-- | protocol/wayland.xml | 36 |
1 files changed, 27 insertions, 9 deletions
diff --git a/protocol/wayland.xml b/protocol/wayland.xml index 52bc98f..a53cb71 100644 --- a/protocol/wayland.xml +++ b/protocol/wayland.xml @@ -1391,29 +1391,48 @@ </interface> <interface name="wl_touch" version="1"> - <description summary="touch screen input device"> + <description summary="touchscreen input device"> + The wl_touch interface represents a touchscreen + associated with a seat. + + Touch interactions can consist of one or more contacts. + For each contact, a series of events is generated, starting + with a down event, followed by one or more motion events, + and ended with an up event. Events relating to the same + contact point can be identified by the ID of the sequence. </description> <event name="down"> + <description summary="touch down event"> + Notifies the client of a new contact point on one + of its surfaces. + </description> <arg name="serial" type="uint"/> <arg name="time" type="uint"/> <arg name="surface" type="object" interface="wl_surface"/> - <arg name="id" type="int" /> - <arg name="x" type="fixed" /> - <arg name="y" type="fixed" /> + <arg name="id" type="int" summary="ID of the touch sequence"/> + <arg name="x" type="fixed"/> + <arg name="y" type="fixed"/> </event> <event name="up"> + <description summary="touch up event"> + Notifies the client that a touch has ended. + </description> <arg name="serial" type="uint"/> <arg name="time" type="uint"/> - <arg name="id" type="int" /> + <arg name="id" type="int"/> </event> <event name="motion"> + <description summary="touch motion event"> + Notifies the client that the position of a contact point + has changed. + </description> <arg name="time" type="uint"/> - <arg name="id" type="int" /> - <arg name="x" type="fixed" /> - <arg name="y" type="fixed" /> + <arg name="id" type="int" summary="ID of the touch sequence"/> + <arg name="x" type="fixed"/> + <arg name="y" type="fixed"/> </event> <event name="frame"> @@ -1431,7 +1450,6 @@ </event> </interface> - <interface name="wl_output" version="1"> <description summary="compositor output region"> An output describes part of the compositor geometry. The |