Struct TextLayout 

pub struct TextLayout<'a> { /* private fields */ }

Builder for laying out a Line within a bounded Rect.

Call measure to get its Size without touching any surface, or render_to_surface to write directly into a Surface.

Examples

use retroglyph_core::layout::{TextLayout, HAlign, VAlign};
use retroglyph_core::grid::Rect;
use retroglyph_core::text::Line;
use retroglyph_core::grid::HasSize;

let rect = Rect::new(0, 0, 20, 5);
let line = Line::raw("Hello, world!");

let metrics = TextLayout::new(&line)
    .rect(rect)
    .h_align(HAlign::Center)
    .measure();

assert_eq!(metrics.height(), 1);

Implementations

impl<'a> TextLayout<'a>

pub const fn new(line: &'a Line) -> TextLayout<'a>

Creates a new layout builder for line.

Defaults: zero-sized rect at origin, left/top alignment. Call rect before measure or render_to_surface.

pub const fn rect(self, rect: Rect<u16>) -> TextLayout<'a>

Sets the bounding rectangle.

pub const fn h_align(self, align: HAlign) -> TextLayout<'a>

Sets the horizontal alignment.

pub const fn v_align(self, align: VAlign) -> TextLayout<'a>

Sets the vertical alignment.

pub fn measure(&self) -> Size<u16>

Measures the text without rendering, returning its Size: width is the widest wrapped line in columns, height is the number of wrapped lines.

Uses the rect’s width for word-wrapping; ignores height.

pub fn render_to_surface(&self, surface: &mut Surface<'_>)

Renders the text into surface, clipping to both the rect’s bounds and surface’s own clip (the rect is intersected with Surface::clip_rect first, so text can never escape whatever clip the caller applied even if rect extends past it).

Examples

use retroglyph_core::backend::Headless;
use retroglyph_core::grid::{Pos, Rect};
use retroglyph_core::layout::TextLayout;
use retroglyph_core::text::Line;
use retroglyph_core::terminal::Terminal;

let mut term = Terminal::new(Headless::new(20, 5));
let line = Line::raw("hi");
TextLayout::new(&line)
    .rect(Rect::new(2, 1, 10, 3))
    .render_to_surface(&mut term.surface());

assert_eq!(term.grid()[Pos::new(2, 1)].glyph(), 'h');

pub fn render_to_grid(&self, grid: &mut Grid, layer: u8)

Renders the text into grid on layer, clipping to the rect’s bounds.