lv_image_decoder.h
API reference for lv_image_decoder.h
See Also: Private HeaderThis header has a companion private implementation with internal data structures.lv_image_decoder_private.h
Summary
Functions
draw/lv_image_decoder.h:159function
lv_image_decoder_set_info_cb
Set a callback to get information about the image
void lv_image_decoder_set_info_cb(lv_image_decoder_t *decoder, lv_image_decoder_info_f_t info_cb)| Name | Type | Description |
|---|---|---|
decoder | lv_image_decoder_t * | pointer to an image decoder |
info_cb | lv_image_decoder_info_f_t | a function to collect info about an image (fill an lv_image_header_t struct) |
draw/lv_image_decoder.h:166function
lv_image_decoder_set_open_cb
Set a callback to open an image
void lv_image_decoder_set_open_cb(lv_image_decoder_t *decoder, lv_image_decoder_open_f_t open_cb)| Name | Type | Description |
|---|---|---|
decoder | lv_image_decoder_t * | pointer to an image decoder |
open_cb | lv_image_decoder_open_f_t | a function to open an image |
draw/lv_image_decoder.h:173function
lv_image_decoder_set_get_area_cb
Set a callback to a decoded line of an image
void lv_image_decoder_set_get_area_cb(lv_image_decoder_t *decoder, lv_image_decoder_get_area_cb_t read_line_cb)| Name | Type | Description |
|---|---|---|
decoder | lv_image_decoder_t * | pointer to an image decoder |
read_line_cb | lv_image_decoder_get_area_cb_t | a function to read a line of an image |
draw/lv_image_decoder.h:180function
lv_image_decoder_set_close_cb
Set a callback to close a decoding session. E.g. close files and free other resources.
void lv_image_decoder_set_close_cb(lv_image_decoder_t *decoder, lv_image_decoder_close_f_t close_cb)| Name | Type | Description |
|---|---|---|
decoder | lv_image_decoder_t * | pointer to an image decoder |
close_cb | lv_image_decoder_close_f_t | a function to close a decoding session |
Enums
lv_image_src_t
Source of image.
| Name | Description |
|---|---|
LV_IMAGE_SRC_VARIABLE | |
LV_IMAGE_SRC_FILE | Binary/C variable |
LV_IMAGE_SRC_SYMBOL | File in filesystem |
LV_IMAGE_SRC_UNKNOWN | Symbol (lv_symbol_def.h) |
Typedefs
draw/lv_image_decoder.h:47typedef
lv_image_decoder_info_f_t
typedef lv_result_t(* lv_image_decoder_info_f_t) (lv_image_decoder_t *decoder, lv_image_decoder_dsc_t *dsc, lv_image_header_t *header)Get info from an image and store in the header
Used by 1 function
lv_image_decoder_set_info_cb— paraminfo_cb
draw/lv_image_decoder.h:55typedef
lv_image_decoder_open_f_t
typedef lv_result_t(* lv_image_decoder_open_f_t) (lv_image_decoder_t *decoder, lv_image_decoder_dsc_t *dsc)Open an image for decoding. Prepare it as it is required to read it later
Used by 1 function
lv_image_decoder_set_open_cb— paramopen_cb
draw/lv_image_decoder.h:67typedef
lv_image_decoder_get_area_cb_t
typedef lv_result_t(* lv_image_decoder_get_area_cb_t) (lv_image_decoder_t *decoder, lv_image_decoder_dsc_t *dsc, const lv_area_t *full_area, lv_area_t *decoded_area)Decode full_area pixels incrementally by calling in a loop. Set decoded_area values to LV_COORD_MIN on first call. Required only if the "open" function can't return with the whole decoded pixel array.
Used by 1 function
lv_image_decoder_set_get_area_cb— paramread_line_cb
draw/lv_image_decoder.h:76typedef
lv_image_decoder_close_f_t
typedef void(* lv_image_decoder_close_f_t) (lv_image_decoder_t *decoder, lv_image_decoder_dsc_t *dsc)Close the pending decoding. Free resources etc.
Used by 1 function
lv_image_decoder_set_close_cb— paramclose_cb
draw/lv_image_decoder.h:86typedef
lv_image_decoder_custom_draw_t
typedef void(* lv_image_decoder_custom_draw_t) (lv_layer_t *layer, const lv_image_decoder_dsc_t *dsc, const lv_area_t *coords, const lv_draw_image_dsc_t *draw_dsc, const lv_area_t *clip_area)Custom drawing functions for special image formats.
Dependencies
How is this guide?
Last updated on