wlr gamma control
This protocol allows a privileged client to set the gamma tables for outputs.
Warning! The protocol described in this file is experimental and backward incompatible changes may be made. Backward compatible changes may be added together with the corresponding interface version bump. Backward incompatible changes are done by bumping the version number in the protocol and interface names and resetting the interface version. Once the protocol is to be declared stable, the 'z' prefix and the version number in the protocol and interface names are removed and the interface version number is reset.
zwlr_gamma_control_manager_v1
This interface is a manager that allows creating per-output gamma controls.
get_gamma_control(id: new_id<zwlr_gamma_control_v1>, output: object<wl_output>)
Argument | Type | Description |
|---|---|---|
| id | new_id<zwlr_gamma_control_v1> | |
| output | object<wl_output> |
Create a gamma control that can be used to adjust gamma tables for the provided output.
destroy()
All objects created by the manager will still remain valid, until their appropriate destroy request has been called.
zwlr_gamma_control_v1
This interface allows a client to adjust gamma tables for a particular output.
The client will receive the gamma size, and will then be able to set gamma tables. At any time the compositor can send a failed event indicating that this object is no longer valid.
There can only be at most one gamma control object per output, which has exclusive access to this particular output. When the gamma control object is destroyed, the gamma table is restored to its original value.
set_gamma(fd: fd)
Argument | Type | Description |
|---|---|---|
| fd | fd | gamma table file descriptor |
Set the gamma table. The file descriptor can be memory-mapped to provide the raw gamma table, which contains successive gamma ramps for the red, green and blue channels. Each gamma ramp is an array of 16-byte unsigned integers which has the same length as the gamma size.
The file descriptor data must have the same length as three times the gamma size.
destroy()
Destroys the gamma control object. If the object is still valid, this restores the original gamma tables.
gamma_size(size: uint)
Argument | Type | Description |
|---|---|---|
| size | uint | number of elements in a ramp |
Advertise the size of each gamma ramp.
This event is sent immediately when the gamma control object is created.
failed()
This event indicates that the gamma control is no longer valid. This can happen for a number of reasons, including: - The output doesn't support gamma tables - Setting the gamma tables failed - Another client already has exclusive gamma control for this output - The compositor has transferred gamma control to another client
Upon receiving this event, the client should destroy this object.
error { invalid_gamma }
Argument | Value | Description |
|---|---|---|
| invalid_gamma | 1 | invalid gamma tables |
Compositor Support
Mutter  46 | KWin  6.2 | Sway  1.9 | COSMIC  1.0.0 | Hyprland  0.42.0 | niri 0.1.8 | Weston  13 | Mir  2.18 | GameScope  3.15.14 | Jay 1.7.0 | |
|---|---|---|---|---|---|---|---|---|---|---|
| zwlr_gamma_control_manager_v1 | x | x | 1 | x | 1 | 1 | x | x | x | x |
Copyright
Copyright © 2015 Giulio camuffo Copyright © 2018 Simon Ser
Permission to use, copy, modify, distribute, and sell this software and its documentation for any purpose is hereby granted without fee, provided that the above copyright notice appear in all copies and that both that copyright notice and this permission notice appear in supporting documentation, and that the name of the copyright holders not be used in advertising or publicity pertaining to distribution of the software without specific, written prior permission. The copyright holders make no representations about the suitability of this software for any purpose. It is provided "as is" without express or implied warranty.
THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.