Struct TextShapingArgs 

#[non_exhaustive]
pub struct TextShapingArgs {

    pub letter_spacing: Px,
    pub word_spacing: Px,
    pub line_height: Px,
    pub line_spacing: Px,
    pub paragraph_spacing: Px,
    pub paragraph_indent: (Px, bool),
    pub lang: Lang,
    pub direction: LayoutDirection,
    pub ignore_ligatures: bool,
    pub disable_kerning: bool,
    pub tab_x_advance: Px,
    pub inline_constraints: Option<InlineConstraintsMeasure>,
    pub font_features: RFontFeatures,
    pub max_width: Px,
    pub paragraph_break: ParagraphBreak,
    pub line_break: LineBreak,
    pub word_break: WordBreak,
    pub hyphens: Hyphens,
    pub hyphen_char: Txt,
    pub obscuring_char: Option<char>,
}

Extra configuration for shape_text.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

letter_spacing: Px

Extra spacing to add after each character.

word_spacing: Px

Extra spacing to add after each space (U+0020 SPACE).

line_height: Px

Height of each line.

Default can be computed using FontMetrics::line_height.

line_spacing: Px

Extra spacing added in between lines.

paragraph_spacing: Px

Replacement space between paragraphs.

paragraph_indent: (Px, bool)

Extra spacing in paragraph lines start.

The bool indicates if spacing is inverted (hang), applied to all paragraph lines except the first.

lang: Lang

Primary language of the text.

direction: LayoutDirection

Text flow direction.

ignore_ligatures: bool

Don’t use font ligatures.

disable_kerning: bool

Don’t use font letter spacing.

tab_x_advance: Px

Width of the TAB character.

inline_constraints: Option<InlineConstraintsMeasure>

Inline constraints for initial text shaping and wrap.

font_features: RFontFeatures

Finalized font features.

max_width: Px

Maximum line width.

Is Px::MAX when text wrap is disabled.

paragraph_break: ParagraphBreak

Definition of paragraphs.

line_break: LineBreak

Line break config for Chinese, Japanese, or Korean text.

word_break: WordBreak

World break config.

This value is only considered if it is impossible to fit the word to a line.

hyphens: Hyphens

Hyphen breaks config.

hyphen_char: Txt

Character rendered when text is hyphenated by break.

obscuring_char: Option<char>

Obscure the text with the replacement char.

Trait Implementations

impl Clone for TextShapingArgs

fn clone(&self) -> TextShapingArgs

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TextShapingArgs

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

Formats the value using the given formatter.

impl Default for TextShapingArgs

fn default() -> Self

Returns the “default value” for a type.