46 Star 173 Fork 4.7K

OpenHarmony/interface_sdk-js

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
文件
克隆/下载
@ohos.effectKit.d.ts 28.90 KB
一键复制 编辑 原始数据 按行查看 历史
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808
/*
* Copyright (c) 2022 Huawei Device Co., Ltd.
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* @file
* @kit ArkGraphics2D
*/
/*** if arkts 1.1 */
import { AsyncCallback } from './@ohos.base';
import image from './@ohos.multimedia.image';
/*** endif */
/*** if arkts 1.2 */
import image from './@ohos.multimedia.image';
/*** endif */
/**
* @namespace effectKit
* @since 9
*/
/**
* @namespace effectKit
* @form
* @atomicservice
* @since 12
*/
/**
* @namespace effectKit
* @crossplatform
* @form
* @atomicservice
* @since arkts {'1.1':'14', '1.2':'20'}
* @arkts 1.1&1.2
*/
declare namespace effectKit {
/**
* The Filter of FilterChain.
* @typedef Filter
* @syscap SystemCapability.Multimedia.Image.Core
* @since 9
*/
/**
* The Filter of FilterChain.
* @typedef Filter
* @syscap SystemCapability.Multimedia.Image.Core
* @form
* @atomicservice
* @since 12
*/
/**
* A class used to add a specified effect to an image. Before calling any method of Filter, use createEffect to create a Filter instance.
* @typedef Filter
* @syscap SystemCapability.Multimedia.Image.Core
* @crossplatform
* @form
* @atomicservice
* @since arkts {'1.1':'14', '1.2':'20'}
* @arkts 1.1&1.2
*/
interface Filter {
/**
* 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
* @since 9
*/
/**
* 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
* @form
* @atomicservice
* @since 12
*/
/**
* Adds the blur effect to the filter linked list, and returns the head node of the linked list.
* @param { number } radius - Blur radius, in pixels. The blur effect is proportional to the configured value.
* A larger value indicates a more obvious effect.
* @returns { Filter } Final image effect.
* @syscap SystemCapability.Multimedia.Image.Core
* @crossplatform
* @form
* @atomicservice
* @since arkts {'1.1':'14', '1.2':'20'}
* @arkts 1.1&1.2
*/
blur(radius: number): Filter;
/**
* Adds the blur effect to the filter linked list, and returns the head node of the linked list.
* @param { number } radius - Blur radius, in pixels. The blur effect is proportional to the configured value.
* A larger value indicates a more obvious effect.
* @param { TileMode } tileMode - Tile mode of the shader effect. The blur effect of image edges is affected. Currently,
* only CPU rendering is supported. Therefore, the tile mode supports only DECAL.
* @returns { Filter } Final image effect.
* @syscap SystemCapability.Multimedia.Image.Core
* @since 14
*/
blur(radius: number, tileMode: TileMode): Filter;
/**
* 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
* @since 9
*/
/**
* 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
* @form
* @atomicservice
* @since 12
*/
/**
* Adds the brightness effect to the filter linked list, and returns the head node of the linked list.
* @param { number } bright - Brightness value, ranging from 0 to 1. When the value is 0, the image brightness remains unchanged.
* @returns { Filter } Final image effect.
* @syscap SystemCapability.Multimedia.Image.Core
* @crossplatform
* @form
* @atomicservice
* @since 14
*/
brightness(bright: number): Filter;
/**
* A Grayscale effect is added to the image.
* @returns { Filter } Filters for the current effect have been added.
* @syscap SystemCapability.Multimedia.Image.Core
* @since 9
*/
/**
* A Grayscale effect is added to the image.
* @returns { Filter } Filters for the current effect have been added.
* @syscap SystemCapability.Multimedia.Image.Core
* @form
* @atomicservice
* @since 12
*/
/**
* Adds the grayscale effect to the filter linked list, and returns the head node of the linked list.
* @returns { Filter } Final image effect.
* @syscap SystemCapability.Multimedia.Image.Core
* @crossplatform
* @form
* @atomicservice
* @since 14
*/
grayscale(): Filter;
/**
* A invert effect is added to the image.
* @returns { Filter } Filters for the current effect have been added.
* @syscap SystemCapability.Multimedia.Image.Core
* @since 12
*/
/**
* Adds the inversion effect to the filter linked list, and returns the head node of the linked list.
* @returns { Filter } Final image effect.
* @syscap SystemCapability.Multimedia.Image.Core
* @crossplatform
* @since 14
*/
invert(): Filter;
/**
* 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
* @since 12
*/
/**
* Adds a custom effect to the filter linked list, and returns the head node of the linked list.
*
* @param { Array<number> } colorMatrix - Custom color matrix.
* A 5 x 4 matrix can be created. The value range of the matrix element is [0, 1],
* where 0 indicates that the color channel is not involved in the calculation,
* and 1 indicates that the color channel is involved in the calculation and retains the original weight.
* @returns { Filter } Final image effect.
* @throws { BusinessError } 401 - Input parameter error.
* @syscap SystemCapability.Multimedia.Image.Core
* @crossplatform
* @since 14
*/
setColorMatrix(colorMatrix: Array<number>): Filter;
/**
* Obtains image.PixelMap of the source image to which the filter linked list is added.
* @returns { image.PixelMap } image.PixelMap.
* @syscap SystemCapability.Multimedia.Image.Core
* @since 9
* @deprecated since 11
* @useinstead effectKit.Filter#getEffectPixelMap
*/
getPixelMap(): image.PixelMap;
/**
* 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
* @since 11
*/
/**
* 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
* @form
* @atomicservice
* @since 12
*/
/**
* Obtains image.PixelMap of the source image to which the filter linked list is added. This API uses a promise to return the result.
* @returns { Promise<image.PixelMap> } - Promise used to return image.PixelMap of the source image.
* @syscap SystemCapability.Multimedia.Image.Core
* @crossplatform
* @form
* @atomicservice
* @since arkts {'1.1':'14', '1.2':'20'}
* @arkts 1.1&1.2
*/
getEffectPixelMap(): Promise<image.PixelMap>;
/**
* Gets the PixelMap where all filter effects have been added to the image.
* @param { boolean } useCpuRender - Whether to use cpu render.
* @returns { Promise<image.PixelMap> } - returns the PixelMap generated.
* @syscap SystemCapability.Multimedia.Image.Core
* @crossplatform
* @form
* @atomicservice
* @since 20
*/
getEffectPixelMap(useCpuRender : boolean): Promise<image.PixelMap>;
}
/**
* The color picker of an image.
* @typedef ColorPicker
* @syscap SystemCapability.Multimedia.Image.Core
* @since 9
*/
/**
* The color picker of an image.
* @typedef ColorPicker
* @syscap SystemCapability.Multimedia.Image.Core
* @form
* @atomicservice
* @since 12
*/
/**
* A class used to obtain the color from an image. Before calling any method of ColorPicker, use createColorPicker to create a ColorPicker instance.
* @typedef ColorPicker
* @syscap SystemCapability.Multimedia.Image.Core
* @crossplatform
* @form
* @atomicservice
* @since 14
*/
interface ColorPicker {
/**
* get main color of an image
* @returns { Promise<Color> } returns the MainColor generated.
* @syscap SystemCapability.Multimedia.Image.Core
* @since 9
*/
/**
* get main color of an image
* @returns { Promise<Color> } returns the MainColor generated.
* @syscap SystemCapability.Multimedia.Image.Core
* @form
* @atomicservice
* @since 12
*/
/**
* Obtains the main color from the image and writes the result to a Color instance. This API uses a promise to return the result.
* @returns { Promise<Color> } Promise used to return the color value of the main color. If the operation fails, an error message is returned.
* @syscap SystemCapability.Multimedia.Image.Core
* @crossplatform
* @form
* @atomicservice
* @since 14
*/
getMainColor(): Promise<Color>;
/**
* get main color of an image
* @returns { Color } Main color picked in the image.
* @syscap SystemCapability.Multimedia.Image.Core
* @since 9
*/
/**
* get main color of an image
* @returns { Color } Main color picked in the image.
* @syscap SystemCapability.Multimedia.Image.Core
* @form
* @atomicservice
* @since 12
*/
/**
* Obtains the main color from the image and writes the result to a Color instance. This API returns the result synchronously.
* @returns { Color } Color value of the main color. If the operation fails, null is returned.
* @syscap SystemCapability.Multimedia.Image.Core
* @crossplatform
* @form
* @atomicservice
* @since 14
*/
getMainColorSync(): Color;
/**
* Get largest proportion color of an image
* @returns { Color } Largest proportion color picked in the image.
* @syscap SystemCapability.Multimedia.Image.Core
* @since 10
*/
/**
* Get largest proportion color of an image
* @returns { Color } Largest proportion color picked in the image.
* @syscap SystemCapability.Multimedia.Image.Core
* @form
* @atomicservice
* @since 12
*/
/**
* Obtains the color with the largest proportion from the image and writes the result to a Color instance. This API returns the result synchronously.
* @returns { Color } Color value of the color with the largest proportion. If the operation fails, null is returned.
* @syscap SystemCapability.Multimedia.Image.Core
* @crossplatform
* @form
* @atomicservice
* @since 14
*/
getLargestProportionColor(): Color;
/**
* 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
* @form
* @atomicservice
* @since 12
*/
/**
* Obtains a given number of colors with the top proportions in the image. This API returns the result synchronously.
* @param { number } colorCount - Number of colors to obtain. The value range is [1, 10]. If a non-integer is passed in, the value will be rounded down.
* @returns { Array<Color | null> } Array of colors, sorted by proportion.
* - If the number of colors obtained is less than the value of colorCount, the array size is the actual number obtained.
* - If the colors fail to be obtained or the number of colors obtained is less than 1, [null] is returned.
* - If the value of colorCount is greater than 10, an array holding the first 10 colors with the top proportions is returned.
* @syscap SystemCapability.Multimedia.Image.Core
* @crossplatform
* @form
* @atomicservice
* @since 14
*/
getTopProportionColors(colorCount: number): Array<Color | null>;
/**
* Get highest saturation color of an image
* @returns { Color } Highest saturation color picked in the image.
* @syscap SystemCapability.Multimedia.Image.Core
* @since 10
*/
/**
* Get highest saturation color of an image
* @returns { Color } Highest saturation color picked in the image.
* @syscap SystemCapability.Multimedia.Image.Core
* @form
* @atomicservice
* @since 12
*/
/**
* Obtains the color with the highest saturation from the image and writes the result to a Color instance. This API returns the result synchronously.
* @returns { Color } Color value of the color with the highest saturation. If the operation fails, null is returned.
* @syscap SystemCapability.Multimedia.Image.Core
* @crossplatform
* @form
* @atomicservice
* @since 14
*/
getHighestSaturationColor(): Color;
/**
* Get average color of an image
* @returns { Color } Average color calculated in the image.
* @syscap SystemCapability.Multimedia.Image.Core
* @since 10
*/
/**
* Get average color of an image
* @returns { Color } Average color calculated in the image.
* @syscap SystemCapability.Multimedia.Image.Core
* @form
* @atomicservice
* @since 12
*/
/**
* Obtains the average color from the image and writes the result to a Color instance. This API returns the result synchronously.
* @returns { Color } Average color value. If the operation fails, null is returned.
* @syscap SystemCapability.Multimedia.Image.Core
* @crossplatform
* @form
* @atomicservice
* @since 14
*/
getAverageColor(): Color;
/**
* 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
* @since 10
*/
/**
* 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
* @form
* @atomicservice
* @since 12
*/
/**
* Checks whether a color is black, white, and gray.
* @param { number } color - Color to check. The value range is [0x0, 0xFFFFFFFF].
* @returns { boolean } Returns true if the image is black, white, and gray; returns false otherwise.
* @syscap SystemCapability.Multimedia.Image.Core
* @crossplatform
* @form
* @atomicservice
* @since 14
*/
isBlackOrWhiteOrGrayColor(color: number): boolean;
}
/**
* The color param.
* @typedef Color
* @syscap SystemCapability.Multimedia.Image.Core
* @since 9
*/
/**
* The color param.
* @typedef Color
* @syscap SystemCapability.Multimedia.Image.Core
* @form
* @atomicservice
* @since 12
*/
/**
* A class that stores the color picked.
* @typedef Color
* @syscap SystemCapability.Multimedia.Image.Core
* @crossplatform
* @form
* @atomicservice
* @since 14
*/
interface Color {
/**
* Red
* @type { number }
* @syscap SystemCapability.Multimedia.Image.Core
* @since 9
*/
/**
* Red
* @type { number }
* @syscap SystemCapability.Multimedia.Image.Core
* @form
* @atomicservice
* @since 12
*/
/**
* Value of the red component. The value range is [0x0, 0xFF].
* @type { number }
* @syscap SystemCapability.Multimedia.Image.Core
* @crossplatform
* @form
* @atomicservice
* @since 14
*/
red: number;
/**
* Green
* @type { number }
* @syscap SystemCapability.Multimedia.Image.Core
* @since 9
*/
/**
* Green
* @type { number }
* @syscap SystemCapability.Multimedia.Image.Core
* @form
* @atomicservice
* @since 12
*/
/**
* Value of the green component. The value range is [0x0, 0xFF].
* @type { number }
* @syscap SystemCapability.Multimedia.Image.Core
* @crossplatform
* @form
* @atomicservice
* @since 14
*/
green: number;
/**
* Blue
* @type { number }
* @syscap SystemCapability.Multimedia.Image.Core
* @since 9
*/
/**
* Blue
* @type { number }
* @syscap SystemCapability.Multimedia.Image.Core
* @form
* @atomicservice
* @since 12
*/
/**
* Value of the blue component. The value range is [0x0, 0xFF].
* @type { number }
* @syscap SystemCapability.Multimedia.Image.Core
* @crossplatform
* @form
* @atomicservice
* @since 14
*/
blue: number;
/**
* Alpha
* @type { number }
* @syscap SystemCapability.Multimedia.Image.Core
* @since 9
*/
/**
* Alpha
* @type { number }
* @syscap SystemCapability.Multimedia.Image.Core
* @form
* @atomicservice
* @since 12
*/
/**
* Value of the alpha component. The value range is [0x0, 0xFF].
* @type { number }
* @syscap SystemCapability.Multimedia.Image.Core
* @crossplatform
* @form
* @atomicservice
* @since 14
*/
alpha: number;
}
/**
* 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
* @since 9
*/
/**
* 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
* @form
* @atomicservice
* @since 12
*/
/**
* Creates a Filter instance based on a pixel map.
* @param { image.PixelMap } source - PixelMap instance created by the image module. An instance can be obtained
* by decoding an image or directly created. For details, see Image Overview.
* @returns { Filter } Head node of the filter linked list without any effect. If the operation fails, null is returned.
* @syscap SystemCapability.Multimedia.Image.Core
* @crossplatform
* @form
* @atomicservice
* @since arkts {'1.1':'14', '1.2':'20'}
* @arkts 1.1&1.2
*/
function createEffect(source: image.PixelMap): Filter;
/**
* 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
* @since 9
*/
/**
* 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
* @form
* @atomicservice
* @since 12
*/
/**
* Creates a ColorPicker instance based on a pixel map. This API uses a promise to return the result.
* @param { image.PixelMap } source - PixelMap instance created by the image module. An instance can be
* obtained by decoding an image or directly created. For details, see Image Overview.
* @returns { Promise<ColorPicker> } - Promise used to return the ColorPicker instance created.
* @throws { BusinessError } 401 - Input parameter error.
* @syscap SystemCapability.Multimedia.Image.Core
* @crossplatform
* @form
* @atomicservice
* @since 14
*/
function createColorPicker(source: image.PixelMap): Promise<ColorPicker>;
/**
* 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
* @since 10
*/
/**
* 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
* @form
* @atomicservice
* @since 12
*/
/**
* Creates a ColorPicker instance for the selected region based on a pixel map. This API uses a promise to return the result.
* @param { image.PixelMap } source - PixelMap instance created by the image module. An instance can be obtained by decoding
* an image or directly created. For details, see Image Overview.
* @param { Array<number> } region - Region of the image from which the color is picked.
* The array consists of four elements, representing the left, top, right, and bottom positions of the image, respectively.
* The value of each element must be in the range [0, 1]. The leftmost and topmost positions of the image correspond to 0,
* and the rightmost and bottom positions correspond to 1. In the array, the third element must be greater than the first element,
* and the fourth element must be greater than the second element.
* @returns { Promise<ColorPicker> } - Promise used to return the ColorPicker instance created.
* @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>;
/**
* 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
* @since 9
*/
/**
* 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
* @form
* @atomicservice
* @since 12
*/
/**
* Creates a ColorPicker instance based on a pixel map. This API uses an asynchronous callback to return the result.
* @param { image.PixelMap } source - PixelMap instance created by the image module. An instance can be obtained by
* decoding an image or directly created. For details, see Image Overview.
* @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;
/**
* 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
* @since 10
*/
/**
* 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
* @form
* @atomicservice
* @since 12
*/
/**
* Creates a ColorPicker instance for the selected region based on a pixel map. This API uses an asynchronous callback to return the result.
* @param { image.PixelMap } source - PixelMap instance created by the image module. An instance can be obtained by decoding an
* image or directly created. For details, see Image Overview.PixelMap instance created by the image module. An instance can be
* obtained by decoding an image or directly created. For details, see Image Overview.
* @param { Array<number> } region - Region of the image from which the color is picked.
* The array consists of four elements, representing the left, top, right, and bottom positions of the image, respectively.
* The value of each element must be in the range [0, 1]. The leftmost and topmost positions of the image correspond to 0,
* and the rightmost and bottom positions correspond to 1. In the array, the third element must be greater than the first element,
* and the fourth element must be greater than the second element.
* @param { AsyncCallback<ColorPicker> } callback - Callback used to return the ColorPicker instance created.
* @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;
/**
* Enumerates the tile modes of the shader effect.
*
* @enum { number }
* @syscap SystemCapability.Multimedia.Image.Core
* @since 14
*/
enum TileMode {
/**
* Replicates the edge color if the shader effect draws outside of its original boundary.
*
* @syscap SystemCapability.Multimedia.Image.Core
* @since 14
*/
CLAMP = 0,
/**
* Repeats the shader effect in both horizontal and vertical directions.
*
* @syscap SystemCapability.Multimedia.Image.Core
* @since 14
*/
REPEAT = 1,
/**
* Repeats the shader effect in both horizontal and vertical directions, alternating mirror images.
*
* @syscap SystemCapability.Multimedia.Image.Core
* @since 14
*/
MIRROR = 2,
/**
* Renders the shader effect only within the original boundary.
*
* @syscap SystemCapability.Multimedia.Image.Core
* @since 14
*/
DECAL = 3,
}
}
export default effectKit;
Loading...
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化
1
https://gitee.com/openharmony/interface_sdk-js.git
git@gitee.com:openharmony/interface_sdk-js.git
openharmony
interface_sdk-js
interface_sdk-js
master

搜索帮助