drawing_color_filter.h

Overview

This file declares the functions related to the color filter in the drawing module.

File to include: <native_drawing/drawing_color_filter.h>

Library: libnative_drawing.so

System capability: SystemCapability.Graphic.Graphic2D.NativeDrawing

Since: 11

Related module: Drawing

Summary

Functions

Name	Description
OH_Drawing_ColorFilter* OH_Drawing_ColorFilterCreateBlendMode(uint32_t color, OH_Drawing_BlendMode blendMode)	Creates an OH_Drawing_ColorFilter object with a given blend mode.
OH_Drawing_ColorFilter* OH_Drawing_ColorFilterCreateCompose(OH_Drawing_ColorFilter* outerColorFilter,OH_Drawing_ColorFilter* innerColorFilter)	Creates an OH_Drawing_ColorFilter object by combining another two color filters. This API may return an error code. For details, call OH_Drawing_ErrorCodeGet. If either outerColorFilter or innerColorFilter is NULL, OH_DRAWING_ERROR_INVALID_PARAMETER is returned.
OH_Drawing_ColorFilter* OH_Drawing_ColorFilterCreateMatrix(const float matrix[20])	Creates an OH_Drawing_ColorFilter object with a given 5x4 color matrix. This API may return an error code. For details, call OH_Drawing_ErrorCodeGet. If matrix is NULL, OH_DRAWING_ERROR_INVALID_PARAMETER is returned.
OH_Drawing_ColorFilter* OH_Drawing_ColorFilterCreateLinearToSrgbGamma(void)	Creates an OH_Drawing_ColorFilter object that applies the sRGB gamma curve to the RGB channels.
OH_Drawing_ColorFilter* OH_Drawing_ColorFilterCreateSrgbGammaToLinear(void)	Creates an OH_Drawing_ColorFilter object that applies the RGB channels to the sRGB gamma curve.
OH_Drawing_ColorFilter* OH_Drawing_ColorFilterCreateLuma(void)	Creates a ColorFilter object that multiplies the luma into the alpha channel and sets the RGB channels to zero.
OH_Drawing_ColorFilter* OH_Drawing_ColorFilterCreateLighting(uint32_t mulColor, uint32_t addColor)	Creates a lighting color filter. It multiplies the RGB channel values by one color and then adds another color value. The final output stays between 0 and 255.
void OH_Drawing_ColorFilterDestroy(OH_Drawing_ColorFilter* colorFilter)	Destroys an OH_Drawing_ColorFilter object and reclaims the memory occupied by the object.

Function Description

OH_Drawing_ColorFilterCreateBlendMode()

OH_Drawing_ColorFilter* OH_Drawing_ColorFilterCreateBlendMode(uint32_t color, OH_Drawing_BlendMode blendMode)

Description

Creates an OH_Drawing_ColorFilter object with a given blend mode.

System capability: SystemCapability.Graphic.Graphic2D.NativeDrawing

Since: 11

Parameters

Name	Description
uint32_t color	Color, which is a 32-bit (ARGB) variable.
OH_Drawing_BlendMode blendMode	Blend mode. For details about the available options, see OH_Drawing_BlendMode.

Returns

Type	Description
OH_Drawing_ColorFilter*	Returns the pointer to the OH_Drawing_ColorFilter object created.

OH_Drawing_ColorFilterCreateCompose()

OH_Drawing_ColorFilter* OH_Drawing_ColorFilterCreateCompose(OH_Drawing_ColorFilter* outerColorFilter,OH_Drawing_ColorFilter* innerColorFilter)

Description

Creates an OH_Drawing_ColorFilter object by combining another two color filters.
This API may return an error code. For details, call OH_Drawing_ErrorCodeGet.
If either outerColorFilter or innerColorFilter is NULL, OH_DRAWING_ERROR_INVALID_PARAMETER is returned.

System capability: SystemCapability.Graphic.Graphic2D.NativeDrawing

Since: 11

Parameters

Name	Description
OH_Drawing_ColorFilter* outerColorFilter	Pointer to the first color filter.
OH_Drawing_ColorFilter* innerColorFilter	Pointer to the second color filter.

Returns

Type	Description
OH_Drawing_ColorFilter*	Returns the pointer to the OH_Drawing_ColorFilter object created.

