:mod:`fontio`
=============

.. py:module:: fontio

.. autoapi-nested-parse::

   Core font related data structures



.. raw:: html

    <p>
    <details>
    <summary>Available on these boards</summary>
    <ul>
    <li> AITHinker ESP32-C3S_Kit
    <li> ARAMCON Badge 2019
    <li> ARAMCON2 Badge
    <li> ATMegaZero ESP32-S2
    <li> Adafruit CLUE nRF52840 Express
    <li> Adafruit Circuit Playground Bluefruit
    <li> Adafruit CircuitPlayground Express with displayio
    <li> Adafruit EdgeBadge
    <li> Adafruit Feather Bluefruit Sense
    <li> Adafruit Feather ESP32-S2 TFT
    <li> Adafruit Feather ESP32S2
    <li> Adafruit Feather M0 Express
    <li> Adafruit Feather M4 CAN
    <li> Adafruit Feather M4 Express
    <li> Adafruit Feather MIMXRT1011
    <li> Adafruit Feather RP2040
    <li> Adafruit Feather STM32F405 Express
    <li> Adafruit Feather nRF52840 Express
    <li> Adafruit FunHouse
    <li> Adafruit Grand Central M4 Express
    <li> Adafruit Hallowing M4 Express
    <li> Adafruit ItsyBitsy M0 Express
    <li> Adafruit ItsyBitsy M4 Express
    <li> Adafruit ItsyBitsy RP2040
    <li> Adafruit ItsyBitsy nRF52840 Express
    <li> Adafruit KB2040
    <li> Adafruit LED Glasses Driver nRF52840
    <li> Adafruit Macropad RP2040
    <li> Adafruit MagTag
    <li> Adafruit Matrix Portal M4
    <li> Adafruit Metro ESP32S2
    <li> Adafruit Metro M0 Express
    <li> Adafruit Metro M4 Airlift Lite
    <li> Adafruit Metro M4 Express
    <li> Adafruit Metro nRF52840 Express
    <li> Adafruit Monster M4SK
    <li> Adafruit PyGamer
    <li> Adafruit PyPortal
    <li> Adafruit PyPortal Pynt
    <li> Adafruit PyPortal Titano
    <li> Adafruit Pybadge
    <li> Adafruit QT Py ESP32S2
    <li> Adafruit QT Py M0 Haxpress
    <li> Adafruit QT Py RP2040
    <li> Adafruit QT2040 Trinkey
    <li> Adafruit Trellis M4 Express
    <li> AloriumTech Evo M51
    <li> Arduino Nano 33 BLE
    <li> Arduino Nano RP2040 Connect
    <li> Artisense Reference Design RD00
    <li> AtelierDuMaker nRF52840 Breakout
    <li> BDMICRO VINA-D21
    <li> BDMICRO VINA-D51
    <li> BLE-SS dev board Multi Sensor
    <li> BastBLE
    <li> BastWiFi
    <li> BlueMicro840
    <li> CP Sapling M0 w/ SPI Flash
    <li> CP32-M4
    <li> Capable Robot Programmable USB Hub
    <li> Cedar Grove StringCar M0 Express
    <li> Challenger NB RP2040 WiFi
    <li> Challenger RP2040 LTE
    <li> Challenger RP2040 WiFi
    <li> CircuitBrains Basic
    <li> CircuitBrains Deluxe
    <li> CrumpS2
    <li> Cytron Maker Nano RP2040
    <li> Cytron Maker Pi RP2040
    <li> DynOSSAT-EDU-EPS
    <li> DynOSSAT-EDU-OBC
    <li> ESP 12k NodeMCU
    <li> Electronic Cats Hunter Cat NFC
    <li> Electronut Labs Blip
    <li> Electronut Labs Papyr
    <li> EncoderPad RP2040
    <li> Espruino Pico
    <li> Espruino Wifi
    <li> Feather ESP32S2 without PSRAM
    <li> Feather MIMXRT1011
    <li> Feather MIMXRT1062
    <li> FeatherS2
    <li> FeatherS2 Neo
    <li> FeatherS2 PreRelease
    <li> Franzininho WIFI w/Wroom
    <li> Franzininho WIFI w/Wrover
    <li> Gravitech Cucumber M
    <li> Gravitech Cucumber MS
    <li> Gravitech Cucumber R
    <li> Gravitech Cucumber RS
    <li> HMI-DevKit-1.1
    <li> Hacked Feather M0 Express with 8Mbyte SPI flash
    <li> HalloWing M0 Express
    <li> HiiBot BlueFi
    <li> IMXRT1010-EVK
    <li> IkigaiSense Vita nRF52840
    <li> Kaluga 1
    <li> LILYGO TTGO T8 ESP32-S2 w/Display
    <li> MDBT50Q-DB-40
    <li> MDBT50Q-RX Dongle
    <li> MEOWBIT
    <li> MORPHEANS MorphESP-240
    <li> MakerDiary nRF52840 MDK
    <li> MakerDiary nRF52840 MDK USB Dongle
    <li> Makerdiary M60 Keyboard
    <li> Makerdiary Pitaya Go
    <li> Makerdiary nRF52840 M.2 Developer Kit
    <li> Melopero Shake RP2040
    <li> Metro MIMXRT1011
    <li> MicroDev microC3
    <li> MicroDev microS2
    <li> Mini SAM M4
    <li> NUCLEO STM32F746
    <li> NUCLEO STM32F767
    <li> NUCLEO STM32H743
    <li> OPENMV-H7 R1
    <li> Oak Dev Tech BREAD2040
    <li> Oak Dev Tech PixelWing ESP32S2
    <li> Open Hardware Summit 2020 Badge
    <li> PCA10056 nRF52840-DK
    <li> PCA10059 nRF52840 Dongle
    <li> PYB LR Nano V2
    <li> Particle Argon
    <li> Particle Boron
    <li> Particle Xenon
    <li> PewPew M4
    <li> Pimoroni Interstate 75
    <li> Pimoroni Keybow 2040
    <li> Pimoroni PGA2040
    <li> Pimoroni Pico LiPo (16MB)
    <li> Pimoroni Pico LiPo (4MB)
    <li> Pimoroni PicoSystem
    <li> Pimoroni Plasma 2040
    <li> Pimoroni Tiny 2040
    <li> PyKey60
    <li> PyboardV1_1
    <li> RP2040 Stamp
    <li> Raspberry Pi 4B
    <li> Raspberry Pi Compute Module 4 IO Board
    <li> Raspberry Pi Pico
    <li> Raspberry Pi Zero 2W
    <li> S2Mini
    <li> S2Pico
    <li> SAM E54 Xplained Pro
    <li> SAM32v26
    <li> ST STM32F746G Discovery
    <li> STM32F411E_DISCO
    <li> STM32F412G_DISCO
    <li> STM32F4_DISCO
    <li> Saola 1 w/Wroom
    <li> Saola 1 w/Wrover
    <li> Seeeduino Wio Terminal
    <li> Serpente
    <li> Silicognition LLC M4-Shim
    <li> SparkFun LUMIDrive
    <li> SparkFun MicroMod RP2040 Processor
    <li> SparkFun MicroMod SAMD51 Processor
    <li> SparkFun MicroMod nRF52840 Processor
    <li> SparkFun Pro Micro RP2040
    <li> SparkFun Pro nRF52840 Mini
    <li> SparkFun RedBoard Turbo
    <li> SparkFun STM32 MicroMod Processor
    <li> SparkFun Thing Plus - RP2040
    <li> SparkFun Thing Plus - SAMD51
    <li> StackRduino M0 PRO
    <li> TG-Boards' Datalore IP M4
    <li> TG-Watch
    <li> THUNDERPACK_v11
    <li> THUNDERPACK_v12
    <li> Targett Module Clip w/Wroom
    <li> Targett Module Clip w/Wrover
    <li> Teensy 4.0
    <li> Teensy 4.1
    <li> Teknikio Bluebird
    <li> The Open Book Feather
    <li> Thingz - Galaxia
    <li> TinkeringTech ScoutMakes Azul
    <li> TinyS2
    <li> Trinket M0 Haxpress
    <li> UARTLogger II
    <li> WarmBit BluePixel nRF52840
    <li> iMX RT 1020 EVK
    <li> iMX RT 1060 EVK
    <li> keithp.com snekboard
    <li> nanoESP32-S2  w/Wrover
    <li> nanoESP32-S2 w/Wroom
    <li> nice!nano
    <li> stm32f411ce-blackpill
    <li> stm32f411ce-blackpill-with-flash
    <li> uGame10
    </ul>
    </details>
    </p>




