Struct Engine

pub struct Engine<'a> {
    pub show_fps: bool,
    /* private fields */
}

The main game engine, which manages the display and input.

Fields

show_fps: bool

Whether the FPS should be calculated and displayed in the titlebar of the window.

Implementations

impl<'a> Engine<'a>

pub fn new( app: &'a mut dyn Application, title: &'a str, width: u32, height: u32, ) -> Result<Engine<'a>, String>

Create a new engine.

Parameters

• app: Defines the application’s logic.
• title: Title of the window.
• width: Width (in pixels) of the window.
• height: Height (in pixels) of the window.

Example

use simple_game_engine::Engine;
let mut app = App {}; // Some `Application` implementation
let engine = Engine::new(&mut app, "Window Title", 640, 480)?;

Examples found in repository

examples/colour_cycle.rs (line 58)

fn main() -> Result<(), Box<dyn Error>> {
    let mut app = App::new();
    let mut engine = sge::Engine::new(&mut app, "Test App", SCREEN_WIDTH, SCREEN_HEIGHT)?;
    engine.start(false)
}

examples/moving_circle.rs (line 57)

fn main() -> Result<(), Box<dyn Error>> {
    let mut app = App::new();
    let mut engine = sge::Engine::new(&mut app, "Test App", SCREEN_WIDTH, SCREEN_HEIGHT)?;
    engine.start(false)
}

examples/moving_rect.rs (line 62)

fn main() -> Result<(), Box<dyn Error>> {
    let mut app = App::new();
    let mut engine = sge::Engine::new(&mut app, "Test App", SCREEN_WIDTH, SCREEN_HEIGHT)?;
    engine.start(false)
}

pub fn start(&mut self, present_vsync: bool) -> Result<(), Box<dyn Error>>

Create and show the window and start the main event loop.

Parameters

• present_vsync: Whether to limit the frame rate of the application to the frame rate of the display.

Example

use simple_game_engine::Engine;
let mut app = App {}; // Some `Application` implementation
let mut engine = Engine::new(&mut app, "Window Title", 640, 480)?;
engine.start(true)?; // Starts with vsync enabled

Examples found in repository

examples/colour_cycle.rs (line 59)

fn main() -> Result<(), Box<dyn Error>> {
    let mut app = App::new();
    let mut engine = sge::Engine::new(&mut app, "Test App", SCREEN_WIDTH, SCREEN_HEIGHT)?;
    engine.start(false)
}

examples/moving_circle.rs (line 58)

fn main() -> Result<(), Box<dyn Error>> {
    let mut app = App::new();
    let mut engine = sge::Engine::new(&mut app, "Test App", SCREEN_WIDTH, SCREEN_HEIGHT)?;
    engine.start(false)
}

examples/moving_rect.rs (line 63)

fn main() -> Result<(), Box<dyn Error>> {
    let mut app = App::new();
    let mut engine = sge::Engine::new(&mut app, "Test App", SCREEN_WIDTH, SCREEN_HEIGHT)?;
    engine.start(false)
}