Chromium Code Reviews Chromium Code Reviews
Issue 2144283003:
wayland-protocols: Add protocol for stylus support (Closed)
Base URL: https://chromium.googlesource.com/chromium/src.git@master| OLD | NEW |
|---|---|
| (Empty) | |
| 1 <?xml version="1.0" encoding="UTF-8"?> | |
| 2 <protocol name="stylus_unstable_v1"> | |
| 3 | |
| 4 <copyright> | |
| 5 Copyright 2016 The Chromium Authors. | |
| 6 | |
| 7 Permission is hereby granted, free of charge, to any person obtaining a | |
| 8 copy of this software and associated documentation files (the "Software"), | |
| 9 to deal in the Software without restriction, including without limitation | |
| 10 the rights to use, copy, modify, merge, publish, distribute, sublicense, | |
| 11 and/or sell copies of the Software, and to permit persons to whom the | |
| 12 Software is furnished to do so, subject to the following conditions: | |
| 13 | |
| 14 The above copyright notice and this permission notice (including the next | |
| 15 paragraph) shall be included in all copies or substantial portions of the | |
| 16 Software. | |
| 17 | |
| 18 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
| 19 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
| 20 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL | |
| 21 THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |
| 22 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING | |
| 23 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER | |
| 24 DEALINGS IN THE SOFTWARE. | |
| 25 </copyright> | |
| 26 | |
| 27 <interface name="zwp_stylus_v1" version="1"> | |
| 28 <description summary="extends wl_pointer with events for on-screen stylus"> | |
| 29 Allows a wl_pointer to represent an on-screen stylus. The client can | |
| 30 interpret the on-screen stylus like any other mouse device, and use | |
| 31 this protocol to obtain detail information about the type of stylus, | |
| 32 as well as the force and tilt of the tool. | |
| 33 | |
| 34 These events are to be fired by the server within the same frame as other | |
| 35 wl_pointer events. | |
| 36 | |
| 37 Warning! The protocol described in this file is experimental and | |
| 38 backward incompatible changes may be made. Backward compatible changes | |
| 39 may be added together with the corresponding uinterface version bump. | |
| 40 Backward incompatible changes are done by bumping the version number in | |
| 41 the protocol and uinterface names and resetting the interface version. | |
| 42 Once the protocol is to be declared stable, the 'z' prefix and the | |
| 43 version number in the protocol and interface names are removed and the | |
| 44 interface version number is reset. | |
| 45 </description> | |
| 46 | |
| 47 <request name="get_pointer_stylus"> | |
| 48 <description summary="get stylus interface for pointer"> | |
| 49 Create pointer_stylus object. See zwp_pointer_stylus_v1 interface for | |
| 50 details. | |
| 51 </description> | |
| 52 <arg name="id" type="new_id" interface="zwp_pointer_stylus_v1"/> | |
| 53 <arg name="pointer" type="object" interface="wl_pointer"/> | |
| 54 </request> | |
| 55 </interface> | |
| 56 | |
| 57 <interface name="zwp_pointer_stylus_v1" version="1"> | |
| 58 <description summary="stylus extension for pointer"> | |
| 59 The zwp_pointer_stylus_v1 interface extends the wl_pointer interface with | |
| 60 events to describe details about a stylus acting as a pointer. | |
| 61 </description> | |
| 62 | |
| 63 <request name="destroy" type="destructor"> | |
| 64 <description summary="destroy stylus object"/> | |
| 65 </request> | |
| 66 | |
| 67 <enum name="tool_type"> | |
| 68 <description summary="tool type of device."/> | |
| 69 <entry name="mouse" value="0" summary="Mouse or touchpad, not a stylus."/> | |
| 70 <entry name="pen" value="1" summary="Pen"/> | |
| 71 <entry name="touch" value="2" summary="Touch"/> | |
| 72 <entry name="eraser" value="3" summary="Eraser"/> | |
| 73 </enum> | |
| 74 | |
| 75 <event name="tool_change"> | |
| 76 <description summary="pointing device tool type changed"> | |
| 77 Notification that the user is using a new tool type. There can only be | |
| 78 one tool in use at a time. If the pointer enters a client surface, with | |
| 79 a tool type other than mouse, this event will also be generated. | |
|
reveman
2016/07/14 20:06:09
I assume this also applies to force/tilt events? M
denniskempin
2016/07/14 20:18:56
Done.
| |
| 80 | |
| 81 If this event is not received, the client has to assume a mouse is in | |
| 82 use. The remaining events of this protocol are only being generated | |
| 83 after this event has been fired with a tool type other than mouse. | |
| 84 </description> | |
| 85 <arg name="type" type="uint" enum="type" summary="new device type"/> | |
| 86 </event> | |
| 87 | |
| 88 <event name="force"> | |
| 89 <description summary="force change event"> | |
| 90 Notification of a change in physical force on the surface of the screen. | |
| 91 | |
| 92 The force is calibrated and normalized to the 0 to 1 range. | |
| 93 </description> | |
| 94 <arg name="time" type="uint" summary="timestamp with millisecond granulari ty"/> | |
| 95 <arg name="force" type="fixed" summary="new value of force"/> | |
| 96 </event> | |
| 97 | |
| 98 <event name="tilt"> | |
| 99 <description summary="force change event"> | |
| 100 Notification of a change in tilt of the pointing tool. | |
| 101 | |
| 102 Measured from surface normal as plane angle in degrees, values lie in | |
| 103 [-90,90]. A positive x is to the right and a positive y is towards the | |
| 104 user. | |
| 105 </description> | |
| 106 <arg name="time" type="uint" summary="timestamp with millisecond granulari ty"/> | |
| 107 <arg name="tilt_x" type="fixed" summary="tilt in x direction"/> | |
| 108 <arg name="tilt_y" type="fixed" summary="tilt in y direction"/> | |
| 109 </event> | |
| 110 </interface> | |
| 111 </protocol> | |
| OLD | NEW |
