docs(display): mention how to manipulate the invalidated area (#6836)

This commit is contained in:
Gabor Kiss-Vamosi
2024-10-01 10:21:34 +02:00
committed by GitHub
parent df6c4a0a4c
commit 14a5fabe00
3 changed files with 43 additions and 0 deletions

View File

@@ -239,6 +239,31 @@ In full and direct modes, the buffer size should be large enough for the whole s
As LVGL can not handle fractional width make sure to round the horizontal resolution to 8- As LVGL can not handle fractional width make sure to round the horizontal resolution to 8-
(For example 90 to 96) (For example 90 to 96)
Constraints on the Redrawn Area
-------------------------------
Some display controllers have specific requirements for the window area where the rendered image can be sent
(e.g., `x1` must be even, and `x2` must be odd).
In the case of monochrome displays, `x1` must be `Nx8`, and `x2` must be `Nx8 - 1`.
(If the display uses `LV_COLOR_FORMAT_I1`, LVGL automatically applies this rounding. See :ref:`monochrome`.)
The size of the invalidated (redrawn) area can be controlled as follows:
.. code:: c
void rounder_event_cb(lv_event_t * e)
{
lv_area_t * a = lv_event_get_invalidated_area(e);
a->x1 = a->x1 & (~0x1); /* Ensure that x1 is even */
a->x2 = a->x2 | 0x1; /* Ensure that x2 is odd */
}
...
lv_display_add_event_cb(disp, rounder_event_cb, LV_EVENT_INVALIDATE_AREA, NULL);
Tiled Rendering Tiled Rendering
--------------- ---------------

View File

@@ -821,6 +821,17 @@ lv_result_t lv_display_send_event(lv_display_t * disp, lv_event_code_t code, voi
return res; return res;
} }
lv_area_t * lv_event_get_invalidated_area(lv_event_t * e)
{
if(e->code == LV_EVENT_INVALIDATE_AREA) {
return lv_event_get_param(e);
}
else {
LV_LOG_WARN("Not interpreted with this event code");
return NULL;
}
}
void lv_display_set_rotation(lv_display_t * disp, lv_display_rotation_t rotation) void lv_display_set_rotation(lv_display_t * disp, lv_display_rotation_t rotation)
{ {
if(disp == NULL) disp = lv_display_get_default(); if(disp == NULL) disp = lv_display_get_default();

View File

@@ -479,6 +479,13 @@ uint32_t lv_display_remove_event_cb_with_user_data(lv_display_t * disp, lv_event
*/ */
lv_result_t lv_display_send_event(lv_display_t * disp, lv_event_code_t code, void * param); lv_result_t lv_display_send_event(lv_display_t * disp, lv_event_code_t code, void * param);
/**
* Get the area to be invalidated. Can be used in `LV_EVENT_INVALIDATE_AREA`
* @param e pointer to an event
* @return the area to invalidated (can be modified as required)
*/
lv_area_t * lv_event_get_invalidated_area(lv_event_t * e);
/** /**
* Set the theme of a display. If there are no user created widgets yet the screens' theme will be updated * Set the theme of a display. If there are no user created widgets yet the screens' theme will be updated
* @param disp pointer to a display * @param disp pointer to a display