lv_bin_decoder.h

API reference for lv_bin_decoder.h

Summary

Functions

lv_result_t lv_bin_decoder_get_area(lv_image_decoder_t *decoder, lv_image_decoder_dsc_t *dsc, const lv_area_t *full_area, lv_area_t *decoded_area)

Initialize the binary image decoder module

void lv_bin_decoder_init(void)

Get info about a lvgl binary image

lv_result_t lv_bin_decoder_info(lv_image_decoder_t *decoder, lv_image_decoder_dsc_t *dsc, lv_image_header_t *header)

Name	Type	Description
`decoder`	`lv_image_decoder_t *`	the decoder where this function belongs
`dsc`	`lv_image_decoder_dsc_t *`	image descriptor containing the source and type of the image and other info.
`header`	`lv_image_header_t *`	store the image data here

Returns: lv_result_t — LV_RESULT_OK: the info is successfully stored in header; LV_RESULT_INVALID: unknown format or other error.

Open a lvgl binary image

lv_result_t lv_bin_decoder_open(lv_image_decoder_t *decoder, lv_image_decoder_dsc_t *dsc)

Name	Type	Description
`decoder`	`lv_image_decoder_t *`	the decoder where this function belongs
`dsc`	`lv_image_decoder_dsc_t *`	pointer to decoder descriptor. `src`, `style` are already initialized in it.

Returns: lv_result_t — LV_RESULT_OK: the info is successfully stored in header; LV_RESULT_INVALID: unknown format or other error.

Close the pending decoding. Free resources etc.

void lv_bin_decoder_close(lv_image_decoder_t *decoder, lv_image_decoder_dsc_t *dsc)

Name	Type	Description
`decoder`	`lv_image_decoder_t *`	pointer to the decoder the function associated with
`dsc`	`lv_image_decoder_dsc_t *`	pointer to decoder descriptor

Indirect dependencies