Arduino_GFX is a Arduino graphics library supporting various displays with various data bus interfaces.
This library start rewrite from Adafruit_GFX, LovyanGFX, TFT_eSPI, Ucglib, and more...
#include <Arduino_GFX_Library.h>
Arduino_DataBus *bus = new Arduino_HWSPI(16 /* DC */, 5 /* CS */);
Arduino_GFX *gfx = new Arduino_ILI9341(bus, 17 /* RST */);
gfx->begin();
gfx->fillScreen(BLACK);
gfx->setCursor(10, 10);
gfx->setTextColor(RED);
gfx->println("Hello World!");
If you are new on this library, I always recommend try Library Example PDQgraphicstest first. You can find it at Arduino IDE -> File menu -> Examples -> GFX Library for Arduino -> PDQgraphicstest.
After open the example, you can see many tabs. The first is PDQgraphicstest, the main program. Start from the second tab, it is related header files, Arduino_GFX_databus.h, ... etc.
If you are using below listed support dev device, simply select the Arduino_GFX_dev_device.h and uncomment the define of your dev device. E.g. if you are using LilyGo T-Deck:
...
// #define JC3248W535
#define LILYGO_T_DECK
// #define LILYGO_T_DISPLAY
...
If you are not using supported dev device:
-
Default DataBus is using Arduino SPI. Other DataBus can modify in Arduino_GFX_databus.h.
-
Default Display is using ILI9341 LCD. Other Display can modify in Arduino_GFX_display.h.
U8g2 Font Support
U8g2 provided various font type and stored in compressed format. So U8g2 font gives more UI design possibilities and still can fit in the MCU limited storage space. Using U8g2 font in Arduino_GFX simply include U8g2lib.h before Arduino_GFX_Library.h:
#include <U8g2lib.h>
#include <Arduino_GFX_Library.h>
And then setfont file to use:
gfx->setCursor(10, 20);
gfx->setFont(u8g2_font_maniac_tr);
gfx->println("Hello World!");
U8g2 font list can be found at: https://github.com/olikraus/u8g2/wiki/fntlistall
Another U8g2 font advantage is the font support Unicode glyphs. Simply enable setUTF8Print:
gfx->begin();
gfx->fillScreen(BLACK);
gfx->setUTF8Print(true);
And then print UTF8 string as usual:
gfx->setCursor(0, 16);
gfx->setFont(u8g2_font_unifont_tr);
gfx->println("Hello World!");
gfx->setFont(u8g2_font_unifont_t_polish);
gfx->println("Witaj świecie!");
gfx->setFont(u8g2_font_unifont_t_vietnamese1);
gfx->println("Chào thế giới!");
gfx->setFont(u8g2_font_unifont_t_chinese2);
gfx->println("世界你好!");
gfx->setFont(u8g2_font_unifont_t_japanese1);
gfx->println("こんにちは世界!");
gfx->setFont(u8g2_font_unifont_t_korean1);
gfx->println("안녕하세요, 세계입니다!");
U8g2 Unifont list can be found at: https://github.com/olikraus/u8g2/wiki/fntgrpunifont
Besides U8g2 generated font, Arduino_GFX also generated some useful font set:
- Glyphs: 13478/13478
- Size: 254,960
- Generation script:
otf2bdf ChillBitmap7x.ttf -p 6 -o ChillBitmap7x.bdf
bdfconv -v -f 1 -b 1 -m "0-4294967295" ChillBitmap7x.bdf -o u8g2_font_chill7_h_cjk.h -n u8g2_font_chill7_h_cjk
- Glyphs: 10167/10167
- Size: 337,650
- Generation script:
otf2bdf Cubic_11_1.013_R.ttf -p 9 -o Cubic_11_1.013_R.bdf
bdfconv -v -f 1 -b 1 -m "0-4294967295" Cubic_11_1.013_R.bdf -o u8g2_font_cubic11_h_cjk.h -n u8g2_font_cubic11_h_cjk
- Glyphs: 18082/18082
- Size: 335,225
- Generation script:
./bdfconv -v -f 1 -b 1 -m "0-4294967295" quan.bdf -o u8g2_font_quan7_h_cjk.h -n u8g2_font_quan7_h_cjk
- Glyphs: 57389/57389
- Size: 2,250,360
- Generation script:
bdfconv -v -f 1 -b 1 -m "0-1114111" unifont_jp-14.0.02.bdf -o u8g2_font_unifont_h_utf8.h -n u8g2_font_unifont_h_utf8
- Glyphs: 22145/57389
- Size: 979,557
- Generation script:
bdfconv -v -f 1 -m "32-127,11904-12351,19968-40959,63744-64255,65280-65376" unifont_jp-14.0.02.bdf -o u8g2_font_unifont_t_chinese.h -n u8g2_font_unifont_t_chinese
- Glyphs: 7199/57389
- Size: 298,564
- Traditional Chinese common font list: https://raw.githubusercontent.com/ButTaiwan/cjktables/master/taiwan/edu_standard_1.txt
- Simplified Chinese common font list: http://zht.glyphwiki.org/font/gw1197839.source
- extra font list: 32-127,11904-12351,63744-64255,65280-65376
- Generation script:
bdfconv -v -f 1 -M chinese4.list unifont_jp-14.0.02.bdf -o u8g2_font_unifont_t_chinese4.h -n u8g2_font_unifont_t_chinese4
- Glyphs: 41364/57389
- Size: 1,704,862
- Generation script:
bdfconv -v -f 1 -m "32-127,4352-4607,11904-12255,12288-19903,19968-40943,43360-43391,44032-55203,55216-55295,63744-64255,65072-65103,65280-65519" unifont_jp-14.0.02.bdf -o u8g2_font_unifont_t_cjk.h -n u8g2_font_unifont_t_cjk
Performance
This library is not putting speed at the first priority, but still paid much effort to make the display look smooth.
Below are some figures compare with other 3 Arduino common display libraries.
- Arduino IDE: 1.8.15
- arduino-esp32: 1.0.6
- Dev Board: TTGO T8 v1.8
- PSRAM: disable
- Display: ILI9341
- Interface: SPI
- SPI Frequency: 40MHz
- Test time: 2021 Jun 16
Benchmark | Adafruit_GFX | Arduino_GFX | Lovyan_GFX | TFT_eSPI |
---|---|---|---|---|
Screen fill | 195,782 | 160,094 | 154,341 | 155,938 |
Text | 97,662 | 18,960 | 22,473 | 21,752 |
Pixels | 1,365,211 | 903,549 | 867,702 | 775,781 |
Lines | 1,062,311 | 412,026 | 269,060 | 264,950 |
Horiz/Vert Lines | 17,637 | 14,197 | 13,692 | 13,833 |
Rectangles-filled | 406,817 | 332,696 | 320,761 | 323,908 |
Rectangles | 11,641 | 9,254 | 8,545 | 8,714 |
Triangles-filled | 150,941 | 118,010 | 105,661 | 109,675 |
Triangles | 58,843 | 23,570 | 15,884 | 16,277 |
Circles-filled | 76,739 | 52,170 | 42,787 | 45,827 |
Circles | 118,125 | 40,955 | 25,959 | 25,269 |
Arcs-filled | N/A | 33,381 | 21,546 | N/A |
Arcs | N/A | 66,054 | 47,901 | N/A |
Rounded rects-fill | 408,534 | 338,136 | 318,882 | 323,189 |
Rounded rects | 43,185 | 21,562 | 13,089 | 15,371 |
- No read operation. Since not all display provide read back graphic memories API, Arduino_GFX skip all read operations. It can reduce the library size footprint and sometimes reduce the operation time.
- Tailor-made data bus classes. Arduino_GFX decouple data bus operation from display driver, it is more easy to write individual data bus class for each platform.
Supported Interfaces
Arduino_GFX utilizes Arduino Built-in SPI class to support 8-bit SPI for most platforms.
Most tiny displays in hobbyist electronics world support 8-bit SPI, but some require 9-bit SPI. Arduino_GFX should be the first Arduino display library that can use ESP32 SPI to support 9-bit hardware SPI. It is important to support the displays that require 9-bit SPI interface. (e.g. HX8357B, ...)
Larger displays most likely do not support standalone SPI since it is not fast enough to refresh the full screen details. Most of them support 8-bit/16-bit Parallel interface.
Some larger display require RGB + 3-bit SPI combo interface, This interface requies at most 3(9-bit SPI) + 4(CS, CD, WR, RD) + 24(RBG888) = 31 pins. Most dev board do not have enough GPIO to support this. Arduino_GFX is stick to RGB565 color, so RGB666 and RGB888 require some connection hack. E.g. RGB666 connect R5 and R6 together, B5 and B6 together to become RGB565. Then the least GPIO requirement can become 3(9-bit SPI) + 2(CD, WR) + 16(RBG565) = 21 pins. Remember always pull down CS pin and always pull up RD pin.
Currently Supported data bus [Wiki]
- 8-bit and 9-bit hardware SPI (ESP32SPI)
- 8-bit hardware SPI (HWSPI, ESP8266SPI, mbedSPI, NRFXSPI, RPiPicoSPI)
- 8-bit and 9-bit software SPI (SWSPI)
- 8-bit parallel interface (SWPAR8, AVRPAR8, ESP32LCD8, ESP32PAR8, ESP32S2PAR8, RPiPicoPAR8, RTLPAR8, STM32PAR8)
- 16-bit parallel interface (ESP32LCD16, ESP32PAR16, ESP32S2PAR16, RPiPicoPAR16)
- RGB565+SPI interface (ESP32RGBPanel)
ESP32LCD8, ESP32LCD16 and ESP32RGBPanel only supported by arduino-esp32 v2.x and no longer support in v3.0.
Supported Dev Board
- Ameba RTL8722DM Board (AMB 21)
- Ameba RTL8722DM MINI Board (AMB 23)
- Arduino Mega 2560 [demo video]
- Arduino Nano
- Arduino Nano BLE 33
- Arduino Pro Micro
- Arduino UNO
- Arduino UNO R4 Minima [demo video]
- Arduino UNO R4 WiFi [demo video]
- ESP8266 Series
- ESP32 Series
- ESP32-C3 Series
- ESP32-S2 Series
- ESP32-S3 Series
- Raspberry Pi Pico
- Raspberry Pi Pico W
- rtlduino BW16 (by Ai-Thinker)
- Sony Spresense
- WeAct BlackPill V2.0 (BlackPill F411CE)
- Seeed Studio XIAO SAMD21
- Seeed Studio XIAO ESP32C3
- Seeed Studio XIAO ESP32S3
Supported Dev Device
Currently Supported Dev Device [Wiki]
- ESP32-1732S019 [demo video] [LVGL demo video]
- ESP32-2432S028
- ESP32-2424012 [demo video]
- ESP32-3248S035
- ESP32-4827A043 [demo video] [LVGL demo video]
- ESP32-4827S043 [demo video 1] [demo video 2] [LVGL demo video]
- ESP32-8048S043 [demo video]
- ESP32-8048S070 [LVGL demo video]
- ESP32 LCDKIT
- ESP32-S3-EYE
- ESP32-S3-Box
- ESP32-S3-Box-3
- ESP32-S3-RGB [LVGL demo video]
- ESP32S3-2.1-TP
- ESPboy [demo video]
- LILYGO T-Deck [demo video]
- LILYGO T-Display
- LILYGO T-Display-S3 [demo video]
- LILYGO T-Display-S3 AMOLED [demo video]
- LILYGO T-Display-S3 AMOLED [demo video][LVGL demo video]
- T-Display S3 Long[LVGL demo video]
- LILYGO T-Display-s3-Pro [demo video]
- LILYGO T-QT [demo video]
- LILYGO T-RGB [LVGL demo video]
- LILYGO T-Track [demo video][LVGL demo video]
- LILYGO T-Watch
- LILYGO T-Watch 2021
- LILYGO T4 S3[LVGL demo video]
- M5Stack Core Family
- M5Stack AtomS3[demo video]
- Makerfabs ESP32 3.5" TFT Touch with Camera
- Makerfabs ESP32-S3 TFT 4.0" [demo video]
- Makerfabs ESP32-S3 TFT 4.3" v1.3 [demo video]
- Odroid Go
- seeed studio Wio Terminal
- Waveshare RP2040-LCD-1.28
- wireless-tag WT-32-SC01
- Elecrow ESP Terminal with 3.5" parallel RGB display DLC35010R [demo video]
- Elecrow Wizee-ESP32 WZ8048C050
- wireless-tag ZX2D10GE10R-V4848
- wireless-tag ZX3D50CE02S
- wireless-tag ZX3D95CE01S-AR
- wireless-tag ZX3D95CE01S-TR [demo video]
- QM Smart Panlee 7.0 inch serial screen ZX7D00CE01S [demo video]
Supported Display
Currently Supported Display [Wiki]
- GC9A01 240x240 round display [demo video]
- GC9106 80x160 [demo video]
- GC9107 128x128 [demo video]
- GC9503V 480x480 (RGB) [demo video]
- HX8347C 240x320 [demo video]
- HX8347D 240x320 [demo video]
- HX8352C 240x400 [demo video]
- HX8357A 320x480 [demo video] (currently only portrait works, i.e. rotation 0 and 2)
- HX8357B 320x480 (9-bit SPI) [demo video]
- HX8369A 480x800 [demo video] [LVGL demo video]
- ILI6122 480x800 (RGB)
- ILI6485 480x272 (RGB) [demo video]
- ILI9225 176x220 [demo video]
- ILI9341 240x320 [demo video]
- ILI9341 240x320 (8-bit/16-bit Parallel) [demo video]
- ILI9342 320x240 [demo video]
- ILI9481 320x480 (18 bit color) [demo video]
- ILI9486 320x480 (8-bit/16-bit Parallel) [demo video]
- ILI9486 320x480 (18 bit color) [demo video]
- ILI9488 320x480 (3 bit color with canvas) [demo video]
- ILI9488 320x480 (18 bit color) [demo video]
- ILI9806 (8-bit/16-bit Parallel) 480x854 [demo video] [LVGL demo video][2]
- JBT6K71 240x320 (8-bit Parallel) [demo video]
- NT35310 320x480 [demo video]
- NT35510 480x800 (8-bit/16-bit Parallel) [demo video]
- NT39125 240x376 (8-bit/16-bit Parallel) [demo video]
- NV3041A 480x272 [demo video]
- OTM8009A 480x800 (8-bit/16-bit Parallel)
- R61529 320x480 (8-bit/16-bit Parallel) [demo video]
- Raspberry Pi DPI Display (RPi_DPI_RGBPanel) Any Resolution [demo video]
- SEPS525 160x128 [demo video]
- SSD1283A 130x130 [demo video]
- SSD1331 96x64 [demo video]
- SSD1351 128x128 [demo video]
- SSD1351 128x96
- ST7735 128x160 (various tabs) [demo video]
- ST7735 128x128 (various tabs) [demo video]
- ST7735 80x160 [demo video]
- ST7701 480x480 (RGB) [demo video] [2.1" round display demo video] [2.8" round display demo video]
- ST7789 135x240 [demo video]
- ST7789 240x240 [demo video]
- ST7789 240x240 [demo video]
- ST7789 240x280 round corner display [demo video]
- ST7789 240x320 [demo video]
- ST7796 320x480 [demo video]
- WEA2012 356x400 [demo video] [LVGL demo video]
- Mono display supported by co-operate with Canvas
- Multi-color e-ink display supported by co-operate with Canvas
Canvas (framebuffer)
Canvas Class [Wiki]
- Arduino_Canvas (16-bit pixel)
- Arduino_Canvas_3bit (1/4 memory space of 16-bit pixel)
- Arduino_Canvas_Indexed (half memory space of 16-bit pixel)
- Arduino_Canvas_Mono (1/16 memory space of 16-bit pixel)
Feature Wishlist
- Print color Emoji Characters
- Load bitmap font files from flash / SD
- Fill Gradient (Discussion #128)
Using source code come from
- https://github.com/adafruit/Adafruit-GFX-Library.git
- https://github.com/adafruit/Adafruit_ILI9341.git
- https://github.com/adafruit/Adafruit-SSD1351-library.git
- https://github.com/ananevilya/Arduino-ST7789-Library.git
- https://github.com/BasementCat/arduino-tft-gif.git
- https://github.com/Bodmer/TFT_eSPI.git
- https://github.com/daumemo/IPS_LCD_R61529_FT6236_Arduino_eSPI_Test.git
- https://github.com/espressif/arduino-esp32.git
- https://github.com/espressif/esp-idf.git
- https://github.com/gitcnd/LCDWIKI_SPI.git
- https://github.com/hi631/LCD_NT35510-MRB3971.git
- https://github.com/lcdwiki/LCDWIKI_SPI.git
- https://github.com/Xinyuan-LilyGO/T-RGB.git
- https://github.com/lovyan03/LovyanGFX.git
- https://github.com/modi12jin/Arduino-ESP32-WEA2012.git
- https://github.com/nopnop2002/esp-idf-parallel-tft.git
- https://github.com/olikraus/u8g2.git
As you may already aware there are lack of sponsorship in this project. Convert the funding in terms of man power, it is much lower than 1 man hour per month. So don't expect too much on the support. Expecially the features not realted to my planned maker projects ;>
For the same reason, Arduino_GFX only focus on the Arduino IDE support. Any other IDE, e.g. PlatformIO, if you found an issue at that IDE but normal at Arduino IDE, please direct report to that IDE for better support.