Struct Text 

pub struct Text { /* private fields */ }

Multi-line Unicode text: a ParagraphStyle shaped into a ParagraphLayout, plus ink and one optional reveal effect. cosmic-text is the sole paragraph shaper, and unhinted skrifa outlines enter the ordinary shared fill pipeline. Static drawing, handwriting and part animation all read the same layout.

Implementations

impl Text

pub fn try_animate_parts_at( &self, context: &SceneContext<'_>, delay: Duration, style: impl Fn(&TextPart) -> PartStyle, ) -> Result<Node, ValidationError>

Evaluates part styles synchronously at explicit scene-local signed time, without reshaping for animation. Source bounds and line wrapping stay fixed; returned node bounds also include transformed animation ink. Measured paragraph baseline is retained for horizontal Row alignment.

impl Text

pub fn from_font( text: &str, font: &FontFace, size: f64, paint: impl Into<Paint>, ) -> Result<Self, ValidationError>

Builds and validates text using one explicit immutable font face.

pub fn new(text: impl Into<Arc<str>>) -> Self

Creates a paragraph with size 24, line height 1.3 and white fill.

pub fn rich(spans: impl IntoIterator<Item = TextSpan>) -> Self

Creates rich spans, whose unset styles inherit paragraph defaults.

pub fn from_paragraph(paragraph: ParagraphStyle) -> Self

Wraps a paragraph description with white fill and no effect.

pub fn paragraph(&self) -> &ParagraphStyle

The paragraph description this text shapes.

pub fn family(self, family: impl Into<Arc<str>>) -> Self

Selects an explicit family; empty uses the library’s generic default.

pub fn size(self, size: f64) -> Self

Sets finite logical size in (0,4096].

pub fn weight(self, weight: FontWeight) -> Self

Selects OpenType weight; variable weight participates in glyph identity.

pub fn fill(self, paint: impl Into<Paint>) -> Self

Sets paint without invalidating shaped geometry.

pub fn stroke(self, width: f64, paint: impl Into<Paint>) -> Self

Adds stroke after filling; existing bounded stroke rules apply.

pub fn line_height(self, height: f64) -> Self

Sets a positive relative line-height multiplier.

pub fn letter_spacing(self, spacing: f64) -> Self

Sets logical tracking, converted to em internally for shaping.

pub fn max_width(self, width: f64) -> Self

Wraps to finite positive logical width.

pub fn alignment(self, alignment: TextAlignment) -> Self

Selects bidirectional-aware paragraph alignment.

pub fn fonts(self, fonts: &FontLibrary) -> Self

Binds an explicit font snapshot, overriding a DrawContext environment.

pub fn split(self, split: TextSplit) -> Self

Selects grapheme, word-boundary or wrapped-line parts.

pub fn visible_parts(self, count: usize) -> Self

Keeps original layout while drawing only the first logical parts.

pub fn write(self, progress: f64) -> Self

Defers vector handwriting to compilation with the current font environment. It replaces any earlier part animation.

pub fn animate_parts( self, delay: Duration, style: impl Fn(&TextPart) -> PartStyle + Send + Sync + 'static, ) -> Self

Defers per-part style evaluation to scene-local drawing time. It replaces any earlier handwriting.

pub fn fit_lines( &self, max_lines: usize, fonts: &FontLibrary, ) -> Result<(Self, bool), ValidationError>

Precomputes a paragraph limited to 1..=512 lines; see ParagraphStyle::fit_lines. Ink and effects are retained.

pub fn layout( &self, fonts: &FontLibrary, ) -> Result<Arc<ParagraphLayout>, ValidationError>

Shapes once per text-style/font snapshot, returning actual line/ink metrics.

pub fn write_with_context( &self, progress: f64, context: &DrawContext, ) -> Result<Node, ValidationError>

Applies the common vector handwriting effect with default contour/fill handoff. Bind fonts on this Text or supply them in the DrawContext.

pub fn vector_tree( &self, context: &DrawContext, ) -> Result<Arc<VectorTree>, ValidationError>

Exports original shared glyph curves, color layers, bitmap strikes and source ranges into the common vector model. No second shaping pass occurs.

pub fn vector_tree_of( &self, layout: &ParagraphLayout, ) -> Result<Arc<VectorTree>, ValidationError>

Exports the glyphs of an already shaped layout, honoring visibility, fills and stroke of this text.

Trait Implementations

impl Clone for Text

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 Text

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

Formats the value using the given formatter.

impl DeferredContent for Text

fn resolve(&self, context: &DrawContext) -> Result<Node, ValidationError>

Resolves this content to an ordinary node at the drawing time in context.

fn baseline(&self, context: &DrawContext) -> Option<f64>

Real horizontal text baseline of the resolved node in local coordinates.

impl From<Text> for Node

fn from(text: Text) -> Node

Converts to this type from the input type.