Struct tetra::Context

pub struct Context { /* fields omitted */ }

A struct containing all of the 'global' state within the framework.

Implementations

impl Context

pub fn run<S, F>(&mut self, init: F) -> Result where
    S: State,
    F: FnOnce(&mut Context) -> Result<S>, 

Runs the game.

The init parameter takes a function or closure that creates a State implementation. A common pattern is to use method references to pass in your state's constructor directly - see the example below for how this works.

Errors

If the State returns an error from update or draw, the game will stop running and this method will return the error.

Examples

use tetra::{Context, ContextBuilder, State};

struct GameState;

impl GameState {
    fn new(ctx: &mut Context) -> tetra::Result<GameState> {
        Ok(GameState)
    }
}

impl State for GameState { }

fn main() -> tetra::Result {
    // Because the signature of GameState::new is
    // (&mut Context) -> tetra::Result<GameState>, you can pass it
    // into run directly.
    ContextBuilder::new("Hello, world!", 1280, 720)
        .build()?
        .run(GameState::new)
}