Images¶

An image can be a file or variable which stores the bitmap itself and some metadata.

Store images¶

You can store images in two places

as a variable in the internal memory (RAM or ROM)
as a file

Variables¶

The images stored internally in a variable is composed mainly of an lv_img_dsc_t structure with the following fields:

header
- cf Color format. See below
- w width in pixels (<= 2048)
- h height in pixels (<= 2048)
- always zero 3 bits which need to be always zero
- reserved reserved for future use
data pointer to an array where the image itself is stored
data_size length of data in bytes

These are usually stored within a project as C files. They are linked into the resulting executable like any other constant data.

Files¶

To deal with files you need to add a Drive to LittlevGL. In short, a Drive is a collection of functions (open, read, close, etc.) registered in LittlevGL to make file operations. You can add an interface to a standard file system (FAT32 on SD card) or you create your simple file system to read data from an SPI Flash memory. In every case, a Drive is just an abstraction to read and/or write data to a memory. See the File system section to learn more.

Images stored as files are not linked into the resulting executable, and must be read to RAM before being drawn. As a result, they are not as resource-friendly as variable images. However, they are easier to replace without needing to recompile the main program.

Color formats¶

Various built-in color formats are supported:

LV_IMG_CF_TRUE_COLOR Simply stores the RGB colors (in whatever color depth LittlevGL is configured for).
LV_IMG_CF_TRUE_COLOR_ALPHA Like LV_IMG_CF_TRUE_COLOR but it also adds an alpha (transparency) byte for every pixel.
LV_IMG_CF_TRUE_COLOR_CHROMA_KEYED Like LV_IMG_CF_TRUE_COLOR but if a pixel has LV_COLOR_TRANSP (set in lv_conf.h) color the pixel will be transparent.
LV_IMG_CF_INDEXED_1/2/4/8BIT Uses a palette with 2, 4, 16 or 256 colors and stores each pixel in 1, 2, 4 or 8 bits.
LV_IMG_CF_ALPHA_1/2/4/8BIT Only stores the Alpha value on 1, 2, 4 or 8 bits. The pixels take the color of style.image.color and the set opacity. The source image has to be an alpha channel. This is ideal for bitmaps similar to fonts (where the whole image is one color but you’d like to be able to change it).

The bytes of the LV_IMG_CF_TRUE_COLOR images are stored in the following order.

For 32-bit color depth:

Byte 0: Blue
Byte 1: Green
Byte 2: Red
Byte 3: Alpha

For 16-bit color depth:

Byte 0: Green 3 lower bit, Blue 5 bit
Byte 1: Red 5 bit, Green 3 higher bit
Byte 2: Alpha byte (only with LV_IMG_CF_TRUE_COLOR_ALPHA)

For 8-bit color depth:

Byte 0: Red 3 bit, Green 3 bit, Blue 2 bit
Byte 2: Alpha byte (only with LV_IMG_CF_TRUE_COLOR_ALPHA)

You can store images in a Raw format to indicate that, it’s not a built-in color format and an external Image decoder needs to be used to decode the image.

LV_IMG_CF_RAW Indicates a basic raw image (e.g. a PNG or JPG image).
LV_IMG_CF_RAW_ALPHA Indicates that the image has alpha and an alpha byte is added for every pixel.
LV_IMG_CF_RAW_CHROME_KEYED Indicates that the image is chrome keyed as described in LV_IMG_CF_TRUE_COLOR_CHROMA_KEYED above.

Add and use images¶

You can add images to LittlevGL in two ways:

using the online converter
manually create images

Online converter¶

The online Image converter is available here: https://littlevgl.com/image-to-c-array

Adding an image to LittlevGL via online converter is easy.

You need to select a BMP, PNG or JPG image first.
Give the image a name that will be used within LittlevGL.
Select the Color format.
Select the type of image you want. Choosing a binary will generate a .bin file that must be stored separately and read using the file support. Choosing a variable will generate a standard C file that can be linked into your project.
Hit the Convert button. Once the conversion is finished, your browser will automatically download the resulting file.

In the converter C arrays (variables), the bitmaps for all the color depths (1, 8, 16 or 32) are included in the C file, but only the color depth that matches LV_COLOR_DEPTH in lv_conf.h will actually be linked into the resulting executable.

