docs(disp): document lv_refr_now (#5480)

This commit is contained in:
Gabor Kiss-Vamosi
2024-01-25 11:04:08 +01:00
committed by GitHub
parent cd930f7c8a
commit a7b767c780

View File

@@ -232,6 +232,16 @@ If the performance monitor is enabled, the value of :c:macro:`LV_DEF_REFR_PERIOD
consistent with the refresh period of the display to ensure that the statistical results are correct.
Force refreshing
----------------
Normally the invalidated areas (marked for redraw) are rendered in :cpp:func:`lv_timer_handler` in every
:cpp:macro:`LV_DEF_REFR_PERIOD`milliseconds. However, by using :cpp:func:`lv_refr_now(display)` you can ask LVGL to
redraw the invalid areas immediately. The refreshing will happen in :cpp:func:`lv_refr_now` which might take
longer time.
The parameter of :cpp:func:`lv_refr_now` is a display to refresh. If ``NULL`` is set the default display will be updated.
Events
******