File: gamescope-action-binding.xml

package info (click to toggle)
gamescope 3.16.15-2
  • links: PTS, VCS
  • area: contrib
  • in suites: sid
  • size: 17,576 kB
  • sloc: cpp: 161,492; ansic: 6,677; cs: 3,131; xml: 2,860; makefile: 8; sh: 5
file content (85 lines) | stat: -rw-r--r-- 3,615 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
<?xml version="1.0" encoding="UTF-8"?>
<protocol name="gamescope_action_binding">

  <copyright>
    Copyright © 2024 Valve Corporation

    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>

  <description summary="gamescope-specific protocol">
    This is a private Gamescope protocol. Regular Wayland clients must not use
    it.
  </description>

  <interface name="gamescope_action_binding_manager" version="1">
    <request name="destroy" type="destructor"></request>

    <request name="create_action_binding">
      <arg name="callback" type="new_id" interface="gamescope_action_binding" summary="new action binding object"/>
    </request>
  </interface>

  <interface name="gamescope_action_binding" version="1">
    <request name="destroy" type="destructor"></request>

    <enum name="arm_flag" bitfield="true">
      <description summary="arm flags">
        Flags that control how the action is armed.
      </description>
      <entry name="one_shot" value="0x1" summary="disarm this action immediately after trigger. unrelated to niko"/>
      <entry name="no_block" value="0x2" summary="don't block the result of this shortcut being seen by the app and keep processing hotkeys"/>
    </enum>

    <enum name="trigger_flag" bitfield="true">
      <description summary="arm flags">
        Flags that say how the action was triggered.
      </description>

      <entry name="keyboard" value="0x1" summary="action was triggered by keyboard trigger"/>
    </enum>

    <request name="set_description">
      <arg name="description" type="string" summary="human-readable description as to what the action is for, used for debugging purposes."/>
    </request>

    <request name="add_keyboard_trigger">
      <arg name="keysyms" type="array" summary="array of xkb_keysym_t's"/>
    </request>

    <request name="clear_triggers">
    </request>

    <request name="arm">
      <arg name="arm_flags" type="uint" enum="arm_flag" summary="combination of 'arm_flag' values"/>
    </request>

    <request name="disarm">
    </request>

    <event name="triggered">
      <arg name="sequence" type="uint" summary="global sequence no of actions that have been trigged"/>
      <arg name="time_lo" type="uint" summary="lower bits of 64-bit timestamp in nanos (CLOCK_MONOTONIC)"/>
      <arg name="time_hi" type="uint" summary="upper bits of 64-bit timestamp in nanos (CLOCK_MONOTONIC)"/>
      <arg name="trigger_flags" type="uint" enum="trigger_flag" summary="flags for this trigger"/>
    </event>
  </interface>

</protocol>