Struct sdf_glyph_renderer::BitmapGlyph

pub struct BitmapGlyph { /* private fields */ }

A raw bitmap containing only the alpha channel.

Implementations

impl BitmapGlyph

pub fn new( alpha: Vec<u8>, width: usize, height: usize, buffer: usize ) -> Result<BitmapGlyph, SdfGlyphError>

Creates a new bitmap from scratch.

This constructor is useful when you already have a buffered glyph. If you have the alpha bitmap but still need to buffer it (what you expect from most font renderers, for example), use Self::from_unbuffered() instead.

The dimensions provided is expected to describe the input data.

pub fn from_unbuffered( alpha: &[u8], width: usize, height: usize, buffer: usize ) -> Result<BitmapGlyph, SdfGlyphError>

Creates a new bitmap from a raw data source, buffered by a given amount.

Most SDF glyphs are buffered a bit so that the outer edges can be properly captured. This constructor does the buffering for you.

The dimensions provided is expected to describe the input data.

pub fn render_sdf(&self, radius: usize) -> Vec<f64>

Render a signed distance field for the given bitmap, recording distances out to radius pixels from the shape outline (the rest will be clamped). The range of the output field is [-1.0, 1.0], normalised to units of radius.

Trait Implementations

impl Debug for BitmapGlyph

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

Formats the value using the given formatter.

impl PartialEq for BitmapGlyph

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for BitmapGlyph

impl StructuralPartialEq for BitmapGlyph