.. py:class:: BuiltinFont

   A font built into CircuitPython

   Creation not supported. Available fonts are defined when CircuitPython is built. See the
   `Adafruit_CircuitPython_Bitmap_Font <https://github.com/adafruit/Adafruit_CircuitPython_Bitmap_Font>`_
   library for dynamically loaded fonts.

   .. py:attribute:: bitmap
      :annotation: :displayio.Bitmap

      Bitmap containing all font glyphs starting with ASCII and followed by unicode. Use
      `get_glyph` in most cases. This is useful for use with `displayio.TileGrid` and
      `terminalio.Terminal`.


   .. py:method:: get_bounding_box() -> Tuple[int, int]

      Returns the maximum bounds of all glyphs in the font in a tuple of two values: width, height.


   .. py:method:: get_glyph(codepoint: int) -> Glyph

      Returns a `fontio.Glyph` for the given codepoint or None if no glyph is available.



.. py:class:: Glyph(bitmap: displayio.Bitmap, tile_index: int, width: int, height: int, dx: int, dy: int, shift_x: int, shift_y: int)

   Storage of glyph info

   Named tuple used to capture a single glyph and its attributes.

   :param bitmap: the bitmap including the glyph
   :param tile_index: the tile index within the bitmap
   :param width: the width of the glyph's bitmap
   :param height: the height of the glyph's bitmap
   :param dx: x adjustment to the bitmap's position
   :param dy: y adjustment to the bitmap's position
   :param shift_x: the x difference to the next glyph
   :param shift_y: the y difference to the next glyph