/ adafruit_bitmap_font / bitmap_font.py
bitmap_font.py
 1  # The MIT License (MIT)
 2  #
 3  # Copyright (c) 2019 Scott Shawcroft for Adafruit Industries LLC
 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  `adafruit_bitmap_font.bitmap_font`
24  ====================================================
25  
26  Loads bitmap glyphs from a variety of font.
27  
28  * Author(s): Scott Shawcroft
29  
30  Implementation Notes
31  --------------------
32  
33  **Hardware:**
34  
35  **Software and Dependencies:**
36  
37  * Adafruit CircuitPython firmware for the supported boards:
38    https://github.com/adafruit/circuitpython/releases
39  
40  """
41  
42  __version__ = "0.0.0-auto.0"
43  __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_Bitmap_Font.git"
44  
45  
46  def load_font(filename, bitmap=None):
47      """Loads a font file. Returns None if unsupported."""
48      # pylint: disable=import-outside-toplevel
49      if not bitmap:
50          import displayio
51  
52          bitmap = displayio.Bitmap
53      font_file = open(filename, "rb")
54      first_four = font_file.read(4)
55      if filename.endswith("bdf") and first_four == b"STAR":
56          from . import bdf
57  
58          return bdf.BDF(font_file, bitmap)
59      if filename.endswith("pcf") and first_four == b"\x01fcp":
60          import pcf
61  
62          return pcf.PCF(font_file)
63      if filename.endswith("ttf") and first_four == b"\x00\x01\x00\x00":
64          import ttf
65  
66          return ttf.TTF(font_file)
67      return None