lv_img_decoder_open() function

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

Syntax

Show:

Summary

Declaration

Definition

from lv_img_decoder.h:168

lv_res_t lv_img_decoder_open(lv_img_decoder_dsc_t * dsc, const void * src, lv_color_t color, int32_t frame_id);

Implemented in lv_img_decoder.c:107

Arguments

Argument

Description

dsc

describes 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`

color

The color of the image with `LV_IMG_CF_ALPHA_...`

frame_id

the index of the frame. Used only with animated images, set 0 for normal images

Return value

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.

Examples

References

from examples

lv_img_decoder_open() function

Syntax

Arguments

Return value

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle