github-code/lvgl
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: fix links, add references, rename files (#5138)

Browse Source
This commit is contained in:
PGNetHun
2024-01-04 07:25:13 +01:00
committed by GitHub
parent 6136bd6cd0
commit 2a129562d8
94 changed files with 1441 additions and 837 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/libs/rle.rst
View File

@@ -1,5 +1,8 @@
.. _rle:
============
RLE Compress
===========
============
LVGL provides a custom RLE compression method. It can be used to reduce binary
image size. The RLE compression is a lossless compression method.
@@ -29,7 +32,7 @@ the for many pixels, the color is the same. The algorithm simply counts how many
repeated data are there and store the count value and the color value.
If the coming pixels are not repeated, it stores the non-repeat count value and
original color value. For more details, the script used to compress the image
can be found from `lvgl/script/LVGLImage.py`.
can be found from ``lvgl/script/LVGLImage.py``.
.. code:: python
@@ -60,11 +63,12 @@ can be found from `lvgl/script/LVGLImage.py`.
return b"".join(compressed_data)
.. _rle_usage:
Usage
-----
To use the RLE Decoder, ensure that `LV_USE_RLE` is defined and set to `1`.
To use the RLE Decoder, enable it in ``lv_conf.h`` configuration file by setting :c:macro:`LV_USE_RLE` to `1`.
The RLE image can be used same as other images.
.. code:: c