Skip to content

zwlr_output_mode_v1¤

wayland.zwlr_output_mode_v1 ¤

Output mode

This object describes an output mode.

Some heads don't support output modes, in which case modes won't be advertised.

Properties sent via this interface are applied atomically via the wlr_output_manager.done event. No guarantees are made regarding the order in which properties are sent.

Methods:

events

size ¤

size(width: int, height: int) -> None

Mode size

This event describes the mode size. The size is given in physical hardware units of the output device. This is not necessarily the same as the output size in the global compositor space. For instance, the output may be scaled or transformed.

Parameters:

  • width ¤

    (int) –

    Width of the mode in hardware units

  • height ¤

    (int) –

    Height of the mode in hardware units

refresh ¤

refresh(refresh: int) -> None

Mode refresh rate

This event describes the mode's fixed vertical refresh rate. It is only sent if the mode has a fixed refresh rate.

Parameters:

  • refresh ¤

    (int) –

    Vertical refresh rate in mhz

preferred ¤

preferred() -> None

Mode is preferred

This event advertises this mode as preferred.

finished ¤

finished() -> None

The mode has disappeared

This event indicates that the mode is no longer available. The mode object becomes inert. Clients should send a destroy request and release any resources associated with it.

release ¤

release() -> None

Destroy the mode object

This request indicates that the client will no longer use this mode object.

on_size ¤

on_size(width: int, height: int) -> None

Mode size.

Override to handle wayland.zwlr_output_mode_v1.events.size.

on_refresh ¤

on_refresh(refresh: int) -> None

Mode refresh rate.

Override to handle wayland.zwlr_output_mode_v1.events.refresh.

on_preferred ¤

on_preferred() -> None

Mode is preferred.

Override to handle wayland.zwlr_output_mode_v1.events.preferred.

on_finished ¤

on_finished() -> None

The mode has disappeared.

Override to handle wayland.zwlr_output_mode_v1.events.finished.