Struct EngineBuilder 

pub struct EngineBuilder { /* private fields */ }

A builder class that helps create an application with specific details

Implementations

impl EngineBuilder

pub fn new() -> Self

Creates a builder with some defualt presets

Self {
    resolution: (600, 600),
    full_screen: false,
    target_fps: 30,
    close_key: None,
    window_icon: None,
    window_title: "Bottonless-Pit Game".into(),
    resizable: true,
    vysnc: false,
}

Examples found in repository

examples/line.rs (line 10)

fn main() {
    let engine = EngineBuilder::new().build().unwrap();

    let line_material = LineMaterial::new(&engine);

    let game = LineExample {
        material: line_material,
    };

    engine.run(game);
}

examples/debug_triangle.rs (line 10)

fn main() {
    let mut engine = EngineBuilder::new()
        .with_resolution((400, 400))
        .build()
        .unwrap();

    let material = MaterialBuilder::new().build(&mut engine);

    let pos = DebugTriangle { material };

    engine.run(pos);
}

examples/input.rs (line 10)

fn main() {
    let engine = EngineBuilder::new().build().unwrap();

    let text_mat = TextMaterial::new("this is a test", Colour::RED, 20.0, 20.0 * 1.3);

    let text_example = TextExample {
        text_mat,
        text: String::new(),
    };

    engine.run(text_example);
}

examples/text.rs (line 12)

fn main() {
    let mut engine = EngineBuilder::new().build().unwrap();

    let comic = Font::new("examples/Comic.ttf", &mut engine, LoadingOp::Blocking);
    let text_mat = TextMaterial::new("this is a test", Colour::RED, 0.5, 0.5 * 1.3);

    let text_example = TextExample {
        text_mat,
        comic,
        font_size: 0.5,
    };

    engine.run(text_example);
}

examples/rectangles.rs (line 13)

fn main() {
    let mut engine = EngineBuilder::new().build().unwrap();

    let texture = Texture::new(&mut engine, "examples/bplogo.png", LoadingOp::Blocking);

    let texture_material = MaterialBuilder::new()
        .add_texture(texture)
        .build(&mut engine);
    let regular_material = MaterialBuilder::new().build(&mut engine);

    let pos = Position {
        pos: vec2! { 0.0 },
        regular_material,
        texture_material,
        state: false,
    };

    engine.run(pos);
}

examples/camera.rs (line 14)

fn main() {
    let mut engine = EngineBuilder::new().build().unwrap();

    let texture = Texture::new(&mut engine, "examples/bplogo.png", LoadingOp::Blocking);

    let material = MaterialBuilder::new()
        .add_texture(texture)
        .build(&mut engine);

    let camera = Camera::default();

    let text = TextMaterial::new(
        "Mouse pos: 0,0 \n Mouse pos: 0, 0",
        Colour::WHITE,
        15.0,
        20.0,
    );

    let game = CameraExample {
        material,
        text,
        camera,
    };

    engine.run(game);
}

Additional examples can be found in:

• examples/texture.rs
• examples/ngon.rs
• examples/shader.rs
• examples/lightmap.rs

pub fn with_resolution(self, resolution: (u32, u32)) -> Self

Overides the defualt resolution

Examples found in repository

examples/debug_triangle.rs (line 11)

fn main() {
    let mut engine = EngineBuilder::new()
        .with_resolution((400, 400))
        .build()
        .unwrap();

    let material = MaterialBuilder::new().build(&mut engine);

    let pos = DebugTriangle { material };

    engine.run(pos);
}

examples/texture.rs (line 15)

fn main() {
    let mut engine = EngineBuilder::new()
        .set_window_title("Testing Triangle")
        .with_resolution((400, 400))
        .build()
        .unwrap();

    let texture = Texture::new(&mut engine, "examples/bplogo.png", LoadingOp::Blocking);

    let texture = MaterialBuilder::new()
        .add_texture(texture)
        .build(&mut engine);
    let defualt = MaterialBuilder::new().build(&mut engine);

    let s = TextureExample {
        current: texture,
        other: defualt,
        pos: vec2! { 0.0 },
    };

    engine.run(s);
}

examples/ngon.rs (line 18)

fn main() {
    let mut engine = EngineBuilder::new()
        .with_resolution((500, 500))
        .remove_vsync()
        .build()
        .unwrap();

    let data = Time {
        time: 0.0,
        _pading: 0.0,
        _padding2: 0.0,
        _padding4: 0.0,
    };

    let uniform_data = UniformData::new(&data);

    let mouse_shader = Shader::new(
        "examples/sinewaves.wgsl",
        ShaderOptions::with_uniform_data(&uniform_data),
        &mut engine,
        LoadingOp::Blocking,
    );

    let regular_material = MaterialBuilder::new()
        .set_shader(mouse_shader)
        .build(&mut engine);

    let pos = Position {
        regular_material,
        time: data,
    };

    engine.run(pos);
}

