riot-ci/RIOT
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

pkg/lvgl: improve lvgl_run documentation

Browse Source
This commit is contained in:
Alexandre Abadie 2021-05-21 10:05:17 +02:00
parent c09c7d549d
commit 5a393c64d6
No known key found for this signature in database
GPG Key ID: 1C919A403CAE1405
1 changed files with 8 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
pkg/lvgl/include/lvgl_riot.h
View File

@ -33,7 +33,13 @@ extern "C" {
void lvgl_init(screen_dev_t *screen_dev);
/**
* Run the lvgl task handler
* @brief Run the lvgl task handler
*
* In order to run the lvgl internal task handler in an endless loop, this
* function must be called manually either from the main thread or from a
* custom thread.
* In case of CONFIG_LVGL_INACTIVITY_PERIOD_MS ms of inactivity, the loop stops
* the thread running the lvgl task handler until @ref lvgl_wakeup is called.
*/
void lvgl_run(void);