mirrors/wayland
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/wayland/wayland.git synced 2026-04-02 07:15:53 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

protocol: document wl_pointer, wl_keyboard, wl_touch

Browse source 
Most of this should be clear, but let's spell a few things out.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
This commit is contained in:
Peter Hutterer 2013-04-02 09:58:17 +10:00 • committed by Kristian Høgsberg
parent 4a599e029d
commit 9c0357af6e
1 changed files with 27 additions and 21 deletions
Download patch file Download diff file Expand all files Collapse all files

48
protocol/wayland.xml
View file

@ -1209,8 +1209,8 @@
<arg name="serial" type="uint" summary="serial of the enter event"/> <arg name="serial" type="uint" summary="serial of the enter event"/>
<arg name="surface" type="object" interface="wl_surface" allow-null="true"/> <arg name="surface" type="object" interface="wl_surface" allow-null="true"/>
<arg name="hotspot_x" type="int"/> <arg name="hotspot_x" type="fixed" summary="x coordinate in surface-relative coordinates"/>
<arg name="hotspot_y" type="int"/> <arg name="hotspot_y" type="fixed" summary="y coordinate in surface-relative coordinates"/>
</request> </request>
<event name="enter"> <event name="enter">
@ -1225,8 +1225,8 @@
<arg name="serial" type="uint"/> <arg name="serial" type="uint"/>
<arg name="surface" type="object" interface="wl_surface"/> <arg name="surface" type="object" interface="wl_surface"/>
<arg name="surface_x" type="fixed"/> <arg name="surface_x" type="fixed" summary="x coordinate in surface-relative coordinates"/>
<arg name="surface_y" type="fixed"/> <arg name="surface_y" type="fixed" summary="y coordinate in surface-relative coordinates"/>
</event> </event>
<event name="leave"> <event name="leave">
@ -1249,8 +1249,8 @@
</description> </description>
<arg name="time" type="uint" summary="timestamp with millisecond granularity"/> <arg name="time" type="uint" summary="timestamp with millisecond granularity"/>
<arg name="surface_x" type="fixed"/> <arg name="surface_x" type="fixed" summary="x coordinate in surface-relative coordinates"/>
<arg name="surface_y" type="fixed"/> <arg name="surface_y" type="fixed" summary="y coordinate in surface-relative coordinates"/>
</event> </event>
<enum name="button_state"> <enum name="button_state">
@ -1407,35 +1407,38 @@
<event name="down"> <event name="down">
<description summary="touch down event"> <description summary="touch down event">
Notifies the client of a new contact point on one A new touch point has appeared on the surface. This touch point is
of its surfaces. assigned a unique @id. Future events from this touchpoint reference
this ID. The ID ceases to be valid after a touch up event and may be
re-used in the future.
</description> </description>
<arg name="serial" type="uint"/> <arg name="serial" type="uint"/>
<arg name="time" type="uint" summary="timestamp with millisecond granularity"/> <arg name="time" type="uint" summary="timestamp with millisecond granularity"/>
<arg name="surface" type="object" interface="wl_surface"/> <arg name="surface" type="object" interface="wl_surface"/>
<arg name="id" type="int" summary="ID of the touch sequence"/> <arg name="id" type="int" summary="the unique ID of this touch point"/>
<arg name="x" type="fixed"/> <arg name="x" type="fixed" summary="x coordinate in surface-relative coordinates"/>
<arg name="y" type="fixed"/> <arg name="y" type="fixed" summary="y coordinate in surface-relative coordinates"/>
</event> </event>
<event name="up"> <event name="up">
<description summary="touch up event"> <description summary="end of a touch event sequence">
Notifies the client that a touch has ended. The touch point has disappeared. No further events will be sent for
this touchpoint and the touch point's ID is released and may be
re-used in a future touch down event.
</description> </description>
<arg name="serial" type="uint"/> <arg name="serial" type="uint"/>
<arg name="time" type="uint" summary="timestamp with millisecond granularity"/> <arg name="time" type="uint" summary="timestamp with millisecond granularity"/>
<arg name="id" type="int"/> <arg name="id" type="int" summary="the unique ID of this touch point"/>
</event> </event>
<event name="motion"> <event name="motion">
<description summary="touch motion event"> <description summary="end of a touch event sequence">
Notifies the client that the position of a contact point A touchpoint has changed coordinates.
has changed.
</description> </description>
<arg name="time" type="uint" summary="timestamp with millisecond granularity"/> <arg name="time" type="uint" summary="timestamp with millisecond granularity"/>
<arg name="id" type="int" summary="ID of the touch sequence"/> <arg name="id" type="int" summary="the unique ID of this touch point"/>
<arg name="x" type="fixed"/> <arg name="x" type="fixed" summary="x coordinate in surface-relative coordinates"/>
<arg name="y" type="fixed"/> <arg name="y" type="fixed" summary="y coordinate in surface-relative coordinates"/>
</event> </event>
<event name="frame"> <event name="frame">
@ -1448,7 +1451,10 @@
<description summary="touch session cancelled"> <description summary="touch session cancelled">
Sent if the compositor decides the touch stream is a global Sent if the compositor decides the touch stream is a global
gesture. No further events are sent to the clients from that gesture. No further events are sent to the clients from that
particular gesture. particular gesture. Touch cancellation applies to all touch points
currently active on this client's surface. The client is
responsible for finalizing the touch points, future touch points on
this surface may re-use the touch point ID.
</description> </description>
</event> </event>
</interface> </interface>