Struct GlyphRun 

pub struct GlyphRun<'a> { /* private fields */ }

A sequence of positioned glyphs with effects

Yielded by TextDisplay::runs.

Implementations

impl<'a> GlyphRun<'a>

pub fn face_id(&self) -> FaceId

Get the font face used for this run

pub fn dpem(&self) -> f32

Get the font size used for this run

Units are dots-per-Em (see crate::fonts).

pub fn glyphs(&self) -> impl Iterator<Item = Glyph> + '_

Get an iterator over glyphs for this run

This method ignores effects; if you want those call Self::glyphs_with_effects instead.

pub fn glyphs_with_effects<F, G>(&self, f: F, g: G)

where F: FnMut(Glyph, u16), G: FnMut(f32, f32, f32, f32, u16),

Yield glyphs and effects for this run

The callback f receives glyph, e where e is the Effect::e value (defaults to 0).

The callback g receives positioning for each underline/strike-through segment: x1, x2, y_top, h where h is the thickness (height). Note that it is possible to have h < 1.0 and y_top, y_top + h to round to the same number; the renderer is responsible for ensuring such lines are actually visible. The last parameter is e as for f.

Note: this is more computationally expensive than GlyphRun::glyphs, so you may prefer to call that. Optionally one may choose to cache the result, though this is not really necessary.