lv_gif.h

API reference for lv_gif.h

Summary

Set the color format of the internally allocated framebuffer that the gif will be decoded to. The default is LV_COLOR_FORMAT_ARGB8888. Call this before lv_gif_set_src to avoid reallocating the framebuffer.

void lv_gif_set_color_format(lv_obj_t *obj, lv_color_format_t color_format)

Name	Type	Description
`obj`	`lv_obj_t *`	pointer to a gif object
`color_format`	`lv_color_format_t`	the color format of the gif framebuffer

widgets/gif/lv_gif.h:59function

lv_gif_set_src

Set the gif data to display on the object

void lv_gif_set_src(lv_obj_t *obj, const void *src)

Name	Type	Description
`obj`	`lv_obj_t *`	pointer to a gif object
`src`	`const void *`	1) pointer to an `lv_image_dsc_t` descriptor (which contains gif raw data) or 2) path to a gif file (e.g. "S:/dir/anim.gif")

widgets/gif/lv_gif.h:96function

lv_gif_set_loop_count

Set the loop count for the GIF.

void lv_gif_set_loop_count(lv_obj_t *obj, int32_t count)

Name	Type	Description
`obj`	`lv_obj_t *`	pointer to a gif obj
`count`	`int32_t`	the loop count to set

widgets/gif/lv_gif.h:103function

lv_gif_set_auto_pause_invisible

Set whether to decode invisible object.

void lv_gif_set_auto_pause_invisible(lv_obj_t *obj, bool auto_pause)

Name	Type	Description
`obj`	`lv_obj_t *`	pointer to a gif object
`auto_pause`	`bool`	true: auto pause when invisible, false: don't auto pause

Variables

widgets/gif/lv_gif.h:31variable

lv_gif_class

const lv_obj_class_t lv_gif_class

Dependencies

Indirect dependencies