Struct ab_glyph::FontRef

pub struct FontRef<'font>(_);

Font data handle stored as a &[u8] + parsed data. See Font for more methods.

Also see the owned version FontVec.

Example

use ab_glyph::{Font, FontRef};

let font = FontRef::try_from_slice(include_bytes!("../../dev/fonts/Exo2-Light.otf"))?;

assert_eq!(font.glyph_id('s'), ab_glyph::GlyphId(56));

Implementations

impl<'font> FontRef<'font>

pub fn try_from_slice(data: &'font [u8]) -> Result<Self, InvalidFont>

Creates an FontRef from a byte-slice.

For font collections see FontRef::try_from_slice_and_index.

Example

let font = FontRef::try_from_slice(include_bytes!("../../dev/fonts/Exo2-Light.otf"))?;

pub fn try_from_slice_and_index(
    data: &'font [u8],
    index: u32
) -> Result<Self, InvalidFont>

Creates an FontRef from byte-slice.

You can set index for font collections. For simple fonts use 0 or FontRef::try_from_slice.

Example

let font =
    FontRef::try_from_slice_and_index(include_bytes!("../../dev/fonts/Exo2-Light.otf"), 0)?;

Trait Implementations

impl<'font> Clone for FontRef<'font>

fn clone(&self) -> FontRef<'font>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FontRef<'_>

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

Formats the value using the given formatter.

impl Font for FontRef<'_>

fn units_per_em(&self) -> Option<f32>

Get the size of the font unit

fn ascent_unscaled(&self) -> f32

Unscaled glyph ascent.

fn descent_unscaled(&self) -> f32

Unscaled glyph descent.

fn line_gap_unscaled(&self) -> f32

Unscaled line gap.

fn glyph_id(&self, c: char) -> GlyphId

Lookup a GlyphId matching a given char.

fn h_advance_unscaled(&self, id: GlyphId) -> f32

Unscaled horizontal advance for a given glyph id.

fn h_side_bearing_unscaled(&self, id: GlyphId) -> f32

Unscaled horizontal side bearing for a given glyph id.

fn v_advance_unscaled(&self, id: GlyphId) -> f32

Unscaled vertical advance for a given glyph id.

fn v_side_bearing_unscaled(&self, id: GlyphId) -> f32

Unscaled vertical side bearing for a given glyph id.

fn kern_unscaled(&self, first: GlyphId, second: GlyphId) -> f32

Returns additional unscaled kerning to apply for a particular pair of glyph ids.

fn outline(&self, id: GlyphId) -> Option<Outline>

Compute unscaled glyph outline curves & bounding box.

fn glyph_count(&self) -> usize

The number of glyphs present in this font. Glyph identifiers for this font will always be in the range 0..self.glyph_count()

fn codepoint_ids<'a>(&'a self) -> CodepointIdIter<'a>

Returns an iterator of all distinct (GlyphId, char) pairs. Not ordered.

fn glyph_raster_image(&self, id: GlyphId, size: u16) -> Option<GlyphImage<'_>>

Returns a pre-rendered image of the glyph.

fn pt_to_px_scale(&self, pt_size: f32) -> Option<PxScale>

Converts pt units into PxScale.

fn height_unscaled(&self) -> f32

Unscaled height ascent - descent.

fn glyph_bounds(&self, glyph: &Glyph) -> Rectwhere
    Self: Sized,

Returns the layout bounds of this glyph. These are different to the outline px_bounds().

fn outline_glyph(&self, glyph: Glyph) -> Option<OutlinedGlyph>where
    Self: Sized,

Compute glyph outline ready for drawing.

fn as_scaled<S: Into<PxScale>>(&self, scale: S) -> PxScaleFont<&Self>where
    Self: Sized,

Construct a PxScaleFontRef by associating with the given pixel scale.

fn into_scaled<S: Into<PxScale>>(self, scale: S) -> PxScaleFont<Self>where
    Self: Sized,

Move into a PxScaleFont associated with the given pixel scale.

impl From<FontRef<'static>> for FontArc

fn from(font: FontRef<'static>) -> Self

Converts to this type from the input type.

impl VariableFont for FontRef<'_>

fn set_variation(&mut self, axis: &[u8; 4], value: f32) -> bool

Sets a variation axis coordinate value by it’s tag.

fn variations(&self) -> Vec<VariationAxis>

Returns variation axes.