wlr_output_power_management_unstable_v1

# zwlr_output_power_manager_v1

This interface is a manager that allows creating per-output power management mode controls.

Requests
- #
  get_output_power
  
  get a power management for an output
  
  struct zwlr_output_power_v1* zwlr_output_power_manager_v1_get_output_power(
  struct zwlr_output_power_manager_v1* zwlr_output_power_manager_v1,
  
  struct wl_output* output
  )
  
  Create an output power management mode control that can be used to adjust the power management mode for a given output.
- #
  destroy
  
  destroy the manager
  
  void zwlr_output_power_manager_v1_destroy(
  struct zwlr_output_power_manager_v1* zwlr_output_power_manager_v1
  )
  
  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.

Requests
- #
  set_mode
  
  Set an outputs power save mode
  
  void zwlr_output_power_v1_set_mode(
  struct zwlr_output_power_v1* zwlr_output_power_v1,
  
  uint32_t 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
  
  destroy this power management
  
  void zwlr_output_power_v1_destroy(
  struct zwlr_output_power_v1* zwlr_output_power_v1
  )
  
  Destroys the output power management mode control object.
Events
- #
  mode
  
  Report a power management mode change
  
  uint32_t 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
  
  object no longer valid
  
  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.
Enums
- #
  mode
  
  ZWLR_OUTPUT_POWER_V1_MODE_OFF /* Output is turned off. */
  
  ZWLR_OUTPUT_POWER_V1_MODE_ON /* Output is turned on, no power saving */
- #
  error
  
  ZWLR_OUTPUT_POWER_V1_ERROR_INVALID_MODE /* nonexistent power save mode */

Copyright Info

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.

wlr_output_power_management_unstable_v1

# zwlr_output_power_manager_v1

Requests

# zwlr_output_power_v1

Requests

Events

Enums

Copyright Info