Struct linfb::shape::Caption

pub struct Caption {
    pub text: String,
    pub size: u32,
    pub font: Font<'static>,
    pub color: Color,
    pub max_width: Option<usize>,
    pub alignment: Alignment,
}

Shape containing single- or multi-line text. Text will be soft wrapped if max_width is set.

Fields

text: String

Caption text

size: u32

Font size in px

font: Font<'static>

Font object, built with FontBuilder

color: Color

Font color. Default is black

max_width: Option<usize>

Soft wrap width. If not set, soft wrapping will be disabled

alignment: Alignment

Text alignment

Methods

impl Caption

pub fn builder() -> CaptionBuilder

Create a default CaptionBuilder

Trait Implementations

impl Shape for Caption

fn render(&self) -> Vec<Vec<Option<Color>>>

Create a two-dimensional array of pixels. Every row must have the same length.

fn at(self, x: usize, y: usize) -> PositionedShape where
    Self: Sized + 'static, 

Convert self into PositionedShape, saving position info. Needed for Compositor.

impl Debug for Caption

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

Formats the value using the given formatter.