lv_animimage.h

Enums

Modified by NXP in 2025

Values:

enumerator LV_PROPERTY_ANIMIMAGE_SRC
enumerator LV_PROPERTY_ANIMIMAGE_DURATION
enumerator LV_PROPERTY_ANIMIMAGE_REPEAT_COUNT
enumerator LV_PROPERTY_ANIMIMAGE_SRC_COUNT
enumerator LV_PROPERTY_ANIMIMAGE_END
enum lv_animimg_part_t

Image parts

Values:

enumerator LV_ANIM_IMAGE_PART_MAIN

Functions

lv_obj_t *lv_animimg_create(lv_obj_t *parent)

Create an animation image objects

Parameters:

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

Returns:

pointer to the created animation image object

void lv_animimg_set_src(lv_obj_t *obj, const void *dsc[], size_t num)

Set the image animation images source.

Parameters:

  • obj – pointer to an animation image object

  • dsc – pointer to a series images

  • num – images' number

void lv_animimg_set_src_reverse(lv_obj_t *obj, const void *dsc[], size_t num)

Set the images source for flip playback of animation image.

Parameters:

  • obj – pointer to an animation image object

  • dsc – pointer to a series images

  • num – images' number

void lv_animimg_start(lv_obj_t *obj)

Startup the image animation.

Parameters:

obj – pointer to an animation image object

bool lv_animimg_delete(lv_obj_t *obj)

Delete the image animation.

Parameters:

obj – pointer to an animation image object

void lv_animimg_set_duration(lv_obj_t *obj, uint32_t duration)

Set the image animation duration time. unit:ms

Parameters:

  • obj – pointer to an animation image object

  • duration – the duration in milliseconds

void lv_animimg_set_repeat_count(lv_obj_t *obj, uint32_t count)

Set the image animation repeatedly play times.

Parameters:

  • obj – pointer to an animation image object

  • count – the number of times to repeat the animation

void lv_animimg_set_reverse_duration(lv_obj_t *obj, uint32_t duration)

Make the image animation to play back to when the forward direction is ready.

Parameters:

  • obj – pointer to an animation image object

  • duration – the duration of the playback image animation in milliseconds. 0: disable playback

void lv_animimg_set_reverse_delay(lv_obj_t *obj, uint32_t duration)

Make the image animation to play back to when the forward direction is ready.

Parameters:

  • obj – pointer to an animation image object

  • duration – delay in milliseconds before starting the playback image animation.

void lv_animimg_set_start_cb(lv_obj_t *obj, lv_anim_start_cb_t start_cb)

Set a function call when the animation image really starts (considering delay)

Parameters:

  • obj – pointer to an animation image object

  • start_cb – a function call when the animation is start

void lv_animimg_set_completed_cb(lv_obj_t *obj, lv_anim_completed_cb_t completed_cb)

Set a function call when the animation is completed

Parameters:

  • obj – pointer to an animation image object

  • completed_cb – a function call when the animation is completed

const void **lv_animimg_get_src(lv_obj_t *obj)

Get the image animation images source.

Parameters:

obj – pointer to an animation image object

Returns:

a pointer that will point to a series images

uint8_t lv_animimg_get_src_count(lv_obj_t *obj)

Get the image animation images source.

Parameters:

obj – pointer to an animation image object

Returns:

the number of source images

uint32_t lv_animimg_get_duration(lv_obj_t *obj)

Get the image animation duration time. unit:ms

Parameters:

obj – pointer to an animation image object

Returns:

the animation duration time

uint32_t lv_animimg_get_repeat_count(lv_obj_t *obj)

Get the image animation repeat play times.

Parameters:

obj – pointer to an animation image object

Returns:

the repeat count

lv_anim_t *lv_animimg_get_anim(lv_obj_t *obj)

Get the image animation underlying animation.

Parameters:

obj – pointer to an animation image object

Returns:

the animation reference

Variables

const lv_obj_class_t lv_animimg_class