Struct PreparedTextLayout 

pub struct PreparedTextLayout {
    pub text: Rc<AnnotatedString>,
    pub visual_style: Arc<TextStyle>,
    pub layout: TextLayout,
    pub render_text: OnceCell<(Arc<RenderString>, PackedU64)>,
    /* private fields */
}

A text laid out between two widths: its glyphs and lines, which every query, measurement and renderer reads, and the size it measures.

Fields

text: Rc<AnnotatedString>

The text that was laid out.

visual_style: Arc<TextStyle>

The style the text draws in, shared with every render node drawn from this layout.

layout: TextLayout

The lines and glyphs.

render_text: OnceCell<(Arc<RenderString>, PackedU64)>

text as a renderer draws it, and its RenderString::render_hash, converted on first use: see PreparedTextLayout::render_text.

Implementations

impl PreparedTextLayout

pub fn size(&self) -> Size

The paragraph’s width, within the widths it was laid out between, and the height of all its lines together.

pub fn metrics(&self) -> TextMetrics

Size and line count.

pub fn alignment_lines(&self) -> AlignmentLines

The first and last baselines.

pub fn did_overflow(&self) -> bool

True when the text did not fit: it had more lines than the line limit, or was wider than the widest it could be.

pub fn render_text(&self) -> Arc<RenderString>

The display text as a renderer draws it. Converted once for the layout and shared after, so every frame and scene rebuild drawing this layout hands over the same allocation.

pub fn render_text_hash(&self) -> u64

RenderString::render_hash of PreparedTextLayout::render_text, kept beside it so that reading it never loads the string.

pub fn visual_style_hash(&self) -> u64

TextStyle::render_hash of visual_style, hashed once for the layout, or handed over by the node that knows its style’s hash.

pub fn result(&self) -> TextLayoutResult

The layout’s queries, as Compose’s TextLayoutResult gives them.

Trait Implementations

impl Clone for PreparedTextLayout

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PreparedTextLayout

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

Formats the value using the given formatter.

impl PartialEq for PreparedTextLayout

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.