OH_Drawing_ColorFilterCreateMatrix()

OH_Drawing_ColorFilter* OH_Drawing_ColorFilterCreateMatrix(const float matrix[20])

Description

Creates an OH_Drawing_ColorFilter object with a given 5x4 color matrix.
This API may return an error code. For details, call OH_Drawing_ErrorCodeGet.
If matrix is NULL, OH_DRAWING_ERROR_INVALID_PARAMETER is returned.

System capability: SystemCapability.Graphic.Graphic2D.NativeDrawing

Since: 11

Parameters

Name	Description
matrix	Matrix, which is represented by a floating-point array with a length of 20.

Returns

Type	Description
OH_Drawing_ColorFilter*	Returns the pointer to the OH_Drawing_ColorFilter object created.

OH_Drawing_ColorFilterCreateLinearToSrgbGamma()

OH_Drawing_ColorFilter* OH_Drawing_ColorFilterCreateLinearToSrgbGamma(void)

Description

Creates an OH_Drawing_ColorFilter object that applies the sRGB gamma curve to the RGB channels.

System capability: SystemCapability.Graphic.Graphic2D.NativeDrawing

Since: 11

Returns

Type	Description
OH_Drawing_ColorFilter*	Returns the pointer to the OH_Drawing_ColorFilter object created.

OH_Drawing_ColorFilterCreateSrgbGammaToLinear()

OH_Drawing_ColorFilter* OH_Drawing_ColorFilterCreateSrgbGammaToLinear(void)

Description

Creates an OH_Drawing_ColorFilter object that applies the RGB channels to the sRGB gamma curve.

System capability: SystemCapability.Graphic.Graphic2D.NativeDrawing

Since: 11

Returns

Type	Description
OH_Drawing_ColorFilter*	Returns the pointer to the OH_Drawing_ColorFilter object created.

OH_Drawing_ColorFilterCreateLuma()

OH_Drawing_ColorFilter* OH_Drawing_ColorFilterCreateLuma(void)

Description

Creates a ColorFilter object that multiplies the luma into the alpha channel and sets the RGB channels to zero.

System capability: SystemCapability.Graphic.Graphic2D.NativeDrawing

Since: 11

Returns

Type	Description
OH_Drawing_ColorFilter*	Returns the pointer to the OH_Drawing_ColorFilter object created.

OH_Drawing_ColorFilterCreateLighting()

OH_Drawing_ColorFilter* OH_Drawing_ColorFilterCreateLighting(uint32_t mulColor, uint32_t addColor)

Description

Creates a lighting color filter. It multiplies the RGB channel values by one color and then adds another color value. The final output stays between 0 and 255.

System capability: SystemCapability.Graphic.Graphic2D.NativeDrawing

Since: 20

Parameters

Name	Description
uint32_t mulColor	Color value used for multiplication.
uint32_t addColor	Color value used for addition.

Returns

Type	Description
OH_Drawing_ColorFilter*	Returns the pointer to the OH_Drawing_ColorFilter object created.

OH_Drawing_ColorFilterDestroy()

void OH_Drawing_ColorFilterDestroy(OH_Drawing_ColorFilter* colorFilter)

Description

Destroys an OH_Drawing_ColorFilter object and reclaims the memory occupied by the object.

System capability: SystemCapability.Graphic.Graphic2D.NativeDrawing

Since: 11

Parameters

Name	Description
OH_Drawing_ColorFilter* colorFilter	Pointer to an OH_Drawing_ColorFilter object.

你可能感兴趣的鸿蒙文章

openharmony 鸿蒙 capi-drawing-gpu-context-h

openharmony 鸿蒙 capi-drawing-nativepixelmap-

openharmony 鸿蒙 capi-nativevsync-oh-nativevsync-expectedraterange

openharmony 鸿蒙 capi-drawing-oh-drawing-brush

openharmony 鸿蒙 capi-drawing-oh-drawing-image-info

openharmony 鸿蒙 capi-drawing-text-linetypography-h

openharmony 鸿蒙 capi-oh-nativeimage-oh-nativeimage

openharmony 鸿蒙 capi-drawing-typeface-h

openharmony 鸿蒙 capi-drawing-brush-h

openharmony 鸿蒙 capi-nativewindow