azul_layout::text::layout

Struct ShapedWords

Source 
#[repr(C)]
pub struct ShapedWords {
    pub items: ShapedWordVec,
    pub longest_word_width: usize,
    pub space_advance: usize,
    pub font_metrics_units_per_em: u16,
    pub font_metrics_ascender: i16,
    pub font_metrics_descender: i16,
    pub font_metrics_line_gap: i16,
}
Expand description

A paragraph of words that are shaped and scaled (* but not yet layouted / positioned*!) according to their final size in pixels.

Fields§

§items: ShapedWordVec

Words scaled to their appropriate font size, but not yet positioned on the screen

§longest_word_width: usize

Longest word in the self.scaled_words, necessary for calculating overflow rectangles.

§space_advance: usize

Horizontal advance of the space glyph

§font_metrics_units_per_em: u16

Units per EM square

§font_metrics_ascender: i16

Descender of the font

§font_metrics_descender: i16§font_metrics_line_gap: i16

Implementations§

Source§

impl ShapedWords

Source

pub fn get_longest_word_width_px(&self, target_font_size: f32) -> f32

Source

pub fn get_space_advance_px(&self, target_font_size: f32) -> f32

Source

pub fn get_baseline_px(&self, target_font_size: f32) -> f32

Get the distance from the top of the text to the baseline of the text (= ascender)

Source

pub fn get_descender(&self, target_font_size: f32) -> f32

NOTE: descender is NEGATIVE

Source

pub fn get_line_height(&self, target_font_size: f32) -> f32

height = sTypoAscender - sTypoDescender + sTypoLineGap

Source

pub fn get_ascender(&self, target_font_size: f32) -> f32

Trait Implementations§

Source§

impl Clone for ShapedWords

Source§

fn clone(&self) -> ShapedWords

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 ShapedWords

Source§

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

Formats the value using the given formatter. Read more

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

impl<G1, G2> Within<G2> for G1
where G2: Contains<G1>,

Source§

fn is_within(&self, b: &G2) -> bool