Skip to main content

EventTime

Struct EventTime 

Source
pub struct EventTime(/* private fields */);
Expand description

When an input event happened, on the engine’s monotonic clock.

§The epoch is the contract

A timestamp whose origin is unspecified is worth nothing: you cannot subtract two of them across subsystems, and you cannot compare one to “now”. So this type states its epoch and makes matching it a backend obligation:

An EventTime is a duration measured from the same origin as the TimeSource driving FrameClock::update — that is, from MonotonicTime::new (process start) in a real run, and from ManualTime’s zero in a deterministic one.

That makes event.time and clock.render_dt() live on one timeline, which is what the P2 input pipeline needs to age an input against the tick it belongs to, and what topic 26’s client prediction needs to compute input-to-photon latency.

§What backends have to do about it

No window system hands us this directly, so rebasing is part of writing a backend, not an optimization:

  • Wayland stamps events with CLOCK_MONOTONIC milliseconds (microseconds under wp_presentation and the high-resolution input protocols). Subtract the clock reading taken when the shell was created.
  • X11 stamps events with the X server’s time: a 32-bit millisecond counter with an unspecified origin that wraps every 49.7 days. The backend estimates the offset once at connection time and must detect the wrap; a backend that forwards the raw value produces an input pipeline that silently breaks after a month and a half of uptime.
  • Win32 has GetMessageTime (a GetTickCount sample, also wrapping) and raw input’s QPC timestamps.
  • The browser gives event.timeStamp, already a performance.now()-relative double.

When a backend genuinely has no timestamp for an event — a synthesized focus-loss key release, for instance — it stamps the event with the current time rather than EventTime::ZERO, because a zero timestamp reads as “this happened at process start” to every consumer downstream.

Implementations§

Source§

impl EventTime

Source

pub const ZERO: EventTime

The clock’s origin.

Source

pub const fn from_duration(since_epoch: Duration) -> EventTime

Wraps a duration measured from the epoch described in the type docs.

Source

pub const fn from_micros(micros: u64) -> EventTime

Microseconds since the epoch — the unit Wayland’s high-resolution input protocols and libinput both use.

Source

pub const fn from_millis(millis: u64) -> EventTime

Milliseconds since the epoch — the unit core Wayland and X11 use.

Source

pub const fn as_duration(self) -> Duration

Time since the epoch.

Source

pub fn as_secs_f64(self) -> f64

Time since the epoch in seconds.

Source

pub fn saturating_since(self, earlier: EventTime) -> Duration

How long after earlier this timestamp is, saturating at zero.

Saturating rather than panicking because event queues are not perfectly ordered in practice — a compositor can deliver a relative-motion event stamped fractionally before the absolute-motion event it accompanies — and an input pipeline must not die of it.

Source

pub const fn saturating_add(self, delta: Duration) -> EventTime

This timestamp moved forward by delta.

Trait Implementations§

Source§

impl Clone for EventTime

Source§

fn clone(&self) -> EventTime

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for EventTime

Source§

impl Debug for EventTime

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for EventTime

Source§

fn default() -> EventTime

Returns the “default value” for a type. Read more
Source§

impl Display for EventTime

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for EventTime

Source§

impl From<Duration> for EventTime

Source§

fn from(since_epoch: Duration) -> EventTime

Converts to this type from the input type.
Source§

impl Hash for EventTime

Source§

fn hash<__H>(&self, state: &mut __H)
where __H: Hasher,

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl Ord for EventTime

Source§

fn cmp(&self, other: &EventTime) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 (const: unstable) · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 (const: unstable) · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 (const: unstable) · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
Source§

fn clamp_to<R>(self, range: R) -> Self
where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)
Restrict a value to a certain range. Read more
Source§

impl PartialEq for EventTime

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl PartialOrd for EventTime

Source§

fn partial_cmp(&self, other: &EventTime) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl StructuralPartialEq for EventTime

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.