Struct Game

pub struct Game<State, Update> { /* private fields */ }

Tells the engine how to run a game.

This is returned by baba::game and you can modify settings with the available methods below.

Implementations

impl<State, Update: Fn(&mut State)> Game<State, Update>

pub fn scale_mode(self, scale_mode: ScaleMode) -> Self

Sets the default scaling for textures. Defaults to nearest scaling.

pub fn framerate(self, framerate: Framerate) -> Self

Sets the framerate limit. Defaults to 1x the display refresh rate.

pub fn vsync(self) -> Self

Enable vsync, reducing tearing at the cost of some latency.

pub fn viewport(self, viewport: Viewport) -> Self

Sets a viewport for the screen.

Examples found in repository

examples/soko.rs (line 5)

fn main() -> baba::Result {
    baba::game("SOKOBAN", Soko::update)
        .viewport(Viewport::new(32 * 7, 32 * 7))
        .run_with(Soko::new)
}

pub fn window_title(self, title: impl Into<String>) -> Self

Sets the window title. This defaults to the name given to game or run.

pub fn window_size(self, width: u32, height: u32) -> Self

Sets the window size. Defaults to 800x600.

pub fn settings(self, settings: Settings) -> Self

Set the engine settings.

This will override any other methods.

pub fn window(self, settings: WindowSettings) -> Self

Sets all window settings.

Overrides any other window_* methods.

pub fn run(self) -> Result

where State: Default,

Runs the game, using Default for the state.

pub fn run_with(self, init: impl FnOnce() -> State) -> Result

Runs the game, using a initializer function.

Examples found in repository

examples/soko.rs (line 6)

fn main() -> baba::Result {
    baba::game("SOKOBAN", Soko::update)
        .viewport(Viewport::new(32 * 7, 32 * 7))
        .run_with(Soko::new)
}