Struct pix_engine::engine::Engine

pub struct Engine { /* private fields */ }

The core engine that maintains the render loop, state, drawing functions, event handling, etc.

Implementations

impl Engine

pub fn builder() -> EngineBuilder

Constructs a default EngineBuilder which can build a Engine instance.

See EngineBuilder for examples.

pub fn run<A>(&mut self, app: &mut A) -> PixResult<()>where
    A: PixEngine,

Starts the Engine application and begins executing the frame loop on a given application which must implement Engine. The only required method of which is [Engine::on_update].

Errors

Any error in the entire library can propagate here and terminate the program. See the error module for details. Also see [Engine::on_stop].

Example

fn main() -> PixResult<()> {
    let mut engine = Engine::builder().build()?;
    let mut app = MyApp::new(); // MyApp implements `Engine`
    engine.run(&mut app)
}

Trait Implementations

impl Debug for Engine

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

Formats the value using the given formatter.