lv_gif.h

Functions

lv_obj_t *lv_gif_create(lv_obj_t *parent)

Create a gif object

Parameters:

parent – pointer to an object, it will be the parent of the new gif.

Returns:

pointer to the gif obj

void lv_gif_set_color_format(lv_obj_t *obj, lv_color_format_t color_format)

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.

Parameters:

  • obj – pointer to a gif object

  • color_format – the color format of the gif framebuffer

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

Set the gif data to display on the object

Parameters:

  • obj – pointer to a gif object

  • src – 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")

void lv_gif_restart(lv_obj_t *obj)

Restart a gif animation.

Parameters:

obj – pointer to a gif obj

void lv_gif_pause(lv_obj_t *obj)

Pause a gif animation.

Parameters:

obj – pointer to a gif obj

void lv_gif_resume(lv_obj_t *obj)

Resume a gif animation.

Parameters:

obj – pointer to a gif obj

bool lv_gif_is_loaded(lv_obj_t *obj)

Checks if the GIF was loaded correctly.

Parameters:

obj – pointer to a gif obj

int32_t lv_gif_get_loop_count(lv_obj_t *obj)

Get the loop count for the GIF.

Parameters:

obj – pointer to a gif obj

void lv_gif_set_loop_count(lv_obj_t *obj, int32_t count)

Set the loop count for the GIF.

Parameters:

  • obj – pointer to a gif obj

  • count – the loop count to set

void lv_gif_set_auto_pause_invisible(lv_obj_t *obj, bool auto_pause)

Set whether to decode invisible object.

Parameters:

  • obj – pointer to a gif object

  • auto_pause – true: auto pause when invisible, false: don't auto pause

bool lv_gif_get_size(const char *src, uint16_t *w, uint16_t *h)

Get gif width & height

Parameters:

  • src – pointer to a gif file

  • w – pointer to store width

  • h – pointer to store height

Returns:

true: success; false: failed

int32_t lv_gif_get_frame_count(lv_obj_t *obj)

Get frame count of the GIF.

Parameters:

obj – pointer to a gif object

Returns:

frame count of the GIF

int32_t lv_gif_get_current_frame_index(lv_obj_t *obj)

Get the current frame index of the GIF.

Parameters:

obj – pointer to a gif object

Returns:

current frame index of the GIF

Variables

const lv_obj_class_t lv_gif_class