1
0
mirror of https://github.com/lvgl/lvgl.git synced 2025-01-21 06:53:01 +08:00
lvgl/src/lv_widgets/lv_objmask.h
2020-02-26 19:48:27 +01:00

112 lines
2.4 KiB
C

/**
* @file lv_objmask.h
*
*/
#ifndef LV_OBJMASK_H
#define LV_OBJMASK_H
#ifdef __cplusplus
extern "C" {
#endif
/*********************
* INCLUDES
*********************/
#include "../lv_conf_internal.h"
#if LV_USE_OBJMASK != 0
#include "../lv_core/lv_obj.h"
#include "../lv_widgets/lv_cont.h"
/*********************
* DEFINES
*********************/
/**********************
* TYPEDEFS
**********************/
typedef struct {
void * param;
} lv_objmask_mask_t;
/*Data of object mask*/
typedef struct {
lv_cont_ext_t cont; /*Ext. of ancestor*/
/*New data for this type */
lv_ll_t mask_ll; /*Store the created masks*/
} lv_objmask_ext_t;
/*Parts of the object*/
enum {
LV_OBJMASK_PART_MAIN,
};
typedef uint8_t lv_objmask_part_t;
/**********************
* GLOBAL PROTOTYPES
**********************/
/**
* Create a object mask objects
* @param par pointer to an object, it will be the parent of the new object mask
* @param copy pointer to a object mask object, if not NULL then the new object will be copied from it
* @return pointer to the created object mask
*/
lv_obj_t * lv_objmask_create(lv_obj_t * par, const lv_obj_t * copy);
/*======================
* Add/remove functions
*=====================*/
/**
* Add a mask
* @param objmask pointer to an Object mask object
* @param param an initialized mask parameter
* @return pointer to the added mask
*/
lv_objmask_mask_t * lv_objmask_add_mask(lv_obj_t * objmask, void * param);
/**
* Update an already created mask
* @param objmask pointer to an Object mask object
* @param mask pointer to created mask (returned by `lv_objmask_add_mask`)
* @param param an initialized mask parameter (initialized by `lv_draw_mask_line/angle/.../_init`)
*/
void lv_objmask_update_mask(lv_obj_t * objmask, lv_objmask_mask_t * mask, void * param);
/**
* Remove a mask
* @param objmask pointer to an Object mask object
* @param mask pointer to created mask (returned by `lv_objmask_add_mask`)
* If `NULL` passed all masks will be deleted.
*/
void lv_objmask_remove_mask(lv_obj_t * objmask, lv_objmask_mask_t * mask);
/*=====================
* Setter functions
*====================*/
/*=====================
* Getter functions
*====================*/
/*=====================
* Other functions
*====================*/
/**********************
* MACROS
**********************/
#endif /*LV_USE_OBJMASK*/
#ifdef __cplusplus
} /* extern "C" */
#endif
#endif /*LV_OBJMASK_H*/