Struct tetra::ContextBuilder

pub struct ContextBuilder { /* fields omitted */ }

Settings that can be configured when starting up a game.

Methods

impl ContextBuilder

pub fn new<S>(title: S, window_width: i32, window_height: i32) -> ContextBuilder where
    S: Into<String>, 

Create a new ContextBuilder, with a title and window size.

pub fn title<S>(&mut self, title: S) -> &mut ContextBuilder where
    S: Into<String>, 

Sets the title of the window.

Defaults to "Tetra".

pub fn size(&mut self, width: i32, height: i32) -> &mut ContextBuilder

Sets the size of the window.

Defaults to 1280 by 720.

pub fn vsync(&mut self, vsync: bool) -> &mut ContextBuilder

Enables or disables vsync.

Defaults to true.

pub fn timestep(&mut self, timestep: Timestep) -> &mut ContextBuilder

Sets the game's timestep.

Defaults to Timestep::Fixed(60.0).

pub fn fullscreen(&mut self, fullscreen: bool) -> &mut ContextBuilder

Sets whether or not the window should start in fullscreen.

Defaults to false.

pub fn maximized(&mut self, maximized: bool) -> &mut ContextBuilder

Sets whether or not the window should start maximized.

Defaults to false.

pub fn minimized(&mut self, minimized: bool) -> &mut ContextBuilder

Sets whether or not the window should start minimized.

Defaults to false.

pub fn resizable(&mut self, resizable: bool) -> &mut ContextBuilder

Sets whether or not the window should be resizable.

Defaults to false.

pub fn borderless(&mut self, borderless: bool) -> &mut ContextBuilder

Sets whether or not the window should be borderless.

Defaults to false.

pub fn show_mouse(&mut self, show_mouse: bool) -> &mut ContextBuilder

Sets whether or not the mouse cursor should be visible when it is within the game window.

Defaults to false.

pub fn quit_on_escape(&mut self, quit_on_escape: bool) -> &mut ContextBuilder

Sets whether or not the game should close when the Escape key is pressed.

Defaults to false.

pub fn debug_info(&mut self, debug_info: bool) -> &mut ContextBuilder

Sets whether or not the game should print out debug info at startup. Please include this if you're submitting a bug report!

pub fn build(&self) -> Result<Context>

Builds the context.

Errors

• TetraError::PlatformError will be returned if the context cannot be initialized.

Trait Implementations

impl Clone for ContextBuilder

fn clone(&self) -> ContextBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ContextBuilder

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

Formats the value using the given formatter.

impl Default for ContextBuilder

fn default() -> ContextBuilder

Returns the "default value" for a type.