Skip to content

wp_presentation¤

wayland.wp_presentation ¤

Timed presentation related wl_surface requests

Methods:

  • destroy –

    Unbind from the presentation interface

  • feedback –

    Request presentation feedback information

  • on_clock_id –

    Clock id for timestamps.

error ¤

Fatal presentation errors

These fatal protocol errors may be emitted in response to illegal presentation requests.

events

clock_id ¤

clock_id(clk_id: int) -> None

Clock id for timestamps

This event tells the client in which clock domain the compositor interprets the timestamps used by the presentation extension. This clock is called the presentation clock.

The compositor sends this event when the client binds to the presentation interface. The presentation clock does not change during the lifetime of the client connection.

The clock identifier is platform dependent. On POSIX platforms, the identifier value is one of the clockid_t values accepted by clock_gettime(). clock_gettime() is defined by POSIX.1-2001.

Timestamps in this clock domain are expressed as tv_sec_hi, tv_sec_lo, tv_nsec triples, each component being an unsigned 32-bit value. Whole seconds are in tv_sec which is a 64-bit value combined from tv_sec_hi and tv_sec_lo, and the additional fractional part in tv_nsec as nanoseconds. Hence, for valid timestamps tv_nsec must be in [0, 999999999].

Note that clock_id applies only to the presentation clock, and implies nothing about e.g. the timestamps used in the Wayland core protocol input events.

Compositors should prefer a clock which does not jump and is not slewed e.g. by NTP. The absolute value of the clock is irrelevant. Precision of one millisecond or better is recommended. Clients must be able to query the current clock value directly, not by asking the compositor.

Parameters:

  • clk_id ¤

    (int) –

    Platform clock identifier

destroy ¤

destroy() -> None

Unbind from the presentation interface

Informs the server that the client will no longer be using this protocol object. Existing objects created by this object are not affected.

feedback ¤

feedback(surface: wl_surface) -> wp_presentation_feedback

Request presentation feedback information

Request presentation feedback for the current content submission on the given surface. This creates a new presentation_feedback object, which will deliver the feedback information once. If multiple presentation_feedback objects are created for the same submission, they will all deliver the same information.

For details on what information is returned, see the presentation_feedback interface.

Parameters:

Returns:

on_clock_id ¤

on_clock_id(clk_id: int) -> None

Clock id for timestamps.

Override to handle wayland.wp_presentation.events.clock_id.