File: ext-input-observation-v1.xml

package info (click to toggle)
wlmaker 0.6.1%2Bgit20250919%2Bds-2
  • links: PTS, VCS
  • area: main
  • in suites: forky
  • size: 12,056 kB
  • sloc: ansic: 144,965; sh: 10,507; xml: 4,163; python: 1,400; makefile: 499; yacc: 119; lex: 70; awk: 12
file content (89 lines) | stat: -rw-r--r-- 3,948 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
<?xml version="1.0" encoding="UTF-8"?>
<protocol name="ext_input_observation_v1">
  <copyright>
    Copyright 2024 Google LLC

    Permission is hereby granted, free of charge, to any person obtaining a
    copy of this software and associated documentation files (the "Software"),
    to deal in the Software without restriction, including without limitation
    the rights to use, copy, modify, merge, publish, distribute, sublicense,
    and/or sell copies of the Software, and to permit persons to whom the
    Software is furnished to do so, subject to the following conditions:

    The above copyright notice and this permission notice (including the next
    paragraph) shall be included in all copies or substantial portions of the
    Software.

    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
    THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
    FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
    DEALINGS IN THE SOFTWARE.
  </copyright>

  <interface name="ext_input_observation_manager_v1" version="1">
    <description summary="Creates an Input Observation Manager">
      This interface permits a privileged clients to register surfaces for
      observing user input, surface does not have the input device's focus.
    </description>

    <request name="destroy" type="destructor">
      <description summary="Destroys the Input Observation Manager">
        Destroys the Input Observation Manager.
      </description>
    </request>

    <request name="create_pointer_observer">
      <description summary="Creates an observer for the given pointer and surface.">
        Creates an observation instance for this pointer's position relative to
        `surface`.
      </description>
      <arg name="id" type="new_id" interface="ext_input_position_observer_v1"/>
      <arg name="pointer" type="object" interface="wl_pointer"/>
      <arg name="surface" type="object" interface="wl_surface"/>
    </request>
  </interface>

  <interface name="ext_input_position_observer_v1" version="1">
    <description summary="Input Position Observer">
      Permits observing the position of input devices with respect to the
      associated surface.

      Status of input devices will be shared only when the surface is
      mapped. 
    </description>

    <request name="destroy" type="destructor">
      <description summary="Destroys the Input Observer.">
        Destructor.
      </description>
    </request>

    <event name="position">
      <description summary="Reports the input device's position.">
        Reports the input device's position relative to the surface.

        If the compositor displays the surface more than once, it may
        share the input device's position relative to each instance of the
        surface, identified by the `instance` argument. The compositor
        will issue a call for each displayed instance, and the client
        may determine whether to act on any or all of the calls.

        The position is reported relative to the surface's edge vectors, and
        irrespective of whether the surface has input focus or whether the
        device's position is in- or outside of the surface area.

        The relative positions will be reported as signed 16:16 fixpoint
        values. Positions within the surface will also be reported, with
        values in the interval [0, 1) for both relative_x and relative_y.
      </description>
      <arg name="surface" type="object" interface="wl_surface"/>
      <arg name="instance" type="uint"/>
      <arg name="relative_x" type="int"/>
      <arg name="relative_y" type="int"/>
    </event>
  </interface>

</protocol>