Class (ColorFilter)

颜色滤波器。

说明：

本模块首批接口从API version 11开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。

本模块使用屏幕物理像素单位px。

本模块为单线程模型策略，需要调用方自行管理线程安全和上下文状态的切换。

导入模块

import { drawing } from '@kit.ArkGraphics2D';

createBlendModeColorFilter

createBlendModeColorFilter(color: common2D.Color, mode: BlendMode) : ColorFilter

创建指定的颜色和混合模式的颜色滤波器。

系统能力： SystemCapability.Graphics.Drawing

参数：

参数名	类型	必填	说明
color	common2D.Color	是	ARGB格式的颜色，每个颜色通道的值是0到255之间的整数。
mode	BlendMode	是	颜色的混合模式。

返回值：

类型	说明
ColorFilter	返回颜色滤波器。

错误码：

以下错误码的详细介绍请参见通用错误码。

错误码ID	错误信息
401	Parameter error.Possible causes:1.Mandatory parameters are left unspecified;2.Incorrect parameter types;3.Parameter verification failed.

示例：

import { common2D, drawing } from '@kit.ArkGraphics2D';

const color : common2D.Color = { alpha: 255, red: 255, green: 0, blue: 0 };
let colorFilter = drawing.ColorFilter.createBlendModeColorFilter(color, drawing.BlendMode.SRC);

createBlendModeColorFilter¹⁸⁺

static createBlendModeColorFilter(color: common2D.Color|number, mode: BlendMode) : ColorFilter

使用指定的颜色和混合模式创建颜色滤波器。

系统能力： SystemCapability.Graphics.Drawing

参数：

参数名	类型	必填	说明
color	common2D.Color \|number	是	颜色，可以用16进制ARGB格式的无符号整数表示。
mode	BlendMode	是	颜色的混合模式。

返回值：

类型	说明
ColorFilter	返回颜色滤波器。

错误码：

以下错误码的详细介绍请参见通用错误码。

错误码ID	错误信息
401	Parameter error.Possible causes:1.Mandatory parameters are left unspecified;2.Incorrect parameter types;3.Parameter verification failed.

示例：

import { drawing } from '@kit.ArkGraphics2D';

let colorFilter = drawing.ColorFilter.createBlendModeColorFilter(0xffff0000, drawing.BlendMode.SRC);

createComposeColorFilter

createComposeColorFilter(outer: ColorFilter, inner: ColorFilter) : ColorFilter

创建一个先应用inner进行滤波，再应用outer进行滤波的组合颜色滤波器。

系统能力： SystemCapability.Graphics.Drawing

参数：

参数名	类型	必填	说明
outer	ColorFilter	是	组合滤波器中后生效的颜色滤波器。
inner	ColorFilter	是	组合滤波器中先生效的颜色滤波器。

返回值：

类型	说明
ColorFilter	返回颜色滤波器。

错误码：

以下错误码的详细介绍请参见通用错误码。

错误码ID	错误信息
401	Parameter error.Possible causes:1.Mandatory parameters are left unspecified;2.Incorrect parameter types.

示例：

import { common2D, drawing } from '@kit.ArkGraphics2D';

const color : common2D.Color = { alpha: 255, red: 255, green: 0, blue: 0 };
let colorFilter1 = drawing.ColorFilter.createBlendModeColorFilter(color, drawing.BlendMode.SRC);
let colorFilter2 = drawing.ColorFilter.createBlendModeColorFilter(color, drawing.BlendMode.DST);
let colorFilter = drawing.ColorFilter.createComposeColorFilter(colorFilter1, colorFilter2);

createLinearToSRGBGamma

createLinearToSRGBGamma() : ColorFilter

创建一个从线性颜色空间转换到SRGB颜色空间的颜色滤波器。

系统能力： SystemCapability.Graphics.Drawing

返回值：

类型	说明
ColorFilter	返回颜色滤波器。

示例：

import { drawing } from '@kit.ArkGraphics2D';

let colorFilter = drawing.ColorFilter.createLinearToSRGBGamma();

createSRGBGammaToLinear

createSRGBGammaToLinear() : ColorFilter

创建一个从SRGB颜色空间转换到线性颜色空间的颜色滤波器。

系统能力： SystemCapability.Graphics.Drawing

返回值：

类型	说明
ColorFilter	返回颜色滤波器。

示例：

import { drawing } from '@kit.ArkGraphics2D';

let colorFilter = drawing.ColorFilter.createSRGBGammaToLinear();

createLumaColorFilter

createLumaColorFilter() : ColorFilter

创建一个颜色滤波器将其输入的亮度值乘以透明度通道，并将红色、绿色和蓝色通道设置为零。

系统能力： SystemCapability.Graphics.Drawing

返回值：

类型	说明
ColorFilter	返回颜色滤波器。

示例：

import { drawing } from '@kit.ArkGraphics2D';

let colorFilter = drawing.ColorFilter.createLumaColorFilter();

createMatrixColorFilter¹²⁺

static createMatrixColorFilter(matrix: Array<number>): ColorFilter

创建颜色滤波器，通过4x5颜色矩阵变换颜色。

系统能力： SystemCapability.Graphics.Drawing

参数：

参数名	类型	必填	说明
matrix	Array<number>	是	长度为20的数组，表示用于颜色变换的4*5矩阵。

返回值：

类型	说明
ColorFilter	返回颜色滤波器。

错误码：

以下错误码的详细介绍请参见通用错误码。

错误码ID	错误信息
401	Parameter error.Possible causes:1.Mandatory parameters are left unspecified;2.Incorrect parameter types;3.Parameter verification failed.

示例：

import { drawing } from '@kit.ArkGraphics2D';

let matrix: Array<number> = [
  1, 0, 0, 0, 0,
  0, 1, 0, 0, 0,
  0, 0, 100, 0, 0,
  0, 0, 0, 1, 0
];
let colorFilter = drawing.ColorFilter.createMatrixColorFilter(matrix);

createLightingColorFilter²⁰⁺

static createLightingColorFilter(mutColor: common2D.Color|number, addColor: common2D.Color|number): ColorFilter

创建一个光照颜色滤波器，此滤波器会将RGB通道的颜色值乘以一种颜色值并加上另一种颜色值，计算结果会被限制在0到255范围内。

系统能力： SystemCapability.Graphics.Drawing

参数：

参数名	类型	必填	说明
mutColor	common2D.Color \|number	是	用来进行乘法运算的颜色，ARGB格式的颜色，每个颜色通道是0到255之间的整数。为number类型时必须是16进制ARGB格式的无符号整数。
addColor	common2D.Color \|number	是	用来进行加法运算的颜色，ARGB格式的颜色，每个颜色通道是0到255之间的整数。为number类型时必须是16进制ARGB格式的无符号整数。

返回值：

类型	说明
ColorFilter	返回一个颜色滤波器。

示例：

import { common2D, drawing } from '@kit.ArkGraphics2D';
let mulColor : common2D.Color = { alpha: 0, red: 0, green: 0, blue: 20 };
let addColor : common2D.Color = { alpha: 0, red: 0, green: 0, blue: 125 };
let colorFilter = drawing.ColorFilter.createLightingColorFilter(mulColor, addColor);