HarmonyOS API：@ohos.effectKit (图像效果)

joytrian

发布于 2023-4-4 15:44

4435浏览

0收藏

版本：v3.1 Beta

@ohos.effectKit (图像效果)

更新时间: 2023-02-17 09:19

图像效果提供处理图像的一些基础能力，包括对当前图像的亮度调节、模糊化、灰度调节、智能取色等。

该模块提供以下图像效果相关的常用功能：

Filter：效果类，用于添加指定效果到图像源。
Color：颜色类，用于保存取色的结果。
ColorPicker：智能取色器。

说明

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

导入模块

import effectKit from '@ohos.effectKit';1.

effectKit.createEffect

createEffect(source: image.PixelMap): Filter

通过传入的PixelMap创建Filter实例。

系统能力： SystemCapability.Multimedia.Image.Core

参数：

参数名	类型	必填	说明
source	image.PixelMap	是	image模块创建的PixelMap实例。

返回值：

类型	说明
Filter	返回不带任何效果的Filter链表的头节点，失败时返回null。

示例：

import image from "@ohos.multimedia.image";

const color = new ArrayBuffer(96);
let opts = { editable: true, pixelFormat: 3, size: { height: 4, width: 6 } }
image.createPixelMap(color, opts).then((pixelMap) => {
  let headFilter = effectKit.createEffect(pixelMap);
})1.
2.
3.
4.
5.
6.
7.

effectKit.createColorPicker

createColorPicker(source: image.PixelMap): Promise<ColorPicker>

通过传入的PixelMap创建ColorPicker实例，使用Promise异步回调。

系统能力： SystemCapability.Multimedia.Image.Core

参数：

参数名	类型	必填	说明
source	image.PixelMap	是	image模块创建的PixelMap实例。

返回值：

类型	说明
Promise<ColorPicker>	Promise对象。返回创建的ColorPicker实例。

示例：

import image from "@ohos.multimedia.image";

const color = new ArrayBuffer(96);
let opts = { editable: true, pixelFormat: 3, size: { height: 4, width: 6 } }
image.createPixelMap(color, opts).then((pixelMap) => {
  effectKit.createColorPicker(pixelMap).then(colorPicker => {
    console.info("color picker=" + colorPicker);
  }).catch(ex => console.error(".error=" + ex.toString()))
})1.
2.
3.
4.
5.
6.
7.
8.
9.

effectKit.createColorPicker

createColorPicker(source: image.PixelMap, callback: AsyncCallback<ColorPicker>): void

通过传入的PixelMap创建ColorPicker实例，使用callback异步回调。

系统能力： SystemCapability.Multimedia.Image.Core

参数：

参数名	类型	必填	说明
source	image.PixelMap	是	image模块创建的PixelMap实例。
callback	AsyncCallback<ColorPicker>	是	回调函数。返回创建的ColorPicker实例。

示例：

import image from "@ohos.multimedia.image";

const color = new ArrayBuffer(96);
let opts = { editable: true, pixelFormat: 3, size: { height: 4, width: 6 } }
image.createPixelMap(color, opts).then((pixelMap) => {
  effectKit.createColorPicker(pixelMap, (error, colorPicker) => {
    if (error) {
      console.log('Failed to create color picker.');
    } else {
      console.log('Succeeded in creating color picker.');
    }
  })
})1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.

Color

颜色类，用于保存取色的结果。

系统能力： SystemCapability.Multimedia.Image.Core

名称	类型	可读	可写	说明
red	number	是	否	红色分量值。
green	number	是	否	绿色分量值。
blue	number	是	否	蓝色分量值。
alpha	number	是	否	透明通道分量值。

ColorPicker

取色类，用于从一张图像数据中获取它的主要颜色。在调用ColorPicker的方法前，需要先通过createColorPicker创建一个ColorPicker实例。

getMainColor

getMainColor(): Promise<Color>

读取图像主色的颜色值，结果写入Color里，使用Promise异步回调。

系统能力： SystemCapability.Multimedia.Image.Core

返回值：

类型	说明
Promise<Color>	Promise对象。返回图像主色对应的颜色值，失败时返回错误信息。

示例：

colorPicker.getMainColor().then(color => {
    console.log('Succeeded in getting main color.');
    console.info(`color[ARGB]=${color.alpha},${color.red},${color.green},${color.blue}`);
}).catch(error => {
    console.log('Failed to get main color.');
})1.
2.
3.
4.
5.
6.

getMainColorSync

getMainColorSync(): Color

读取图像主色的颜色值，结果写入Color里，使用同步方式返回。

