Skip to main content

EngineHandle

Struct EngineHandle 

Source
pub struct EngineHandle { /* private fields */ }
Expand description

A handle to a running or initialized engine instance.

Holds the engine configuration, an optional Canvas 2D renderer, an optional WebGPU renderer, and the optional scheduler handle once the game loop has started. Use Engine::new_handle to construct one, then call init_canvas or init_webgpu (matching the backend chosen in RenderConfig) and finally start to begin the game loop.

Implementations§

Source§

impl EngineHandle

Implements lifecycle management for EngineHandle.

All getter methods (get_config, get_canvas_renderer, get_webgpu_renderer) are generated by the Data derive on the struct definition; this impl only contributes lifecycle and accessor behavior that is not expressible as a plain getter.

Source

pub fn init_canvas(&mut self) -> bool

Initializes the Canvas 2D rendering backend.

On success, populates canvas_renderer and clears webgpu_renderer. On failure, both renderer fields remain None.

§Returns
  • bool - true if the renderer was created successfully.
Source

pub async fn init_webgpu(&mut self) -> Result<WebGpuRenderer, WebGpuInitError>

Initializes the WebGPU rendering backend.

On success, populates webgpu_renderer and clears canvas_renderer. On failure, both renderer fields remain None and the typed error is returned so the caller can decide how to surface it (typically via Console::error).

§Returns
  • Result<WebGpuRenderer, WebGpuInitError> - The initialized renderer, or a typed error describing the specific failure.
Source

pub fn start(&mut self, handler: TickHandlerRc)

Starts the game loop with the given tick handler.

The scheduler configuration from EngineConfig controls the fixed timestep and maximum frame time. The scheduler handle is stored internally and can be stopped via stop.

§Arguments
  • TickHandlerRc - The tick handler receiving update and render callbacks.
Source

pub fn stop(&self)

Stops the game loop and cancels any pending animation frame request.

Source

pub fn is_running(&self) -> bool

Returns whether the game loop is currently running.

§Returns
  • bool - true if the scheduler is running.
Source§

impl EngineHandle

Source§

impl EngineHandle

Source

pub fn new( config: EngineConfig, canvas_renderer: Option<CanvasRenderer>, webgpu_renderer: Option<WebGpuRenderer>, scheduler_handle: Option<SchedulerHandle>, ) -> Self

Trait Implementations§

Source§

impl Clone for EngineHandle

Source§

fn clone(&self) -> EngineHandle

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

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 = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.
Source§

impl<S, T> Upcast<T> for S
where T: UpcastFrom<S> + ?Sized, S: ?Sized,

Source§

fn upcast(&self) -> &T
where Self: ErasableGeneric, T: Sized + ErasableGeneric<Repr = Self::Repr>,

Perform a zero-cost type-safe upcast to a wider ref type within the Wasm bindgen generics type system. Read more
Source§

fn upcast_into(self) -> T
where Self: Sized + ErasableGeneric, T: Sized + ErasableGeneric<Repr = Self::Repr>,

Perform a zero-cost type-safe upcast to a wider type within the Wasm bindgen generics type system. Read more