1<?xml version="1.0" encoding="UTF-8"?> 2<protocol name="stylus_unstable_v2"> 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="zcr_stylus_v2" version="1"> 28 <description summary="extends wl_touch with events for on-screen stylus"> 29 Allows a wl_touch to report stylus specific information. The client can 30 interpret the on-screen stylus like any other touch event, 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_touch 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 <enum name="error"> 48 <entry name="touch_stylus_exists" value="0" 49 summary="the touch already has a touch_stylus object associated"/> 50 </enum> 51 52 <request name="get_touch_stylus"> 53 <description summary="get stylus interface for touch"> 54 Create touch_stylus object. See zcr_touch_stylus_v1 interface for 55 details. If the given wl_touch already has a touch_stylus object 56 associated, the touch_stylus_exists protocol error is raised. 57 </description> 58 <arg name="id" type="new_id" interface="zcr_touch_stylus_v2"/> 59 <arg name="touch" type="object" interface="wl_touch"/> 60 </request> 61 </interface> 62 63 <interface name="zcr_touch_stylus_v2" version="1"> 64 <description summary="stylus extension for touch"> 65 The zcr_touch_stylus_v1 interface extends the wl_touch interface with 66 events to describe details about a stylus. 67 </description> 68 69 <request name="destroy" type="destructor"> 70 <description summary="destroy stylus object"/> 71 </request> 72 73 <enum name="tool_type"> 74 <description summary="tool type of device."/> 75 <entry name="touch" value="1" summary="Touch"/> 76 <entry name="pen" value="2" summary="Pen"/> 77 <entry name="eraser" value="3" summary="Eraser"/> 78 </enum> 79 80 <event name="tool"> 81 <description summary="sets tool type of touch"> 82 Notification that the user is using a tool type other than touch. There 83 can only be one tool in use at a time. 84 This event is sent in the same frame as the wl_touch.down event. The 85 tool type cannot change while a touch is being reported. 86 </description> 87 <arg name="id" type="uint" summary="touch id"/> 88 <arg name="type" type="uint" enum="tool_type" summary="type of tool in use"/> 89 </event> 90 91 <event name="force"> 92 <description summary="force change event"> 93 Notification of a change in physical force on the surface of the screen. 94 The force is calibrated and normalized to the 0 to 1 range. 95 </description> 96 <arg name="time" type="uint" summary="timestamp with millisecond granularity"/> 97 <arg name="id" type="uint" summary="touch id"/> 98 <arg name="force" type="fixed" summary="new value of force"/> 99 </event> 100 101 <event name="tilt"> 102 <description summary="tilt change event"> 103 Notification of a change in tilt of a stylus. 104 105 Measured from surface normal as plane angle in degrees, values lie in 106 [-90,90]. A positive x is to the right and a positive y is towards the 107 user. 108 </description> 109 <arg name="time" type="uint" summary="timestamp with millisecond granularity"/> 110 <arg name="id" type="uint" summary="touch id"/> 111 <arg name="tilt_x" type="fixed" summary="tilt in x direction"/> 112 <arg name="tilt_y" type="fixed" summary="tilt in y direction"/> 113 </event> 114 </interface> 115 116</protocol> 117