Skip to main content

Loads bitmap fonts into CircuitPython displayio.

Project description

Introduction

Documentation Status Discord Build Status

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 .env
source .env/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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

File details

Details for the file adafruit-circuitpython-bitmap_font-1.5.8.tar.gz.

File metadata

File hashes

Hashes for adafruit-circuitpython-bitmap_font-1.5.8.tar.gz
Algorithm Hash digest
SHA256 5a116bae7e579e9ef831b0281d179f367c6837c909f5a8db7d537993b1ccd3c6
MD5 2150697e702eaacaace196b24a97d319
BLAKE2b-256 35243f9536329a3fb46163ceb4021a0d18a67ec362cedfa8beeba1a0e5fe4e1b

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page