Struct TextShapingArgs

source

pub struct TextShapingArgs {Show 17 fields
    pub letter_spacing: Px,
    pub word_spacing: Px,
    pub line_height: Px,
    pub line_spacing: Px,
    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 line_break: LineBreak,
    pub word_break: WordBreak,
    pub hyphens: Hyphens,
    pub hyphen_char: Txt,
    pub obscuring_char: Option<char>,
}

Expand description

Extra configuration for shape_text.

Fields§

§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.

§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.

§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§

source §

impl Clone for TextShapingArgs

source §

fn clone(&self) -> TextShapingArgs

Returns a copy of the value. Read more

1.0.0 · source§

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

Performs copy-assignment from source. Read more

source §

impl Debug for TextShapingArgs

source §

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

Formats the value using the given formatter. Read more

source §

impl Default for TextShapingArgs

source §

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl UnwindSafe for TextShapingArgs

Blanket Implementations§

source §

impl<T> Any for T
where T: 'static + ?Sized,

source §

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source §

impl<T> Borrow<T> for T
where T: ?Sized,

source §

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source §

impl<T> BorrowMut<T> for T
where T: ?Sized,

source §

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source §

impl<T> CloneToUninit for T
where T: Clone,

source §

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dst. Read more

source §

impl<T> From<T> for T

source §

fn from(t: T) -> T

Returns the argument unchanged.

source §

impl<T> FsChangeNote for T
where T: Debug + Any + Send + Sync,

source §

fn as_any(&self) -> &(dyn Any + 'static)

Access any.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more

§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

source §

impl<T, U> Into for T
where U: From<T>,

source §

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source §

impl<T> IntoEither for T

source §

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

§