lv_anim_timeline.h

API reference for lv_anim_timeline.h

Report on GitHub
See Also: Private HeaderThis header has a companion private implementation with internal data structures.lv_anim_timeline_private.h

Functions

lv_anim_timeline_set_reverse

Set the playback direction of the animation timeline.

 
void lv_anim_timeline_set_reverse(lv_anim_timeline_t *at, bool reverse)
Parameters
NameTypeDescription
atlv_anim_timeline_t *pointer to the animation timeline.
reverseboolwhether to play in reverse.

lv_anim_timeline_set_delay

Set the time to wait before starting the animation. Applies only when playing from the very start, or reverse from the very end.

 
void lv_anim_timeline_set_delay(lv_anim_timeline_t *at, uint32_t delay)
Parameters
NameTypeDescription
atlv_anim_timeline_t *pointer to an animation timeline
delayuint32_tthe delay time in milliseconds

lv_anim_timeline_set_repeat_count

Make the animation timeline repeat itself.

 
void lv_anim_timeline_set_repeat_count(lv_anim_timeline_t *at, uint32_t cnt)
Parameters
NameTypeDescription
atlv_anim_timeline_t *pointer to the animation timeline.
cntuint32_trepeat count or LV_ANIM_REPEAT_INFINITE for infinite repetition. 0: to disable repetition.

lv_anim_timeline_set_repeat_delay

Set a delay before repeating the animation timeline.

 
void lv_anim_timeline_set_repeat_delay(lv_anim_timeline_t *at, uint32_t delay)
Parameters
NameTypeDescription
atlv_anim_timeline_t *pointer to the animation timeline.
delayuint32_tdelay in milliseconds before repeating the animation timeline.

lv_anim_timeline_set_progress

Set the progress of the animation timeline.

 
void lv_anim_timeline_set_progress(lv_anim_timeline_t *at, uint16_t progress)
Parameters
NameTypeDescription
atlv_anim_timeline_t *pointer to the animation timeline.
progressuint16_tset value 065535 to map 0100% animation progress.

lv_anim_timeline_set_user_data

Set the user_data of a an animation timeline

 
void lv_anim_timeline_set_user_data(lv_anim_timeline_t *at, void *user_data)
Parameters
NameTypeDescription
atlv_anim_timeline_t *pointer to the animation timeline.
user_datavoid *pointer to any data. Only the pointer will be saved.

Structs

struct

_lv_anim_timeline_dsc_t

MemberTypeDescription
animlv_anim_t
start_timeuint32_t
is_starteduint8_t
is_completeduint8_t

Typedefs

lv_anim_timeline_dsc_t

 
typedef struct _lv_anim_timeline_dsc_t lv_anim_timeline_dsc_t

Macros

LV_ANIM_TIMELINE_PROGRESS_MAX

 
#define LV_ANIM_TIMELINE_PROGRESS_MAX 0xFFFF

Dependencies

How is this guide?

Last updated on

On this page