In case of binary files, you need to specify the color format you want:

RGB332 for 8-bit color depth
RGB565 for 16-bit color depth
RGB565 Swap for 16-bit color depth (two bytes are swapped)
RGB888 for 32-bit color depth

Manually create an image¶

If you are generating an image at run-time, you can craft an image variable to display it using LittlevGL. For example:

uint8_t my_img_data[] = {0x00, 0x01, 0x02, ...};

static lv_img_dsc_t my_img_dsc = {
    .header.always_zero = 0,
    .header.w = 80,
    .header.h = 60,
    .data_size = 80 * 60 * LV_COLOR_DEPTH / 8,
    .header.cf = LV_IMG_CF_TRUE_COLOR,          /*Set the color format*/
    .data = my_img_data,
};

If the color format is LV_IMG_CF_TRUE_COLOR_ALPHA you can set data_size like 80 * 60 * LV_IMG_PX_SIZE_ALPHA_BYTE.

Another (possibly simpler) option to create and display an image at run-time is to use the Canvas object.

Use images¶

The simplest way to use an image in LittlevGL is to display it with an lv_img object:

lv_obj_t * icon = lv_img_create(lv_scr_act(), NULL);

/*From variable*/
lv_img_set_src(icon, &my_icon_dsc);

/*From file*/
lv_img_set_src(icon, "S:my_icon.bin");

If the image was converted with the online converter, you should use LV_IMG_DECLARE(my_icon_dsc) to declare the image in the file where you want to use it.

Image decoder¶

As you can see in the Color formats section, LittlevGL supports several built-in image formats. In many cases, these will be all you need. LittlevGL doesn’t directly support, however, generic image formats like PNG or JPG.

To handle non-built-in image formats, you need to use external libraries and attach them to LittlevGL via the Image decoder interface.

The image decoder consists of 4 callbacks:

info get some basic info about the image (width, height and color format).
open open the image: either store the decoded image or set it to NULL to indicate the image can be read line-by-line.
read if open didn’t fully open the image this function should give some decoded data (max 1 line) from a given position.
close close the opened image, free the allocated resources.

You can add any number of image decoders. When an image needs to be drawn, the library will try all the registered image decoder until finding one which can open the image, i.e. knowing that format.

The LV_IMG_CF_TRUE_COLOR_..., LV_IMG_INDEXED_... and LV_IMG_ALPHA_... formats (essentially, all non-RAW formats) are understood by the built-in decoder.

Custom image formats¶

The easiest way to create a custom image is to use the online image converter and set Raw, Raw with alpha or Raw with chrome keyed format. It will just take every byte of the binary file you uploaded and write it as the image “bitmap”. You then need to attach an image decoder that will parse that bitmap and generate the real, renderable bitmap.

header.cf will be LV_IMG_CF_RAW, LV_IMG_CF_RAW_ALPHA or LV_IMG_CF_RAW_CHROME_KEYED accordingly. You should choose the correct format according to your needs: fully opaque image, use alpha channel or use chroma keying.

