lv_canvas.h

lv_canvas_set_buffer

Set a buffer for the canvas.

Use lv_canvas_set_draw_buf() instead if you need to set a buffer with alignment requirement.

void lv_canvas_set_buffer(lv_obj_t *obj, void *buf, int32_t w, int32_t h, lv_color_format_t cf)

lv_canvas_set_draw_buf

Set a draw buffer for the canvas. A draw buffer either can be allocated by lv_draw_buf_create() or defined statically by LV_DRAW_BUF_DEFINE_STATIC. When buffer start address and stride has alignment requirement, it's recommended to use lv_draw_buf_create.

void lv_canvas_set_draw_buf(lv_obj_t *obj, lv_draw_buf_t *draw_buf)

lv_canvas_set_px

Set a pixel's color and opacity

void lv_canvas_set_px(lv_obj_t *obj, int32_t x, int32_t y, lv_color_t color, lv_opa_t opa)

lv_canvas_set_palette

Set the palette color of a canvas for index format. Valid only for LV_COLOR_FORMAT_I1/2/4/8

void lv_canvas_set_palette(lv_obj_t *obj, uint8_t index, lv_color32_t color)

lv_canvas_get_draw_buf

lv_draw_buf_t * lv_canvas_get_draw_buf(lv_obj_t *obj)

lv_canvas_get_px

Get a pixel's color and opacity

lv_color32_t lv_canvas_get_px(lv_obj_t *obj, int32_t x, int32_t y)

Returns: lv_color32_t — ARGB8888 color of the pixel

lv_canvas_get_image

Get the image of the canvas as a pointer to an lv_image_dsc_t variable.

lv_image_dsc_t * lv_canvas_get_image(lv_obj_t *obj)

Returns: lv_image_dsc_t * — pointer to the image descriptor.

lv_canvas_get_buf

Return the pointer for the buffer. It's recommended to use this function instead of the buffer form the return value of lv_canvas_get_image() as is can be aligned

const void * lv_canvas_get_buf(lv_obj_t *obj)

Returns: const void * — pointer to the buffer

lv_canvas_create

Create a canvas object

lv_obj_t * lv_canvas_create(lv_obj_t *parent)

Returns: lv_obj_t * — pointer to the created canvas

lv_canvas_copy_buf

Copy a buffer to the canvas

void lv_canvas_copy_buf(lv_obj_t *obj, const lv_area_t *canvas_area, lv_draw_buf_t *src_buf, const lv_area_t *src_area)

lv_canvas_fill_bg

Fill the canvas with color

void lv_canvas_fill_bg(lv_obj_t *obj, lv_color_t color, lv_opa_t opa)

lv_canvas_init_layer

Initialize a layer to use LVGL's generic draw functions (lv_draw_rect/label/...) on the canvas. Needs to be usd in pair with lv_canvas_finish_layer.

void lv_canvas_init_layer(lv_obj_t *obj, lv_layer_t *layer)

lv_canvas_finish_layer

Wait until all the drawings are finished on layer. Needs to be usd in pair with lv_canvas_init_layer.

void lv_canvas_finish_layer(lv_obj_t *canvas, lv_layer_t *layer)

lv_canvas_buf_size

Just a wrapper to LV_CANVAS_BUF_SIZE for bindings.

uint32_t lv_canvas_buf_size(int32_t w, int32_t h, uint8_t bpp, uint8_t stride)