Introduction¶
Loads bitmap fonts into CircuitPython’s displayio. BDF and PCF files are well supported. TTF support is not yet complete.
Dependencies¶
This driver depends on:
Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading the Adafruit library and driver bundle.
Installing from PyPI¶
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally from PyPI. To install for current user:
pip3 install adafruit-circuitpython-bitmap_font
To install system-wide (this may be required in some cases):
sudo pip3 install adafruit-circuitpython-bitmap_font
To install in a virtual environment in your current project:
mkdir project-name && cd project-name
python3 -m venv .venv
source .venv/bin/activate
pip3 install adafruit-circuitpython-bitmap_font
Usage Example¶
from adafruit_bitmap_font import bitmap_font
from displayio import Bitmap
font = bitmap_font.load_font("fonts/LeagueSpartan-Bold-16.bdf", Bitmap)
print(font.get_glyph(ord("A")))
Creating Fonts¶
See this learn guide for more information about building custom fornt files
The command line tool otf2bdf
can be used make bdf files for use with this library.
The command line tool bdftopcf
can be used make pcf files for use with this library.
Documentation¶
API documentation for this library can be found on Read the Docs.
For information on building library documentation, please check out this guide.
Contributing¶
Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.
Table of Contents¶
API Reference
adafruit_bitmap_font.bdf
BDF
adafruit_bitmap_font.bitmap_font
load_font()
adafruit_bitmap_font.glyph_cache
GlyphCache
adafruit_bitmap_font.pcf
Accelerators
Accelerators.constant_metrics
Accelerators.constant_width
Accelerators.draw_direction
Accelerators.font_ascent
Accelerators.font_descent
Accelerators.ink_inside
Accelerators.ink_maxbounds
Accelerators.ink_metrics
Accelerators.ink_minbounds
Accelerators.max_overlap
Accelerators.maxbounds
Accelerators.minbounds
Accelerators.no_overlap
Accelerators.terminal_font
Bitmap
Encoding
Metrics
PCF
Table