diff --git a/api/@ohos.effectKit.d.ts b/api/@ohos.effectKit.d.ts index 301e96c287c6448ec67e6597b3b997252228e20d..269b7cfe6f02e622dfddd24207c09cae687249b6 100644 --- a/api/@ohos.effectKit.d.ts +++ b/api/@ohos.effectKit.d.ts @@ -1,776 +1,800 @@ -/* -* 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 - */ - /** - * The Filter of FilterChain. - * @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 - */ - /** - * 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 arkts {'1.1':'14', '1.2':'20'} - * @arkts 1.1&1.2 - */ - blur(radius: number): Filter; - - /** - * A blur effect is added to the image. - * @param { number } radius - The degree of blur, the value is measured in pixels. - * @param { TileMode } tileMode - The tile mode of blur. - * @returns { Filter } Filters for the current effect have been added. - * @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 - */ - /** - * 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; - - /** - * 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 - */ - /** - * 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; - - /** - * 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 - */ - /** - * 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; - - /** - * A custom effect is added to the image. - * - * @param { Array } 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 - */ - /** - * A custom effect is added to the image. - * - * @param { Array } 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): Filter; - - /** - * Gets the PixelMap where all filter effects have been added to the image. - * @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 } - 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 } - returns the PixelMap generated. - * @syscap SystemCapability.Multimedia.Image.Core - * @form - * @atomicservice - * @since 12 - */ - /** - * Gets the PixelMap where all filter effects have been added to the image. - * @returns { Promise } - returns the PixelMap generated. - * @syscap SystemCapability.Multimedia.Image.Core - * @crossplatform - * @form - * @atomicservice - * @since arkts {'1.1':'14', '1.2':'20'} - * @arkts 1.1&1.2 - */ - getEffectPixelMap(): Promise; - } - - /** - * 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 - */ - /** - * The color picker of an image. - * @typedef ColorPicker - * @syscap SystemCapability.Multimedia.Image.Core - * @crossplatform - * @form - * @atomicservice - * @since 14 - */ - interface ColorPicker { - - /** - * get main color of an image - * @returns { Promise } returns the MainColor generated. - * @syscap SystemCapability.Multimedia.Image.Core - * @since 9 - */ - /** - * get main color of an image - * @returns { Promise } returns the MainColor generated. - * @syscap SystemCapability.Multimedia.Image.Core - * @form - * @atomicservice - * @since 12 - */ - /** - * get main color of an image - * @returns { Promise } returns the MainColor generated. - * @syscap SystemCapability.Multimedia.Image.Core - * @crossplatform - * @form - * @atomicservice - * @since 14 - */ - getMainColor(): Promise; - - /** - * 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 - */ - /** - * 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; - - /** - * 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 - */ - /** - * 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; - - /** - * Get top proportion color of an image - * @param { number } colorCount - The number of colors to require, the value is 1 to 10. - * @returns { Array } 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 - */ - /** - * Get top proportion color of an image - * @param { number } colorCount - The number of colors to require, the value is 1 to 10. - * @returns { Array } 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; - - /** - * 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 - */ - /** - * 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; - - /** - * 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 - */ - /** - * 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; - - /** - * 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 - */ - /** - * 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; - } - - /** - * 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 - */ - /** - * The color param. - * @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 - */ - /** - * Red - * @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 - */ - /** - * Green - * @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 - */ - /** - * Blue - * @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 - */ - /** - * Alpha - * @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 - */ - /** - * 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 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 } - 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 } - returns the ColorPicker generated. - * @throws { BusinessError } 401 - Input parameter error. - * @syscap SystemCapability.Multimedia.Image.Core - * @form - * @atomicservice - * @since 12 - */ - /** - * Create a color picker to get color of an image. - * @param { image.PixelMap } source - the source pixelmap. - * @returns { Promise } - 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; - - /** - * Create a color picker to get color of an image. - * @param { image.PixelMap } source - the source pixelmap. - * @param { Array } 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 } - 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 } 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 } - returns the ColorPicker generated. - * @throws { BusinessError } 401 - Input parameter error. - * @syscap SystemCapability.Multimedia.Image.Core - * @form - * @atomicservice - * @since 12 - */ - /** - * Create a color picker to get color of an image. - * @param { image.PixelMap } source - the source pixelmap. - * @param { Array } 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 } - 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): Promise; - - /** - * Create a color picker to get color of an image. - * @param { image.PixelMap } source - the source pixelmap. - * @param { AsyncCallback } 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 } callback - the callback of createColorPicker. - * @throws { BusinessError } 401 - Input parameter error. - * @syscap SystemCapability.Multimedia.Image.Core - * @form - * @atomicservice - * @since 12 - */ - /** - * Create a color picker to get color of an image. - * @param { image.PixelMap } source - the source pixelmap. - * @param { AsyncCallback } 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): void; - - /** - * Create a color picker to get color of an image. - * @param { image.PixelMap } source - the source pixelmap. - * @param { Array } 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 } 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 } 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 } callback - the callback of createColorPicker. - * @throws { BusinessError } 401 - Input parameter error. - * @syscap SystemCapability.Multimedia.Image.Core - * @form - * @atomicservice - * @since 12 - */ - /** - * Create a color picker to get color of an image. - * @param { image.PixelMap } source - the source pixelmap. - * @param { Array } 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 } 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, callback: AsyncCallback): void; - - /** - * TileMode enumeration description - * - * @enum { number } - * @syscap SystemCapability.Multimedia.Image.Core - * @since 14 - */ - enum TileMode { - /** - * Clamp mode. - * - * @syscap SystemCapability.Multimedia.Image.Core - * @since 14 - */ - CLAMP = 0, - - /** - * Repeat mode. - * - * @syscap SystemCapability.Multimedia.Image.Core - * @since 14 - */ - REPEAT = 1, - - /** - * Mirror mode. - * - * @syscap SystemCapability.Multimedia.Image.Core - * @since 14 - */ - MIRROR = 2, - - /** - * Decal mode. - * - * @syscap SystemCapability.Multimedia.Image.Core - * @since 14 - */ - DECAL = 3, - } -} - -export default effectKit; +/* +* 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 + */ + + +import { AsyncCallback } from './@ohos.base'; +import image from './@ohos.multimedia.image'; + + +/** + * @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 + */ + /** + * The Filter of FilterChain. + * @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 + */ + /** + * 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 arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 + */ + blur(radius: number): Filter; + + /** + * A blur effect is added to the image. + * @param { number } radius - The degree of blur, the value is measured in pixels. + * @param { TileMode } tileMode - The tile mode of blur. + * @returns { Filter } Filters for the current effect have been added. + * @syscap SystemCapability.Multimedia.Image.Core + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 + */ + 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 + */ + /** + * 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 arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 + */ + 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 + */ + /** + * 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 arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 + */ + 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 + */ + /** + * 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 arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 + */ + invert(): Filter; + + /** + * A custom effect is added to the image. + * + * @param { Array } 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 + */ + /** + * A custom effect is added to the image. + * + * @param { Array } 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 arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 + */ + setColorMatrix(colorMatrix: Array): Filter; + + /** + * Gets the PixelMap where all filter effects have been added to the image. + * @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 } - 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 } - returns the PixelMap generated. + * @syscap SystemCapability.Multimedia.Image.Core + * @form + * @atomicservice + * @since 12 + */ + /** + * Gets the PixelMap where all filter effects have been added to the image. + * @returns { Promise } - returns the PixelMap generated. + * @syscap SystemCapability.Multimedia.Image.Core + * @crossplatform + * @form + * @atomicservice + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 + */ + getEffectPixelMap(): Promise; + } + + /** + * 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 + */ + /** + * The color picker of an image. + * @typedef ColorPicker + * @syscap SystemCapability.Multimedia.Image.Core + * @crossplatform + * @form + * @atomicservice + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 + */ + interface ColorPicker { + + /** + * get main color of an image + * @returns { Promise } returns the MainColor generated. + * @syscap SystemCapability.Multimedia.Image.Core + * @since 9 + */ + /** + * get main color of an image + * @returns { Promise } returns the MainColor generated. + * @syscap SystemCapability.Multimedia.Image.Core + * @form + * @atomicservice + * @since 12 + */ + /** + * get main color of an image + * @returns { Promise } returns the MainColor generated. + * @syscap SystemCapability.Multimedia.Image.Core + * @crossplatform + * @form + * @atomicservice + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 + */ + getMainColor(): Promise; + + /** + * 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 + */ + /** + * get main color of an image + * @returns { Color } Main color picked in the image. + * @syscap SystemCapability.Multimedia.Image.Core + * @crossplatform + * @form + * @atomicservice + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 + */ + 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 + */ + /** + * 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 arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 + */ + 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 } 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 + */ + /** + * Get top proportion color of an image + * @param { number } colorCount - The number of colors to require, the value is 1 to 10. + * @returns { Array } 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 arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 + */ + getTopProportionColors(colorCount: number): Array; + + /** + * 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 + */ + /** + * 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 arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 + */ + 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 + */ + /** + * Get average color of an image + * @returns { Color } Average color calculated in the image. + * @syscap SystemCapability.Multimedia.Image.Core + * @crossplatform + * @form + * @atomicservice + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 + */ + 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 + */ + /** + * 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 arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 + */ + 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 + */ + /** + * The color param. + * @typedef Color + * @syscap SystemCapability.Multimedia.Image.Core + * @crossplatform + * @form + * @atomicservice + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 + */ + interface Color { + + /** + * Red + * @type { number } + * @syscap SystemCapability.Multimedia.Image.Core + * @since 9 + */ + /** + * Red + * @type { number } + * @syscap SystemCapability.Multimedia.Image.Core + * @form + * @atomicservice + * @since 12 + */ + /** + * Red + * @type { number } + * @syscap SystemCapability.Multimedia.Image.Core + * @crossplatform + * @form + * @atomicservice + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 + */ + red: number; + + /** + * Green + * @type { number } + * @syscap SystemCapability.Multimedia.Image.Core + * @since 9 + */ + /** + * Green + * @type { number } + * @syscap SystemCapability.Multimedia.Image.Core + * @form + * @atomicservice + * @since 12 + */ + /** + * Green + * @type { number } + * @syscap SystemCapability.Multimedia.Image.Core + * @crossplatform + * @form + * @atomicservice + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 + */ + green: number; + + /** + * Blue + * @type { number } + * @syscap SystemCapability.Multimedia.Image.Core + * @since 9 + */ + /** + * Blue + * @type { number } + * @syscap SystemCapability.Multimedia.Image.Core + * @form + * @atomicservice + * @since 12 + */ + /** + * Blue + * @type { number } + * @syscap SystemCapability.Multimedia.Image.Core + * @crossplatform + * @form + * @atomicservice + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 + */ + blue: number; + + /** + * Alpha + * @type { number } + * @syscap SystemCapability.Multimedia.Image.Core + * @since 9 + */ + /** + * Alpha + * @type { number } + * @syscap SystemCapability.Multimedia.Image.Core + * @form + * @atomicservice + * @since 12 + */ + /** + * Alpha + * @type { number } + * @syscap SystemCapability.Multimedia.Image.Core + * @crossplatform + * @form + * @atomicservice + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 + */ + 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 + */ + /** + * 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 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 } - 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 } - returns the ColorPicker generated. + * @throws { BusinessError } 401 - Input parameter error. + * @syscap SystemCapability.Multimedia.Image.Core + * @form + * @atomicservice + * @since 12 + */ + /** + * Create a color picker to get color of an image. + * @param { image.PixelMap } source - the source pixelmap. + * @returns { Promise } - returns the ColorPicker generated. + * @throws { BusinessError } 401 - Input parameter error. + * @syscap SystemCapability.Multimedia.Image.Core + * @crossplatform + * @form + * @atomicservice + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 + */ + function createColorPicker(source: image.PixelMap): Promise; + + /** + * Create a color picker to get color of an image. + * @param { image.PixelMap } source - the source pixelmap. + * @param { Array } 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 } - 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 } 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 } - returns the ColorPicker generated. + * @throws { BusinessError } 401 - Input parameter error. + * @syscap SystemCapability.Multimedia.Image.Core + * @form + * @atomicservice + * @since 12 + */ + /** + * Create a color picker to get color of an image. + * @param { image.PixelMap } source - the source pixelmap. + * @param { Array } 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 } - returns the ColorPicker generated. + * @throws { BusinessError } 401 - Input parameter error. + * @syscap SystemCapability.Multimedia.Image.Core + * @crossplatform + * @form + * @atomicservice + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 + */ + function createColorPicker(source: image.PixelMap, region: Array): Promise; + + /** + * Create a color picker to get color of an image. + * @param { image.PixelMap } source - the source pixelmap. + * @param { AsyncCallback } 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 } callback - the callback of createColorPicker. + * @throws { BusinessError } 401 - Input parameter error. + * @syscap SystemCapability.Multimedia.Image.Core + * @form + * @atomicservice + * @since 12 + */ + /** + * Create a color picker to get color of an image. + * @param { image.PixelMap } source - the source pixelmap. + * @param { AsyncCallback } callback - the callback of createColorPicker. + * @throws { BusinessError } 401 - Input parameter error. + * @syscap SystemCapability.Multimedia.Image.Core + * @crossplatform + * @form + * @atomicservice + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 + */ + function createColorPicker(source: image.PixelMap, callback: AsyncCallback): void; + + /** + * Create a color picker to get color of an image. + * @param { image.PixelMap } source - the source pixelmap. + * @param { Array } 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 } 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 } 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 } callback - the callback of createColorPicker. + * @throws { BusinessError } 401 - Input parameter error. + * @syscap SystemCapability.Multimedia.Image.Core + * @form + * @atomicservice + * @since 12 + */ + /** + * Create a color picker to get color of an image. + * @param { image.PixelMap } source - the source pixelmap. + * @param { Array } 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 } callback - the callback of createColorPicker. + * @throws { BusinessError } 401 - Input parameter error. + * @syscap SystemCapability.Multimedia.Image.Core + * @crossplatform + * @form + * @atomicservice + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 + */ + function createColorPicker(source: image.PixelMap, region: Array, callback: AsyncCallback): void; + + /** + * TileMode enumeration description + * + * @enum { number } + * @syscap SystemCapability.Multimedia.Image.Core + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 + */ + enum TileMode { + /** + * Clamp mode. + * + * @syscap SystemCapability.Multimedia.Image.Core + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 + */ + CLAMP = 0, + + /** + * Repeat mode. + * + * @syscap SystemCapability.Multimedia.Image.Core + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 + */ + REPEAT = 1, + + /** + * Mirror mode. + * + * @syscap SystemCapability.Multimedia.Image.Core + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 + */ + MIRROR = 2, + + /** + * Decal mode. + * + * @syscap SystemCapability.Multimedia.Image.Core + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 + */ + DECAL = 3, + } +} + +export default effectKit; diff --git a/api/@ohos.graphics.uiEffect.d.ts b/api/@ohos.graphics.uiEffect.d.ts index b30a33873168c441df807c6ffd04d04b17e34187..daa434171b69c0fbad11f02ced417bd61ff63faa 100644 --- a/api/@ohos.graphics.uiEffect.d.ts +++ b/api/@ohos.graphics.uiEffect.d.ts @@ -44,7 +44,8 @@ declare namespace uiEffect { * @returns { Filter } * @syscap SystemCapability.Graphics.Drawing * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ pixelStretch(stretchSizes: Array, tileMode: TileMode): Filter; @@ -54,7 +55,8 @@ declare namespace uiEffect { * @param { number } blurRadius * @returns { Filter } * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ blur(blurRadius: number): Filter; @@ -71,7 +73,8 @@ declare namespace uiEffect { * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @syscap SystemCapability.Graphics.Drawing * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ waterRipple(progress: number, waveCount: number, x: number, y: number, rippleMode: WaterRippleMode): Filter; @@ -85,7 +88,8 @@ declare namespace uiEffect { * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @syscap SystemCapability.Graphics.Drawing * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ flyInFlyOutEffect(degree: number, flyMode: FlyMode): Filter; @@ -100,7 +104,8 @@ declare namespace uiEffect { * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @syscap SystemCapability.Graphics.Drawing * @systemapi - * @since 13 + * @since arkts {'1.1':'13', '1.2':'20'} + * @arkts 1.1&1.2 */ distort(distortionK: number): Filter; } @@ -111,7 +116,8 @@ declare namespace uiEffect { * @enum { number } * @syscap SystemCapability.Graphics.Drawing * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ enum TileMode { /** @@ -119,7 +125,8 @@ declare namespace uiEffect { * * @syscap SystemCapability.Graphics.Drawing * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ CLAMP = 0, @@ -128,7 +135,8 @@ declare namespace uiEffect { * * @syscap SystemCapability.Graphics.Drawing * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ REPEAT = 1, @@ -137,7 +145,8 @@ declare namespace uiEffect { * * @syscap SystemCapability.Graphics.Drawing * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ MIRROR = 2, @@ -146,7 +155,8 @@ declare namespace uiEffect { * * @syscap SystemCapability.Graphics.Drawing * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ DECAL = 3, } @@ -157,7 +167,8 @@ declare namespace uiEffect { * @enum { number } * @syscap SystemCapability.Graphics.Drawing * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ enum WaterRippleMode { /** @@ -165,7 +176,8 @@ declare namespace uiEffect { * * @syscap SystemCapability.Graphics.Drawing * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ SMALL2MEDIUM_RECV = 0, @@ -174,7 +186,8 @@ declare namespace uiEffect { * * @syscap SystemCapability.Graphics.Drawing * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ SMALL2MEDIUM_SEND = 1, @@ -183,7 +196,8 @@ declare namespace uiEffect { * * @syscap SystemCapability.Graphics.Drawing * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ SMALL2SMALL = 2, @@ -192,7 +206,8 @@ declare namespace uiEffect { * * @syscap SystemCapability.Graphics.Drawing * @systemapi - * @since 17 + * @since arkts {'1.1':'17', '1.2':'20'} + * @arkts 1.1&1.2 */ MINI_RECV = 3, } @@ -203,7 +218,8 @@ declare namespace uiEffect { * @enum { number } * @syscap SystemCapability.Graphics.Drawing * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ enum FlyMode { /** @@ -211,7 +227,8 @@ declare namespace uiEffect { * * @syscap SystemCapability.Graphics.Drawing * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ BOTTOM = 0, @@ -220,7 +237,8 @@ declare namespace uiEffect { * * @syscap SystemCapability.Graphics.Drawing * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ TOP = 1, } @@ -357,7 +375,8 @@ declare namespace uiEffect { * Create a Filter to add multiple effects to the component. * @returns { Filter } Returns the head node of Filter. * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ function createFilter(): Filter;