Struct Game 

pub struct Game { /* private fields */ }

The game builder. Configure your game and run it.

Example

use game_gem::prelude::*;

struct MyGame;
impl GameState for MyGame {
    fn update(&mut self, ctx: &mut Context) {
        if ctx.input.keyboard.is_pressed(KeyCode::Escape) { ctx.quit(); }
    }
    fn render(&mut self, ctx: &mut Context) {
        ctx.graphics.clear(Color::BLACK);
    }
}

fn main() {
    Game::new()
        .window_title("Hello game-gem!")
        .window_size(1024, 768)
        .clear_color(Color::from_hex("#1A1A2E").unwrap())
        .target_fps(60)
        .run(MyGame);
}

Implementations

impl Game

pub fn new() -> Self

Create a new game with default configuration.

Examples found in repository

examples/scene_demo.rs (line 111)

fn main() {
    let example = SceneDemo {
        scenes: SceneManager::new(),
    };

    Game::new()
        .window_title("game-gem: Scene Demo")
        .window_size(800, 600)
        .run(example);
}

examples/particles.rs (line 107)

fn main() {
    let example = ParticlesExample {
        emitters: Vec::new(),
    };

    Game::new()
        .window_title("game-gem: Particles Example")
        .window_size(800, 600)
        .clear_color(Color::from_hex("#0A0A1A").unwrap())
        .run(example);
}

examples/basics.rs (line 154)

fn main() {
    let example = BasicsExample {
        ball: BouncingBall::new(),
        hue: 0.0,
        click_count: 0,
    };

    Game::new()
        .window_title("game-gem: Basics Example")
        .window_size(800, 600)
        .clear_color(Color::from_hex("#0F0F23").unwrap())
        .run(example);
}

pub fn window_title(self, title: &str) -> Self

Set the window title.

Examples found in repository

examples/scene_demo.rs (line 112)

fn main() {
    let example = SceneDemo {
        scenes: SceneManager::new(),
    };

    Game::new()
        .window_title("game-gem: Scene Demo")
        .window_size(800, 600)
        .run(example);
}

examples/particles.rs (line 108)

fn main() {
    let example = ParticlesExample {
        emitters: Vec::new(),
    };

    Game::new()
        .window_title("game-gem: Particles Example")
        .window_size(800, 600)
        .clear_color(Color::from_hex("#0A0A1A").unwrap())
        .run(example);
}

examples/basics.rs (line 155)

fn main() {
    let example = BasicsExample {
        ball: BouncingBall::new(),
        hue: 0.0,
        click_count: 0,
    };

    Game::new()
        .window_title("game-gem: Basics Example")
        .window_size(800, 600)
        .clear_color(Color::from_hex("#0F0F23").unwrap())
        .run(example);
}

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

Set the window size in pixels.

Examples found in repository

examples/scene_demo.rs (line 113)

fn main() {
    let example = SceneDemo {
        scenes: SceneManager::new(),
    };

    Game::new()
        .window_title("game-gem: Scene Demo")
        .window_size(800, 600)
        .run(example);
}

examples/particles.rs (line 109)

fn main() {
    let example = ParticlesExample {
        emitters: Vec::new(),
    };

    Game::new()
        .window_title("game-gem: Particles Example")
        .window_size(800, 600)
        .clear_color(Color::from_hex("#0A0A1A").unwrap())
        .run(example);
}

examples/basics.rs (line 156)

fn main() {
    let example = BasicsExample {
        ball: BouncingBall::new(),
        hue: 0.0,
        click_count: 0,
    };

    Game::new()
        .window_title("game-gem: Basics Example")
        .window_size(800, 600)
        .clear_color(Color::from_hex("#0F0F23").unwrap())
        .run(example);
}

pub fn resizable(self, resizable: bool) -> Self

Set whether the window is resizable.

pub fn fullscreen(self, fullscreen: bool) -> Self

Set whether to start in fullscreen.

pub fn vsync(self, vsync: bool) -> Self

Set whether to enable vsync.

pub fn msaa(self, samples: u32) -> Self

Set MSAA samples (0 = disabled).

pub fn clear_color(self, color: Color) -> Self

Set the clear/background color.

Examples found in repository

examples/particles.rs (line 110)

fn main() {
    let example = ParticlesExample {
        emitters: Vec::new(),
    };

    Game::new()
        .window_title("game-gem: Particles Example")
        .window_size(800, 600)
        .clear_color(Color::from_hex("#0A0A1A").unwrap())
        .run(example);
}

examples/basics.rs (line 157)

fn main() {
    let example = BasicsExample {
        ball: BouncingBall::new(),
        hue: 0.0,
        click_count: 0,
    };

    Game::new()
        .window_title("game-gem: Basics Example")
        .window_size(800, 600)
        .clear_color(Color::from_hex("#0F0F23").unwrap())
        .run(example);
}

pub fn target_fps(self, fps: u32) -> Self

Set target FPS cap (0 = unlimited).

pub fn min_size(self, w: u32, h: u32) -> Self

Set minimum window size.

pub fn icon(self, path: &str) -> Self

Set the window icon from a file path.

pub fn run<S: GameState>(self, state: S)

Run the game with the given game state.

This is the main entry point. It creates the window, initializes the context, and runs the game loop until the game exits.

Examples found in repository

examples/scene_demo.rs (line 114)

fn main() {
    let example = SceneDemo {
        scenes: SceneManager::new(),
    };

    Game::new()
        .window_title("game-gem: Scene Demo")
        .window_size(800, 600)
        .run(example);
}

examples/particles.rs (line 111)

fn main() {
    let example = ParticlesExample {
        emitters: Vec::new(),
    };

    Game::new()
        .window_title("game-gem: Particles Example")
        .window_size(800, 600)
        .clear_color(Color::from_hex("#0A0A1A").unwrap())
        .run(example);
}

examples/basics.rs (line 158)

fn main() {
    let example = BasicsExample {
        ball: BouncingBall::new(),
        hue: 0.0,
        click_count: 0,
    };

    Game::new()
        .window_title("game-gem: Basics Example")
        .window_size(800, 600)
        .clear_color(Color::from_hex("#0F0F23").unwrap())
        .run(example);
}

Trait Implementations

impl Default for Game

fn default() -> Self

Returns the “default value” for a type.