lv_animimage.h
API reference for lv_animimage.h
See Also: Private HeaderThis header has a companion private implementation with internal data structures.lv_animimage_private.h
Summary
Functions
lv_animimg_set_src
Set the image animation images source.
void lv_animimg_set_src(lv_obj_t *obj, const void *dsc[], size_t num)| Name | Type | Description |
|---|---|---|
obj | lv_obj_t * | pointer to an animation image object |
dsc | const void * | pointer to a series images |
num | size_t | images' number |
lv_animimg_set_src_reverse
Set the images source for flip playback of animation image.
void lv_animimg_set_src_reverse(lv_obj_t *obj, const void *dsc[], size_t num)| Name | Type | Description |
|---|---|---|
obj | lv_obj_t * | pointer to an animation image object |
dsc | const void * | pointer to a series images |
num | size_t | images' number |
lv_animimg_set_duration
Set the image animation duration time. unit:ms
void lv_animimg_set_duration(lv_obj_t *obj, uint32_t duration)| Name | Type | Description |
|---|---|---|
obj | lv_obj_t * | pointer to an animation image object |
duration | uint32_t | the duration in milliseconds |
lv_animimg_set_repeat_count
Set the image animation repeatedly play times.
void lv_animimg_set_repeat_count(lv_obj_t *obj, uint32_t count)| Name | Type | Description |
|---|---|---|
obj | lv_obj_t * | pointer to an animation image object |
count | uint32_t | the number of times to repeat the animation |
lv_animimg_set_reverse_duration
Make the image animation to play back to when the forward direction is ready.
void lv_animimg_set_reverse_duration(lv_obj_t *obj, uint32_t duration)| Name | Type | Description |
|---|---|---|
obj | lv_obj_t * | pointer to an animation image object |
duration | uint32_t | the duration of the playback image animation in milliseconds. 0: disable playback |
lv_animimg_set_reverse_delay
Make the image animation to play back to when the forward direction is ready.
void lv_animimg_set_reverse_delay(lv_obj_t *obj, uint32_t duration)| Name | Type | Description |
|---|---|---|
obj | lv_obj_t * | pointer to an animation image object |
duration | uint32_t | delay in milliseconds before starting the playback image animation. |
lv_animimg_set_start_cb
Set a function call when the animation image really starts (considering delay)
void lv_animimg_set_start_cb(lv_obj_t *obj, lv_anim_start_cb_t start_cb)| Name | Type | Description |
|---|---|---|
obj | lv_obj_t * | pointer to an animation image object |
start_cb | lv_anim_start_cb_t | a function call when the animation is start |
lv_animimg_set_completed_cb
Set a function call when the animation is completed
void lv_animimg_set_completed_cb(lv_obj_t *obj, lv_anim_completed_cb_t completed_cb)| Name | Type | Description |
|---|---|---|
obj | lv_obj_t * | pointer to an animation image object |
completed_cb | lv_anim_completed_cb_t | a function call when the animation is completed |
Enums
_lv_property_animimage_id_t
Modified by NXP in 2025
| Name | Value |
|---|---|
LV_PROPERTY_ANIMIMAGE_SRC | (LV_PROPERTY_ANIMIMAGE_START + ((int) 0 )) | (( 5 ) << 28 ) | (( 1 ) << 24 ) |
LV_PROPERTY_ANIMIMAGE_DURATION | (LV_PROPERTY_ANIMIMAGE_START + ((int) 1 )) | (( 1 ) << 28 ) |
LV_PROPERTY_ANIMIMAGE_REPEAT_COUNT | (LV_PROPERTY_ANIMIMAGE_START + ((int) 2 )) | (( 1 ) << 28 ) |
LV_PROPERTY_ANIMIMAGE_SRC_COUNT | (LV_PROPERTY_ANIMIMAGE_START + ((int) 3 )) | (( 1 ) << 28 ) |
LV_PROPERTY_ANIMIMAGE_END |
lv_animimg_part_t
Image parts
| Name |
|---|
LV_ANIM_IMAGE_PART_MAIN |
Variables
lv_animimg_class
const lv_obj_class_t lv_animimg_classDependencies
Indirect dependencies
lv_anim.hlv_area.hlv_array.hlv_assert.hlv_bidi.hlv_color.hlv_color_op.hlv_conf_internal.hlv_conf_kconfig.hlv_display.hlv_draw.hlv_draw_arc.hlv_draw_blur.hlv_draw_buf.hlv_draw_image.hlv_draw_label.hlv_draw_line.hlv_draw_rect.hlv_draw_triangle.hlv_event.hlv_ext_data.hlv_flex.hlv_font.hlv_fs.hlv_grad.hlv_grid.hlv_group.hlv_image_decoder.hlv_image_dsc.hlv_indev.hlv_layout.hlv_ll.hlv_log.hlv_math.hlv_matrix.hlv_mem.hlv_obj.hlv_obj_class.hlv_obj_draw.hlv_obj_event.hlv_obj_pos.hlv_obj_property.hlv_obj_property_names.hlv_obj_scroll.hlv_obj_style.hlv_obj_style_gen.hlv_obj_tree.hlv_observer.hlv_palette.hlv_profiler.hlv_profiler_builtin.hlv_sprintf.hlv_string.hlv_style.hlv_style_gen.hlv_style_properties.hlv_symbol_def.hlv_text.hlv_tick.hlv_timer.h
How is this guide?
Last updated on