Struct BTermBuilder 

pub struct BTermBuilder { /* private fields */ }

Provides a builder mechanism for initializing BTerm. You can chain builders together, and and with a call to .build(). This allows you to provide settings if you want to, or just use a simple initializer if you are in a hurry.

Implementations

impl BTermBuilder

pub fn new() -> Self

Provides a new, unconfigured, starting point for an BTerm session. You’ll have to specify everything manually.

pub fn simple80x50() -> Self

Provides an 80x50 console in the baked-in 8x8 terminal font as your starting point.

pub fn simple<T>(width: T, height: T) -> BResult<Self>

where T: TryInto<u32>,

Provides an 8x8 terminal font simple console, with the specified dimensions as your starting point.

pub fn vga80x50() -> Self

Provides an 80x50 terminal, in the VGA font as your starting point.

pub fn vga<T>(width: T, height: T) -> Self

where T: TryInto<u32>,

Provides a VGA-font simple terminal with the specified dimensions as your starting point.

pub fn with_dimensions<T>(self, width: T, height: T) -> Self

where T: TryInto<u32>,

Adds width/height dimensions to the BTerm builder.

pub fn with_tile_dimensions<T>(self, width: T, height: T) -> Self

where T: TryInto<u32>,

Overrides the default assumption for tile sizes. Needed for a raw initialization. If you have lots of fonts, the library will pick one (generally the first) to try and determine what dimensions you want to use when figuring out your window size. This method is used to override that assumption. It’s a great idea to use this when using multiple layers and fonts.

pub fn with_title<S: ToString>(self, title: S) -> Self

Adds a window title to the BTerm builder.

pub fn with_resource_path<S: ToString>(self, path: S) -> Self

Adds a resource path to the BTerm builder. You only need to specify this if you aren’t embedding your resources.

pub fn with_font<S: ToString, T>( self, font_path: S, width: T, height: T, ) -> Self

where T: TryInto<u32>,

Adds a font registration to the BTerm builder.

pub fn with_font_bg<S: ToString, T, COLOR>( self, font_path: S, width: T, height: T, background: COLOR, ) -> Self

where T: TryInto<u32>, COLOR: Into<RGB>,

Adds a font registration to the BTerm builder.

pub fn with_simple_console<S: ToString, T>( self, width: T, height: T, font: S, ) -> Self

where T: TryInto<u32>,

Adds a simple console layer to the BTerm builder.

pub fn with_simple_console_no_bg<S: ToString, T>( self, width: T, height: T, font: S, ) -> Self

where T: TryInto<u32>,

Adds a simple console layer to the BTerm builder, with no background.

pub fn with_simple8x8(self) -> Self

Adds a simple console, hard-coded to the baked-in 8x8 terminal font. This does NOT register the font.

pub fn with_sparse_console<S: ToString, T>( self, width: T, height: T, font: S, ) -> Self

where T: TryInto<u32>,

Adds a sparse console layer to the BTerm builder.

pub fn with_sparse_console_no_bg<S: ToString, T>( self, width: T, height: T, font: S, ) -> Self

where T: TryInto<u32>,

Adds a sparse console with no bg rendering layer to the BTerm builder.

pub fn with_fancy_console<S: ToString, T>( self, width: T, height: T, font: S, ) -> Self

where T: TryInto<u32>,

Adds a fancy (supporting per-glyph offsets, rotation, etc.) console. OpenGL only for now.

pub fn with_sprite_console<T>( self, width: T, height: T, sprite_sheet: usize, ) -> Self

where T: TryInto<u32>,

Adds a sprite console

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

Enables you to override the vsync default for native rendering.

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

Enables you to override the full screen setting for native rendering.

pub fn with_fitscreen(self, fitscreen: bool) -> Self

Enables you to auto adjust the window to fit the screen.

pub fn with_platform_specific(self, hints: InitHints) -> Self

Push platform-specific initialization hints to the builder. THIS REMOVES CROSS-PLATFORM COMPATIBILITY

pub fn with_fps_cap(self, fps: f32) -> Self

Instructs the back-end (not all of them honor it; WASM and Amethyst do their own thing) to try to limit frame-rate and CPU utilization.

pub fn with_advanced_input(self, advanced_input: bool) -> Self

Enables input event queue

pub fn with_automatic_console_resize(self, resize_scaling: bool) -> Self

Enable resize changing console size, rather than scaling. Native OpenGL only.

pub fn with_sprite_sheet(self, ss: SpriteSheet) -> Self

Register a sprite sheet

pub fn with_gutter(self, desired_gutter: u32) -> Self

Request a pixel gutter around the rendered area. The gutter is applied with half at each side of the screen, centering it. If you want a 4 pixel gutter on every side, request a gutter size of 8.

pub fn build(self) -> BResult<BTerm>

Combine all of the builder parameters, and return an BTerm context ready to go.

Trait Implementations

impl Default for BTermBuilder

fn default() -> Self

Returns the “default value” for a type.