Struct gemini_engine::elements::ascii::Text

#[non_exhaustive]
pub struct Text {
    pub pos: Vec2D,
    pub content: String,
    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

The position of the text. You can use Text::align to determine how it aligns to this position

content: String

The actual text content of the element

align: TextAlign

How the content should align to the position

modifier: Modifier

A raw Modifier, determining the appearance of the Text

Implementations

impl Text

pub fn new(pos: Vec2D, content: &str, modifier: Modifier) -> Self

Create a new Text element with a position, content and modifier

Panics

This function will panic if the content contains a newline, as Text only works with single lines. For multi-line strings, see Sprite

Examples found in repository

examples/self-resizing.rs (line 20)

fn main() {
    let mut scale_view = ScaleFitView::new(ColChar::BACKGROUND);

    let mut text = Text::new(Vec2D::ZERO, "This is some centered text!", Modifier::None)
        .with_align(TextAlign::Centered);

    let mut sprite =
        Sprite::new(Vec2D::ZERO, TEXTURE, Modifier::None).with_align(TextAlign2D::CENTERED);

    loop {
        text.pos = scale_view.intended_size() / 2;
        sprite.pos = scale_view.intended_size() / 2;
        sprite.pos.y -= 5;

        scale_view.update();
        scale_view.view.blit(&text, Wrapping::Wrap);
        scale_view.view.blit(&sprite, Wrapping::Wrap);
        let _ = scale_view.view.display_render();

        sleep(Duration::from_millis(10));
    }
}

pub const fn with_align(self, align: TextAlign) -> Self

Return the Text with the modified align property

Examples found in repository

examples/self-resizing.rs (line 21)

fn main() {
    let mut scale_view = ScaleFitView::new(ColChar::BACKGROUND);

    let mut text = Text::new(Vec2D::ZERO, "This is some centered text!", Modifier::None)
        .with_align(TextAlign::Centered);

    let mut sprite =
        Sprite::new(Vec2D::ZERO, TEXTURE, Modifier::None).with_align(TextAlign2D::CENTERED);

    loop {
        text.pos = scale_view.intended_size() / 2;
        sprite.pos = scale_view.intended_size() / 2;
        sprite.pos.y -= 5;

        scale_view.update();
        scale_view.view.blit(&text, Wrapping::Wrap);
        scale_view.view.blit(&sprite, Wrapping::Wrap);
        let _ = scale_view.view.display_render();

        sleep(Duration::from_millis(10));
    }
}

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

Return a vector of Pixels to display the given content

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

Return a vector of Pixels to display the given content, aligning the content to the position as directed by the align attribute

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 Debug for Text

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

Formats the value using the given formatter.

impl ViewElement for Text

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

Return a vector of the element’s Pixels - A 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

fn active_points(&self) -> Vec<Vec2D>

Return the positions the ViewElement occupies, essentially active_pixels() without the ColChars. This has a default setting that extracts the Vec2Ds from active_pixels but you can set it to something else to make it faster