cedargrovestudios / circuitpython_palettefader Goto Github PK

A CircuitPython color palette and list brightness setter and normalizer tool.

PaletteFader is a CircuitPython class for brightness-adjusting color lists and displayio palettes. Normalization (scaling all palette values relative to the brightest palette color) is optionally applied to the palette prior to brightness and gamma adjustments. Transparency index values are preserved and associated with the adjusted palette. Creates an adjusted displayio color palette object (displayio.Palette) property that can also be read as a color list.

Two versions of PaletteFader are contained in the cedargrove_palettefader package folder, palettefader and palettefader_ulab. The faster of the two is palettefader_ulab, requiring CircuitPython with ulab as a built-in module. Certain CircuitPython distributions and versions may not support ulab; check your specific implementation. For example, ulab is not included in MatrixPortal distributions after CircuitPython version 7.3.2. A list of built-in modules are listed for each distribution on the https://circuitpython.org/downloads page.

This driver depends on:

• Adafruit CircuitPython

Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading the Adafruit library and driver bundle or individual libraries can be installed using circup.

Make sure that you have circup installed in your Python environment. Install it with the following command if necessary:

pip3 install circup

With circup installed and your CircuitPython device connected use the following command to install:

circup install cedargrove_palettefader

Or the following command to update an existing version:

circup update

# For CircuitPython distributions without ulab (such as the MatrixPortal)
from cedargrove_palettefader.palettefader import PaletteFader

# Instantiate PaletteFader
faded_object = PaletteFader(source_palette=object_palette, brightness=0.5)

# For CircuitPython distributions with ulab
from cedargrove_palettefader.palettefader_ulab import PaletteFader

# Instantiate PaletteFader
faded_object = PaletteFader(source_palette=object_palette, brightness=0.5)

palettefader_simpletest.py and other examples can be found in the examples folder.

PaletteFader API Class Description

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