Gamescope action binding
This is a private Gamescope protocol. Regular Wayland clients must not use it.
gamescope_action_binding_manager
destroy()
create_action_binding(callback: new_id<gamescope_action_binding>)
Argument | Type | Description |
|---|---|---|
| callback | new_id<gamescope_action_binding> | new action binding object |
gamescope_action_binding
destroy()
set_description(description: string)
Argument | Type | Description |
|---|---|---|
| description | string | human-readable description as to what the action is for, used for debugging purposes. |
clear_triggers()
arm(arm_flags: uint<gamescope_action_binding.arm_flag>)
Argument | Type | Description |
|---|---|---|
| arm_flags | uint<gamescope_action_binding.arm_flag> | combination of 'arm_flag' values |
disarm()
triggered(sequence: uint, time_lo: uint, time_hi: uint, trigger_flags: uint<gamescope_action_binding.trigger_flag>)
Argument | Type | Description |
|---|---|---|
| sequence | uint | global sequence no of actions that have been trigged |
| time_lo | uint | lower bits of 64-bit timestamp in nanos (CLOCK_MONOTONIC) |
| time_hi | uint | upper bits of 64-bit timestamp in nanos (CLOCK_MONOTONIC) |
| trigger_flags | uint<gamescope_action_binding.trigger_flag> | flags for this trigger |
Argument | Value | Description |
|---|---|---|
| one_shot | 0x1 | disarm this action immediately after trigger. unrelated to niko |
| no_block | 0x2 | don't block the result of this shortcut being seen by the app and keep processing hotkeys |
Flags that control how the action is armed.
Compositor Support
| gamescope_action_binding_manager | ↓ | ||
| Compositors | |||
| Cage | 0.3.0 | x | |
| COSMIC | 1.11.0 | x | |
| flakewm | 3.0.5 | x | |
| GameScope | 3.17.0 | 1 | |
| Hyprland | 0.57.2 | x | |
| Jay | 1.14.0 | x | |
| KWin | 6.7 | x | |
| Labwc | 0.20.2 | x | |
| Louvre | 2.14.1 | x | |
| Mango | 0.16.3 | x | |
| Mir | 2.26 | x | |
| Muffin | 6.7.4 | x | |
| Mutter | 51 | x | |
| niri | 26.04 | x | |
| phoc | 0.55 | x | |
| Pila | 0.5.1 | x | |
| Qtile | 0.37.1 | x | |
| river | 0.5.0 | x | |
| Sway | 1.11 | x | |
| Treeland | 0.8.0 | x | |
| Wayfire | 0.9.0 | x | |
| Weston | 15.0.1 | x | |
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.