Skip to content

wp_commit_timer_v1¤

wayland.wp_commit_timer_v1 ¤

Surface commit timer

An object to set a time constraint for a content update on a surface.

Methods:

error ¤

set_timestamp ¤

set_timestamp(tv_sec_hi: int, tv_sec_lo: int, tv_nsec: int) -> None

Specify time the following commit takes effect

Provide a timing constraint for a surface content update.

A set_timestamp request may be made before a wl_surface.commit to tell the compositor that the content is intended to be presented as closely as possible to, but not before, the specified time. The time is in the domain of the compositor's presentation clock.

An invalid_timestamp error will be generated for invalid tv_nsec.

If a timestamp already exists on the surface, a timestamp_exists error is generated.

Requesting set_timestamp after the commit_timer object's surface is destroyed will generate a "surface_destroyed" error.

Parameters:

  • tv_sec_hi ¤

    (int) –

    High 32 bits of the seconds part of target time

  • tv_sec_lo ¤

    (int) –

    Low 32 bits of the seconds part of target time

  • tv_nsec ¤

    (int) –

    Nanoseconds part of target time

destroy ¤

destroy() -> None

Destroy the timer

Informs the server that the client will no longer be using this protocol object.

Existing timing constraints are not affected by the destruction.