After decoding, the raw formats are considered True color by the library. In other words, the image decoder must decode the Raw images to True color according to the format described in [#color-formats](Color formats) section.

If you want to create a custom image, you should use LV_IMG_CF_USER_ENCODED_0..7 color formats. However, the library can draw the images only in True color format (or Raw but finally it’s supposed to be in True color format). So the LV_IMG_CF_USER_ENCODED_... formats are not known by the library, therefore, they should be decoded to one of the known formats from [#color-formats](Color formats) section. It’s possible to decode the image to a non-true color format first, for example, LV_IMG_INDEXED_4BITS, and then call the built-in decoder functions to convert it to True color.

With User encoded formats, the color format in the open function (dsc->header.cf) should be changed according to the new format.

Register an image decoder¶

Here’s an example of getting LittlevGL to work with PNG images.

First, you need to create a new image decoder and set some functions to open/close the PNG files. It should looks like this:

/*Create a new decoder and register functions */
lv_img_decoder_t * dec = lv_img_decoder_create();
lv_img_decoder_set_info_cb(dec, decoder_info);
lv_img_decoder_set_open_cb(dec, decoder_open);
lv_img_decoder_set_close_cb(dec, decoder_close);

/**
 * Get info about a PNG image
 * @param decoder pointer to the decoder where this function belongs
 * @param src can be file name or pointer to a C array
 * @param header store the info here
 * @return LV_RES_OK: no error; LV_RES_INV: can't get the info
 */
static lv_res_t decoder_info(lv_img_decoder_t * decoder, const void * src, lv_img_header_t * header)
{
  /*Check whether the type `src` is known by the decoder*/
  if(is_png(src) == false) return LV_RES_INV;

  /* Read the PNG header and find `width` and `height` */
  ...

  header->cf = LV_IMG_CF_RAW_ALPHA;
  header->w = width;
  header->h = height;
}

/**
 * Open a PNG image and return the decided image
 * @param decoder pointer to the decoder where this function belongs
 * @param dsc pointer to a descriptor which describes this decoding session
 * @return LV_RES_OK: no error; LV_RES_INV: can't get the info
 */
static lv_res_t decoder_open(lv_img_decoder_t * decoder, lv_img_decoder_dsc_t * dsc)
{

  /*Check whether the type `src` is known by the decoder*/
  if(is_png(src) == false) return LV_RES_INV;

  /*Decode and store the image. If `dsc->img_data` is `NULL`, the `read_line` function will be called to get the image data line-by-line*/
  dsc->img_data = my_png_decoder(src);

  /*Change the color format if required. For PNG usually 'Raw' is fine*/
  dsc->header.cf = LV_IMG_CF_...

  /*Call a built in decoder function if required. It's not required if`my_png_decoder` opened the image in true color format.*/
  lv_res_t res = lv_img_decoder_built_in_open(decoder, dsc);

  return res;
}

/**
 * Decode `len` pixels starting from the given `x`, `y` coordinates and store them in `buf`.
 * Required only if the "open" function can't open the whole decoded pixel array. (dsc->img_data == NULL)
 * @param decoder pointer to the decoder the function associated with
 * @param dsc pointer to decoder descriptor
 * @param x start x coordinate
 * @param y start y coordinate
 * @param len number of pixels to decode
 * @param buf a buffer to store the decoded pixels
 * @return LV_RES_OK: ok; LV_RES_INV: failed
 */
lv_res_t decoder_built_in_read_line(lv_img_decoder_t * decoder, lv_img_decoder_dsc_t * dsc, lv_coord_t x,
                                                  lv_coord_t y, lv_coord_t len, uint8_t * buf)
{
   /*With PNG it's usually not required*/

   /*Copy `len` pixels from `x` and `y` coordinates in True color format to `buf` */

}

/**
 * Free the allocated resources
 * @param decoder pointer to the decoder where this function belongs
 * @param dsc pointer to a descriptor which describes this decoding session
 */
static void decoder_close(lv_img_decoder_t * decoder, lv_img_decoder_dsc_t * dsc)
{
  /*Free all allocated data*/

  /*Call the built-in close function if the built-in open/read_line was used*/
  lv_img_decoder_built_in_close(decoder, dsc);

}

So in summary:

In decoder_info, you should collect some basic information about the image and store it in header.
In decoder_open, you should try to open the image source pointed by dsc->src. Its type is already in dsc->src_type == LV_IMG_SRC_FILE/VARIABLE. If this format/type is not supported by the decoder, return LV_RES_INV. However, if you can open the image, a pointer to the decoded True color image should be set in dsc->img_data. If the format is known but, you don’t want to decode while image (e.g. no memory for it) set dsc->img_data = NULL to call read_line to get the pixels.
In decoder_close you should free all the allocated resources.
decoder_read is optional. Decoding the whole image requires extra memory and some computational overhead. However, if can decode one line of the image without decoding the whole image, you can save memory and time. To indicate that, the line read function should be used, set dsc->img_data = NULL in the open function.

Manually use an image decoder¶

LittlevGL will use the registered image decoder automatically if you try and draw a raw image (i.e. using the lv_img object) but you can use them manually too. Create a lv_img_decoder_dsc_t variable to describe the decoding session and call lv_img_decoder_open(), lv_img_decoder_open().

lv_res_t res;
lv_img_decoder_dsc_t dsc;
res = lv_img_decoder_open(&dsc, &my_img_dsc, &lv_style_plain);

if(res == LV_RES_OK) {
  /*Do something with `dsc->img_data`*/
  lv_img_decoder_close(&dsc);
}

Image caching¶

Sometimes it takes a lot of time to open an image. Continuously decoding a PNG image or loading images from a slow external memory would be inefficient and detrimental to the user experience.

Therefore, LittlevGL caches a given number of images. Caching means some images will be left open, hence LittlevGL can quickly access them from dsc->img_data instead of needing to decode them again.

Of course, caching images is resource-intensive as it uses more RAM (to store the decoded image). LittlevGL tries to optimize the process as much as possible (see below), but you will still need to evaluate if this would be beneficial for your platform or not. If you have a deeply embedded target which decodes small images from a relatively fast storage medium, image caching may not be worth it.

Cache size¶

The number of cache entries can be defined in LV_IMG_CACHE_DEF_SIZE in lv_conf.h. The default value is 1 so only the most recently used image will be left open.

The size of the cache can be changed at run-time with lv_img_cache_set_size(entry_num).

Value of images¶

When you use more images than cache entries, LittlevGL can’t cache all of the images. Instead, the library will close one of the cached images (to free space).

To decide which image to close, LittlevGL uses a measurement it previously made of how long it took to open the image. Cache entries that hold slower-to-open images are considered more valuable and are kept in the cache as long as possible.

If you want or need to override LittlevGL’s measurement, you can manually set the time to open value in the decoder open function in dsc->time_to_open = time_ms to give a higher or lower value. (Leave it unchanged to let LittlevGL set it.)

Every cache entry has a “life” value. Every time an image opening happens through the cache, the life of all entries are decreased to make them older. When a cached image is used, its life is increased by the time to open value to make it more alive.

If there is no more space in the cache, always the entry with the smallest life will be closed.

Memory usage¶

Note that, the cached image might continuously consume memory. For example, if 3 PNG images are cached, they will consume memory while they are opened.

Therefore, it’s the user’s responsibility to be sure there is enough RAM to cache, even the largest images at the same time.

Clean the cache¶

Let’s say you have loaded a PNG image into a lv_img_dsc_t my_png variable and use it in an lv_img object. If the image is already cached and you then change the underlying PNG file, you need to notify LittlevGL to cache the image again. Otherwise, there is no easy way of detecting that the underlying file changed and LittlevGL will still draw the old image.

To do this, use lv_img_cache_invalidate_src(&my_png). If NULL is passed as a parameter, the whole cache will be cleaned.

API¶

Image decoder¶

Typedefs

typedef uint8_t lv_img_src_t¶

typedef uint8_t lv_img_cf_t¶

typedef lv_res_t (*lv_img_decoder_info_f_t)(struct _lv_img_decoder *decoder, const void *src, lv_img_header_t *header)¶

Get info from an image and store in the header

Return

LV_RES_OK: info written correctly; LV_RES_INV: failed

Parameters

src: the image source. Can be a pointer to a C array or a file name (Use lv_img_src_get_type to determine the type)
header: store the info here

typedef lv_res_t (*lv_img_decoder_open_f_t)(struct _lv_img_decoder *decoder, struct _lv_img_decoder_dsc *dsc)¶

Open an image for decoding. Prepare it as it is required to read it later

Parameters

decoder: pointer to the decoder the function associated with
dsc: pointer to decoder descriptor. src, style are already initialized in it.

typedef lv_res_t (*lv_img_decoder_read_line_f_t)(struct _lv_img_decoder *decoder, struct _lv_img_decoder_dsc *dsc, lv_coord_t x, lv_coord_t y, lv_coord_t len, uint8_t *buf)¶

Decode len pixels starting from the given x, y coordinates and store them in buf. Required only if the “open” function can’t return with the whole decoded pixel array.

Return

LV_RES_OK: ok; LV_RES_INV: failed

Parameters

decoder: pointer to the decoder the function associated with
dsc: pointer to decoder descriptor
x: start x coordinate
y: start y coordinate
len: number of pixels to decode
buf: a buffer to store the decoded pixels

typedef void (*lv_img_decoder_close_f_t)(struct _lv_img_decoder *decoder, struct _lv_img_decoder_dsc *dsc)¶

Close the pending decoding. Free resources etc.

Parameters

decoder: pointer to the decoder the function associated with
dsc: pointer to decoder descriptor

typedef struct _lv_img_decoder lv_img_decoder_t¶

typedef struct _lv_img_decoder_dsc lv_img_decoder_dsc_t¶: Describe an image decoding session. Stores data about the decoding

Enums

enum [anonymous]¶

Source of image.

Values:

enumerator LV_IMG_SRC_VARIABLE¶

enumerator LV_IMG_SRC_FILE¶: Binary/C variable

enumerator LV_IMG_SRC_SYMBOL¶: File in filesystem

enumerator LV_IMG_SRC_UNKNOWN¶: Symbol (lv_symbol_def.h)

enum [anonymous]¶

Values:

enumerator LV_IMG_CF_UNKNOWN = 0¶

enumerator LV_IMG_CF_RAW¶: Contains the file as it is. Needs custom decoder function

enumerator LV_IMG_CF_RAW_ALPHA¶: Contains the file as it is. The image has alpha. Needs custom decoder function

enumerator LV_IMG_CF_RAW_CHROMA_KEYED¶: Contains the file as it is. The image is chroma keyed. Needs custom decoder function

enumerator LV_IMG_CF_TRUE_COLOR¶: Color format and depth should match with LV_COLOR settings

enumerator LV_IMG_CF_TRUE_COLOR_ALPHA¶: Same as LV_IMG_CF_TRUE_COLOR but every pixel has an alpha byte

enumerator LV_IMG_CF_TRUE_COLOR_CHROMA_KEYED¶: Same as LV_IMG_CF_TRUE_COLOR but LV_COLOR_TRANSP pixels will be transparent

enumerator LV_IMG_CF_INDEXED_1BIT¶: Can have 2 different colors in a palette (always chroma keyed)

enumerator LV_IMG_CF_INDEXED_2BIT¶: Can have 4 different colors in a palette (always chroma keyed)

enumerator LV_IMG_CF_INDEXED_4BIT¶: Can have 16 different colors in a palette (always chroma keyed)

enumerator LV_IMG_CF_INDEXED_8BIT¶: Can have 256 different colors in a palette (always chroma keyed)

enumerator LV_IMG_CF_ALPHA_1BIT¶: Can have one color and it can be drawn or not

enumerator LV_IMG_CF_ALPHA_2BIT¶: Can have one color but 4 different alpha value

enumerator LV_IMG_CF_ALPHA_4BIT¶: Can have one color but 16 different alpha value

enumerator LV_IMG_CF_ALPHA_8BIT¶: Can have one color but 256 different alpha value

enumerator LV_IMG_CF_RESERVED_15¶: Reserved for further use.

enumerator LV_IMG_CF_RESERVED_16¶: Reserved for further use.

enumerator LV_IMG_CF_RESERVED_17¶: Reserved for further use.

enumerator LV_IMG_CF_RESERVED_18¶: Reserved for further use.

enumerator LV_IMG_CF_RESERVED_19¶: Reserved for further use.

enumerator LV_IMG_CF_RESERVED_20¶: Reserved for further use.

enumerator LV_IMG_CF_RESERVED_21¶: Reserved for further use.

enumerator LV_IMG_CF_RESERVED_22¶: Reserved for further use.

enumerator LV_IMG_CF_RESERVED_23¶: Reserved for further use.

enumerator LV_IMG_CF_USER_ENCODED_0¶: User holder encoding format.

enumerator LV_IMG_CF_USER_ENCODED_1¶: User holder encoding format.

enumerator LV_IMG_CF_USER_ENCODED_2¶: User holder encoding format.

enumerator LV_IMG_CF_USER_ENCODED_3¶: User holder encoding format.

enumerator LV_IMG_CF_USER_ENCODED_4¶: User holder encoding format.

enumerator LV_IMG_CF_USER_ENCODED_5¶: User holder encoding format.

enumerator LV_IMG_CF_USER_ENCODED_6¶: User holder encoding format.

enumerator LV_IMG_CF_USER_ENCODED_7¶: User holder encoding format.

Functions

void lv_img_decoder_init(void)¶: Initialize the image decoder module

lv_res_t lv_img_decoder_get_info(const char *src, lv_img_header_t *header)¶

Get information about an image. Try the created image decoder one by one. Once one is able to get info that info will be used.

Return

LV_RES_OK: success; LV_RES_INV: wasn’t able to get info about the image

Parameters

src: the image source. Can be 1) File name: E.g. “S:folder/img1.png” (The drivers needs to registered via lv_fs_add_drv()) 2) Variable: Pointer to an lv_img_dsc_t variable 3) Symbol: E.g. LV_SYMBOL_OK
header: the image info will be stored here

