displayio/shape.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.shape`
  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 displayio.bitmap import Bitmap
  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 Shape(Bitmap):
  47     """Create a Shape object with the given fixed size. Each pixel is one bit and is stored
  48     by the column boundaries of the shape on each row. Each row’s boundary defaults to the
  49     full row.
  50     """
  51
  52     def __init__(self, width, height, *, mirror_x=False, mirror_y=False):
  53         """Create a Shape object with the given fixed size. Each pixel is one bit and is
  54         stored by the column boundaries of the shape on each row. Each row’s boundary
  55         defaults to the full row.
  56         """
  57         super().__init__(width, height, 2)
  58
  59     def set_boundary(self, y, start_x, end_x):
  60         """Loads pre-packed data into the given row."""
  61         pass