1# @ohos.graphics.uiEffect (效果级联)
2
3本模块提供组件效果的一些基础能力，包括模糊、边缘像素扩展、提亮等。效果被分为Filter和VisualEffect大类，同类效果可以级联在一个效果大类的实例下。在实际开发中，模糊可用于背景虚化，提亮可用于亮屏显示等。
4
5- [Filter](#filter)：用于添加指定Filter效果到组件上。
6- [VisualEffect](#visualeffect)：用于添加指定VisualEffect效果到组件上。
7
8> **说明：**
9>
10> 本模块首批接口从API version 12开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
11
12## 导入模块
13
14```ts
15import { uiEffect } from "@kit.ArkGraphics2D";
16```
17
18## uiEffect.createFilter
19createFilter(): Filter
20
21创建Filter实例用于给组件添加多种filter效果。
22
23**系统能力：** SystemCapability.Graphics.Drawing
24
25**返回值：**
26
27| 类型              | 说明                 |
28| ------------------| ------------------- |
29| [Filter](#filter) | 返回Filter的头节点。 |
30
31**示例：**
32
33```ts
34let filter : uiEffect.Filter = uiEffect.createFilter()
35```
36
37## uiEffect.createEffect
38createEffect(): VisualEffect
39
40创建VisualEffect实例用于给组件添加多种effect效果。
41
42**系统能力：** SystemCapability.Graphics.Drawing
43
44**返回值：**
45
46| 类型                          | 说明                       |
47| ----------------------------- | ------------------------- |
48| [VisualEffect](#visualeffect) | 返回VisualEffect的头节点。 |
49
50**示例：**
51
52```ts
53let visualEffect : uiEffect.VisualEffect = uiEffect.createEffect()
54```
55
56## Filter
57Filter效果类，用于将相应的效果添加到指定的组件上。在调用Filter的方法前，需要先通过[createFilter](#uieffectcreatefilter)创建一个Filter实例。
58
59### blur
60blur(blurRadius: number): Filter
61
62将模糊效果添加至组件上。
63
64**系统能力：** SystemCapability.Graphics.Drawing
65
66**参数：**
67| 参数名       | 类型   | 必填 | 说明       |
68| ----------- | -------| ---- | --------- |
69| blurRadius  | number | 是   | 模糊半径。<br/>取值需大于等于0，模糊半径越大，模糊效果越强。<br/>模糊半径为0时无模糊效果。 |
70
71**返回值：**
72
73| 类型               | 说明                       |
74| ----------------- | -------------------------- |
75| [Filter](#filter) | 返回挂载了模糊效果的Filter。 |
76
77**示例：**
78
79```ts
80filter.blur(20)
81```
82
83## VisualEffect
84VisualEffect效果类，用于将相应的效果添加到指定的组件上。在调用VisualEffect的方法前，需要先通过[createEffect](#uieffectcreateeffect)创建一个VisualEffect实例。