Struct bracket_lib::prelude::DrawBatch

pub struct DrawBatch { /* fields omitted */ }

Represents a batch of drawing commands, designed to be submitted together.

Methods

impl DrawBatch

pub fn new() -> Reusable<'static, DrawBatch>

Obtain a new, empty draw batch

pub fn submit(&mut self, z_order: usize)

Submits a batch to the global drawing buffer, and empties the batch.

pub fn cls(&mut self) -> &mut DrawBatch

Adds a CLS (clear screen) to the drawing batch

pub fn cls_color(&mut self, color: RGB) -> &mut DrawBatch

Adds a CLS (clear screen) to the drawing batch

pub fn target(&mut self, console: usize) -> &mut DrawBatch

Sets the target console for rendering

pub fn set(&mut self, pos: Point, color: ColorPair, glyph: u8) -> &mut DrawBatch

Sets an individual cell glyph

pub fn set_bg(&mut self, pos: Point, bg: RGB) -> &mut DrawBatch

Sets an individual cell glyph

pub fn print<S>(&mut self, pos: Point, text: S) -> &mut DrawBatch where
    S: ToString, 

Prints text in the default colors at a given location

pub fn print_color<S>(
    &mut self,
    pos: Point,
    text: S,
    color: ColorPair
) -> &mut DrawBatch where
    S: ToString, 

Prints text in the default colors at a given location

pub fn print_centered<S>(&mut self, y: i32, text: S) -> &mut DrawBatch where
    S: ToString, 

Prints text, centered to the whole console width, at vertical location y.

pub fn print_color_centered<S>(
    &mut self,
    y: i32,
    text: S,
    color: ColorPair
) -> &mut DrawBatch where
    S: ToString, 

Prints text, centered to the whole console width, at vertical location y.

pub fn draw_box(&mut self, pos: Rect, color: ColorPair) -> &mut DrawBatch

Draws a box, starting at x/y with the extents width/height using CP437 line characters

pub fn draw_hollow_box(&mut self, pos: Rect, color: ColorPair) -> &mut DrawBatch

Draws a non-filled (hollow) box, starting at x/y with the extents width/height using CP437 line characters

pub fn draw_double_box(&mut self, pos: Rect, color: ColorPair) -> &mut DrawBatch

Draws a double-lined box, starting at x/y with the extents width/height using CP437 line characters

pub fn draw_hollow_double_box(
    &mut self,
    pos: Rect,
    color: ColorPair
) -> &mut DrawBatch

Draws a non-filled (hollow) double-lined box, starting at x/y with the extents width/height using CP437 line characters

pub fn fill_region(
    &mut self,
    pos: Rect,
    color: ColorPair,
    glyph: u8
) -> &mut DrawBatch

Draws a non-filled (hollow) double-lined box, starting at x/y with the extents width/height using CP437 line characters

pub fn bar_horizontal(
    &mut self,
    pos: Point,
    width: i32,
    n: i32,
    max: i32,
    color: ColorPair
) -> &mut DrawBatch

Draw a horizontal progress bar

pub fn bar_vertical(
    &mut self,
    pos: Point,
    height: i32,
    n: i32,
    max: i32,
    color: ColorPair
) -> &mut DrawBatch

Draw a horizontal progress bar