Struct Config 

pub struct Config { /* private fields */ }

Presentation settings for a game.

Implementations

impl Config

pub const DEFAULT_SIZE: UVec2

The window size used when none is set, in logical pixels.

pub const DEFAULT_TICK_INTERVAL: Duration

The simulation step used when none is set: a sixtieth of a second.

pub fn new(title: impl Into<String>) -> Self

A configuration with title and the engine’s other defaults.

Examples found in repository

examples/input-lab.rs (line 532)

fn main() {
    run(
        Config::new("Mirage: every control as an action"),
        InputLab::init,
    );
}

examples/stress-preview.rs (line 105)

fn main() {
    run(
        Config::new("Mirage: stress preview").with_size(1280, 720),
        StressPreview::init,
    );
}

examples/post-effects.rs (line 170)

fn main() {
    run(
        Config::new("Mirage: screen effects").with_size(1280, 720),
        PostEffectEffects::init,
    );
}

examples/sound-lab.rs (line 115)

fn main() {
    run(
        Config::new("Mirage: sound lab")
            .with_size(1280, 720)
            .with_assets(ASSET_FILES),
        SoundCheck::init,
    );
}

examples/flock-parallelism.rs (line 758)

fn main() {
    run(
        Config::new("Mirage: flock parallelism")
            .with_size(1280, 720)
            .with_assets([BUTTERFLY_SOURCE]),
        Flock::init,
    );
}

examples/breakout-game.rs (line 159)

fn main() {
    run(
        Config::new("Mirage: breakout game")
            .with_size(1280, 720)
            .with_assets([MODEL].into_iter().chain(SOUNDS)),
        Breakout::init,
    );
}

Additional examples can be found in:

• examples/animation.rs
• examples/isometric-board.rs
• examples/ui-fonts.rs
• examples/material-playground.rs
• examples/sprite-adventure.rs

pub fn with_assets( self, sources: impl IntoIterator<Item = impl Into<String>>, ) -> Self

Loads these sources before the game starts, into the Assets its meshes build from.

Sources are file paths on the desktop, relative to the working directory the game runs in, and URLs relative to the page in the browser. Anything that fails to load, decode, or match a cataloged mesh’s slots stops startup with an error.

Examples found in repository

examples/sound-lab.rs (line 117)

fn main() {
    run(
        Config::new("Mirage: sound lab")
            .with_size(1280, 720)
            .with_assets(ASSET_FILES),
        SoundCheck::init,
    );
}

examples/flock-parallelism.rs (line 760)

fn main() {
    run(
        Config::new("Mirage: flock parallelism")
            .with_size(1280, 720)
            .with_assets([BUTTERFLY_SOURCE]),
        Flock::init,
    );
}

examples/breakout-game.rs (line 161)

fn main() {
    run(
        Config::new("Mirage: breakout game")
            .with_size(1280, 720)
            .with_assets([MODEL].into_iter().chain(SOUNDS)),
        Breakout::init,
    );
}

examples/animation.rs (line 1048)

fn main() {
    run(
        Config::new("Mirage: animation")
            .with_size(WINDOW_WIDTH, WINDOW_HEIGHT)
            .with_assets([ELF_SOURCE, BUTTERFLY_SOURCE]),
        Scene::init,
    );
}

examples/isometric-board.rs (line 172)

fn main() {
    run(
        Config::new("Mirage: isometric board")
            .with_size(1280, 720)
            .with_assets([SPRITE_SOURCE, CLICK_SOURCE])
            .with_tick_interval(TICK_INTERVAL),
        Board::init,
    );
}

examples/ui-fonts.rs (lines 859-864)

fn main() {
    run(
        Config::new("Mirage: a game's own fonts")
            .with_size(1280, 720)
            .with_assets([
                "examples/assets/pixel-operator.ttf",
                "examples/assets/pixel-operator-mono.ttf",
                "examples/assets/ferrum.otf",
                "examples/assets/kenney-input-keyboard-mouse.ttf",
            ]),
        WatchRoom::init,
    );
}

Additional examples can be found in:

• examples/material-playground.rs
• examples/sprite-adventure.rs

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

Requests an initial window size in logical pixels.

The browser ignores it: the canvas fills the page, so the page sizes the game.

Examples found in repository

examples/stress-preview.rs (line 105)

