Struct SurfaceRenderer 

pub struct SurfaceRenderer {
    pub fg_color: Color,
    pub bg_color: Color,
    pub scale: u32,
    pub bold: bool,
    pub italic: bool,
    /* private fields */
}

Storage class for rendering settings.

Fields

fg_color: Color

The colour to use to draw text.

bg_color: Color

The colour to use to fill the surface before drawing text.

scale: u32

Integer scale multiplier, since Unifont is a raster font.

bold: bool

Whether or not to make text bold. Uses XTerm-style bolding, where the text is just drawn twice on the x-axis, one pixel apart.

italic: bool

Whether or not to make text italicised. Simply shifts pixels to the right by one additional pixel, every two vertical pixels.

Implementations

impl SurfaceRenderer

pub fn new(fg_color: Color, bg_color: Color) -> SurfaceRenderer

Creates a new Unifont renderer which renders text to new SDL surfaces.

pub fn reset(&mut self)

Returns the renderer to the state it was in when it was first created (i.e. the foreground and background colours are reset to the values given to the constructor, and all other fields are reset).

pub fn draw(&self, text: &str) -> Result<Surface<'_>, String>

Draws the supplied text to a new surface, which has been sized to fit the text exactly, using the renderer’s style settings. Returns an Err result if a character was found which is not in the font, or the font could not be initialised.

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

Sums the width of each character in the supplied text, and multiples the sum by the renderer’s integer scale factor. Takes into consideration formatting options’ effects on text width.

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

May in the future take into consideration newlines and other formatting. For now, it just returns 16 * scale, thus, the result of this method can always be safely unwrap()ped.