Skip to content

Commit 7b543b3

Browse files
committed
[lvgl] Document update_when_display_idle option
1 parent 2e3e305 commit 7b543b3

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

content/components/lvgl/_index.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -131,6 +131,11 @@ The following configuration variables apply to the main `lvgl` component, in ord
131131
> - If you press the encoder on a complex object (like a list, message box, etc.) the object will go to edit mode whereby you can adjust the value of the object by turning the encoder.
132132
> - To leave edit mode, long press the button.
133133

134+
- **update_when_display_idle** (*Optional*, boolean): When using the {{< docref "/components/display/epaper_spi" >}}
135+
or other displays with long update times, setting this option
136+
to `true` will cause the display to only be updated if the display is idle. During the update LVGL will pause.
137+
The display `update_interval` should be set to `never` when this is used, as the display will be updated automatically
138+
by LVGL.
134139
- **resume_on_input** (*Optional*, boolean): If LVGL is paused and the user interacts with the screen, resume the activity of LVGL. Defaults to `true`. "Interacts" means to release a touch or button, or rotate an encoder.
135140
- **color_depth** (*Optional*, string): The color depth at which the contents are generated. Currently only `16` is supported (RGB565, 2 bytes/pixel), which is the default value.
136141
- **buffer_size** (*Optional*, percentage): The percentage of screen size to allocate buffer memory. If unconfigured, the default is `100%` with runtime fallback to `12%` if a full size buffer allocation fails. For devices without PSRAM, the recommended value is `25%`.

0 commit comments

Comments
 (0)