Struct runa_wayland_protocols::stable::presentation_time::wp_presentation_feedback::v1::events::Presented

pub struct Presented {
    pub tv_sec_hi: u32,
    pub tv_sec_lo: u32,
    pub tv_nsec: u32,
    pub refresh: u32,
    pub seq_hi: u32,
    pub seq_lo: u32,
    pub 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.

Fields

tv_sec_hi: u32

tv_sec_lo: u32

tv_nsec: u32

refresh: u32

seq_hi: u32

seq_lo: u32

flags: Kind

Implementations

impl Presented

pub const OPCODE: u16 = 1u16

Trait Implementations

impl Clone for Presented

fn clone(&self) -> Presented

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Presented

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

Formats the value using the given formatter.

impl<'a> Deserialize<'a> for Presented

fn deserialize(data: &'a [u8], fds: &'a [RawFd]) -> Result<Self, Error>

Deserialize from the given buffer. Returns deserialized message, and number of bytes and file descriptors consumed, respectively.

impl PartialEq<Presented> for Presented

fn eq(&self, other: &Presented) -> 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 Serialize for Presented

fn serialize<Fds: Extend<OwnedFd>>(self, buf: &mut BytesMut, fds: &mut Fds)

Serialize into the buffered writer. This function returns no errors, failures in seializing are generally program errors, and triggers panicking.

fn len(&self) -> u16

How many bytes will this message serialize to. Including the 8 byte header.

fn nfds(&self) -> u8

How many file descriptors will this message serialize to.

impl Copy for Presented

impl Eq for Presented

impl StructuralEq for Presented

impl StructuralPartialEq for Presented