From c23b9bc5ce3b89894a7f75bc2645ccb0bf4a589d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=2E=20Neusch=C3=A4fer?= Date: Mon, 5 Feb 2024 07:12:19 +0100 Subject: [PATCH] docs(indev): Document the relation between LV_INDEV_MODE_EVENT and data->continue_reading (#5586) --- docs/porting/indev.rst | 2 ++ src/indev/lv_indev.h | 2 +- 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/porting/indev.rst b/docs/porting/indev.rst index 2592f3bae..2bab65e43 100644 --- a/docs/porting/indev.rst +++ b/docs/porting/indev.rst @@ -258,6 +258,8 @@ You can do this in the following way: .. note:: that :cpp:func:`lv_indev_read`, :cpp:func:`lv_timer_handler` and :cpp:func:`_lv_display_refr_timer` can not run at the same time. +.. note:: For devices in event-driven mode, `data->continue_reading` is ignored. + Further reading *************** diff --git a/src/indev/lv_indev.h b/src/indev/lv_indev.h index 62e44b8ea..a5b647b95 100644 --- a/src/indev/lv_indev.h +++ b/src/indev/lv_indev.h @@ -55,7 +55,7 @@ typedef struct { int16_t enc_diff; /**< For LV_INDEV_TYPE_ENCODER number of steps since the previous read*/ lv_indev_state_t state; /**< LV_INDEV_STATE_REL or LV_INDEV_STATE_PR*/ - bool continue_reading; /**< If set to true, the read callback is invoked again*/ + bool continue_reading; /**< If set to true, the read callback is invoked again, unless the device is in event-driven mode*/ } lv_indev_data_t; typedef void (*lv_indev_read_cb_t)(lv_indev_t * indev, lv_indev_data_t * data);