lv_res_t lv_img_decoder_open(lv_img_decoder_dsc_t *dsc, const void *src, const lv_style_t *style)¶

Open an image. Try the created image decoder one by one. Once one is able to open the image that decoder is save in dsc

Return

LV_RES_OK: opened the image. dsc->img_data and dsc->header are set. LV_RES_INV: none of the registered image decoders were able to open the image.

Parameters

dsc: describe a decoding session. Simply a pointer to an lv_img_decoder_dsc_t variable.
src: the image source. Can be 1) File name: E.g. “S:folder/img1.png” (The drivers needs to registered via lv_fs_add_drv()) 2) Variable: Pointer to an lv_img_dsc_t variable 3) Symbol: E.g. LV_SYMBOL_OK
style: the style of the image

lv_res_t lv_img_decoder_read_line(lv_img_decoder_dsc_t *dsc, lv_coord_t x, lv_coord_t y, lv_coord_t len, uint8_t *buf)¶

Read a line from an opened image

Return

LV_RES_OK: success; LV_RES_INV: an error occurred

Parameters

dsc: pointer to lv_img_decoder_dsc_t used in lv_img_decoder_open
x: start X coordinate (from left)
y: start Y coordinate (from top)
len: number of pixels to read
buf: store the data here

void lv_img_decoder_close(lv_img_decoder_dsc_t *dsc)¶

