diff --git a/adafruit_display_text/bitmap_label.py b/adafruit_display_text/bitmap_label.py index a613039..fc6716b 100755 --- a/adafruit_display_text/bitmap_label.py +++ b/adafruit_display_text/bitmap_label.py @@ -39,8 +39,8 @@ class Label(LabelBase): """A label displaying a string of text that is stored in a bitmap. - Note: This ``bitmap_label.py`` library utilizes a bitmap to display the text. - This method is memory-conserving relative to ``label.py``. + Note: This ``bitmap_label.py`` library utilizes a :py:class:`~displayio.Bitmap` + to display the text. This method is memory-conserving relative to ``label.py``. For further reduction in memory usage, set ``save_text=False`` (text string will not be stored and ``line_spacing`` and ``font`` are immutable with ``save_text`` @@ -534,3 +534,12 @@ def _set_label_direction(self, new_label_direction: str) -> None: def _get_valid_label_directions(self) -> Tuple[str, ...]: return "LTR", "RTL", "UPD", "UPR", "DWR" + + @property + def bitmap(self): + """ + The Bitmap object that the text and background are drawn into. + + :rtype: displayio.Bitmap + """ + return self._bitmap