Skip to main content

Displays text using CircuitPython's displayio.

Project description


Documentation Status Discord Build Status Code Style: Black

This library decodes an image file into new bitmap and palette objects of the provided type. It’s designed to load code needed during decoding as needed. This is meant to minimize the memory overhead of the decoding code.

Only certain types of bitmaps work with this library, and they often have to be exported in specific ways. To find out what types are supported and how to make them, see this learn guide page.

Usage Example

import board
import displayio
import adafruit_imageload

image, palette = adafruit_imageload.load(
    "images/4bit.bmp", bitmap=displayio.Bitmap, palette=displayio.Palette
tile_grid = displayio.TileGrid(image, pixel_shader=palette)

group = displayio.Group()
board.DISPLAY.root_group = group
while True:


API documentation for this library can be found on Read the Docs.

For information on building library documentation, please check out this guide.


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

Built Distribution

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