displayio/_palette.py

   1 # SPDX-FileCopyrightText: 2020 Melissa LeBlanc-Williams for Adafruit Industries
   2 #
   3 # SPDX-License-Identifier: MIT
   4
   5 """
   6 `displayio.palette`
   7 ================================================================================
   8
   9 displayio for Blinka
  10
  11 **Software and Dependencies:**
  12
  13 * Adafruit Blinka:
  14   https://github.com/adafruit/Adafruit_Blinka/releases
  15
  16 * Author(s): Melissa LeBlanc-Williams
  17
  18 """
  19
  20 from typing import Optional, Union, Tuple
  21 from circuitpython_typing import ReadableBuffer
  22 from ._colorconverter import ColorConverter
  23 from ._colorspace import Colorspace
  24 from ._structs import InputPixelStruct, OutputPixelStruct, ColorStruct
  25
  26 __version__ = "0.0.0+auto.0"
  27 __repo__ = "https://github.com/adafruit/Adafruit_Blinka_displayio.git"
  28
  29
  30 class Palette:
  31     """Map a pixel palette_index to a full color. Colors are transformed to the display's
  32     format internally to save memory.
  33     """
  34
  35     def __init__(self, color_count: int, *, dither: bool = False):
  36         """Create a Palette object to store a set number of colors.
  37
  38         :param int color_count: The number of colors in the Palette
  39         :param bool dither: When true, dither the RGB color before converting to the
  40                             display's color space
  41         """
  42         self._needs_refresh = False
  43         self._dither = dither
  44
  45         self._colors = []
  46         for _ in range(color_count):
  47             self._colors.append(self._make_color(0))
  48
  49     @staticmethod
  50     def _make_color(value, transparent=False):
  51         color = ColorStruct(transparent=transparent)
  52
  53         if isinstance(value, (tuple, list, bytes, bytearray)):
  54             value = (value[0] & 0xFF) << 16 | (value[1] & 0xFF) << 8 | value[2] & 0xFF
  55         elif isinstance(value, int):
  56             if not 0 <= value <= 0xFFFFFF:
  57                 raise ValueError("Color must be between 0x000000 and 0xFFFFFF")
  58         else:
  59             raise TypeError("Color buffer must be a buffer, tuple, list, or int")
  60         color.rgb888 = value
  61
  62         return color
  63
  64     def __len__(self) -> int:
  65         """Returns the number of colors in a Palette"""
  66         return len(self._colors)
  67
  68     def __setitem__(
  69         self,
  70         index: int,
  71         value: Union[int, ReadableBuffer, Tuple[int, int, int]],
  72     ) -> None:
  73         """Sets the pixel color at the given index. The index should be
  74         an integer in the range 0 to color_count-1.
  75
  76         The value argument represents a color, and can be from 0x000000 to 0xFFFFFF
  77         (to represent an RGB value). Value can be an int, bytes (3 bytes (RGB) or
  78         4 bytes (RGB + pad byte)), bytearray, or a tuple or list of 3 integers.
  79         """
  80         if self._colors[index].rgb888 == value:
  81             return
  82         self._colors[index] = self._make_color(value)
  83         self._colors[index].cached_colorspace = None
  84         self._needs_refresh = True
  85
  86     def __getitem__(self, index: int) -> Optional[int]:
  87         if not 0 <= index < len(self._colors):
  88             raise ValueError("Palette index out of range")
  89         return self._colors[index].rgb888
  90
  91     def make_transparent(self, palette_index: int) -> None:
  92         """Set the palette index to be a transparent color"""
  93         self._colors[palette_index].transparent = True
  94         self._needs_refresh = True
  95
  96     def make_opaque(self, palette_index: int) -> None:
  97         """Set the palette index to be an opaque color"""
  98         self._colors[palette_index].transparent = False
  99         self._needs_refresh = True
 100
 101     def _get_color(
 102         self,
 103         colorspace: Colorspace,
 104         input_pixel: InputPixelStruct,
 105         output_color: OutputPixelStruct,
 106     ):
 107         palette_index = input_pixel.pixel
 108         if palette_index > len(self._colors) or self._colors[palette_index].transparent:
 109             output_color.opaque = False
 110             return
 111
 112         color = self._colors[palette_index]
 113         if (
 114             not self._dither
 115             and color.cached_colorspace == colorspace
 116             and color.cached_colorspace_grayscale_bit == colorspace.grayscale_bit
 117             and color.cached_colorspace_grayscale == colorspace.grayscale
 118         ):
 119             output_color.pixel = self._colors[palette_index].cached_color
 120             return
 121
 122         rgb888_pixel = input_pixel
 123         rgb888_pixel.pixel = self._colors[palette_index].rgb888
 124         ColorConverter._convert_color(  # pylint: disable=protected-access
 125             colorspace, self._dither, rgb888_pixel, output_color
 126         )
 127         if not self._dither:
 128             color.cached_colorspace = colorspace
 129             color.cached_color = output_color.pixel
 130             color.cached_colorspace_grayscale = colorspace.grayscale
 131             color.cached_colorspace_grayscale_bit = colorspace.grayscale_bit
 132
 133     def is_transparent(self, palette_index: int) -> bool:
 134         """Returns True if the palette index is transparent. Returns False if opaque."""
 135         return self._colors[palette_index].transparent
 136
 137     def _finish_refresh(self):
 138         self._needs_refresh = False
 139
 140     @property
 141     def dither(self) -> bool:
 142         """When true the palette dithers the output by adding
 143         random noise when truncating to display bitdepth
 144         """
 145         return self._dither
 146
 147     @dither.setter
 148     def dither(self, value: bool):
 149         if not isinstance(value, bool):
 150             raise ValueError("Value should be boolean")
 151         self._dither = value