examples/lightmap.rs (line 18)

fn main() {
    let mut engine = EngineBuilder::new()
        .set_window_title("Lightmap")
        .with_resolution((800, 800))
        .build()
        .unwrap();

    let uniform_texture = UniformTexture::new(&engine, engine.get_window_size());

    let light = Light {
        colour: Colour::ORANGE,
        pos_x: 0.0,
        pos_y: 0.0,
        brightness: 0.75,
        aspect_ratio: 1.0,
    };

    let light_data = UniformData::new(&light);

    let shader_options = ShaderOptions::with_all(&light_data, &uniform_texture);
    let light_shader = Shader::new(
        "examples/light.wgsl",
        shader_options,
        &mut engine,
        LoadingOp::Blocking,
    );

    let material = MaterialBuilder::new()
        .set_shader(light_shader)
        .build(&mut engine);

    let ocluder_material = MaterialBuilder::new().build(&mut engine);

    let rectangles = vec![
        Rectangle::new(Vec2 { x: 120.0, y: 20.0 }, Vec2 { x: 50.0, y: 50.0 }),
        Rectangle::new(Vec2 { x: 270.0, y: 70.0 }, Vec2 { x: 50.0, y: 50.0 }),
        Rectangle::new(Vec2 { x: 130.0, y: 280.0 }, Vec2 { x: 50.0, y: 50.0 }),
        Rectangle::new(Vec2 { x: 220.0, y: 300.0 }, Vec2 { x: 50.0, y: 50.0 }),
        Rectangle::new(Vec2 { x: 350.0, y: 350.0 }, Vec2 { x: 100.0, y: 100.0 }),
    ];

    let s = TextureExample {
        material,
        ocluder_material,
        light,
        uniform_texture,
        rectangles,
        mouse_pos: ZEROS,
    };

    engine.run(s);
}

pub fn fullscreen(self) -> Self

Will cause the window to be fullscreen upon launch

pub fn set_target_fps(self, fps: u16) -> Self

Sets a target fps cap. The thread will spin sleep using the spin_sleep crate untill the desired frame time is reached. If the frames are slower than the target no action is taken to “speed” up the rendering and updating

pub fn remove_vsync(self) -> Self

Will cause the framerate to be uncapped if the platform supports it using wgpu’s PresentMode::AutoNoVsync by defualt the engine uses PresentMode::AutoVsync

Examples found in repository

examples/ngon.rs (line 19)

fn main() {
    let mut engine = EngineBuilder::new()
        .with_resolution((500, 500))
        .remove_vsync()
        .build()
        .unwrap();

    let data = Time {
        time: 0.0,
        _pading: 0.0,
        _padding2: 0.0,
        _padding4: 0.0,
    };

    let uniform_data = UniformData::new(&data);

    let mouse_shader = Shader::new(
        "examples/sinewaves.wgsl",
        ShaderOptions::with_uniform_data(&uniform_data),
        &mut engine,
        LoadingOp::Blocking,
    );

    let regular_material = MaterialBuilder::new()
        .set_shader(mouse_shader)
        .build(&mut engine);

    let pos = Position {
        regular_material,
        time: data,
    };

    engine.run(pos);
}

pub fn set_close_key(self, key: Key) -> Self

Sets a key that will instantly close the window

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

Sets the title of the window

Examples found in repository

examples/texture.rs (line 14)

fn main() {
    let mut engine = EngineBuilder::new()
        .set_window_title("Testing Triangle")
        .with_resolution((400, 400))
        .build()
        .unwrap();

    let texture = Texture::new(&mut engine, "examples/bplogo.png", LoadingOp::Blocking);

    let texture = MaterialBuilder::new()
        .add_texture(texture)
        .build(&mut engine);
    let defualt = MaterialBuilder::new().build(&mut engine);

    let s = TextureExample {
        current: texture,
        other: defualt,
        pos: vec2! { 0.0 },
    };

    engine.run(s);
}

examples/lightmap.rs (line 17)

