displayio/_structs.py

   1 # SPDX-FileCopyrightText: 2021 Melissa LeBlanc-Williams
   2 #
   3 # SPDX-License-Identifier: MIT
   4
   5 """
   6 `displayio._structs`
   7 ================================================================================
   8
   9 Struct Data Classes for Blinka Displayio
  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 dataclasses import dataclass
  21
  22 __version__ = "0.0.0+auto.0"
  23 __repo__ = "https://github.com/adafruit/Adafruit_Blinka_Displayio.git"
  24
  25
  26 @dataclass
  27 class RectangleStruct:
  28     # pylint: disable=invalid-name
  29     """Rectangle Struct Dataclass. To eventually be replaced by Area."""
  30     x1: int
  31     y1: int
  32     x2: int
  33     y2: int
  34
  35
  36 @dataclass
  37 class TransformStruct:
  38     # pylint: disable=invalid-name
  39     """Transform Struct Dataclass"""
  40     x: int = 0
  41     y: int = 0
  42     dx: int = 1
  43     dy: int = 1
  44     scale: int = 1
  45     transpose_xy: bool = False
  46     mirror_x: bool = False
  47     mirror_y: bool = False
  48
  49
  50 @dataclass
  51 class ColorspaceStruct:
  52     # pylint: disable=invalid-name, too-many-instance-attributes
  53     """Colorspace Struct Dataclass"""
  54     depth: int
  55     bytes_per_cell: int = 0
  56     tricolor_hue: int = 0
  57     tricolor_luma: int = 0
  58     grayscale_bit: int = 0
  59     grayscale: bool = False
  60     tricolor: bool = False
  61     sevencolor: bool = False  # Acep e-ink screens.
  62     pixels_in_byte_share_row: bool = False
  63     reverse_pixels_in_byte: bool = False
  64     reverse_bytes_in_word: bool = False
  65     dither: bool = False
  66
  67
  68 @dataclass
  69 class InputPixelStruct:
  70     """InputPixel Struct Dataclass"""
  71
  72     pixel: int = 0
  73     x: int = 0
  74     y: int = 0
  75     tile: int = 0
  76     tile_x: int = 0
  77     tile_y: int = 0
  78
  79
  80 @dataclass
  81 class OutputPixelStruct:
  82     """OutputPixel Struct Dataclass"""
  83
  84     pixel: int = 0
  85     opaque: bool = False
  86
  87
  88 @dataclass
  89 class ColorStruct:
  90     """Color Struct Dataclass"""
  91
  92     rgb888: int = 0
  93     cached_colorspace: ColorspaceStruct = None
  94     cached_color: int = 0
  95     cached_colorspace_grayscale_bit: int = 0
  96     cached_colorspace_grayscale: bool = False
  97     transparent: bool = False
  98
  99     def rgba(self) -> tuple[int, int, int, int]:
 100         """Return the color as a tuple of red, green, blue, alpha"""
 101         return (
 102             self.rgb888 >> 16,
 103             (self.rgb888 >> 8) & 0xFF,
 104             self.rgb888 & 0xFF,
 105             0 if self.transparent else 0xFF,
 106         )