• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# Class (ShadowLayer)
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## create<sup>12+</sup>
29
30static create(blurRadius: number, x: number, y: number, color: common2D.Color): ShadowLayer
31
32创建阴影层对象。
33
34**系统能力:** SystemCapability.Graphics.Drawing
35
36**参数:**
37
38| 参数名     | 类型      | 必填 | 说明                                 |
39| ---------- | -------- | ---- | ----------------------------------- |
40| blurRadius  | number   | 是   | 阴影的半径,必须为大于零的浮点数。     |
41| x           | number   | 是   | x轴上的偏移点,该参数为浮点数。        |
42| y           | number   | 是   | Y轴上的偏移点,该参数为浮点数。        |
43| color       | [common2D.Color](js-apis-graphics-common2D.md#color) | 是   | ARGB格式的颜色,每个颜色通道的值是0到255之间的整数。 |
44
45**返回值:**
46
47| 类型                        | 说明                  |
48| --------------------------- | -------------------- |
49| [ShadowLayer](arkts-apis-graphics-drawing-ShadowLayer.md) | 返回创建的阴影层对象。 |
50
51**错误码:**
52
53以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)。
54
55| 错误码ID | 错误信息 |
56| ------- | --------------------------------------------|
57| 401 | Parameter error.Possible causes:1.Mandatory parameters are left unspecified;2.Incorrect parameter types;3.Parameter verification failed. |
58
59**示例:**
60
61```ts
62import { RenderNode } from '@kit.ArkUI';
63import { common2D, drawing } from '@kit.ArkGraphics2D';
64
65class DrawingRenderNode extends RenderNode {
66  draw(context : DrawContext) {
67    const canvas = context.canvas;
68    let color : common2D.Color = {alpha: 0xFF, red: 0x00, green: 0xFF, blue: 0x00};
69    let shadowLayer = drawing.ShadowLayer.create(3, -3, 3, color);
70  }
71}
72```
73
74## create<sup>18+</sup>
75
76static create(blurRadius: number, x: number, y: number, color: common2D.Color | number): ShadowLayer
77
78创建阴影层对象。
79
80**系统能力:** SystemCapability.Graphics.Drawing
81
82**参数:**
83
84| 参数名     | 类型      | 必填 | 说明                                 |
85| ---------- | -------- | ---- | ----------------------------------- |
86| blurRadius  | number   | 是   | 阴影的半径,必须为大于零的浮点数。     |
87| x           | number   | 是   | x轴上的偏移点,该参数为浮点数。        |
88| y           | number   | 是   | Y轴上的偏移点,该参数为浮点数。        |
89| color       | [common2D.Color](js-apis-graphics-common2D.md#color) \| number   | 是   | 颜色,可以用16进制ARGB格式的无符号整数表示。  |
90
91**返回值:**
92
93| 类型                        | 说明                  |
94| --------------------------- | -------------------- |
95| [ShadowLayer](arkts-apis-graphics-drawing-ShadowLayer.md) | 返回创建的阴影层对象。 |
96
97**错误码:**
98
99以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)。
100
101| 错误码ID | 错误信息 |
102| ------- | --------------------------------------------|
103| 401 | Parameter error.Possible causes:1.Mandatory parameters are left unspecified;2.Incorrect parameter types;3.Parameter verification failed. |
104
105**示例:**
106
107```ts
108import { RenderNode } from '@kit.ArkUI';
109import { drawing } from '@kit.ArkGraphics2D';
110
111class DrawingRenderNode extends RenderNode {
112  draw(context : DrawContext) {
113    const canvas = context.canvas;
114    let shadowLayer = drawing.ShadowLayer.create(3, -3, 3, 0xff00ff00);
115  }
116}
117```