1# drawing_filter.h 2 3<!--Kit: ArkGraphics 2D--> 4<!--Subsystem: Graphic--> 5<!--Owner: @hangmengxin--> 6<!--Designer: @wangyanglan--> 7<!--Tester: @nobuggers--> 8<!--Adviser: @ge-yafang--> 9 10## 概述 11 12声明与绘图模块中的滤波器对象相关的函数。 13 14**引用文件：** <native_drawing/drawing_filter.h> 15 16**库：** libnative_drawing.so 17 18**起始版本：** 11 19 20**相关模块：** [Drawing](capi-drawing.md) 21 22## 汇总 23 24### 函数 25 26| 名称 | 描述 | 27| -- | -- | 28| [OH_Drawing_Filter* OH_Drawing_FilterCreate(void)](#oh_drawing_filtercreate) | 创建一个滤波器对象。 | 29| [void OH_Drawing_FilterSetImageFilter(OH_Drawing_Filter* filter, OH_Drawing_ImageFilter* imageFilter)](#oh_drawing_filtersetimagefilter) | 为滤波器对象设置图像滤波器对象。<br>本接口会产生错误码，可以通过[OH_Drawing_ErrorCodeGet](capi-drawing-error-code-h.md#oh_drawing_errorcodeget)查看错误码的取值。<br>filter为NULL时返回OH_DRAWING_ERROR_INVALID_PARAMETER。 | 30| [void OH_Drawing_FilterSetMaskFilter(OH_Drawing_Filter* filter, OH_Drawing_MaskFilter* maskFilter)](#oh_drawing_filtersetmaskfilter) | 为滤波器对象设置蒙版滤波器对象。<br>本接口会产生错误码，可以通过[OH_Drawing_ErrorCodeGet](capi-drawing-error-code-h.md#oh_drawing_errorcodeget)查看错误码的取值。<br>filter为NULL时返回OH_DRAWING_ERROR_INVALID_PARAMETER。 | 31| [void OH_Drawing_FilterSetColorFilter(OH_Drawing_Filter* filter, OH_Drawing_ColorFilter* colorFilter)](#oh_drawing_filtersetcolorfilter) | 为滤波器对象设置颜色滤波器对象。<br>本接口会产生错误码，可以通过[OH_Drawing_ErrorCodeGet](capi-drawing-error-code-h.md#oh_drawing_errorcodeget)查看错误码的取值。<br>filter为NULL时返回OH_DRAWING_ERROR_INVALID_PARAMETER。 | 32| [void OH_Drawing_FilterGetColorFilter(OH_Drawing_Filter* filter, OH_Drawing_ColorFilter* colorFilter)](#oh_drawing_filtergetcolorfilter) | 从滤波器对象获取颜色滤波器对象。<br>本接口会产生错误码，可以通过[OH_Drawing_ErrorCodeGet](capi-drawing-error-code-h.md#oh_drawing_errorcodeget)查看错误码的取值。<br>filter、colorFilter任意一个为NULL时返回OH_DRAWING_ERROR_INVALID_PARAMETER。 | 33| [void OH_Drawing_FilterDestroy(OH_Drawing_Filter* filter)](#oh_drawing_filterdestroy) | 销毁滤波器对象，并收回该对象占用的内存。 | 34 35## 函数说明 36 37### OH_Drawing_FilterCreate() 38 39``` 40OH_Drawing_Filter* OH_Drawing_FilterCreate(void) 41``` 42 43**描述** 44 45创建一个滤波器对象。 46 47**系统能力：** SystemCapability.Graphic.Graphic2D.NativeDrawing 48 49**起始版本：** 11 50 51**返回：** 52 53| 类型 | 说明 | 54| -- | -- | 55| [OH_Drawing_Filter](capi-drawing-oh-drawing-filter.md)* | 返回创建的滤波器对象的指针。 | 56 57### OH_Drawing_FilterSetImageFilter() 58 59``` 60void OH_Drawing_FilterSetImageFilter(OH_Drawing_Filter* filter, OH_Drawing_ImageFilter* imageFilter) 61``` 62 63**描述** 64 65为滤波器对象设置图像滤波器对象。<br>本接口会产生错误码，可以通过[OH_Drawing_ErrorCodeGet](capi-drawing-error-code-h.md#oh_drawing_errorcodeget)查看错误码的取值。<br>filter为NULL时返回OH_DRAWING_ERROR_INVALID_PARAMETER。 66 67**系统能力：** SystemCapability.Graphic.Graphic2D.NativeDrawing 68 69**起始版本：** 12 70 71 72**参数：** 73 74| 参数项 | 描述 | 75| -- | -- | 76| [OH_Drawing_Filter](capi-drawing-oh-drawing-filter.md)* filter | 指示指向滤波器对象[OH_Drawing_Filter](capi-drawing-oh-drawing-filter.md)的指针。 | 77| [OH_Drawing_ImageFilter](capi-drawing-oh-drawing-imagefilter.md)* imageFilter | 指示指向图像滤波器[OH_Drawing_ImageFilter](capi-drawing-oh-drawing-imagefilter.md)对象的指针，为NULL表示清空滤波器对象中的图像滤波器效果。 | 78 79### OH_Drawing_FilterSetMaskFilter() 80 81``` 82void OH_Drawing_FilterSetMaskFilter(OH_Drawing_Filter* filter, OH_Drawing_MaskFilter* maskFilter) 83``` 84 85**描述** 86 87为滤波器对象设置蒙版滤波器对象。<br>本接口会产生错误码，可以通过[OH_Drawing_ErrorCodeGet](capi-drawing-error-code-h.md#oh_drawing_errorcodeget)查看错误码的取值。<br>filter为NULL时返回OH_DRAWING_ERROR_INVALID_PARAMETER。 88 89**系统能力：** SystemCapability.Graphic.Graphic2D.NativeDrawing 90 91**起始版本：** 11 92 93 94**参数：** 95 96| 参数项 | 描述 | 97| -- | -- | 98| [OH_Drawing_Filter](capi-drawing-oh-drawing-filter.md)* filter | 指示指向滤波器对象[OH_Drawing_Filter](capi-drawing-oh-drawing-filter.md)的指针。 | 99| [OH_Drawing_MaskFilter](capi-drawing-oh-drawing-maskfilter.md)* maskFilter | 指示指向蒙版滤波器对象[OH_Drawing_ColorFilter](capi-drawing-oh-drawing-colorfilter.md)的指针，为NULL表示清空滤波器对象中的蒙版滤波器效果。 | 100 101### OH_Drawing_FilterSetColorFilter() 102 103``` 104void OH_Drawing_FilterSetColorFilter(OH_Drawing_Filter* filter, OH_Drawing_ColorFilter* colorFilter) 105``` 106 107**描述** 108 109为滤波器对象设置颜色滤波器对象。<br>本接口会产生错误码，可以通过[OH_Drawing_ErrorCodeGet](capi-drawing-error-code-h.md#oh_drawing_errorcodeget)查看错误码的取值。<br>filter为NULL时返回OH_DRAWING_ERROR_INVALID_PARAMETER。 110 111**系统能力：** SystemCapability.Graphic.Graphic2D.NativeDrawing 112 113**起始版本：** 11 114 115 116**参数：** 117 118| 参数项 | 描述 | 119| -- | -- | 120| [OH_Drawing_Filter](capi-drawing-oh-drawing-filter.md)* filter | 指示指向滤波器对象[OH_Drawing_Filter](capi-drawing-oh-drawing-filter.md)的指针。 | 121| [OH_Drawing_ColorFilter](capi-drawing-oh-drawing-colorfilter.md)* colorFilter | 指示指向颜色滤波器对象[OH_Drawing_ColorFilter](capi-drawing-oh-drawing-colorfilter.md)的指针，为NULL表示清空滤波器对象中的颜色滤波器效果。 | 122 123### OH_Drawing_FilterGetColorFilter() 124 125``` 126void OH_Drawing_FilterGetColorFilter(OH_Drawing_Filter* filter, OH_Drawing_ColorFilter* colorFilter) 127``` 128 129**描述** 130 131从滤波器对象获取颜色滤波器对象。<br>本接口会产生错误码，可以通过[OH_Drawing_ErrorCodeGet](capi-drawing-error-code-h.md#oh_drawing_errorcodeget)查看错误码的取值。<br>filter、colorFilter任意一个为NULL时返回OH_DRAWING_ERROR_INVALID_PARAMETER。 132 133**系统能力：** SystemCapability.Graphic.Graphic2D.NativeDrawing 134 135**起始版本：** 12 136 137 138**参数：** 139 140| 参数项 | 描述 | 141| -- | -- | 142| [OH_Drawing_Filter](capi-drawing-oh-drawing-filter.md)* filter | 指示指向滤波器对象[OH_Drawing_Filter](capi-drawing-oh-drawing-filter.md)的指针。 | 143| [OH_Drawing_ColorFilter](capi-drawing-oh-drawing-colorfilter.md)* colorFilter | 指示指向颜色滤波器对象[OH_Drawing_ColorFilter](capi-drawing-oh-drawing-colorfilter.md)的指针。 | 144 145### OH_Drawing_FilterDestroy() 146 147``` 148void OH_Drawing_FilterDestroy(OH_Drawing_Filter* filter) 149``` 150 151**描述** 152 153销毁滤波器对象，并收回该对象占用的内存。 154 155**系统能力：** SystemCapability.Graphic.Graphic2D.NativeDrawing 156 157**起始版本：** 11 158 159 160**参数：** 161 162| 参数项 | 描述 | 163| -- | -- | 164| [OH_Drawing_Filter](capi-drawing-oh-drawing-filter.md)* filter | 指示指向滤波器对象[OH_Drawing_Filter](capi-drawing-oh-drawing-filter.md)的指针。 | 165 166 167