1
2# BMP decoder
3
4This extension allows the use of BMP images in LVGL.
5This implementation uses [bmp-decoder](https://github.com/caj-johnson/bmp-decoder) library.
6The pixels are read on demand (not the whole image is loaded) so using BMP images requires very little RAM.
7
8If enabled in `lv_conf.h` by `LV_USE_BMP` LVGL will register a new image decoder automatically so BMP files can be directly used as image sources. For example:
9```
10lv_img_set_src(my_img, "S:path/to/picture.bmp");
11```
12
13Note that, a file system driver needs to registered to open images from files. Read more about it [here](https://docs.lvgl.io/master/overview/file-system.html) or just enable one in `lv_conf.h` with `LV_USE_FS_...`
14
15## Limitations
16- Only BMP files are supported and BMP images as C array (`lv_img_dsc_t`) are not. It's because there is no practical differences between how the BMP files and LVGL's image format stores the image data.
17- BMP files can be loaded only from file. If you want to store them in flash it's better to convert them to C array with [LVGL's image converter](https://lvgl.io/tools/imageconverter).
18- The BMP files color format needs to match with `LV_COLOR_DEPTH`. Use GIMP to save the image in the required format.
19  Both RGB888 and ARGB888 works with `LV_COLOR_DEPTH 32`
20- Palette is not supported.
21- Because not the whole image is read in can not be zoomed or rotated.
22
23
24## Example
25```eval_rst
26
27.. include:: ../../examples/libs/bmp/index.rst
28
29```
30
31## API
32
33```eval_rst
34
35.. doxygenfile:: lv_bmp.h
36  :project: lvgl
37
38```
39