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.

Contributing

Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.

Documentation

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

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.15.3.tar.gz (63.5 kB view details)

Uploaded Source

File details

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

File metadata

  • Download URL: adafruit-circuitpython-imageload-1.15.3.tar.gz
  • Upload date:
  • Size: 63.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.6.0 importlib_metadata/4.8.2 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.10.0

File hashes

Hashes for adafruit-circuitpython-imageload-1.15.3.tar.gz
Algorithm Hash digest
SHA256 a628c55183a23bde1260f3051f1a2b2096a2beea196adfad0ac3d79ecf184510
MD5 4fabe3581e8a3b7e70b6193b500f6a5e
BLAKE2b-256 3aa91fc90e5b6c72e37f95d209148d547267eeb57b19112e11dd334445a73cc9

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