fn main() {
    run(
        Config::new("Mirage: stress preview").with_size(1280, 720),
        StressPreview::init,
    );
}

examples/post-effects.rs (line 170)

fn main() {
    run(
        Config::new("Mirage: screen effects").with_size(1280, 720),
        PostEffectEffects::init,
    );
}

examples/sound-lab.rs (line 116)

fn main() {
    run(
        Config::new("Mirage: sound lab")
            .with_size(1280, 720)
            .with_assets(ASSET_FILES),
        SoundCheck::init,
    );
}

examples/flock-parallelism.rs (line 759)

fn main() {
    run(
        Config::new("Mirage: flock parallelism")
            .with_size(1280, 720)
            .with_assets([BUTTERFLY_SOURCE]),
        Flock::init,
    );
}

examples/breakout-game.rs (line 160)

fn main() {
    run(
        Config::new("Mirage: breakout game")
            .with_size(1280, 720)
            .with_assets([MODEL].into_iter().chain(SOUNDS)),
        Breakout::init,
    );
}

examples/animation.rs (line 1047)

fn main() {
    run(
        Config::new("Mirage: animation")
            .with_size(WINDOW_WIDTH, WINDOW_HEIGHT)
            .with_assets([ELF_SOURCE, BUTTERFLY_SOURCE]),
        Scene::init,
    );
}

Additional examples can be found in:

• examples/isometric-board.rs
• examples/ui-fonts.rs
• examples/material-playground.rs
• examples/sprite-adventure.rs

pub fn with_antialiasing(self, antialiasing: bool) -> Self

Draws edges smoothly, over four samples per pixel; on by default.

Off draws one sample per pixel, which is less work.

pub fn with_tonemap(self, tonemap: Tonemap) -> Self

Sets the curve the frame is drawn to the screen through; Tonemap::Neutral by default.

pub fn with_shadow_resolution(self, texels: u32) -> Self

Sets the side of the depth map a light flagged with Light::shadow draws into, in texels; 2048 by default.

Held within 256..=4096. A larger map has denser shadow edges and costs more memory; each of a point light’s six faces is half this side. The maps live in arrays that grow to the most a frame ever requested and never give it back — casting lights hold the most memory they ever took for the whole run.

pub fn with_mesh_memory(self, bytes: usize) -> Self

Sets the memory the engine keeps built mesh data in, in bytes; 256 MB by default.

Past it the engine drops the copies used least and builds them again when the game draws those meshes; a game whose meshes fit never builds one twice. It bounds the system memory the copies hold, not what the meshes take on the GPU. A mesh built through prepare is held like any other: past the cap it too can be dropped and built again.

pub fn with_tick_interval(self, interval: Duration) -> Self

Sets the simulated time one Game::tick covers, held to at least Duration::from_micros(1); Config::DEFAULT_TICK_INTERVAL by default.

Examples found in repository

examples/isometric-board.rs (line 173)

fn main() {
    run(
        Config::new("Mirage: isometric board")
            .with_size(1280, 720)
            .with_assets([SPRITE_SOURCE, CLICK_SOURCE])
            .with_tick_interval(TICK_INTERVAL),
        Board::init,
    );
}

pub fn with_double_click_interval(self, interval: Duration) -> Self

Sets how long after a press a second one still counts as a double click, which FrameContext::clicks counts by.

Without this the engine counts by what the desktop states, and by 400 milliseconds where the desktop states none; no browser states one. A windowless session counts by those 400 milliseconds until this sets another.

pub fn with_canvas_id(self, id: impl Into<String>) -> Self

Draws into the page’s <canvas> with this id, instead of the one the engine creates to fill the viewport.

Ignored outside the browser; startup fails if the page has no such canvas. A page of the game’s own carries data-mirage-worker="<the worker script>" on its <body> beside that canvas, naming the script every worker of the run is started on — the game thread and each worker of the pool; startup stops naming the attribute where the page carries none.

pub fn title(&self) -> &str

The window title.

pub fn size(&self) -> UVec2

The requested initial window size, in logical pixels.

pub fn tick_interval(&self) -> Duration

Simulated time one Game::tick covers.

pub fn canvas_id(&self) -> Option<&str>

The page canvas to draw into, if the game named one.

pub fn asset_sources(&self) -> &[String]

The asset sources loaded before the game starts, in load order.

pub fn antialiasing(&self) -> bool

