lv_image_decoder_private.h

API reference for lv_image_decoder_private.h

Report on GitHub

Summary

2Functions

5Structs

Functions

draw/lv_image_decoder_private.h:129function

lv_image_decoder_init

Initialize the image decoder module

void lv_image_decoder_init(uint32_t image_cache_size, uint32_t image_header_count)

Name	Type	Description
`image_cache_size`	`uint32_t`	Image cache size in bytes. 0 to disable cache.
`image_header_count`	`uint32_t`	Number of header cache entries. 0 to disable header cache.

draw/lv_image_decoder_private.h:134function

lv_image_decoder_deinit

Deinitialize the image decoder module

void lv_image_decoder_deinit(void)

Image decoder args. It determines how to decoder an image, e.g. whether to premultiply the alpha or not. It should be passed to lv_img_decoder_open() function. If NULL is provided, default args are used.

Default args: all field are zero or false.

Member	Type	Description
`stride_align`	`bool`	Whether stride should be aligned
`premultiply`	`bool`	Whether image should be premultiplied or not after decoding
`no_cache`	`bool`	When set, decoded image won't be put to cache, and decoder open will also ignore cache.
`use_indexed`	`bool`	Decoded indexed image as is. Convert to ARGB8888 if false.
`flush_cache`	`bool`	Whether to flush the data cache after decoding

struct

_lv_image_decoder_t

Member	Type	Description
`info_cb`	`lv_image_decoder_info_f_t`
`open_cb`	`lv_image_decoder_open_f_t`
`get_area_cb`	`lv_image_decoder_get_area_cb_t`
`close_cb`	`lv_image_decoder_close_f_t`
`custom_draw_cb`	`lv_image_decoder_custom_draw_t`
`name`	`const char *`
`user_data`	`void *`

struct

_lv_image_cache_data_t

Member	Type	Description
`slot`	`lv_cache_slot_size_t`
`src`	`const void *`
`src_type`	`lv_image_src_t`
`decoded`	`const lv_draw_buf_t *`
`decoder`	`const lv_image_decoder_t *`
`user_data`	`void *`

struct

_lv_image_header_cache_data_t

Member	Type	Description
`src`	`const void *`
`src_type`	`lv_image_src_t`
`header`	`lv_image_header_t`
`decoder`	`lv_image_decoder_t *`

struct

_lv_image_decoder_dsc_t

Describe an image decoding session. Stores data about the decoding

Member	Type	Description
`decoder`	`lv_image_decoder_t *`	The decoder which was able to open the image source
`args`	`lv_image_decoder_args_t`	A copy of parameters of how this image is decoded
`src`	`const void *`	The image source. A file path like "S:my_img.png" or pointer to an `lv_image_dsc_t` variable
`src_type`	`lv_image_src_t`	Type of the source: file or variable. Can be set in `open` function if required
`file`	`lv_fs_file_t`
`header`	`lv_image_header_t`	Info about the opened image: color format, size, etc. MUST be set in `open` function
`decoded`	`const lv_draw_buf_t *`	Pointer to a draw buffer where the image's data (pixels) are stored in a decoded, plain format. MUST be set in `open` or `get_area_cb`function
`palette`	`const lv_color32_t *`
`palette_size`	`uint32_t`
`time_to_open`	`uint32_t`	How much time did it take to open the image. [ms] If not set `lv_image_cache` will measure and set the time to open
`error_msg`	`const char *`	A text to display instead of the image when the image can't be opened. Can be set in `open` function or set NULL.
`cache`	`lv_cache_t *`
`cache_entry`	`lv_cache_entry_t *`	Point to cache entry information
`user_data`	`void *`	Store any custom data here is required

lv_image_decoder_private.h

Functions

lv_image_decoder_init

lv_image_decoder_deinit

Structs

_lv_image_decoder_args_t

_lv_image_decoder_t

_lv_image_cache_data_t

_lv_image_header_cache_data_t

_lv_image_decoder_dsc_t

Dependencies

On this page