Skip to main content

CoalescedSample

Struct CoalescedSample 

Source
#[non_exhaustive]
pub struct CoalescedSample { pub time: EventTime, pub window_position: Point, pub axes: PointerAxes, }
Expand description

One position the OS batched into a packet, with the axes it was sampled at and its own time.

A backend that reports a batch — a digitizer whose packets arrive faster than the window’s message rate, a platform with an explicit coalescing API — hands over one PointerSample per packet with the intermediate positions in PointerSample::coalesced. The alternative, one whole tree dispatch per digitizer packet, costs a hit test, an arbitration turn and a handler walk for a position no one had a chance to draw between.

Consumers see these through EventContext::coalesced. A drawing surface fans out over them and then over the sample’s own position; a velocity tracker integrates them; everything else ignores them, which costs nothing because the list is empty for every producer that does not batch.

§Coordinates

window_position is window-logical, exactly like PointerSample::position and WidgetEvent::Scroll’s window_position, and is named for it. The router localises the event’s position against the captor’s current bounds; a batch has no single widget to localise against, and a handler that needs widget-local coordinates converts at the use site — a SceneView does it through SceneView::view_transform_signal.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§time: EventTime

When the device produced this position, on the tree’s timeline.

§window_position: Point

Where, in window-logical coordinates. See the type’s docs.

§axes: PointerAxes

The continuous axes as they read at this position — a digitizer varies pressure and tilt within a batch, and that variation is the whole reason to keep the intermediate samples rather than the endpoints.

Implementations§

Source§

impl CoalescedSample

Source

pub fn new(time: EventTime, window_position: Point) -> Self

One batched position. Axes default to “reported nothing”; set them with with_axes.

Source

pub fn with_axes(self, axes: PointerAxes) -> Self

This position with its axes recorded.

Trait Implementations§

Source§

impl Clone for CoalescedSample

Source§

fn clone(&self) -> Self

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 CoalescedSample

Source§

impl Debug for CoalescedSample

Source§

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

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

impl PartialEq for CoalescedSample

Source§

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

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

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for CoalescedSample

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, 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.