wlr output power management
This protocol allows clients to control power management modes of outputs that are currently part of the compositor space. The intent is to allow special clients like desktop shells to power down outputs when the system is idle.
To modify outputs not currently part of the compositor space see wlr-output-management.
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_output_power_manager_v1
This interface is a manager that allows creating per-output power management mode controls.
get_output_power(id: new_id<zwlr_output_power_v1>, output: object<wl_output>)
Argument | Type | Description |
|---|---|---|
| id | new_id<zwlr_output_power_v1> | |
| output | object<wl_output> |
Create an output power management mode control that can be used to adjust the power management mode for a given output.
destroy()
All objects created by the manager will still remain valid, until their appropriate destroy request has been called.
zwlr_output_power_v1
This object offers requests to set the power management mode of an output.
set_mode(mode: uint<zwlr_output_power_v1.mode>)
Argument | Type | Description |
|---|---|---|
| mode | uint<zwlr_output_power_v1.mode> | the power save mode to set |
Set an output's power save mode to the given mode. The mode change is effective immediately. If the output does not support the given mode a failed event is sent.
destroy()
Destroys the output power management mode control object.
mode(mode: uint<zwlr_output_power_v1.mode>)
Argument | Type | Description |
|---|---|---|
| mode | uint<zwlr_output_power_v1.mode> | the output's new power management mode |
Report the power management mode change of an output.
The mode event is sent after an output changed its power management mode. The reason can be a client using set_mode or the compositor deciding to change an output's mode. This event is also sent immediately when the object is created so the client is informed about the current power management mode.
failed()
This event indicates that the output power management mode control is no longer valid. This can happen for a number of reasons, including: - The output doesn't support power management - Another client already has exclusive power management mode control for this output - The output disappeared
Upon receiving this event, the client should destroy this object.
error { invalid_mode }
Argument | Value | Description |
|---|---|---|
| invalid_mode | 1 | nonexistent power save mode |
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_output_power_manager_v1 | x | x | 1 | x | 1 | x | x | x | x | x |
Copyright
Copyright © 2019 Purism SPC
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.