Gamescope ReShade

gamescope-specific reshade integration

This protocol allows applications to load and interact with a reshade FX shader in gamescope.


destroy()
set_effect(path: string)
Argument
Type
Description
pathstring
Path to the FX file
set the path to the reshade FX file

The effect will be disabled to allow an opportunity to set uniform variables before enabling it.

enable_effect()
turn on the effect

Enables the effect that was previously loaded by set_effect.

set_uniform_variable(key: string, value: array)
Argument
Type
Description
keystring
Name of the uniform variable
valuearray
Value of the uniform variable
set a uniform variable for the currently loaded effect

Set the value of a uniform variable. Can be called before or after enabling the effect.

disable_effect()
turn off the effect

Disables the effect that was previously enabled by enable_effect.

effect_ready(effect_path: string)
Argument
Type
Description
effect_pathstring
Path to the FX file
alerts when the requested effect is ready

This event alerts the client when an effect has been enabled.


Compositor Support

gamescope_reshade↓
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 Wayne Heaney

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.