feat(tiny_ttf): ttf support (#3680)
Co-authored-by: embeddedt <42941056+embeddedt@users.noreply.github.com> Co-authored-by: Gabor Kiss-Vamosi <kisvegabor@gmail.com>
This commit is contained in:
committed by
GitHub
parent
4c3bca9a7f
commit
57e0943b10
28
docs/libs/tiny_ttf.md
Normal file
28
docs/libs/tiny_ttf.md
Normal file
@@ -0,0 +1,28 @@
|
||||
# Tiny TTF font engine
|
||||
|
||||
## Usage
|
||||
|
||||
Allow using TrueType fonts LVGL. Based on https://github.com/nothings/stb
|
||||
|
||||
When enabled in `lv_conf.h` with `LV_USE_TINY_TTF` `lv_tiny_ttf_create_data(data, data_size, line_height)` can be used to create a TTF font instance at the specified line height. You can then use that font anywhere `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 `LV_TINY_TTF_FILE_SUPPORT` is enabled, `lv_tiny_ttf_create_file(path, line_height)` 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 size by using `lv_tiny_ttf_set_size(font, line_height)`.
|
||||
|
||||
|
||||
## Example
|
||||
```eval_rst
|
||||
|
||||
.. include:: ../../examples/libs/tiny_ttf/index.rst
|
||||
|
||||
```
|
||||
|
||||
## API
|
||||
|
||||
```eval_rst
|
||||
|
||||
.. doxygenfile:: lv_tiny_ttf.h
|
||||
:project: lvgl
|
||||
Reference in New Issue
Block a user