README.rst
1.. zephyr:code-sample:: cfb-custom-fonts
2 :name: Custom fonts
3 :relevant-api: monochrome_character_framebuffer
4
5 Generate and use a custom font.
6
7Overview
8********
9A simple example showing how to generate Character Framebuffer (CFB)
10font headers automatically at build time.
11
12This example generates a font with font elements for 6 sided dice from
13a PNG image, and then uses the generated header (``cfb_font_dice.h``)
14to show the font elements on the display of a supported board.
15
16The source code for this sample application can be found at:
17:zephyr_file:`samples/subsys/display/cfb_custom_font`.
18
19Building and Running
20********************
21
22There are different configuration files in the cfb_custom_font
23directory:
24
25- :file:`prj.conf`
26 Generic config file, normally you should use this.
27
28- :file:`boards/reel_board.conf`
29 This overlay config enables support for SSD16XX display controller
30 on the reel_board.
31
32
33Example building for the reel_board with SSD16XX display support:
34
35.. zephyr-app-commands::
36 :zephyr-app: samples/subsys/display/cfb_custom_font
37 :host-os: unix
38 :board: reel_board
39 :goals: flash
40 :compact:
41
