Struct Paragraph 

pub struct Paragraph { /* private fields */ }

Shaped, line-broken and aligned text, ready to draw as GlyphRuns.

Built by TextSystem::paragraph. Changing the width (reflow) re-breaks the shaped text without shaping it again; changing the text or styles needs a new paragraph. Iterating runs never allocates, so drawing a paragraph every frame is allocation-free.

Not yet supported: variable-font axes and synthetic bold/italic (glyphs are drawn from the face’s default instance), color glyphs (emoji draw as coverage masks).

Implementations

impl Paragraph

pub fn width(&self) -> f32

Width of the widest line, in pixels.

pub fn height(&self) -> f32

Height of all lines, in pixels: the bottom of the last line box.

Taken from the (pixel-snapped) line boxes rather than parley’s unsnapped total, so stacking paragraphs by height never drifts from where their lines are drawn.

pub fn max_width(&self) -> Option<f32>

The width lines wrap at; None if they only break at newlines.

pub fn lines(&self) -> &[LineBox]

The lines, top to bottom.

pub fn glyph_count(&self) -> usize

Glyphs to draw, in all runs.

pub fn runs(&self) -> impl ExactSizeIterator<Item = GlyphRun<'_>> + '_

The glyph runs to draw, positioned relative to the paragraph’s top-left corner.

pub fn reflow(&mut self, max_width: Option<f32>) -> Result<(), ParagraphError>

Re-breaks and re-aligns the lines for a new max_width (None: no wrapping), without shaping again.

Errors

ParagraphError::InvalidWidth if max_width is negative or not finite.

Trait Implementations

impl Debug for Paragraph

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

Formats the value using the given formatter.