Skip to main content

TextStyle

Struct TextStyle 

Source
pub struct TextStyle {
    pub font_family: Option<String>,
    pub font_size: f32,
    pub font_weight: FontWeight,
    pub font_style: FontStyle,
    pub letter_spacing: f32,
    pub line_height: Option<f32>,
    pub align: TextAlign,
    pub vertical_align: TextVerticalAlign,
}
Expand description

Everything crate::DrawScope needs to measure and draw a run of text.

A style is a plain value: sizes are already in scope (logical) units, and every field is resolved — there is no inheritance or theme lookup at draw time. Build one once and reuse it; measurement is cached on the (text, style) pair, so a style rebuilt with identical values still hits the cache.

Fields§

§font_family: Option<String>

Family name to resolve against the fonts the app registered. None asks for the framework’s default family.

Only named families resolve: file-backed families are loaded by the app at startup and looked up by the name in their font tables.

§font_size: f32§font_weight: FontWeight§font_style: FontStyle§letter_spacing: f32

Extra advance inserted between characters, in scope units.

§line_height: Option<f32>

Distance between consecutive baselines. None uses the font’s natural line height.

§align: TextAlign§vertical_align: TextVerticalAlign

Implementations§

Source§

impl TextStyle

Source

pub const DEFAULT_FONT_SIZE: f32 = 14.0

The size used when a style carries a non-positive or non-finite one. Matches the framework-wide text default.

Source

pub fn new(font_size: f32) -> Self

Source

pub fn with_font_family(self, family: impl Into<String>) -> Self

Source

pub fn with_font_size(self, font_size: f32) -> Self

Source

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

Source

pub fn with_style(self, style: FontStyle) -> Self

Source

pub fn with_letter_spacing(self, letter_spacing: f32) -> Self

Source

pub fn with_line_height(self, line_height: f32) -> Self

Source

pub fn with_align(self, align: TextAlign) -> Self

Source

pub fn with_vertical_align(self, vertical_align: TextVerticalAlign) -> Self

Source

pub fn resolved_font_size(&self) -> f32

The font size a measurer/rasterizer will actually use. Non-finite and non-positive sizes fall back to TextStyle::DEFAULT_FONT_SIZE instead of producing NaN geometry.

Source

pub fn resolved_letter_spacing(&self) -> f32

The letter spacing a measurer will actually use.

Source

pub fn resolved_line_height(&self, natural: f32) -> f32

The line height a measurer will actually use, given the font’s natural one. natural is only consulted when the style leaves it unset.

Trait Implementations§

Source§

impl Clone for TextStyle

Source§

fn clone(&self) -> TextStyle

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for TextStyle

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for TextStyle

Source§

fn default() -> Self

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

impl PartialEq for TextStyle

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for TextStyle

Auto Trait Implementations§

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, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.