fn main() {
    let mut engine = EngineBuilder::new()
        .set_window_title("Lightmap")
        .with_resolution((800, 800))
        .build()
        .unwrap();

    let uniform_texture = UniformTexture::new(&engine, engine.get_window_size());

    let light = Light {
        colour: Colour::ORANGE,
        pos_x: 0.0,
        pos_y: 0.0,
        brightness: 0.75,
        aspect_ratio: 1.0,
    };

    let light_data = UniformData::new(&light);

    let shader_options = ShaderOptions::with_all(&light_data, &uniform_texture);
    let light_shader = Shader::new(
        "examples/light.wgsl",
        shader_options,
        &mut engine,
        LoadingOp::Blocking,
    );

    let material = MaterialBuilder::new()
        .set_shader(light_shader)
        .build(&mut engine);

    let ocluder_material = MaterialBuilder::new().build(&mut engine);

    let rectangles = vec![
        Rectangle::new(Vec2 { x: 120.0, y: 20.0 }, Vec2 { x: 50.0, y: 50.0 }),
        Rectangle::new(Vec2 { x: 270.0, y: 70.0 }, Vec2 { x: 50.0, y: 50.0 }),
        Rectangle::new(Vec2 { x: 130.0, y: 280.0 }, Vec2 { x: 50.0, y: 50.0 }),
        Rectangle::new(Vec2 { x: 220.0, y: 300.0 }, Vec2 { x: 50.0, y: 50.0 }),
        Rectangle::new(Vec2 { x: 350.0, y: 350.0 }, Vec2 { x: 100.0, y: 100.0 }),
    ];

    let s = TextureExample {
        material,
        ocluder_material,
        light,
        uniform_texture,
        rectangles,
        mouse_pos: ZEROS,
    };

    engine.run(s);
}

pub fn set_window_icon(self, icon: Icon) -> Self

Sets the window icon

pub fn unresizable(self) -> Self

Prevents the window from being resized during runtime

pub fn build(self) -> Result<Engine, BuildError>

Attempts to buld the Engine

Examples found in repository

examples/line.rs (line 10)

fn main() {
    let engine = EngineBuilder::new().build().unwrap();

    let line_material = LineMaterial::new(&engine);

    let game = LineExample {
        material: line_material,
    };

    engine.run(game);
}

examples/debug_triangle.rs (line 12)

fn main() {
    let mut engine = EngineBuilder::new()
        .with_resolution((400, 400))
        .build()
        .unwrap();

    let material = MaterialBuilder::new().build(&mut engine);

    let pos = DebugTriangle { material };

    engine.run(pos);
}

examples/input.rs (line 10)

fn main() {
    let engine = EngineBuilder::new().build().unwrap();

    let text_mat = TextMaterial::new("this is a test", Colour::RED, 20.0, 20.0 * 1.3);

    let text_example = TextExample {
        text_mat,
        text: String::new(),
    };

    engine.run(text_example);
}

examples/text.rs (line 12)

fn main() {
    let mut engine = EngineBuilder::new().build().unwrap();

    let comic = Font::new("examples/Comic.ttf", &mut engine, LoadingOp::Blocking);
    let text_mat = TextMaterial::new("this is a test", Colour::RED, 0.5, 0.5 * 1.3);

    let text_example = TextExample {
        text_mat,
        comic,
        font_size: 0.5,
    };

    engine.run(text_example);
}

examples/rectangles.rs (line 13)

fn main() {
    let mut engine = EngineBuilder::new().build().unwrap();

    let texture = Texture::new(&mut engine, "examples/bplogo.png", LoadingOp::Blocking);

    let texture_material = MaterialBuilder::new()
        .add_texture(texture)
        .build(&mut engine);
    let regular_material = MaterialBuilder::new().build(&mut engine);

    let pos = Position {
        pos: vec2! { 0.0 },
        regular_material,
        texture_material,
        state: false,
    };

    engine.run(pos);
}

examples/camera.rs (line 14)

fn main() {
    let mut engine = EngineBuilder::new().build().unwrap();

    let texture = Texture::new(&mut engine, "examples/bplogo.png", LoadingOp::Blocking);

    let material = MaterialBuilder::new()
        .add_texture(texture)
        .build(&mut engine);

    let camera = Camera::default();

    let text = TextMaterial::new(
        "Mouse pos: 0,0 \n Mouse pos: 0, 0",
        Colour::WHITE,
        15.0,
        20.0,
    );

    let game = CameraExample {
        material,
        text,
        camera,
    };

    engine.run(game);
}

Additional examples can be found in:

• examples/texture.rs
• examples/ngon.rs
• examples/shader.rs
• examples/lightmap.rs

Trait Implementations

impl Default for EngineBuilder

fn default() -> Self

Returns the “default value” for a type.