Skip to main content

OverlayEventKind

Enum OverlayEventKind 

Source
pub enum OverlayEventKind {
    Pointer(PointerEvent),
    Scroll {
        position: Point,
        delta: ScrollDelta,
    },
    Scale {
        focal: Point,
        phase: ScalePhase,
        scale_delta: f64,
        velocity: f64,
    },
    OutsideDown,
}
Expand description

The input an OverlayEvent delivers.

§Window space, not local space

Every position here is absolute logical window space, deliberately: the broadcast reaches the owner by travelling the main tree, so the translation chain it passes through on the way (ChildPod::event_child subtracting each container’s origin) describes the owner’s position, not the floated pod’s. Translating the payload would therefore corrupt it. The owner instead subtracts its own registered window_rect origin before forwarding into the pod, which is the only offset that means anything — which is also why InputEvent::translated returns an overlay event unchanged.

Variants§

§

Pointer(PointerEvent)

A pointer event inside the surface’s rect, positioned in window space.

§

Scroll

A scroll inside the surface’s rect, positioned in window space.

Fields

§position: Point

Where the scroll occurred, in absolute window space.

§delta: ScrollDelta

How much to scroll.

§

Scale

A scale gesture inside the surface’s rect, focal point in window space — the overlay mirror of InputEvent::Scale, routed here on exactly the same hit-test terms as Scroll.

Fields

§focal: Point

Where the gesture is centered, in absolute window space.

§phase: ScalePhase

The gesture phase.

§scale_delta: f64

The multiplicative scale change this event represents.

§velocity: f64

The gesture’s current rate of scale change, per second.

§

OutsideDown

A primary press landed outside every registered surface — the light-dismiss notification, delivered only to entries registered OutsideTap::Notify. It carries no position: where the press landed is the main tree’s business, and an owner that wants it can register consume: false and watch the press arrive there normally.

Trait Implementations§

Source§

impl Clone for OverlayEventKind

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 Debug for OverlayEventKind

Source§

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

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

impl PartialEq for OverlayEventKind

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 OverlayEventKind

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> StorageAccess<T> for T

Source§

fn as_borrowed(&self) -> &T

Borrows the value.
Source§

fn into_taken(self) -> T

Takes the value.
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.