lv_draw_mask.h

API reference for lv_draw_mask.h

Summary

Functions

Try to get a rectangle mask draw descriptor from a draw task.

lv_draw_mask_rect_dsc_t * lv_draw_task_get_mask_rect_dsc(lv_draw_task_t *task)

Name	Type	Description
`task`	`lv_draw_task_t *`	draw task

Returns: lv_draw_mask_rect_dsc_t * — the task's draw descriptor or NULL if the task is not of type LV_DRAW_TASK_TYPE_MASK_RECTANGLE

Initialize a rectangle mask draw descriptor.

void lv_draw_mask_rect_dsc_init(lv_draw_mask_rect_dsc_t *dsc)

Name	Type	Description
`dsc`	`lv_draw_mask_rect_dsc_t *`	pointer to a draw descriptor

Create a draw task to mask a rectangle from the buffer

void lv_draw_mask_rect(lv_layer_t *layer, const lv_draw_mask_rect_dsc_t *dsc)

Name	Type	Description
`layer`	`lv_layer_t *`	pointer to a layer
`dsc`	`const lv_draw_mask_rect_dsc_t *`	pointer to a draw descriptor

struct

Member	Type	Description
`base`	`lv_draw_dsc_base_t`
`area`	`lv_area_t`	The area to mask.
`radius`	`int32_t`	The radius of masking
`keep_outside`	`uint32_t`	0: clear the content out of the `area`. 1: don't touch the area out of `area`