Struct pix_engine::engine::PixEngine

pub struct PixEngine { /* private fields */ }

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

Implementations

impl PixEngine

pub fn builder() -> Builder

Constructs a default Builder which can build a PixEngine instance.

See Builder for examples.

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

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

Errors

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

Example

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

Trait Implementations

impl Debug for PixEngine

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

Formats the value using the given formatter.