lv_timer.h

API reference for lv_timer.h

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

Functions

lv_timer_handler_set_resume_cb

Set the resume callback to the timer handler

 
void lv_timer_handler_set_resume_cb(lv_timer_handler_resume_cb_t cb, void *data)
Parameters
NameTypeDescription
cblv_timer_handler_resume_cb_tthe function to call when timer handler is resumed
datavoid *pointer to a resume data

lv_timer_set_cb

Set the callback to the timer (the function to call periodically)

 
void lv_timer_set_cb(lv_timer_t *timer, lv_timer_cb_t timer_cb)
Parameters
NameTypeDescription
timerlv_timer_t *pointer to a timer
timer_cblv_timer_cb_tthe function to call periodically

lv_timer_set_period

Set new period for a lv_timer

 
void lv_timer_set_period(lv_timer_t *timer, uint32_t period)
Parameters
NameTypeDescription
timerlv_timer_t *pointer to a lv_timer
perioduint32_tthe new period

lv_timer_set_repeat_count

Set the number of times a timer will repeat.

 
void lv_timer_set_repeat_count(lv_timer_t *timer, int32_t repeat_count)
Parameters
NameTypeDescription
timerlv_timer_t *pointer to a lv_timer.
repeat_countint32_t-1 : infinity; 0 : stop ; n>0: residual times

lv_timer_set_auto_delete

Set whether a lv_timer will be deleted automatically when it is called repeat_count times.

 
void lv_timer_set_auto_delete(lv_timer_t *timer, bool auto_delete)
Parameters
NameTypeDescription
timerlv_timer_t *pointer to a lv_timer.
auto_deletebooltrue: auto delete; false: timer will be paused when it is called repeat_count times.

lv_timer_set_user_data

Set custom parameter to the lv_timer.

 
void lv_timer_set_user_data(lv_timer_t *timer, void *user_data)
Parameters
NameTypeDescription
timerlv_timer_t *pointer to a lv_timer.
user_datavoid *custom parameter

lv_timer_set_external_data

Attaches external user data and destructor callback to a timer object.

Associates custom user data with an LVGL timer and specifies a destructor function that will be automatically invoked when the timer is deleted to properly clean up the associated resources.

 
void lv_timer_set_external_data(lv_timer_t *timer, void *data, void(*free_cb)(void *data))
Parameters
NameTypeDescription
timerlv_timer_t *Pointer to the timer object
datavoid *User-defined data pointer to associate with the timer
free_cbvoid(*)(void *data)

Typedefs

lv_timer_cb_t

 
typedef void(* lv_timer_cb_t) (lv_timer_t *)

Timers execute this type of functions.

Used by 2 functions
  • lv_timer_create — param timer_xcb
  • lv_timer_set_cb — param timer_cb

lv_timer_handler_resume_cb_t

 
typedef void(* lv_timer_handler_resume_cb_t) (void *data)

Timer handler resume this type of function.

Used by 1 function
  • lv_timer_handler_set_resume_cb — param cb

Macros

LV_NO_TIMER_READY

 
#define LV_NO_TIMER_READY 0xFFFFFFFF

Dependencies

How is this guide?

Last updated on

On this page