Split module into multiple files

[hackapet/Adafruit_Blinka_Displayio.git] / displayio / palette.py

diff --git a/displayio/palette.py b/displayio/palette.py
new file mode 100644 (file)
index 0000000..7769ba7
--- /dev/null
+++ b/displayio/palette.py
@@ -0,0 +1,98 @@
+# The MIT License (MIT)
+#
+# Copyright (c) 2020 Melissa LeBlanc-Williams for Adafruit Industries
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+"""
+`displayio`
+================================================================================
+
+displayio for Blinka
+
+**Software and Dependencies:**
+
+* Adafruit Blinka:
+  https://github.com/adafruit/Adafruit_Blinka/releases
+
+* Author(s): Melissa LeBlanc-Williams
+
+"""
+
+__version__ = "0.0.0-auto.0"
+__repo__ = "https://github.com/adafruit/Adafruit_Blinka_displayio.git"
+
+
+class Palette:
+    """Map a pixel palette_index to a full color. Colors are transformed to the display’s
+    format internally to save memory.
+    """
+
+    def __init__(self, color_count):
+        """Create a Palette object to store a set number of colors."""
+        self._needs_refresh = False
+
+        self._colors = []
+        for _ in range(color_count):
+            self._colors.append(self._make_color(0))
+
+    def _make_color(self, value, transparent=False):
+        color = {
+            "transparent": transparent,
+            "rgb888": 0,
+        }
+        if isinstance(value, (tuple, list, bytes, bytearray)):
+            value = (value[0] & 0xFF) << 16 | (value[1] & 0xFF) << 8 | value[2] & 0xFF
+        elif isinstance(value, int):
+            if not 0 <= value <= 0xFFFFFF:
+                raise ValueError("Color must be between 0x000000 and 0xFFFFFF")
+        else:
+            raise TypeError("Color buffer must be a buffer, tuple, list, or int")
+        color["rgb888"] = value
+        self._needs_refresh = True
+
+        return color
+
+    def __len__(self):
+        """Returns the number of colors in a Palette"""
+        return len(self._colors)
+
+    def __setitem__(self, index, value):
+        """Sets the pixel color at the given index. The index should be
+        an integer in the range 0 to color_count-1.
+
+        The value argument represents a color, and can be from 0x000000 to 0xFFFFFF
+        (to represent an RGB value). Value can be an int, bytes (3 bytes (RGB) or
+        4 bytes (RGB + pad byte)), bytearray, or a tuple or list of 3 integers.
+        """
+        if self._colors[index]["rgb888"] != value:
+            self._colors[index] = self._make_color(value)
+
+    def __getitem__(self, index):
+        if not 0 <= index < len(self._colors):
+            raise ValueError("Palette index out of range")
+        return self._colors[index]
+
+    def make_transparent(self, palette_index):
+        """Set the palette index to be a transparent color"""
+        self._colors[palette_index]["transparent"] = True
+
+    def make_opaque(self, palette_index):
+        """Set the palette index to be an opaque color"""
+        self._colors[palette_index]["transparent"] = False