Struct SchedulerHandle 

pub struct SchedulerHandle { /* private fields */ }

A handle to a running scheduler, allowing the caller to stop it later.

Implementations

impl SchedulerHandle

Implements lifecycle management for SchedulerHandle.

pub fn stop(&self)

Stops the scheduler and cancels any pending animation frame request.

pub fn is_running(&self) -> bool

Returns whether the scheduler is currently running.

Returns

• bool - True if the scheduler is running.

pub fn update_count(&self) -> u64

Returns the total number of fixed update steps executed.

Returns

• u64 - The update count.

pub fn frame_count(&self) -> u64

Returns the total number of render frames executed.

Returns

• u64 - The frame count.

pub fn register_task<T>(registry: &TaskRegistryRc, task: T) -> TaskHandle

where T: Updatable + 'static,

Registers a task to be advanced on every fixed step.

The task is driven by SchedulerState::tick immediately after the handler’s on_update callback, using the same SchedulerConfig::get_fixed_timestep delta.

Arguments

• &TaskRegistryRc - The registry to add the task to.
• T - The updater to register. Must implement Updatable.

Returns

• TaskHandle - A handle used to unregister the task.

pub fn start( config: SchedulerConfig, handler: TickHandlerRc, tasks: Option<&TaskRegistryRc>, input_cell: Option<&InputStateCell>, ) -> SchedulerHandle

Starts the scheduler with the given configuration and handler.

Creates a requestAnimationFrame-driven loop that calls tick on each animation frame. The returned SchedulerHandle can be used to stop the scheduler.

When no global window exists (non-browser context), the scheduler is not started and an already-stopped handle is returned instead.

Arguments

• SchedulerConfig - The scheduler configuration.
• TickHandlerRc - The handler receiving update and render callbacks.
• Option<&TaskRegistryRc> - The task registry advanced on every fixed step, or None when no tasks are registered.
• Option<&InputStateCell> - The shared input state whose per-frame edge state is cleared at the end of every frame, or None when input listeners are not registered.

Returns

• SchedulerHandle - A handle to control the running scheduler.

impl SchedulerHandle

pub fn get_state(&self) -> &Rc<EngineCell<SchedulerState>>

pub fn get_closure_cell(&self) -> &RafClosureCell

impl SchedulerHandle

pub fn new( state: Rc<EngineCell<SchedulerState>>, closure_cell: RafClosureCell, ) -> Self

Trait Implementations

impl Clone for SchedulerHandle

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.