https://github.com/adafruit/adafruit_circuitpython_imageload

Super-slim image decoder that loads code as needed to minimize memory use
https://github.com/adafruit/adafruit_circuitpython_imageload

bitmap circuitpython graphics hacktoberfest

Last synced: 5 days ago
JSON representation

Super-slim image decoder that loads code as needed to minimize memory use

• Host: GitHub
• URL: https://github.com/adafruit/adafruit_circuitpython_imageload
• Owner: adafruit
• License: mit
• Created: 2018-08-30T20:29:07.000Z (over 6 years ago)
• Default Branch: main
• Last Pushed: 2025-01-17T18:38:17.000Z (16 days ago)
• Last Synced: 2025-01-28T22:37:33.371Z (5 days ago)
• Topics: bitmap, circuitpython, graphics, hacktoberfest
• Language: Python
• Size: 502 KB
• Stars: 15
• Watchers: 20
• Forks: 21
• Open Issues: 3
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
Introduction

============

.. image:: https://readthedocs.org/projects/adafruit-circuitpython-imageload/badge/?version=latest

    :target: https://docs.circuitpython.org/projects/imageload/en/latest/

    :alt: Documentation Status

.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg

    :target: https://adafru.it/discord

    :alt: Discord

.. image:: https://github.com/adafruit/Adafruit_CircuitPython_ImageLoad/workflows/Build%20CI/badge.svg

    :target: https://github.com/adafruit/Adafruit_CircuitPython_ImageLoad/actions/

    :alt: Build Status

.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json

    :target: https://github.com/astral-sh/ruff

    :alt: Code Style: Ruff

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

=============

.. code-block:: python

    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.root_group = 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.