Whether edges are drawn smoothly.

Examples found in repository

examples/material-playground.rs (line 1039)

    fn controls(&mut self, ctx: &mut FrameContext<'_, Self>) {
        let tonemap = ctx.config().tonemap();
        let antialiasing = ctx.config().antialiasing();
        let shadow_resolution = ctx.config().shadow_resolution();

        ctx.ui(|ui| {
            egui::Panel::right("controls")
                .resizable(false)
                .default_size(300.0)
                .show(ui, |ui| {
                    egui::ScrollArea::vertical().show(ui, |ui| {
                        ui.label(
                            "right mouse button to look, W/A/S/D to move, \
                             space/shift up and down, wheel to scale speed",
                        );
                        ui.separator();
                        self.lighting_controls(ui);
                        ui.separator();
                        self.light_controls(ui);
                        ui.separator();
                        self.material_controls(ui);
                        ui.separator();
                        ui.label(format!(
                            "tone map {tonemap:?} \u{b7} antialiasing {antialiasing} \u{b7} \
                             shadow {shadow_resolution}px: set at startup, not live"
                        ));
                        ui.add(egui::Slider::new(&mut self.exposure, 0.1..=3.0).text("exposure"));
                        ui.add(egui::Slider::new(&mut self.bloom, 0.0..=1.0).text("bloom"));
                    });
                });
        });
    }

pub fn tonemap(&self) -> Tonemap

The curve the frame is drawn to the screen through.

Examples found in repository

examples/material-playground.rs (line 1038)

    fn controls(&mut self, ctx: &mut FrameContext<'_, Self>) {
        let tonemap = ctx.config().tonemap();
        let antialiasing = ctx.config().antialiasing();
        let shadow_resolution = ctx.config().shadow_resolution();

        ctx.ui(|ui| {
            egui::Panel::right("controls")
                .resizable(false)
                .default_size(300.0)
                .show(ui, |ui| {
                    egui::ScrollArea::vertical().show(ui, |ui| {
                        ui.label(
                            "right mouse button to look, W/A/S/D to move, \
                             space/shift up and down, wheel to scale speed",
                        );
                        ui.separator();
                        self.lighting_controls(ui);
                        ui.separator();
                        self.light_controls(ui);
                        ui.separator();
                        self.material_controls(ui);
                        ui.separator();
                        ui.label(format!(
                            "tone map {tonemap:?} \u{b7} antialiasing {antialiasing} \u{b7} \
                             shadow {shadow_resolution}px: set at startup, not live"
                        ));
                        ui.add(egui::Slider::new(&mut self.exposure, 0.1..=3.0).text("exposure"));
                        ui.add(egui::Slider::new(&mut self.bloom, 0.0..=1.0).text("bloom"));
                    });
                });
        });
    }

pub fn shadow_resolution(&self) -> u32

The side of one light’s depth map, in texels.

Examples found in repository

examples/material-playground.rs (line 1040)

    fn controls(&mut self, ctx: &mut FrameContext<'_, Self>) {
        let tonemap = ctx.config().tonemap();
        let antialiasing = ctx.config().antialiasing();
        let shadow_resolution = ctx.config().shadow_resolution();

        ctx.ui(|ui| {
            egui::Panel::right("controls")
                .resizable(false)
                .default_size(300.0)
                .show(ui, |ui| {
                    egui::ScrollArea::vertical().show(ui, |ui| {
                        ui.label(
                            "right mouse button to look, W/A/S/D to move, \
                             space/shift up and down, wheel to scale speed",
                        );
                        ui.separator();
                        self.lighting_controls(ui);
                        ui.separator();
                        self.light_controls(ui);
                        ui.separator();
                        self.material_controls(ui);
                        ui.separator();
                        ui.label(format!(
                            "tone map {tonemap:?} \u{b7} antialiasing {antialiasing} \u{b7} \
                             shadow {shadow_resolution}px: set at startup, not live"
                        ));
                        ui.add(egui::Slider::new(&mut self.exposure, 0.1..=3.0).text("exposure"));
                        ui.add(egui::Slider::new(&mut self.bloom, 0.0..=1.0).text("bloom"));
                    });
                });
        });
    }

pub fn mesh_memory(&self) -> usize

Memory the engine keeps built mesh data in, in bytes.

Trait Implementations

impl Clone for Config

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.