1
0
mirror of https://github.com/lvgl/lvgl.git synced 2025-01-14 06:42:58 +08:00
lvgl/docs/others/imgfont.rst

29 lines
650 B
ReStructuredText

====================
Image font (imgfont)
====================
Draw image in label or span obj with imgfont. This is often used to
display Unicode emoji icons in text. Supported image formats: determined
by LVGL image decoder.
Usage
-----
Enable :c:macro:`LV_USE_IMGFONT` in ``lv_conf.h``.
To create a new imgfont use :c:expr:`lv_imgfont_create(height, path_cb)`.
``height`` used to indicate the size of a imgfont. ``path_cb`` Used to
get the image path of the specified unicode.
Use :c:expr:`lv_imgfont_destroy(imgfont)` to destroy a imgfont that is no
longer used.
Example
-------
.. include:: ../examples/others/imgfont/index.rst
API
---