Font rendering

From uGFX Wiki
Jump to: navigation, search


The µGFX font rendering engine provides the following features:


The word wrapping feature can be enabled by setting GDISP_NEED_TEXT_WORDWRAP to TRUE.

Word wrapping only has an effect when using gdispDrawStringBox() or gdispFillStringBox(). When the word wrapping feature is not enabled the string will simply be cut-off at the border of the specified box.


Unicode support can be enabled by setting GDISP_NEED_TEXT_UTF8 to TRUE.

Unicode support allows to display fonts of many different languages such as English, French, German, Russian (Cyrillic), Chinese, Japanese and so on. For information about cyrillic font support, see Cyrillic.


To use the anti-aliasing font feature, the following three conditions have to be fulfilled:

  1. Using an anti-aliased font
  2. GDISP_NEED_ANTIALIAS needs to be set to TRUE
  3. Either have GDISP_NEED_PIXELREAD set to TRUE or using one of the text drawing functions that have a background color parameter.

Note that you can use normal (non anti-aliased) fonts along with anti-aliased ones without any problems.


Kerning support can be enabled by setting GDISP_NEED_TEXT_KERNING to TRUE.

TrueType-Font support

Any TrueType-Font available in a *.ttf or a *.bdf file format can be used in uGFX. See Adding Fonts.


Every font that's available in a .ttf or .bdf format can be displayed through µGFX. However, we already added a bunch of fonts in different sizes and versions which should cover most use cases. Use the Font name as the parameter of the gdispOpenFont() routine.

Font Font name
DejaVu Sans 10 DejaVuSans10
DejaVu Sans 12 DejaVuSans12
DejaVu Sans 12 Bold DejaVuSansBold12
DejaVu Sans 12 Anti-Aliased DejaVuSans12_aa
DejaVu Sans 12 Anti-Aliased Bold DejaVuSansBold12_aa
DejaVu Sans 16 DejaVuSans16
DejaVu Sans 16 Anti-Aliased DejaVuSans16_aa
DejaVu Sans 20 DejaVuSans20
DejaVu Sans 20 Anti-Aliased DejaVuSans20_aa
DejaVu Sans 24 DejaVuSans24
DejaVu Sans 24 Anti-Aliased DejaVuSans24_aa
DejaVu Sans 32 DejaVuSans32
DejaVu Sans 32 Anti-Aliased DejaVuSans32_aa
Fixed 10x20 fixed_10x20
Fixed 7x14 fixed_7x14
Fixed 5x8 fixed_5x8
UI1 Double UI1 Double
UI1 Narrow UI1 Narrow
UI2 Double UI2 Double
UI2 Narrow UI2 Narrow
Large numbers LargeNumbers

Note that each of these fonts has to be enabled in your configuration file.

The UI fonts are created by the µGFX developers to provide a default font. The UI fonts stand under the GFX license and should therefore be used in preference to other fonts if suitable. The other fonts are under their own respective licenses.


Before you can use a font, you first have to open it by calling gdispOpenFont().

gFont font = gdispOpenFont("DejaVuSans32_aa");

Note: When the font name specified could not be found, the last enabled font in the configuration file will be used.

You should call gdispCloseFont() to release any allocated resources if you don't need a font any longer:


After opening a font, the font variable can now be passed to any API call that takes a font parameter. You may start by reading through the basic GDISP text drawing routines before you take a look at the different GWIN system.

Adding fonts

The following step-by-step guide will lead you through the process of adding a custom *.ttf font. This guide works for every font, not only ASCII but also cyrillic and any other unicode compatible ones.

1. Acquire a font

First of all, you'll need a font in the *.ttf source. You can find plenty of these using google. Please notice their licenses.

2. Convert the font

The next step is to convert the font into a format that can be understood by the µGFX decoder. This can be done very easily using our online converter. The converter allows you to set the font size, enable or disable anti-aliasing and filter for certain characters. Filtering un-needed characters is essential to keep the font size low. This table might help you choose the correct character range. A click on the button «Get .c file» will offer you a C file to download after a few moments. Please click that button just once. It can take up to a minute to convert a larger font.

3. Implement the font

Place the downloaded c file inside your project directory and name it userfonts.h. Alternatively write a userfonts.h file that includes each of your downloaded font c files. In your gfxconf.h, enable the following setting:


4. Open the font

You can now open and use this font as any other one. If you're curious about the parameter of gdispOpenFont(), you can either use the full_name or the short_name field that can be found in the struct at the very bottom of the C file (first and second entry). Please note that you need to configure your text editor to operate in UTF-8 mode, when you want to display those fonts successfully.

For a more detailed guide on how to add your own font, see Cyrillic.

Font metrics

The GDISP API provides several function to retrieve information about font metrics:

typedef enum fontmetric {
} fontmetric_t;
gCoord gdispGetFontMetric(gFont font, fontmetric_t metric);
gCoord gdispGetCharWidth(char c, gFont font);
gCoord gdispGetStringWidth(const char* str, gFont font);
gCoord gdispGetStringWidthCount(const char* str, gFont font, uint16_t count);


µGFX comes with a built-in support of mcufont. The author of the mcufont project provides a re-licensed version of his works to the µGFX projects.