Struct gemini_engine::elements::ascii::Text

#[non_exhaustive]
pub struct Text<'a> {
    pub pos: Vec2D,
    pub content: &'a str,
    pub align: TextAlign,
    pub modifier: Modifier,
}

Displays text at the given position

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

pos: Vec2D

content: &'a str

align: TextAlign

A raw Modifier, determining the appearance of the Sprite

modifier: Modifier

Implementations

impl<'a> Text<'a>

pub fn new(pos: Vec2D, content: &str, modifier: Modifier) -> Text<'_>

pub fn new_with_align( pos: Vec2D, content: &str, align: TextAlign, modifier: Modifier ) -> Text<'_>

pub fn draw(pos: Vec2D, content: &str, modifier: Modifier) -> Vec<Point>

Return a vector of Points to display the given content

pub fn draw_with_align( pos: Vec2D, content: &str, align: TextAlign, modifier: Modifier ) -> Vec<Point>

Trait Implementations

impl<'a> Clone for Text<'a>

fn clone(&self) -> Text<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Text<'a>

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

Formats the value using the given formatter.

impl ViewElement for Text<'_>

fn active_pixels(&self) -> Vec<Point>

Return a vector of every coordinate where a pixel should be placed and its respective ColChar. If your whole object is a solid colour, consider using utils::points_to_pixels() which will add the same ColChar to every point and can then be used as this function’s output