Skip to content

zwlr_output_power_v1¤

wayland.zwlr_output_power_v1 ¤

Adjust power management mode for an output

This object offers requests to set the power management mode of an output.

Methods:

  • set_mode –

    Set an outputs power save mode

  • destroy –

    Destroy this power management

  • on_mode –

    Report a power management mode change.

  • on_failed –

    Object no longer valid.

mode ¤

  • off –
    Output is turned off.
  • on –
    Output is turned on, no power saving

error ¤

events

mode ¤

mode(mode: mode) -> None

Report a power management mode change

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.

Parameters:

  • mode ¤

    (mode) –

    The output's new power management mode

failed ¤

failed() -> None

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.

set_mode ¤

set_mode(mode: mode) -> None

Set an outputs power save mode

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.

Parameters:

  • mode ¤

    (mode) –

    The power save mode to set

destroy ¤

destroy() -> None

Destroy this power management

Destroys the output power management mode control object.

on_mode ¤

on_mode(mode: mode) -> None

Report a power management mode change.

Override to handle wayland.zwlr_output_power_v1.events.mode.

on_failed ¤

on_failed() -> None

Object no longer valid.

Override to handle wayland.zwlr_output_power_v1.events.failed.