Gamescope action binding

gamescope-specific protocol

This is a private Gamescope protocol. Regular Wayland clients must not use it.


destroy()
set_description(description: string)
Argument
Type
Description
descriptionstring
human-readable description as to what the action is for, used for debugging purposes.
add_keyboard_trigger(keysyms: array)
Argument
Type
Description
keysymsarray
array of xkb_keysym_t's
Argument
Type
Description
sequenceuint
global sequence no of actions that have been trigged
time_louint
lower bits of 64-bit timestamp in nanos (CLOCK_MONOTONIC)
time_hiuint
upper bits of 64-bit timestamp in nanos (CLOCK_MONOTONIC)
trigger_flagsuint<gamescope_action_binding.trigger_flag>
flags for this trigger
arm_flag { one_shot, no_block } 
Argument
Value
Description
one_shot0x1
disarm this action immediately after trigger. unrelated to niko
no_block0x2
don't block the result of this shortcut being seen by the app and keep processing hotkeys
arm flags

Flags that control how the action is armed.

trigger_flag { keyboard } 
Argument
Value
Description
keyboard0x1
action was triggered by keyboard trigger
arm flags

Flags that say how the action was triggered.


Compositor Support

gamescope_action_binding_manager↓
Compositors
CageCage0.3.0
x
COSMICCOSMIC1.11.0
x
flakewm3.0.5
x
GameScopeGameScope3.17.0
1
HyprlandHyprland0.57.2
x
Jay1.14.0
x
KWinKWin6.7
x
LabwcLabwc0.20.2
x
LouvreLouvre2.14.1
x
MangoMango0.16.3
x
MirMir2.26
x
MuffinMuffin6.7.4
x
MutterMutter51
x
niriniri26.04
x
phocphoc0.55
x
Pila0.5.1
x
QtileQtile0.37.1
x
riverriver0.5.0
x
SwaySway1.11
x
TreelandTreeland0.8.0
x
WayfireWayfire0.9.0
x
WestonWeston15.0.1
x

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.