Close a decoding session

Parameters

dsc: pointer to lv_img_decoder_dsc_t used in lv_img_decoder_open

lv_img_decoder_t *lv_img_decoder_create(void)¶

Create a new image decoder

Return: pointer to the new image decoder

void lv_img_decoder_delete(lv_img_decoder_t *decoder)¶

Delete an image decoder

Parameters

decoder: pointer to an image decoder

void lv_img_decoder_set_info_cb(lv_img_decoder_t *decoder, lv_img_decoder_info_f_t info_cb)¶

Set a callback to get information about the image

Parameters

decoder: pointer to an image decoder
info_cb: a function to collect info about an image (fill an lv_img_header_t struct)

void lv_img_decoder_set_open_cb(lv_img_decoder_t *decoder, lv_img_decoder_open_f_t open_cb)¶

Set a callback to open an image

Parameters

decoder: pointer to an image decoder
open_cb: a function to open an image

void lv_img_decoder_set_read_line_cb(lv_img_decoder_t *decoder, lv_img_decoder_read_line_f_t read_line_cb)¶

Set a callback to a decoded line of an image

Parameters

decoder: pointer to an image decoder
read_line_cb: a function to read a line of an image

void lv_img_decoder_set_close_cb(lv_img_decoder_t *decoder, lv_img_decoder_close_f_t close_cb)¶

