Struct Runtime 

pub struct Runtime { /* private fields */ }

Owns the state cells, UI tasks, frame callbacks and invalidated scopes of one composition. Clones share the same runtime.

Implementations

impl Runtime

pub fn new(scheduler: SchedulerRef) -> Self

Creates a runtime whose UI thread is the current thread. scheduler is asked for a frame whenever the runtime has work.

pub fn handle(&self) -> RuntimeHandle

Returns a handle that reaches this runtime without keeping it alive.

pub fn has_updates(&self) -> bool

Returns true if node updates are queued or any recompose scope is invalid.

pub fn needs_frame(&self) -> bool

Returns true if the runtime has asked for a frame or has a task ready to run.

pub fn set_needs_frame(&self, value: bool)

Sets or clears the request for a frame.

pub fn has_pending_ui(&self) -> bool

Returns true if posted UI work has not run yet. The owner of a runtime asks it here; a RuntimeHandle costs a clone of its parts.

pub fn has_invalid_scopes(&self) -> bool

Returns true if any recompose scope is invalid.

pub fn has_frame_callbacks(&self) -> bool

Returns true if any frame callback is registered.

pub fn has_transient_frame_callbacks(&self) -> bool

Returns true while a one-shot frame callback waits for the next frame. Perpetual frame callbacks do not count.

pub fn drain_frame_callbacks(&self, frame_time_nanos: u64)

Runs the frame callbacks due at frame_time_nanos.

pub fn last_frame_time_nanos(&self) -> Option<u64>

Animation-clock time of the most recent frame-callback drain. This is the same clock Animatables advance on (virtual under robot exact captures), so per-frame integrators derive dt from it instead of wall time.

pub fn frame_clock(&self) -> FrameClock

Returns a clock for the frames of this runtime.

Trait Implementations

impl Clone for Runtime

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Drop for Runtime

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.