Struct wayland_protocols::presentation_time::server::wp_presentation_feedback::WpPresentationFeedback

pub struct WpPresentationFeedback(_);

Implementations

impl WpPresentationFeedback

pub fn sync_output(&self, output: &WlOutput)

presentation synchronized to this output

As presentation can be synchronized to only one output at a time, this event tells which output it was. This event is only sent prior to the presented event.

As clients may bind to the same global wl_output multiple times, this event is sent for each bound instance that matches the synchronized output. If a client has not bound to the right wl_output global at all, this event is not sent.

pub fn presented(
    &self,
    tv_sec_hi: u32,
    tv_sec_lo: u32,
    tv_nsec: u32,
    refresh: u32,
    seq_hi: u32,
    seq_lo: u32,
    flags: Kind
)

the content update was displayed

The associated content update was displayed to the user at the indicated time (tv_sec_hi/lo, tv_nsec). For the interpretation of the timestamp, see presentation.clock_id event.

The timestamp corresponds to the time when the content update turned into light the first time on the surface’s main output. Compositors may approximate this from the framebuffer flip completion events from the system, and the latency of the physical display path if known.

This event is preceded by all related sync_output events telling which output’s refresh cycle the feedback corresponds to, i.e. the main output for the surface. Compositors are recommended to choose the output containing the largest part of the wl_surface, or keeping the output they previously chose. Having a stable presentation output association helps clients predict future output refreshes (vblank).

The ‘refresh’ argument gives the compositor’s prediction of how many nanoseconds after tv_sec, tv_nsec the very next output refresh may occur. This is to further aid clients in predicting future refreshes, i.e., estimating the timestamps targeting the next few vblanks. If such prediction cannot usefully be done, the argument is zero.

If the output does not have a constant refresh rate, explicit video mode switches excluded, then the refresh argument must be zero.

The 64-bit value combined from seq_hi and seq_lo is the value of the output’s vertical retrace counter when the content update was first scanned out to the display. This value must be compatible with the definition of MSC in GLX_OML_sync_control specification. Note, that if the display path has a non-zero latency, the time instant specified by this counter may differ from the timestamp’s.

If the output does not have a concept of vertical retrace or a refresh cycle, or the output device is self-refreshing without a way to query the refresh count, then the arguments seq_hi and seq_lo must be zero.

pub fn discarded(&self)

the content update was not displayed

The content update was never displayed to the user.

Trait Implementations

impl AsRef<Resource<WpPresentationFeedback>> for WpPresentationFeedback

fn as_ref(&self) -> &Resource<Self>

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for WpPresentationFeedback

fn clone(&self) -> WpPresentationFeedback

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for WpPresentationFeedback

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<Resource<WpPresentationFeedback>> for WpPresentationFeedback

fn from(value: Resource<Self>) -> Self

Converts to this type from the input type.

impl From<WpPresentationFeedback> for Resource<WpPresentationFeedback>

fn from(value: WpPresentationFeedback) -> Self

Converts to this type from the input type.

impl Interface for WpPresentationFeedback

type Request = Request

Set of requests associated to this interface

type Event = Event

Set of events associated to this interface

const NAME: &'static str = "wp_presentation_feedback"

Name of this interface

const VERSION: u32 = 1u32

Maximum supported version of this interface

fn c_interface() -> *const wl_interface

Pointer to the C representation of this interface

impl PartialEq<WpPresentationFeedback> for WpPresentationFeedback

fn eq(&self, other: &WpPresentationFeedback) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for WpPresentationFeedback

impl StructuralEq for WpPresentationFeedback

impl StructuralPartialEq for WpPresentationFeedback