Struct sdf_glyph_renderer::BitmapGlyph

pub struct BitmapGlyph { /* fields omitted */ }

A raw bitmap containing only the alpha channel.

Implementations

impl BitmapGlyph

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

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.

Panics

The caller is responsible for checking the integrity of the data. If the dimensions provided can’t describe the input data, this function will panic.

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

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.

Panics

The caller is responsible for checking the integrity of the data. If the dimensions provided can’t describe the input data, this function will panic.

Trait Implementations

impl Debug for BitmapGlyph

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

Formats the value using the given formatter.

impl PartialEq<BitmapGlyph> 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: &BitmapGlyph) -> bool

This method tests for !=.

impl StructuralPartialEq for BitmapGlyph