Skip to main content

Loads bitmap fonts into CircuitPython displayio.

Project description

Introduction

Documentation Status Discord Build Status Code Style: Black

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.

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

adafruit-circuitpython-bitmap_font-2.0.1.tar.gz (173.5 kB view details)

Uploaded Source

Built Distribution

File details

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

File metadata

File hashes

Hashes for adafruit-circuitpython-bitmap_font-2.0.1.tar.gz
Algorithm Hash digest
SHA256 2c40c45c2b7de636ae59f11b8ab615ffdd52205f314e10251608ceec1ade0c3f
MD5 46888ca5cecadd8b100ba2ff6aa6efdd
BLAKE2b-256 399ba722659b82c207d4d922476da7b6ebd9ecfbbf6a0af31651a72ce50c6d37

See more details on using hashes here.

File details

Details for the file adafruit_circuitpython_bitmap_font-2.0.1-py3-none-any.whl.

File metadata

File hashes

Hashes for adafruit_circuitpython_bitmap_font-2.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 4e594169f842673640101be88742c878eea6890b6bbafd0a8a60ab8a11804a45
MD5 40d7f40b680220b17292f961cad6011e
BLAKE2b-256 a2f7f936bfd4d09bebc4921d71d839be3088ddba1e122ec0ae75877849626603

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