Skip to content

wp_tearing_control_v1¤

wayland.wp_tearing_control_v1 ¤

Per-surface tearing control interface

An additional interface to a wl_surface object, which allows the client to hint to the compositor if the content on the surface is suitable for presentation with tearing. The default presentation hint is vsync. See presentation_hint for more details.

If the associated wl_surface is destroyed, this object becomes inert and should be destroyed.

Methods:

presentation_hint ¤

Presentation hint values

This enum provides information for if submitted frames from the client may be presented with tearing.

  • vsync
    Tearing-free presentation The content of this surface is meant to be synchronized to the vertical blanking period. This should not result in visible tearing and may result in a delay before a surface commit is presented.
  • async_
    Asynchronous presentation The content of this surface is meant to be presented with minimal latency and tearing is acceptable.

set_presentation_hint ¤

set_presentation_hint(hint: presentation_hint) -> None

Set presentation hint

Set the presentation hint for the associated wl_surface. This state is double-buffered, see wl_surface.commit.

The compositor is free to dynamically respect or ignore this hint based on various conditions like hardware capabilities, surface state and user preferences.

destroy ¤

destroy() -> None

Destroy tearing control object

Destroy this surface tearing object and revert the presentation hint to vsync. The change will be applied on the next wl_surface.commit.