系统能力： SystemCapability.Multimedia.Image.Core

返回值：

类型	说明
Color	Color实例，即图像主色对应的颜色值，失败时返回null。

示例：

let color = colorPicker.getMainColorSync();
console.log('get main color =' + color);1.
2.

HarmonyOS API：@ohos.effectKit (图像效果)-鸿蒙开发者社区

Filter

图像效果类，用于将指定的效果添加到输入图像中。在调用Filter的方法前，需要先通过createEffect创建一个Filter实例。

blur

blur(radius: number): Filter

将模糊效果添加到效果链表中，结果返回效果链表的头节点。

系统能力： SystemCapability.Multimedia.Image.Core

参数：

参数名	类型	必填	说明
radius	number	是	模糊半径，单位是像素。模糊效果与所设置的值成正比，值越大效果越明显。

返回值：

类型	说明
Filter	返回已添加的图像效果。

示例：

import image from "@ohos.multimedia.image";

const color = new ArrayBuffer(96);
let opts = { editable: true, pixelFormat: 3, size: { height: 4, width: 6 } };
image.createPixelMap(color, opts).then((pixelMap) => {
  let radius = 5;
  let headFilter = effectKit.createEffect(pixelMap);
  if (headFilter != null) {
    headFilter.blur(radius);
  }
})1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.

HarmonyOS API：@ohos.effectKit (图像效果)-鸿蒙开发者社区

brightness

brightness(bright: number): Filter

将高亮效果添加到效果链表中，结果返回效果链表的头节点。

系统能力： SystemCapability.Multimedia.Image.Core

参数：

参数名	类型	必填	说明
bright	number	是	高亮程度，取值范围在0-1之间，取值为0时图像保持不变。

返回值：

类型	说明
Filter	返回已添加的图像效果。

示例：

import image from "@ohos.multimedia.image";

const color = new ArrayBuffer(96);
let opts = { editable: true, pixelFormat: 3, size: { height: 4, width: 6 } };
image.createPixelMap(color, opts).then((pixelMap) => {
  let bright = 0.5;
  let headFilter = effectKit.createEffect(pixelMap);
  if (headFilter != null) {
    headFilter.brightness(bright);
  }
})1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.

HarmonyOS API：@ohos.effectKit (图像效果)-鸿蒙开发者社区

grayscale

grayscale(): Filter

将灰度效果添加到效果链表中，结果返回效果链表的头节点。

系统能力： SystemCapability.Multimedia.Image.Core

返回值：

类型	说明
Filter	返回已添加的图像效果。

示例：

import image from "@ohos.multimedia.image";

const color = new ArrayBuffer(96);
let opts = { editable: true, pixelFormat: 3, size: { height: 4, width: 6 } };
image.createPixelMap(color, opts).then((pixelMap) => {
  let headFilter = effectKit.createEffect(pixelMap);
  if (headFilter != null) {
    headFilter.grayscale();
  }
})1.
2.
3.
4.
5.
6.
7.
8.
9.
10.

HarmonyOS API：@ohos.effectKit (图像效果)-鸿蒙开发者社区

getPixelMap

getPixelMap(): image.PixelMap

获取已添加链表效果的源图像的image.PixelMap。

系统能力： SystemCapability.Multimedia.Image.Core

返回值：

类型	说明
image.PixelMap	已添加效果的源图像的image.PixelMap。

示例：

import image from "@ohos.multimedia.image";

const color = new ArrayBuffer(96);
let opts = { editable: true, pixelFormat: 3, size: { height: 4, width: 6 } };
image.createPixelMap(color, opts).then((pixelMap) => {
  let pixel = effectKit.createEffect(pixelMap).grayscale().getPixelMap();
})1.
2.
3.
4.
5.
6.
7.

文章转载自：https://developer.harmonyos.com/cn/docs/documentation/doc-references-V3/js-apis-effectkit-0000001427745032-V3?catalogVersion=V3#ZH-CN_TOPIC_0000001427745032__导入模块

分类

卡片开发

三方库

标签

HarmonyOS API

已于2023-4-4 15:44:13修改

51CTO

51CTO博客

51CTO学堂

HarmonyOS API：@ohos.effectKit (图像效果)

@ohos.effectKit (图像效果)

导入模块

effectKit.createEffect

effectKit.createColorPicker

effectKit.createColorPicker

Color

ColorPicker

getMainColor

getMainColorSync

Filter

blur

brightness

grayscale

getPixelMap

目录

订阅鸿蒙技术特刊，精选内容抢先看