adafruit_bitmap_font.bdf

Loads BDF format fonts.

  • Author(s): Scott Shawcroft

Implementation Notes

Hardware:

Software and Dependencies:

class adafruit_bitmap_font.bdf.BDF(f: FileIO, bitmap_class: Bitmap)

Loads glyphs from a BDF file in the given bitmap_class.

property ascent: int | None

The number of pixels above the baseline of a typical ascender

property descent: int | None

The number of pixels below the baseline of a typical descender

get_bounding_box() → Tuple[int, int, int, int]

Return the maximum glyph size as a 4-tuple of: width, height, x_offset, y_offset

load_glyphs(code_points: int | str | Iterable[int]) → None

Loads displayio.Glyph objects into the GlyphCache from the font.

adafruit_bitmap_font.bitmap_font

Loads bitmap glyphs from a variety of font.

  • Author(s): Scott Shawcroft

Implementation Notes

Hardware:

Software and Dependencies:

adafruit_bitmap_font.bitmap_font.load_font(filename: str, bitmap: Bitmap | None = None) → BDF | PCF | TTF

Loads a font file. Returns None if unsupported.

adafruit_bitmap_font.glyph_cache

Displays text using CircuitPython’s displayio.

  • Author(s): Scott Shawcroft

Implementation Notes

Hardware:

Software and Dependencies:

class adafruit_bitmap_font.glyph_cache.GlyphCache

Caches glyphs loaded by a subclass.

get_glyph(code_point: int) → fontio.Glyph

Returns a displayio.Glyph for the given code point or None is unsupported.

load_glyphs(code_points: int | str | Iterable[int]) → None

Loads displayio.Glyph objects into the GlyphCache from the font.

adafruit_bitmap_font.pcf

Loads PCF format fonts.

  • Author(s): Jeff Epler

Implementation Notes

Hardware:

Software and Dependencies:

class adafruit_bitmap_font.pcf.Accelerators(no_overlap, constant_metrics, terminal_font, constant_width, ink_inside, ink_metrics, draw_direction, font_ascent, font_descent, max_overlap, minbounds, maxbounds, ink_minbounds, ink_maxbounds)
constant_metrics

Alias for field number 1

constant_width

Alias for field number 3

draw_direction

Alias for field number 6

font_ascent

Alias for field number 7

font_descent

Alias for field number 8

ink_inside

Alias for field number 4

ink_maxbounds

Alias for field number 13

ink_metrics

Alias for field number 5

ink_minbounds

Alias for field number 12

max_overlap

Alias for field number 9

maxbounds

Alias for field number 11

minbounds

Alias for field number 10

no_overlap

Alias for field number 0

terminal_font

Alias for field number 2

class adafruit_bitmap_font.pcf.Bitmap(glyph_count, bitmap_sizes)
bitmap_sizes

Alias for field number 1

glyph_count

Alias for field number 0

class adafruit_bitmap_font.pcf.Encoding(min_byte2, max_byte2, min_byte1, max_byte1, default_char)
default_char

Alias for field number 4

max_byte1

Alias for field number 3

max_byte2

Alias for field number 1

min_byte1

Alias for field number 2

min_byte2

Alias for field number 0

class adafruit_bitmap_font.pcf.Metrics(left_side_bearing, right_side_bearing, character_width, character_ascent, character_descent, character_attributes)
character_ascent

Alias for field number 3

character_attributes

Alias for field number 5

character_descent

Alias for field number 4

character_width

Alias for field number 2

left_side_bearing

Alias for field number 0

right_side_bearing

Alias for field number 1

class adafruit_bitmap_font.pcf.PCF(f: FileIO, bitmap_class: Bitmap)

Loads glyphs from a PCF file in the given bitmap_class.

property ascent: int

The number of pixels above the baseline of a typical ascender

property descent: int

The number of pixels below the baseline of a typical descender

get_bounding_box() → Tuple[int, int, int, int]

Return the maximum glyph size as a 4-tuple of: width, height, x_offset, y_offset

load_glyphs(code_points: int | str | Iterable[int]) → None

Loads displayio.Glyph objects into the GlyphCache from the font.

class adafruit_bitmap_font.pcf.Table(format, size, offset)
format

Alias for field number 0

offset

Alias for field number 2

size

Alias for field number 1