Struct FormattedRenderer 

pub struct FormattedRenderer { /* private fields */ }

Advanced renderer with additional capabilities.

Implementations

impl FormattedRenderer

pub fn new(bg_color: Color) -> FormattedRenderer

Creates a new blank FormattedRenderer. All segments use the same background colour.

pub fn add_text(&mut self, text: &str, color: Color, bold: bool, italic: bool)

Adds a string literal, which cannot be modified once added (i.e. you’ll need to create a new FormattedRenderer instead).

pub fn add_var(&mut self, name: &str, color: Color, bold: bool, italic: bool)

Adds a named variable, which can have its value and changed after creation.

pub fn set_var(&mut self, name: &str, value: &str)

Sets or modifies the value of an already added variable. If the variable referenced does not exist, nothing happens.

pub fn set_bg_color(&mut self, bg_color: Color)

Sets the background color of each component of the formatted output.

pub fn get_bg_color(&self) -> Color

Returns the default background colour for each rendered section (unless it’s been changed by modifying a renderer’s background colour through the iter_mut method).

pub fn set_scale(&mut self, scale: u32)

Sets the scale of each component in the formatted output.

pub fn get_scale(&self) -> u32

Gets the current scale factor used for draw operations.

pub fn iter_mut(&mut self) -> IterMut<'_, SurfaceRenderer>

Returns an iterator over each renderer, which allows the renderers’ settings to be modified.

pub fn draw<'a>(&self) -> Result<Surface<'a>, String>

Sequentially draws each literal and variable, using its associated renderer, and linearly appends the output surfaces.

pub fn measure_width(&self) -> Result<u32, String>

Measures the width of all of the contained text, including variable values, taking into consideration the formatting of each section.

pub fn measure_height(&self) -> Result<u32, String>

Returns the height of all content in the formatted string.

Trait Implementations

impl IntoIterator for FormattedRenderer

type Item = SurfaceRenderer

The type of the elements being iterated over.

type IntoIter = IntoIter<SurfaceRenderer>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.