diff --git a/zh-cn/application-dev/reference/apis-arkgraphics2d/js-apis-uiEffect-sys.md b/zh-cn/application-dev/reference/apis-arkgraphics2d/js-apis-uiEffect-sys.md index e2952ca64e285a7fcb4e79176f1f662975e192a3..55aee63f100becf1a5065ce53817d915da2acb60 100644 --- a/zh-cn/application-dev/reference/apis-arkgraphics2d/js-apis-uiEffect-sys.md +++ b/zh-cn/application-dev/reference/apis-arkgraphics2d/js-apis-uiEffect-sys.md @@ -342,4 +342,76 @@ BrightnessBlender参数列表。 | saturation | number | 否 | 否 | 提亮的基准饱和度。
取值范围[0, 20]。 | | positiveCoefficient | [number, number, number] | 否 | 否 | 基于基准饱和度的RGB正向调整参数。
每个number的取值范围[-20, 20]。 | | negativeCoefficient | [number, number, number] | 否 | 否 | 基于基准饱和度的RGB负向调整参数。
每个number的取值范围[-20, 20]。 | -| fraction | number | 否 | 否 | 提亮效果的混合比例。
取值范围[0, 1],超出边界会在实现时自动截断。 | \ No newline at end of file +| fraction | number | 否 | 否 | 提亮效果的混合比例。
取值范围[0, 1],超出边界会在实现时自动截断。 | + +### createRippleMask20+ +createRippleMask(center: common2D.Point, radius: number, width: number, offset?: number): Mask + +通过输入波环圆心的位置、半径、宽度创建波环遮罩效果Mask实例,具体的效果由输入的参数决定。 + +**系统能力:** SystemCapability.Graphics.Drawing + +**系统接口:** 此接口为系统接口。 + +**参数:** +| 参数名 | 类型 | 必填 | 说明 | +| ------- | ---------------------------------------- | ---- | ------------------------- | +| center | common2D.Point | 是 | 设置波环圆心在屏幕上的位置,[0,0]为屏幕左上角,[1,1]为屏幕的右下角。
取值范围[-10, 10],超出边界会在实现时自动截断。 | +| radius | number | 是 | 设置波环的半径,半径为1等于屏幕的高度。
取值范围[0, 10],超出边界会在实现时自动截断。 | +| width | number | 是 | 设置波环的宽度。
取值范围[0, 10],超出边界会在实现时自动截断。 | +| offset | number | 否 | 设置波峰位置的偏移,默认值为0,表示波峰在波环的正中心,-1.0表示波峰在波环的最内侧,1.0表示波峰在波环的最外侧。
取值范围[-1, 1],超出边界会在实现时自动截断。 | + +**返回值:** + +| 类型 | 说明 | +| ----------------------------- | ------------------------------------------------- | +| [Mask](#mask20) | 返回具有波环遮罩效果的Mask。 | + +**错误码:** + +以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)。 + +| 错误码ID | 错误信息 | +| ------- | --------------------------------------------| +| 202 | Permission verification failed. A non-system application calls a system API. | + +**示例:** + +```ts + let mask = uiEffect.Mask.createRippleMask({x:0.5, y:1.0}, 0.5, 0.3, 0.0); +``` + +### displacementDistort20+ +displacementDistort(displacementMap: Mask, factor?: [number, number]): Filter; + +为组件中Mask遮罩区域内容添加扭曲效果。 + +**系统能力:** SystemCapability.Graphics.Drawing + +**系统接口:** 此接口为系统接口。 + +**参数:** +| 参数名 | 类型 | 必填 | 说明 | +| ------------- | --------------------- | ---- | ------------------------- | +| displacementMap | Mask | 是 | 使用Mask或得遮罩区域,设置扭曲效果生效区域范围| +| factor | [number, number] | 否 | 调节水平和竖直方向扭曲程度
取值范围[0, 10],超出边界会在实现时自动截断。 | + +**返回值:** + +| 类型 | 说明 | +| ----------------- | --------------------------------- | +| [Filter](#filter) | 返回挂载了扭曲效果的Filter。 | + +**错误码:** + +以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)。 + +| 错误码ID | 错误信息 | +| ------- | --------------------------------------------| +| 202 | Permission verification failed. A non-system application calls a system API. | + +**示例:** + +```ts +filter.displacementDistort(uiEffect.Mask.createRippleMask({x:0.5, y:1.0}, 0.5, 0.3, 0.0), [1.0, 1.0]) +```