Set a callback to close a decoding session. E.g. close files and free other resources.

Parameters

decoder: pointer to an image decoder
close_cb: a function to close a decoding session

lv_res_t lv_img_decoder_built_in_info(lv_img_decoder_t *decoder, const void *src, lv_img_header_t *header)¶

Get info about a built-in image

Return

LV_RES_OK: the info is successfully stored in header; LV_RES_INV: unknown format or other error.

Parameters

decoder: the decoder where this function belongs
src: the image source: pointer to an lv_img_dsc_t variable, a file path or a symbol
header: store the image data here

lv_res_t lv_img_decoder_built_in_open(lv_img_decoder_t *decoder, lv_img_decoder_dsc_t *dsc)¶

Open a built in image

Return

LV_RES_OK: the info is successfully stored in header; LV_RES_INV: unknown format or other error.

Parameters

decoder: the decoder where this function belongs
dsc: pointer to decoder descriptor. src, style are already initialized in it.

lv_res_t lv_img_decoder_built_in_read_line(lv_img_decoder_t *decoder, lv_img_decoder_dsc_t *dsc, lv_coord_t x, lv_coord_t y, lv_coord_t len, uint8_t *buf)¶

Decode len pixels starting from the given x, y coordinates and store them in buf. Required only if the “open” function can’t return with the whole decoded pixel array.

