Introduction
============
.. image:: https://readthedocs.org/projects/blinka_displayio_pygamedisplay/badge/?version=stable
:target: https://blinka-displayio-pygamedisplay.readthedocs.io/en/stable/
:alt: Documentation Status
.. image:: https://img.shields.io/discord/327254708534116352.svg
:target: https://adafru.it/discord
:alt: Discord
.. image:: https://github.com/foamyguy/Blinka_Displayio_PyGameDisplay/workflows/Build%20CI/badge.svg
:target: https://github.com/foamyguy/Blinka_Displayio_PyGameDisplay/actions
:alt: Build Status
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black
:alt: Code Style: Black
.. image:: https://github.com/FoamyGuy/Blinka_Displayio_PyGameDisplay/blob/main/banner.png?raw=true
:alt: PyGame + Blinka
Blinka makes her debut on the big screen! With this library you can use CircuitPython ``displayio`` code on PC and Raspberry Pi to output to a PyGame window instead of a hardware display connected to I2C or SPI. This makes it easy to to use ``displayio`` elements on HDMI and other large format screens.
Warning: you must check ``display.check_quit()`` in the main loop and ``break`` if it's true in order to correctly handle the close button!
Dependencies
=============
This driver depends on:
* `PyGame <https://github.com/pygame/pygame>`_
* `Adafruit Blinka Displayio <https://github.com/adafruit/Adafruit_Blinka_Displayio>`_
Please ensure all dependencies are available they can be installed with pip3
Optional Dependencies
=====================
This driver can optionally make use of these ``displayio`` module libraries:
* `Adafruit Display Text <https://github.com/adafruit/Adafruit_CircuitPython_Display_Text>`_
* `Adafruit ImageLoad <https://github.com/adafruit/Adafruit_CircuitPython_ImageLoad>`_
* `Adafruit Progress Bar <https://github.com/adafruit/Adafruit_CircuitPython_ProgressBar>`_
* `Adafruit Display Button <https://github.com/adafruit/Adafruit_CircuitPython_Display_Button>`_
They can be installed with pip3.
Installing from PyPI
=====================
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
PyPI <https://pypi.org/project/adafruit-circuitpython-blinka_displayio_pygamedisplay/>`_. To install for current user:
.. code-block:: shell
pip3 install blinka-displayio-pygamedisplay
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install blinka-displayio-pygamedisplay
To install in a virtual environment in your current project:
.. code-block:: shell
mkdir project-name && cd project-name
python3 -m venv .env
source .env/bin/activate
pip3 install blinka-displayio-pygamedisplay
Usage Example
=============
.. code-block:: python
import displayio
from blinka_displayio_pygamedisplay import PyGameDisplay
display = PyGameDisplay(width=320, height=240)
splash = displayio.Group()
display.show(splash)
color_bitmap = displayio.Bitmap(display.width, display.height, 1)
color_palette = displayio.Palette(1)
color_palette[0] = 0x00FF00 # Bright Green
bg_sprite = displayio.TileGrid(color_bitmap, pixel_shader=color_palette, x=0, y=0)
splash.append(bg_sprite)
# Must check display.running in the main loop!
while True:
if display.check_quit():
break
Contributing
============
Contributions are welcome! Please read our `Code of Conduct
<https://github.com/foamyguy/Foamyguy_CircuitPython_Blinka_Displayio_PyGameDisplay/blob/master/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Documentation
=============
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>`_.
Raw data
{
"_id": null,
"home_page": "",
"name": "blinka-displayio-pygamedisplay",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "adafruit,blinka,circuitpython,micropython,blinka_displayio_pygamedisplay,displayio,hdmi,pc,window,pygame",
"author": "",
"author_email": "Tim C <foamyguy@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/26/c9/ff2567e37873e723c79af7a963fce55f9386134b6e3e12c36290d7c512c3/blinka-displayio-pygamedisplay-2.3.0.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n.. image:: https://readthedocs.org/projects/blinka_displayio_pygamedisplay/badge/?version=stable\n :target: https://blinka-displayio-pygamedisplay.readthedocs.io/en/stable/\n :alt: Documentation Status\n\n.. image:: https://img.shields.io/discord/327254708534116352.svg\n :target: https://adafru.it/discord\n :alt: Discord\n\n.. image:: https://github.com/foamyguy/Blinka_Displayio_PyGameDisplay/workflows/Build%20CI/badge.svg\n :target: https://github.com/foamyguy/Blinka_Displayio_PyGameDisplay/actions\n :alt: Build Status\n\n.. image:: https://img.shields.io/badge/code%20style-black-000000.svg\n :target: https://github.com/psf/black\n :alt: Code Style: Black\n\n.. image:: https://github.com/FoamyGuy/Blinka_Displayio_PyGameDisplay/blob/main/banner.png?raw=true\n :alt: PyGame + Blinka\n\nBlinka makes her debut on the big screen! With this library you can use CircuitPython ``displayio`` code on PC and Raspberry Pi to output to a PyGame window instead of a hardware display connected to I2C or SPI. This makes it easy to to use ``displayio`` elements on HDMI and other large format screens.\n\nWarning: you must check ``display.check_quit()`` in the main loop and ``break`` if it's true in order to correctly handle the close button!\n\nDependencies\n=============\nThis driver depends on:\n\n* `PyGame <https://github.com/pygame/pygame>`_\n* `Adafruit Blinka Displayio <https://github.com/adafruit/Adafruit_Blinka_Displayio>`_\n\nPlease ensure all dependencies are available they can be installed with pip3\n\n\nOptional Dependencies\n=====================\nThis driver can optionally make use of these ``displayio`` module libraries:\n\n* `Adafruit Display Text <https://github.com/adafruit/Adafruit_CircuitPython_Display_Text>`_\n* `Adafruit ImageLoad <https://github.com/adafruit/Adafruit_CircuitPython_ImageLoad>`_\n* `Adafruit Progress Bar <https://github.com/adafruit/Adafruit_CircuitPython_ProgressBar>`_\n* `Adafruit Display Button <https://github.com/adafruit/Adafruit_CircuitPython_Display_Button>`_\n\nThey can be installed with pip3.\n\nInstalling from PyPI\n=====================\n\nOn supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from\nPyPI <https://pypi.org/project/adafruit-circuitpython-blinka_displayio_pygamedisplay/>`_. To install for current user:\n\n.. code-block:: shell\n\n pip3 install blinka-displayio-pygamedisplay\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install blinka-displayio-pygamedisplay\n\nTo install in a virtual environment in your current project:\n\n.. code-block:: shell\n\n mkdir project-name && cd project-name\n python3 -m venv .env\n source .env/bin/activate\n pip3 install blinka-displayio-pygamedisplay\n\nUsage Example\n=============\n\n.. code-block:: python\n\n import displayio\n from blinka_displayio_pygamedisplay import PyGameDisplay\n\n display = PyGameDisplay(width=320, height=240)\n splash = displayio.Group()\n display.show(splash)\n\n color_bitmap = displayio.Bitmap(display.width, display.height, 1)\n color_palette = displayio.Palette(1)\n color_palette[0] = 0x00FF00 # Bright Green\n\n bg_sprite = displayio.TileGrid(color_bitmap, pixel_shader=color_palette, x=0, y=0)\n splash.append(bg_sprite)\n # Must check display.running in the main loop!\n\n while True:\n if display.check_quit():\n break\n\nContributing\n============\n\nContributions are welcome! Please read our `Code of Conduct\n<https://github.com/foamyguy/Foamyguy_CircuitPython_Blinka_Displayio_PyGameDisplay/blob/master/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n\nDocumentation\n=============\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",
"bugtrack_url": null,
"license": "MIT",
"summary": "Use CircuitPython displayio code on PC and Raspberry Pi outputting to a PyGame window instead of a physical display.",
"version": "2.3.0",
"project_urls": {
"Homepage": "https://github.com/foamyguy/Blinka_Displayio_PyGameDisplay"
},
"split_keywords": [
"adafruit",
"blinka",
"circuitpython",
"micropython",
"blinka_displayio_pygamedisplay",
"displayio",
"hdmi",
"pc",
"window",
"pygame"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f82c0ba1846479025856432d52cddccc1d84e00c06ec57ad2b0fef81d7aa79d9",
"md5": "2398c7e447c6d0884f1cc90246444ec8",
"sha256": "82c509e8dde1acfda66d18d3864ae8ad7fb222ee17b53c944f63080dd7683534"
},
"downloads": -1,
"filename": "blinka_displayio_pygamedisplay-2.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2398c7e447c6d0884f1cc90246444ec8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 6742,
"upload_time": "2023-08-22T22:34:59",
"upload_time_iso_8601": "2023-08-22T22:34:59.584724Z",
"url": "https://files.pythonhosted.org/packages/f8/2c/0ba1846479025856432d52cddccc1d84e00c06ec57ad2b0fef81d7aa79d9/blinka_displayio_pygamedisplay-2.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "26c9ff2567e37873e723c79af7a963fce55f9386134b6e3e12c36290d7c512c3",
"md5": "8669a0a1982e90fc4e60faab06dd636a",
"sha256": "bebc6e25930648108ad57bd4e16fcf17367e6f7a218c0f1adb53ed308e59680f"
},
"downloads": -1,
"filename": "blinka-displayio-pygamedisplay-2.3.0.tar.gz",
"has_sig": false,
"md5_digest": "8669a0a1982e90fc4e60faab06dd636a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 233590,
"upload_time": "2023-08-22T22:35:01",
"upload_time_iso_8601": "2023-08-22T22:35:01.744237Z",
"url": "https://files.pythonhosted.org/packages/26/c9/ff2567e37873e723c79af7a963fce55f9386134b6e3e12c36290d7c512c3/blinka-displayio-pygamedisplay-2.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-22 22:35:01",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "foamyguy",
"github_project": "Blinka_Displayio_PyGameDisplay",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "blinka-displayio-pygamedisplay"
}
JSON
