acid-drop

- Hacking the planet from a LilyGo T-Deck using custom firmware
git clone git://git.acid.vegas/acid-drop.git
Log | Files | Refs | Archive | README | LICENSE

bmp.md (1614B)

      1 ```eval_rst
      2 .. include:: /header.rst
      3 :github_url: |github_link_base|/libs/bmp.md
      4 ```
      5 
      6 # BMP decoder
      7 
      8 This extension allows the use of BMP images in LVGL.
      9 This implementation uses [bmp-decoder](https://github.com/caj-johnson/bmp-decoder) library.
     10 The pixels are read on demand (not the whole image is loaded) so using BMP images requires very little RAM.
     11 
     12 If 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:
     13 ```
     14 lv_img_set_src(my_img, "S:path/to/picture.bmp");
     15 ```
     16 
     17 Note 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_...`
     18 
     19 ## Limitations
     20 - 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.
     21 - 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).
     22 - The BMP files color format needs to match with `LV_COLOR_DEPTH`. Use GIMP to save the image in the required format.
     23   Both RGB888 and ARGB888 works with `LV_COLOR_DEPTH 32`
     24 - Palette is not supported.
     25 - Because not the whole image is read in can not be zoomed or rotated.
     26 
     27 
     28 ## Example
     29 ```eval_rst
     30 
     31 .. include:: ../../examples/libs/bmp/index.rst
     32 
     33 ```
     34 
     35 ## API
     36 
     37 ```eval_rst
     38 
     39 .. doxygenfile:: lv_bmp.h
     40   :project: lvgl
     41 
     42 ```