Snapshot

Snapshot provides an API to take a snapshot image for an LVGL Widget together with its children. The image will look exactly like the Widget on the display.

Snapshot provides an API to take a snapshot image for an LVGL Widget together with its children. The image will look exactly like the Widget on the display.

Usage

Simply call function lv_snapshot_take(widget, color_format) to generate the image descriptor which can be used as an Image Widget's image source using lv_image_set_src.

Note, only following color formats are supported at this time:

• LV_COLOR_FORMAT_RGB565
• LV_COLOR_FORMAT_ARGB8565
• LV_COLOR_FORMAT_RGB888
• LV_COLOR_FORMAT_XRGB8888
• LV_COLOR_FORMAT_ARGB8888
• LV_COLOR_FORMAT_A8
• LV_COLOR_FORMAT_L8
• LV_COLOR_FORMAT_I1
• LV_COLOR_FORMAT_ARGB2222
• LV_COLOR_FORMAT_ARGB4444
• LV_COLOR_FORMAT_ARGB1555

Support for color formats depends on the drawing unit. Please check your drawing unit.

Freeing the Image

The memory lv_snapshot_take uses is dynamically allocated using lv_draw_buf_create. Use lv_draw_buf_destroy to free the memory it allocated.

The snapshot image which is the draw buffer returned by lv_snapshot_take normally won't be added to the cache because it can be drawn directly. So you don't need to invalidate the cache by calling lv_image_cache_drop before destroying the draw buffer.

The below code snippet demonstrates correct use of lv_snapshot_take:

void update_snapshot(lv_obj_t * widget, lv_obj_t * img_snapshot)
{
    lv_draw_buf_t* snapshot = (void*)lv_image_get_src(img_snapshot);
    if(snapshot) {
        lv_draw_buf_destroy(snapshot);
    }
    snapshot = lv_snapshot_take(widget, LV_COLOR_FORMAT_ARGB8888);
    lv_image_set_src(img_snapshot, snapshot);
}

Using an Existing Buffer

If the snapshot needs to be updated repeatedly, or if the caller provides the draw buffer, use lv_snapshot_take_to_draw_buf(widget, color_format, draw_buf). In this case, the caller is responsible for creating and destroying the draw buffer.

If snapshot is generated successfully, the image descriptor is updated, the image data will be stored to the provided draw_buf, and the function will return LV_RESULT_OK.

Note that snapshot may fail if the provided buffer is not large enough, which can happen if the Widget's size changes. It's recommended to use lv_snapshot_reshape_draw_buf(widget, draw_buf) to first ensure the buffer is large enough, and if it fails, destroy the existing draw buffer and call lv_snapshot_take directly.

Example

Simple snapshot example

API