• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# Class (MaskFilter)
2
3<!--Kit: ArkGraphics 2D-->
4<!--Subsystem: Graphics-->
5<!--Owner: @hangmengxin-->
6<!--Designer: @wangyanglan-->
7<!--Tester: @nobuggers-->
8<!--Adviser: @ge-yafang-->
9
10> **说明:**
11>
12> - 本模块首批接口从API version 11开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
13>
14> - 本Class首批接口从API version 12开始支持。
15>
16> - 本模块使用屏幕物理像素单位px。
17>
18> - 本模块为单线程模型策略,需要调用方自行管理线程安全和上下文状态的切换。
19
20蒙版滤镜对象。
21
22## 导入模块
23
24```ts
25import { drawing } from '@kit.ArkGraphics2D';
26```
27
28## createBlurMaskFilter<sup>12+</sup>
29
30static createBlurMaskFilter(blurType: BlurType, sigma: number): MaskFilter
31
32创建具有模糊效果的蒙版滤镜。
33
34**系统能力:** SystemCapability.Graphics.Drawing
35
36**参数:**
37
38| 参数名     | 类型                   | 必填 | 说明                                 |
39| ---------- | --------------------- | ---- | ----------------------------------- |
40| blurType   | [BlurType](arkts-apis-graphics-drawing-e.md#blurtype12) | 是   | 模糊类型。                           |
41| sigma      | number                | 是   | 高斯模糊的标准偏差,必须为大于0的浮点数。 |
42
43**返回值:**
44
45| 类型                      | 说明                |
46| ------------------------- | ------------------ |
47| [MaskFilter](arkts-apis-graphics-drawing-MaskFilter.md) | 返回创建的蒙版滤镜对象。 |
48
49**错误码:**
50
51以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)。
52
53| 错误码ID | 错误信息 |
54| ------- | --------------------------------------------|
55| 401 | Parameter error.Possible causes:1.Mandatory parameters are left unspecified;2.Incorrect parameter types;3.Parameter verification failed. |
56
57**示例:**
58
59```ts
60import { RenderNode } from '@kit.ArkUI';
61import { common2D, drawing } from '@kit.ArkGraphics2D';
62
63class DrawingRenderNode extends RenderNode {
64  draw(context : DrawContext) {
65    const canvas = context.canvas;
66    let maskFilter = drawing.MaskFilter.createBlurMaskFilter(drawing.BlurType.OUTER, 10);
67  }
68}
69```