effectkit跨平台编译

Signed-off-by: lw19901203 <liuwei793@h-partners.com>
This commit is contained in:
lw19901203 2024-09-24 10:41:27 +08:00
parent 7bcc263ef6
commit ec9b2da218

View File

@ -31,7 +31,13 @@ import image from './@ohos.multimedia.image';
* @atomicservice
* @since 12
*/
/**
* @namespace effectKit
* @crossplatform
* @form
* @atomicservice
* @since 14
*/
declare namespace effectKit {
@ -49,6 +55,15 @@ declare namespace effectKit {
* @atomicservice
* @since 12
*/
/**
* The Filter of FilterChain.
* @typedef Filter
* @syscap SystemCapability.Multimedia.Image.Core
* @crossplatform
* @form
* @atomicservice
* @since 14
*/
interface Filter {
/**
@ -67,6 +82,16 @@ declare namespace effectKit {
* @atomicservice
* @since 12
*/
/**
* A blur effect is added to the image.
* @param { number } radius - The degree of blur, the value is measured in pixels.
* @returns { Filter } Filters for the current effect have been added.
* @syscap SystemCapability.Multimedia.Image.Core
* @crossplatform
* @form
* @atomicservice
* @since 14
*/
blur(radius: number): Filter;
/**
@ -85,6 +110,16 @@ declare namespace effectKit {
* @atomicservice
* @since 12
*/
/**
* A Brightness effect is added to the image.
* @param { number } bright - The degree of light and darkness,the value range is 0 to 1.
* @returns { Filter } Filters for the current effect have been added.
* @syscap SystemCapability.Multimedia.Image.Core
* @crossplatform
* @form
* @atomicservice
* @since 14
*/
brightness(bright: number): Filter;
/**
@ -101,6 +136,15 @@ declare namespace effectKit {
* @atomicservice
* @since 12
*/
/**
* A Grayscale effect is added to the image.
* @returns { Filter } Filters for the current effect have been added.
* @syscap SystemCapability.Multimedia.Image.Core
* @crossplatform
* @form
* @atomicservice
* @since 14
*/
grayscale(): Filter;
/**
@ -109,6 +153,13 @@ declare namespace effectKit {
* @syscap SystemCapability.Multimedia.Image.Core
* @since 12
*/
/**
* A invert effect is added to the image.
* @returns { Filter } Filters for the current effect have been added.
* @syscap SystemCapability.Multimedia.Image.Core
* @crossplatform
* @since 14
*/
invert(): Filter;
/**
@ -120,6 +171,16 @@ declare namespace effectKit {
* @syscap SystemCapability.Multimedia.Image.Core
* @since 12
*/
/**
* A custom effect is added to the image.
*
* @param { Array<number> } colorMatrix - A matrix of 5x4 size for create effect filter.
* @returns { Filter } Filters for the current effect have been added.
* @throws { BusinessError } 401 - Input parameter error.
* @syscap SystemCapability.Multimedia.Image.Core
* @crossplatform
* @since 14
*/
setColorMatrix(colorMatrix: Array<number>): Filter;
/**
@ -146,6 +207,15 @@ declare namespace effectKit {
* @atomicservice
* @since 12
*/
/**
* Gets the PixelMap where all filter effects have been added to the image.
* @returns { Promise<image.PixelMap> } - returns the PixelMap generated.
* @syscap SystemCapability.Multimedia.Image.Core
* @crossplatform
* @form
* @atomicservice
* @since 14
*/
getEffectPixelMap(): Promise<image.PixelMap>;
}
@ -163,6 +233,15 @@ declare namespace effectKit {
* @atomicservice
* @since 12
*/
/**
* The color picker of an image.
* @typedef ColorPicker
* @syscap SystemCapability.Multimedia.Image.Core
* @crossplatform
* @form
* @atomicservice
* @since 14
*/
interface ColorPicker {
/**
@ -179,6 +258,15 @@ declare namespace effectKit {
* @atomicservice
* @since 12
*/
/**
* get main color of an image
* @returns { Promise<Color> } returns the MainColor generated.
* @syscap SystemCapability.Multimedia.Image.Core
* @crossplatform
* @form
* @atomicservice
* @since 14
*/
getMainColor(): Promise<Color>;
/**
@ -195,6 +283,15 @@ declare namespace effectKit {
* @atomicservice
* @since 12
*/
/**
* get main color of an image
* @returns { Color } Main color picked in the image.
* @syscap SystemCapability.Multimedia.Image.Core
* @crossplatform
* @form
* @atomicservice
* @since 14
*/
getMainColorSync(): Color;
/**
@ -211,6 +308,15 @@ declare namespace effectKit {
* @atomicservice
* @since 12
*/
/**
* Get largest proportion color of an image
* @returns { Color } Largest proportion color picked in the image.
* @syscap SystemCapability.Multimedia.Image.Core
* @crossplatform
* @form
* @atomicservice
* @since 14
*/
getLargestProportionColor(): Color;
/**
@ -223,6 +329,17 @@ declare namespace effectKit {
* @atomicservice
* @since 12
*/
/**
* Get top proportion color of an image
* @param { number } colorCount - The number of colors to require, the value is 1 to 10.
* @returns { Array<Color | null> } An array of feature colors sorted by proportion, with a size equal to
* the minimum of colorCount and the actual number of extracted feature colors.
* @syscap SystemCapability.Multimedia.Image.Core
* @crossplatform
* @form
* @atomicservice
* @since 14
*/
getTopProportionColors(colorCount: number): Array<Color | null>;
/**
@ -239,6 +356,15 @@ declare namespace effectKit {
* @atomicservice
* @since 12
*/
/**
* Get highest saturation color of an image
* @returns { Color } Highest saturation color picked in the image.
* @syscap SystemCapability.Multimedia.Image.Core
* @crossplatform
* @form
* @atomicservice
* @since 14
*/
getHighestSaturationColor(): Color;
/**
@ -255,6 +381,15 @@ declare namespace effectKit {
* @atomicservice
* @since 12
*/
/**
* Get average color of an image
* @returns { Color } Average color calculated in the image.
* @syscap SystemCapability.Multimedia.Image.Core
* @crossplatform
* @form
* @atomicservice
* @since 14
*/
getAverageColor(): Color;
/**
@ -273,6 +408,16 @@ declare namespace effectKit {
* @atomicservice
* @since 12
*/
/**
* Determine whether the color is black or white or gray
* @param { number } color - The 32 bit ARGB color to discriminate.
* @returns { boolean } Result of judging black, white and gray.
* @syscap SystemCapability.Multimedia.Image.Core
* @crossplatform
* @form
* @atomicservice
* @since 14
*/
isBlackOrWhiteOrGrayColor(color: number): boolean;
}
@ -290,6 +435,15 @@ declare namespace effectKit {
* @atomicservice
* @since 12
*/
/**
* The color param.
* @typedef Color
* @syscap SystemCapability.Multimedia.Image.Core
* @crossplatform
* @form
* @atomicservice
* @since 14
*/
interface Color {
/**
@ -306,6 +460,15 @@ declare namespace effectKit {
* @atomicservice
* @since 12
*/
/**
* Red
* @type { number }
* @syscap SystemCapability.Multimedia.Image.Core
* @crossplatform
* @form
* @atomicservice
* @since 14
*/
red: number;
/**
@ -322,6 +485,15 @@ declare namespace effectKit {
* @atomicservice
* @since 12
*/
/**
* Green
* @type { number }
* @syscap SystemCapability.Multimedia.Image.Core
* @crossplatform
* @form
* @atomicservice
* @since 14
*/
green: number;
/**
@ -338,6 +510,15 @@ declare namespace effectKit {
* @atomicservice
* @since 12
*/
/**
* Blue
* @type { number }
* @syscap SystemCapability.Multimedia.Image.Core
* @crossplatform
* @form
* @atomicservice
* @since 14
*/
blue: number;
/**
@ -354,6 +535,15 @@ declare namespace effectKit {
* @atomicservice
* @since 12
*/
/**
* Alpha
* @type { number }
* @syscap SystemCapability.Multimedia.Image.Core
* @crossplatform
* @form
* @atomicservice
* @since 14
*/
alpha: number;
}
@ -373,6 +563,16 @@ declare namespace effectKit {
* @atomicservice
* @since 12
*/
/**
* Create a FilterChain to add multiple effects to an image.
* @param { image.PixelMap } source - the source pixelmap.
* @returns { Filter } Returns the head node of FilterChain.
* @syscap SystemCapability.Multimedia.Image.Core
* @crossplatform
* @form
* @atomicservice
* @since 14
*/
function createEffect(source: image.PixelMap): Filter;
/**
@ -393,6 +593,17 @@ declare namespace effectKit {
* @atomicservice
* @since 12
*/
/**
* Create a color picker to get color of an image.
* @param { image.PixelMap } source - the source pixelmap.
* @returns { Promise<ColorPicker> } - returns the ColorPicker generated.
* @throws { BusinessError } 401 - Input parameter error.
* @syscap SystemCapability.Multimedia.Image.Core
* @crossplatform
* @form
* @atomicservice
* @since 14
*/
function createColorPicker(source: image.PixelMap): Promise<ColorPicker>;
/**
@ -417,6 +628,19 @@ declare namespace effectKit {
* @atomicservice
* @since 12
*/
/**
* Create a color picker to get color of an image.
* @param { image.PixelMap } source - the source pixelmap.
* @param { Array<number> } region - contains 4 elements, represents the region's left, top, right, bottom coordinates,
* default is [0, 0, 1, 1], represents the region of color picker is the whole pixelMap.
* @returns { Promise<ColorPicker> } - returns the ColorPicker generated.
* @throws { BusinessError } 401 - Input parameter error.
* @syscap SystemCapability.Multimedia.Image.Core
* @crossplatform
* @form
* @atomicservice
* @since 14
*/
function createColorPicker(source: image.PixelMap, region: Array<number>): Promise<ColorPicker>;
/**
@ -437,6 +661,17 @@ declare namespace effectKit {
* @atomicservice
* @since 12
*/
/**
* Create a color picker to get color of an image.
* @param { image.PixelMap } source - the source pixelmap.
* @param { AsyncCallback<ColorPicker> } callback - the callback of createColorPicker.
* @throws { BusinessError } 401 - Input parameter error.
* @syscap SystemCapability.Multimedia.Image.Core
* @crossplatform
* @form
* @atomicservice
* @since 14
*/
function createColorPicker(source: image.PixelMap, callback: AsyncCallback<ColorPicker>): void;
/**
@ -461,6 +696,19 @@ declare namespace effectKit {
* @atomicservice
* @since 12
*/
/**
* Create a color picker to get color of an image.
* @param { image.PixelMap } source - the source pixelmap.
* @param { Array<number> } region - contains 4 elements, represents the region's left, top, right, bottom coordinates,
* default is [0, 0, 1, 1], represents the region of color picker is the whole pixelMap.
* @param { AsyncCallback<ColorPicker> } callback - the callback of createColorPicker.
* @throws { BusinessError } 401 - Input parameter error.
* @syscap SystemCapability.Multimedia.Image.Core
* @crossplatform
* @form
* @atomicservice
* @since 14
*/
function createColorPicker(source: image.PixelMap, region: Array<number>, callback: AsyncCallback<ColorPicker>): void;
}