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.
<https://learn.adafruit.com/creating-your-first-tilemap-game-with-circuitpython/indexed-bmp-graphics>`_
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 <https://docs.circuitpython.org/projects/imageload/en/latest/>`_.
For information on building library documentation, please check out `this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.
Contributing
============
Contributions are welcome! Please read our `Code of Conduct
<https://github.com/adafruit/Adafruit_CircuitPython_ImageLoad/blob/main/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": null,
"name": "adafruit-circuitpython-imageload",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "adafruit, blinka, circuitpython, micropython, bitmap, fonts, text, display, tft, lcd, displayio, imageload, image",
"author": null,
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/98/f1/4c225668791bcfbce9321d87a8986f4a95a378884dfbef642f55f7ac4ae9/adafruit_circuitpython_imageload-1.23.3.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-imageload/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/imageload/en/latest/\n :alt: Documentation Status\n\n.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg\n :target: https://adafru.it/discord\n :alt: Discord\n\n.. image:: https://github.com/adafruit/Adafruit_CircuitPython_ImageLoad/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_ImageLoad/actions/\n :alt: Build Status\n\n.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json\n :target: https://github.com/astral-sh/ruff\n :alt: Code Style: Ruff\n\nThis library decodes an image file into new bitmap and palette objects of the provided type. It's\ndesigned to load code needed during decoding as needed. This is meant to minimize the memory\noverhead of the decoding code.\n\nOnly 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.\n<https://learn.adafruit.com/creating-your-first-tilemap-game-with-circuitpython/indexed-bmp-graphics>`_\n\nUsage Example\n=============\n\n.. code-block:: python\n\n import board\n import displayio\n import adafruit_imageload\n\n image, palette = adafruit_imageload.load(\n \"images/4bit.bmp\", bitmap=displayio.Bitmap, palette=displayio.Palette\n )\n tile_grid = displayio.TileGrid(image, pixel_shader=palette)\n\n group = displayio.Group()\n group.append(tile_grid)\n board.DISPLAY.root_group = group\n while True:\n pass\n\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/imageload/en/latest/>`_.\n\nFor information on building library documentation, please check out `this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.\n\nContributing\n============\n\nContributions are welcome! Please read our `Code of Conduct\n<https://github.com/adafruit/Adafruit_CircuitPython_ImageLoad/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Displays text using CircuitPython's displayio.",
"version": "1.23.3",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_ImageLoad"
},
"split_keywords": [
"adafruit",
" blinka",
" circuitpython",
" micropython",
" bitmap",
" fonts",
" text",
" display",
" tft",
" lcd",
" displayio",
" imageload",
" image"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d8cee54f5bb60d9c1058b2a4477852ae07bd5b42942740bbfe17ae70023f7ad3",
"md5": "c1392755c4b45a667ccba0ab354d8f21",
"sha256": "16f380b159197b9663686dc7bebf21f78bc0d3efa4d49fd7e0586ad1841cb281"
},
"downloads": -1,
"filename": "adafruit_circuitpython_imageload-1.23.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c1392755c4b45a667ccba0ab354d8f21",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 27920,
"upload_time": "2024-10-20T15:48:27",
"upload_time_iso_8601": "2024-10-20T15:48:27.886928Z",
"url": "https://files.pythonhosted.org/packages/d8/ce/e54f5bb60d9c1058b2a4477852ae07bd5b42942740bbfe17ae70023f7ad3/adafruit_circuitpython_imageload-1.23.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "98f14c225668791bcfbce9321d87a8986f4a95a378884dfbef642f55f7ac4ae9",
"md5": "2bf7c1e67a3150276e07532e46589d60",
"sha256": "95559151068f903b5abc2394f6d45d90dbe69953c8aae41d51d54ae4b767188e"
},
"downloads": -1,
"filename": "adafruit_circuitpython_imageload-1.23.3.tar.gz",
"has_sig": false,
"md5_digest": "2bf7c1e67a3150276e07532e46589d60",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 93105,
"upload_time": "2024-10-20T15:48:28",
"upload_time_iso_8601": "2024-10-20T15:48:28.888446Z",
"url": "https://files.pythonhosted.org/packages/98/f1/4c225668791bcfbce9321d87a8986f4a95a378884dfbef642f55f7ac4ae9/adafruit_circuitpython_imageload-1.23.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-20 15:48:28",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_ImageLoad",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "adafruit-circuitpython-imageload"
}
JSON