Return

LV_RES_OK: ok; LV_RES_INV: failed

Parameters

decoder: pointer to the decoder the function associated with
dsc: pointer to decoder descriptor
x: start x coordinate
y: start y coordinate
len: number of pixels to decode
buf: a buffer to store the decoded pixels

void lv_img_decoder_built_in_close(lv_img_decoder_t *decoder, lv_img_decoder_dsc_t *dsc)¶

Close the pending decoding. Free resources etc.

Parameters

decoder: pointer to the decoder the function associated with
dsc: pointer to decoder descriptor

struct lv_img_header_t¶

#include <lv_img_decoder.h>

LittlevGL image header

Public Members

uint32_t cf¶

uint32_t always_zero¶

uint32_t reserved¶

uint32_t w¶

uint32_t h¶

struct lv_img_dsc_t¶

#include <lv_img_decoder.h>

Image header it is compatible with the result from image converter utility

Public Members

lv_img_header_t header¶

uint32_t data_size¶

const uint8_t *data¶

struct _lv_img_decoder¶

Public Members

lv_img_decoder_info_f_t info_cb¶

lv_img_decoder_open_f_t open_cb¶

lv_img_decoder_read_line_f_t read_line_cb¶

lv_img_decoder_close_f_t close_cb¶

lv_img_decoder_user_data_t user_data¶

struct _lv_img_decoder_dsc¶

#include <lv_img_decoder.h>

Describe an image decoding session. Stores data about the decoding

Public Members

lv_img_decoder_t *decoder¶: The decoder which was able to open the image source

const void *src¶: The image source. A file path like “S:my_img.png” or pointer to an lv_img_dsc_t variable

const lv_style_t *style¶: Style to draw the image.

lv_img_src_t src_type¶: Type of the source: file or variable. Can be set in open function if required

lv_img_header_t header¶: Info about the opened image: color format, size, etc. MUST be set in open function

const uint8_t *img_data¶: Pointer to a buffer where the image’s data (pixels) are stored in a decoded, plain format. MUST be set in open function

uint32_t time_to_open¶: How much time did it take to open the image. [ms] If not set lv_img_cache will measure and set the time to open

const char *error_msg¶: A text to display instead of the image when the image can’t be opened. Can be set in open function or set NULL.

void *user_data¶: Store any custom data here is required

Image cache¶

Functions

lv_img_cache_entry_t *lv_img_cache_open(const void *src, const lv_style_t *style)¶

Open an image using the image decoder interface and cache it. The image will be left open meaning if the image decoder open callback allocated memory then it will remain. The image is closed if a new image is opened and the new image takes its place in the cache.

Return

pointer to the cache entry or NULL if can open the image

Parameters

src: source of the image. Path to file or pointer to an lv_img_dsc_t variable
style: style of the image

void lv_img_cache_set_size(uint16_t new_slot_num)¶

Set the number of images to be cached. More cached images mean more opened image at same time which might mean more memory usage. E.g. if 20 PNG or JPG images are open in the RAM they consume memory while opened in the cache.

Parameters

new_entry_cnt: number of image to cache

void lv_img_cache_invalidate_src(const void *src)¶

Invalidate an image source in the cache. Useful if the image source is updated therefore it needs to be cached again.

Parameters

src: an image source path to a file or pointer to an lv_img_dsc_t variable.

struct lv_img_cache_entry_t¶

#include <lv_img_cache.h>

When loading images from the network it can take a long time to download and decode the image.

To avoid repeating this heavy load images can be cached.

Public Members

lv_img_decoder_dsc_t dec_dsc¶: Image information

int32_t life¶: Count the cache entries’s life. Add time_tio_open to life when the entry is used. Decrement all lifes by one every in every lv_img_cache_open. If life == 0 the entry can be reused