Struct storm::Text

pub struct Text {
    pub string: String,
    pub pos: Vector3<f32>,
    pub max_width: Option<f32>,
    pub scale: u32,
    pub color: RGBA8,
    pub font: FontToken,
}

Configuration settings for text.

Fields

string: String

Text that's being drawn.

pos: Vector3<f32>

Position of the text. The X and Y coordinates represent the bottom left corner of the text. The Z coordinate represents sprite depth. Units are measured in pixels.

max_width: Option<f32>

Max width of the text before it's pushed to a new line. If this is set to None, it will not wrap text to a new line. Units are measured in pixels. The default is None.

scale: u32

Amount to scale the text by as defined by the font. The default is 24.

color: RGBA8

Color to use for the text. The default is black.

font: FontToken

Font to use for the text. This is the engine font by default.

Methods

impl Text

pub fn new(
    string: String,
    pos: Vector3<f32>,
    max_width: Option<f32>,
    scale: u32,
    color: RGBA8,
    font: FontToken
) -> Text

pub fn set_string(&mut self, string: &str)

Trait Implementations

impl Clone for Text

fn clone(&self) -> Text

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for Text

fn default() -> Text

Returns the "default value" for a type.

impl Debug for Text

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

Formats the value using the given formatter.