Struct Font

pub struct Font(/* private fields */);

A sized font face.

A sized font can be requested from a FontFace.

This type is a shared reference to the loaded font data, cloning it is cheap.

Implementations

impl Font

pub fn space_index(&self) -> GlyphIndex

Glyph index for the space ' ' character.

pub fn space_x_advance(&self) -> Px

Returns the horizontal advance of the space ' ' character.

pub fn shape_text( self: &Font, text: &SegmentedText, config: &TextShapingArgs, ) -> ShapedText

Calculates a ShapedText.

pub fn outline( &self, glyph_id: GlyphIndex, sink: &mut impl OutlineSink, ) -> Option<PxRect>

Sends the sized vector path for a glyph to sink.

Returns the glyph bounds if a full outline was sent to the sink.

pub fn h_line_hits( &self, glyph_id: GlyphIndex, line_y_range: (f32, f32), ) -> Option<(f32, f32)>

Ray cast an horizontal line across the glyph and returns the entry and exit hits.

The line_y_range are two vertical offsets relative to the baseline, the offsets define the start and inclusive end of the horizontal line, that is, (underline, underline + thickness), note that positions under the baseline are negative so a 2px underline set 1px under the baseline becomes (-1.0, -3.0).

Returns Ok(Some(x_enter, x_exit)) where the two values are x-advances, returns None if there is no hit. The first x-advance is from the left typographic border to the first hit on the outline, the second x-advance is from the first across the outline to the exit hit.

impl Font

pub fn face(&self) -> &FontFace

Reference the font face source of this font.

pub fn harfbuzz(&self) -> Option<Face<'_>>

Gets the sized harfbuzz font.

pub fn size(&self) -> Px

Font size.

This is also the pixels-per-em value.

pub fn variations(&self) -> &RFontVariations

Custom font variations.

pub fn metrics(&self) -> &FontMetrics

Sized font metrics.

pub fn ligature_caret_offsets( &self, lig: GlyphIndex, ) -> impl ExactSizeIterator<Item = f32> + DoubleEndedIterator + '_

Iterate over pixel offsets relative to lig glyph start that represents the caret offset for each cluster that is covered by the ligature, after the first.

The caret offset for the first cluster is the glyph offset and is not yielded in the iterator. The yielded offsets are relative to the glyph position.

Trait Implementations

impl Clone for Font

fn clone(&self) -> Font

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Font

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

Formats the value using the given formatter.

impl Font for Font

fn is_empty_fallback(&self) -> bool

Gets if the font is the fallback that does not have any glyph.

fn renderer_id( &self, renderer: &ViewRenderer, synthesis: FontSynthesis, ) -> FontId

Gets the instance key in the renderer namespace.

impl PartialEq for Font

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Font