displayio/ondiskbitmap.py

   1 # The MIT License (MIT)
   2 #
   3 # Copyright (c) 2020 Melissa LeBlanc-Williams for Adafruit Industries
   4 #
   5 # Permission is hereby granted, free of charge, to any person obtaining a copy
   6 # of this software and associated documentation files (the "Software"), to deal
   7 # in the Software without restriction, including without limitation the rights
   8 # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
   9 # copies of the Software, and to permit persons to whom the Software is
  10 # furnished to do so, subject to the following conditions:
  11 #
  12 # The above copyright notice and this permission notice shall be included in
  13 # all copies or substantial portions of the Software.
  14 #
  15 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16 # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17 # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  18 # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  20 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  21 # THE SOFTWARE.
  22
  23 """
  24 `displayio.ondiskbitmap`
  25 ================================================================================
  26
  27 displayio for Blinka
  28
  29 **Software and Dependencies:**
  30
  31 * Adafruit Blinka:
  32   https://github.com/adafruit/Adafruit_Blinka/releases
  33
  34 * Author(s): Melissa LeBlanc-Williams
  35
  36 """
  37
  38 from PIL import Image
  39
  40 __version__ = "0.0.0-auto.0"
  41 __repo__ = "https://github.com/adafruit/Adafruit_Blinka_displayio.git"
  42
  43 # pylint: disable=unnecessary-pass, unused-argument
  44
  45
  46 class OnDiskBitmap:
  47     """
  48     Loads values straight from disk. This minimizes memory use but can lead to much slower
  49     pixel load times. These load times may result in frame tearing where only part of the
  50     image is visible."""
  51
  52     def __init__(self, file):
  53         self._image = Image.open(file).convert("RGBA")
  54
  55     @property
  56     def width(self):
  57         """Width of the bitmap. (read only)"""
  58         return self._image.width
  59
  60     @property
  61     def height(self):
  62         """Height of the bitmap. (read only)"""
  63         return self._image.height
  64
  65     def __getitem__(self, index):
  66         """
  67         Returns the value at the given index. The index can either be
  68         an x,y tuple or an int equal to `y * width + x`.
  69         """
  70         if isinstance(index, (tuple, list)):
  71             x = index[0]
  72             y = index[1]
  73         elif isinstance(index, int):
  74             x = index % self._image._width
  75             y = index // self._image._width
  76         if not 0 <= x < self._image.width or not 0 <= y < self._image.height:
  77             return 0
  78
  79         return self._image.getpixel((x, y))