effect_types.h

Overview

This file declares the data types of the image effect filter.

File to include: <native_effect/effect_types.h>

Library: libnative_effect.so

System capability: SystemCapability.Multimedia.Image.Core

Since: 12

Related module: effectKit

Name	typedef Keyword	Description
OH_Filter_ColorMatrix	-	Describes a matrix used to create an effect filter.
OH_Filter	OH_Filter	Defines a struct for a filter used to generate a filter PixelMap.
OH_PixelmapNative	OH_PixelmapNative	Defines a struct for a PixelMap.

Name	typedef Keyword	Description
EffectErrorCode	EffectErrorCode	Enumerates the status codes that may be used by the effect filter.
EffectTileMode	EffectTileMode	Enumerates the tile modes of the shader effect.

enum EffectErrorCode

Description

Enumerates the status codes that may be used by the effect filter.

Since: 12

Value	Description
EFFECT_SUCCESS = 0	Operation successful.
EFFECT_BAD_PARAMETER = 401	Invalid parameter.
EFFECT_UNSUPPORTED_OPERATION = 7600201	Unsupported operation.
EFFECT_UNKNOWN_ERROR = 7600901	Unknown error.

enum EffectTileMode

Description

Enumerates the tile modes of the shader effect.

Since: 14

Value	Description
CLAMP = 0	Replicates the edge color if the shader effect draws outside of its original boundary.
REPEAT	Repeats the shader effect in both horizontal and vertical directions.
MIRROR	Repeats the shader effect in both horizontal and vertical directions, alternating mirror images.
DECAL	Renders the shader effect only within the original boundary.