Struct FrameCause 

pub struct FrameCause(/* private fields */);

Why a frame was drawn: every reason that reached the window between the start of the last frame and the start of this one. Read from a view as Core::frame_cause. A set, because a frame answers everything that asked since the last one — a keystroke and the caret’s blink, a wheel and the transition it started.

Empty is a frame nobody here asked for: the platform’s own redraw (an expose, a live resize the OS paints through), or a driver that notes nothing.

Implementations

impl FrameCause

pub const NONE: FrameCause

Nothing recorded.

pub const POINTER_MOVE: FrameCause

The pointer moved over the window.

pub const POINTER_LEAVE: FrameCause

The pointer left the window.

pub const BUTTON: FrameCause

A mouse button went down or up, or a force click.

pub const WHEEL: FrameCause

A wheel or a trackpad scroll — a swipe’s momentum included, which the platform sends as scrolls after the hand has left.

pub const KEY: FrameCause

A key went down or up.

pub const MODIFIERS: FrameCause

The modifier keys changed.

pub const TEXT: FrameCause

Text arrived: typed, committed by an input method, or pasted.

pub const PREEDIT: FrameCause

An input method’s composition changed.

pub const ACCESS: FrameCause

Assistive technology asked for an action.

pub const FILE_DRAG: FrameCause

Files dragged over the window, dropped on it, or taken away.

pub const FILES: FrameCause

A file dialog answered, or the OS handed the app documents to open (InputEvent::Open, backlog F124).

pub const FIRST: FrameCause

The window’s first frame.

pub const WAKE: FrameCause

The app woke the loop from another thread (a Waker).

pub const HOST: FrameCause

The host asked for a frame: a pumped runner’s request_redraw, a new view handed over.

pub const RESIZE: FrameCause

The window changed size.

pub const SCALE: FrameCause

The window moved to a display of another scale.

pub const FOCUS: FrameCause

The window gained or lost the keyboard.

pub const OCCLUSION: FrameCause

The window was uncovered, or came back from minimized. The runner leaves out of that frame what it noted while the window could not draw and no frame took — another window’s input, an appearance change — so a restore does not report reasons from long before; resize is the same edge on Windows, where restoring is a resize.

pub const APPEARANCE: FrameCause

The system’s appearance or settings changed: light or dark, the accent, reduced motion, assistive technology coming or going, a font installed or removed.

pub const CARET: FrameCause

The caret’s blink changed phase.

pub const RETRY: FrameCause

The last frame’s surface refused it (skipped, out of date, misconfigured) and the frame is tried again.

pub const OVERDUE: FrameCause

A frame held for the display waited too long and is drawn anyway.

pub const DEVICE: FrameCause

The graphics device was reopened.

pub const AFTER_FRAME: FrameCause

The last frame’s own events — a resize, what a new layout put under a still pointer — were routed after it, and answered.

pub const ELSEWHERE: FrameCause

Something that reached the app in another window, which can change what this one shows.

pub const MENU: FrameCause

A menu (the platform’s context menu or menu bar) was answered.

pub const AUDIO: FrameCause

A sound finished or was refused, and its event was routed.

pub const SMOKE: FrameCause

A smoke run’s frame counter asked for the next frame.

pub const OWED: FrameCause

The last frame left one owed (Core::owed); Core::owed_by says who, when traced.

pub const ALL: [(FrameCause, &'static str); 29]

Each reason and its name, in bit order.

pub const fn bits(self) -> u32

The bits, for a binding or a log.

pub const fn from_bits(bits: u32) -> FrameCause

The set these bits spell; bits no reason has are dropped.

pub const fn is_empty(self) -> bool

pub const fn contains(self, other: FrameCause) -> bool

Whether every reason in other is in this set.

pub const fn intersects(self, other: FrameCause) -> bool

Whether any reason in other is in this set.

pub const fn union(self, other: FrameCause) -> FrameCause

pub fn names(self) -> impl Iterator<Item = &'static str>

The names of the reasons in the set, in bit order.

pub fn of_input(ev: &InputEvent) -> FrameCause

The reason one input is: what Core::handle_input records, and what a driver that screens input before the core sees it can note for an event it keeps.

Trait Implementations

impl BitOr for FrameCause

type Output = FrameCause

The resulting type after applying the | operator.

fn bitor(self, rhs: FrameCause) -> FrameCause

Performs the | operation.

impl BitOrAssign for FrameCause

fn bitor_assign(&mut self, rhs: FrameCause)

Performs the |= operation.

impl Clone for FrameCause

fn clone(&self) -> FrameCause

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for FrameCause

impl Debug for FrameCause

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

FrameCause(key|caret), FrameCause() when empty.

impl Default for FrameCause

fn default() -> FrameCause

Returns the “default value” for a type.

impl Eq for FrameCause

impl Hash for FrameCause

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

where __H: Hasher,

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for FrameCause

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for FrameCause