Skip to main content

Displays text using CircuitPython's displayio.

Project description

Introduction

Documentation Status Discord Build Status

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()
group.append(tile_grid)
board.DISPLAY.show(group)

while True:
    pass

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-imageload-1.16.0.tar.gz (65.8 kB view details)

Uploaded Source

File details

Details for the file adafruit-circuitpython-imageload-1.16.0.tar.gz.

File metadata

File hashes

Hashes for adafruit-circuitpython-imageload-1.16.0.tar.gz
Algorithm Hash digest
SHA256 e99bda7cdb1fc9d2f5f452aa6cd7b861a96fa3ed53500dd63807e2c5a4bee59b
MD5 1ef138e9e999654306c0f77991c68aa7
BLAKE2b-256 2b6ac8595600f509328842658f30bb9f91954aef5dcbbeccdb50e550fcccd6bc

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