init Files

libraries/lvgl/docs/libs/tiny_ttf.rst

@@ -0,0 +1,55 @@
+.. _tiny_ttf:
+
+====================
+Tiny TTF font engine
+====================
+
+.. _tiny_ttf_usage:
+
+Usage
+-----
+
+Allow using TrueType fonts in LVGL.
+
+Detailed introduction: https://github.com/nothings/stb
+
+When enabled in ``lv_conf.h`` with :c:macro:`LV_USE_TINY_TTF`
+:cpp:expr:`lv_tiny_ttf_create_data(data, data_size, font_size)` can be used to
+create a TTF font instance at the specified line height. You can then
+use that font anywhere :c:struct:`lv_font_t` is accepted.
+
+By default, the TTF or OTF file must be embedded as an array, either in
+a header, or loaded into RAM in order to function.
+
+However, if :c:macro:`LV_TINY_TTF_FILE_SUPPORT` is enabled,
+:cpp:expr:`lv_tiny_ttf_create_file(path, font_size)` will also be available,
+allowing tiny_ttf to stream from a file. The file must remain open the
+entire time the font is being used.
+
+After a font is created, you can change the font size in pixels by using
+:cpp:expr:`lv_tiny_ttf_set_size(font, font_size)`.
+
+By default, a font will cache data for upto 256 glyphs elements to speed up rendering.
+This maximum can be changed by using
+:cpp:expr:`lv_tiny_ttf_create_data_ex(data, data_size, font_size, kerning, cache_size)`
+or :cpp:expr:`lv_tiny_ttf_create_file_ex(path, font_size, kerning, cache_size)` (when
+available). The cache size is indicated in number of entries. Kerning is whether to allow
+if supported, or disable.
+
+
+
+.. _tiny_ttf_example:
+
+Example
+-------
+
+.. include:: ../examples/libs/tiny_ttf/index.rst
+
+.. _tiny_ttf_api:
+
+API
+---
+
+:ref:`stb_rect_pack`
+
+:ref:`stb_truetype_htcw`