1
0
mirror of https://github.com/lvgl/lvgl.git synced 2025-01-14 06:42:58 +08:00
lvgl/docs/libs/lodepng.rst
_VIFEXTech 45fb2148d5
chore(libs/png): rename lv_png to lv_lodepng (#4574)
Signed-off-by: pengyiqiang <pengyiqiang@xiaomi.com>
Co-authored-by: pengyiqiang <pengyiqiang@xiaomi.com>
2023-09-20 10:30:04 +02:00

31 lines
839 B
ReStructuredText

===============
LODEPNG decoder
===============
Allow the use of PNG images in LVGL. This implementation uses
`lodepng <https://github.com/lvandeve/lodepng>`__ library.
If enabled in ``lv_conf.h`` by :c:macro:`LV_USE_LODEPNG` LVGL will register a new
image decoder automatically so PNG files can be directly used as any
other image sources.
Note that, a file system driver needs to registered to open images from
files. Read more about it :ref:`file-system` or just
enable one in ``lv_conf.h`` with ``LV_USE_FS_...``
The whole PNG image is decoded so during decoding RAM equals to
``image width x image height x 4`` bytes are required.
As it might take significant time to decode PNG images LVGL's :ref:`image-caching` feature can be useful.
Example
-------
.. include:: ../examples/libs/lodepng/index.rst
API
---
:ref:`lodepng`