Struct agui_primitives::FontArc

pub struct FontArc(_);

Font implementor that wraps another concrete Font + 'static type storing in an Arc.

Provides convenient type erasure & cheap clones (particularly for FontVec).

Example

use ab_glyph::{Font, FontArc};

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

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

Implementations

impl FontArc

pub fn new<F>(font: F) -> FontArc where
    F: 'static + Font + Send + Sync, 

Example

let font_arc = FontArc::new(font_vec);

pub fn try_from_vec(data: Vec<u8, Global>) -> Result<FontArc, InvalidFont>

Creates an FontArc from owned data.

Example

let font = FontArc::try_from_vec(owned_font_data)?;

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

Creates an FontArc from a byte-slice.

Example

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

Trait Implementations

impl Clone for FontArc

pub fn clone(&self) -> FontArc

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FontArc

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

Formats the value using the given formatter.

impl Font for FontArc

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

Get the size of the font unit

pub fn ascent_unscaled(&self) -> f32

Unscaled glyph ascent.

pub fn descent_unscaled(&self) -> f32

Unscaled glyph descent.

pub fn line_gap_unscaled(&self) -> f32

Unscaled line gap.

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

Lookup a GlyphId matching a given char.

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

Unscaled horizontal advance for a given glyph id.

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

Unscaled horizontal side bearing for a given glyph id.

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

Unscaled vertical advance for a given glyph id.

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

Unscaled vertical side bearing for a given glyph id.

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

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

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

Compute unscaled glyph outline curves & bounding box.

pub 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()

pub fn codepoint_ids(&self) -> CodepointIdIter<'_>

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

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

Returns a pre-rendered image of the glyph.

fn height_unscaled(&self) -> f32

Unscaled height ascent - descent.

fn glyph_bounds(&self, glyph: &Glyph) -> Rect

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

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

Compute glyph outline ready for drawing.

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

Construct a PxScaleFontRef by associating with the given pixel scale.

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

Move into a PxScaleFont associated with the given pixel scale.

impl From<Arc<dyn Font + Sync + Send + 'static>> for FontArc

pub fn from(font: Arc<dyn Font + Sync + Send + 'static>) -> FontArc

Performs the conversion.

impl From<FontRef<'static>> for FontArc

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

Performs the conversion.

impl From<FontVec> for FontArc

pub fn from(font: FontVec) -> FontArc

Performs the conversion.