We use essential cookies for the website to function, as well as analytics cookies for analyzing and creating statistics of the website performance. To agree to the use of analytics cookies, click "Accept All". You can manage your preferences at any time by clicking "Cookie Settings" on the footer. More Information.

Cookie Settings
Only Essential Cookies
Accept All
MaterialsConsole

HarmonyOS

输入关键字搜索
HMS Core
AppGallery Connect
HUAWEI HiAI
CTRL+K
Advanced filters
Created with Pixso.
API versionAll
DeviceAll
Atomic service APIsNot filter by this
ReferencesGraphicsArkGraphics 2DC APIsHeader Filesdrawing_filter.h

drawing_filter.h

Phone12+PC/2in113+Tablet12+TV19+Wearable18+
Last updated: 2026-09-04 06:52
Content overview
Expand

Overview

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

File to include: <native_drawing/drawing_filter.h>

Library: libnative_drawing.so

System capability: SystemCapability.Graphic.Graphic2D.NativeDrawing

Since: 11

Related module: Drawing

Summary

Functions

Expand
Name Description
OH_Drawing_Filter* OH_Drawing_FilterCreate(void) Creates an OH_Drawing_Filter object.
void OH_Drawing_FilterSetImageFilter(OH_Drawing_Filter* filter, OH_Drawing_ImageFilter* imageFilter)

Sets an OH_Drawing_ImageFilter object for an OH_Drawing_Filter object.

This API may return an error code. For details, call OH_Drawing_ErrorCodeGet.

If filter is NULL, OH_DRAWING_ERROR_INVALID_PARAMETER is returned.
void OH_Drawing_FilterSetMaskFilter(OH_Drawing_Filter* filter, OH_Drawing_MaskFilter* maskFilter)

Sets an OH_Drawing_MaskFilter object for an OH_Drawing_Filter object.

This API may return an error code. For details, call OH_Drawing_ErrorCodeGet.

If filter is NULL, OH_DRAWING_ERROR_INVALID_PARAMETER is returned.
void OH_Drawing_FilterSetColorFilter(OH_Drawing_Filter* filter, OH_Drawing_ColorFilter* colorFilter)

Sets an OH_Drawing_ColorFilter object for an OH_Drawing_Filter object.

This API may return an error code. For details, call OH_Drawing_ErrorCodeGet.

If filter is NULL, OH_DRAWING_ERROR_INVALID_PARAMETER is returned.
void OH_Drawing_FilterGetColorFilter(OH_Drawing_Filter* filter, OH_Drawing_ColorFilter* colorFilter)

Obtains an OH_Drawing_ColorFilter object from an OH_Drawing_Filter object.

This API may return an error code. For details, call OH_Drawing_ErrorCodeGet.

If either filter or colorFilter is NULL, OH_DRAWING_ERROR_INVALID_PARAMETER is returned.
void OH_Drawing_FilterDestroy(OH_Drawing_Filter* filter) Destroys an OH_Drawing_Filter object and reclaims the memory occupied by the object.

Function Description

OH_Drawing_FilterCreate()

Phone12+PC/2in113+Tablet12+TV19+Wearable18+
Collapse
Word wrap
Dark theme
Copy code
  1. OH_Drawing_Filter* OH_Drawing_FilterCreate(void)

Description

Creates an OH_Drawing_Filter object.

System capability: SystemCapability.Graphic.Graphic2D.NativeDrawing

Since: 11

Return value

Expand
Type Description
OH_Drawing_Filter* Returns the pointer to the OH_Drawing_Filter object created.

OH_Drawing_FilterSetImageFilter()

Phone12+PC/2in113+Tablet12+TV19+Wearable18+
Collapse
Word wrap
Dark theme
Copy code
  1. void OH_Drawing_FilterSetImageFilter(OH_Drawing_Filter* filter, OH_Drawing_ImageFilter* imageFilter)

Description

Sets an OH_Drawing_ImageFilter object for an OH_Drawing_Filter object.

This API may return an error code. For details, call OH_Drawing_ErrorCodeGet.

If filter is NULL, OH_DRAWING_ERROR_INVALID_PARAMETER is returned.

System capability: SystemCapability.Graphic.Graphic2D.NativeDrawing

Since: 12

Parameters

Expand
Name Description
OH_Drawing_Filter* filter Pointer to an OH_Drawing_Filter object.
OH_Drawing_ImageFilter* imageFilter Pointer to an OH_Drawing_ImageFilter object. If NULL is passed in, the image filter effect of the object will be cleared.

OH_Drawing_FilterSetMaskFilter()

Phone12+PC/2in113+Tablet12+TV19+Wearable18+
Collapse
Word wrap
Dark theme
Copy code
  1. void OH_Drawing_FilterSetMaskFilter(OH_Drawing_Filter* filter, OH_Drawing_MaskFilter* maskFilter)

Description

Sets an OH_Drawing_MaskFilter object for an OH_Drawing_Filter object.

This API may return an error code. For details, call OH_Drawing_ErrorCodeGet.

If filter is NULL, OH_DRAWING_ERROR_INVALID_PARAMETER is returned.

System capability: SystemCapability.Graphic.Graphic2D.NativeDrawing

Since: 11

Parameters

Expand
Name Description
OH_Drawing_Filter* filter Pointer to an OH_Drawing_Filter object.
OH_Drawing_MaskFilter* maskFilter Pointer to an OH_Drawing_MaskFilter object. If NULL is passed in, the mask filter effect of the object will be cleared.

OH_Drawing_FilterSetColorFilter()

Phone12+PC/2in113+Tablet12+TV19+Wearable18+
Collapse
Word wrap
Dark theme
Copy code
  1. void OH_Drawing_FilterSetColorFilter(OH_Drawing_Filter* filter, OH_Drawing_ColorFilter* colorFilter)

Description

Sets an OH_Drawing_ColorFilter object for an OH_Drawing_Filter object.

This API may return an error code. For details, call OH_Drawing_ErrorCodeGet.

If filter is NULL, OH_DRAWING_ERROR_INVALID_PARAMETER is returned.

System capability: SystemCapability.Graphic.Graphic2D.NativeDrawing

Since: 11

Parameters

Expand
Name Description
OH_Drawing_Filter* filter Pointer to an OH_Drawing_Filter object.
OH_Drawing_ColorFilter* colorFilter Pointer to an OH_Drawing_ColorFilter object. If NULL is passed in, the color filter effect of the object will be cleared.

OH_Drawing_FilterGetColorFilter()

Phone12+PC/2in113+Tablet12+TV19+Wearable18+
Collapse
Word wrap
Dark theme
Copy code
  1. void OH_Drawing_FilterGetColorFilter(OH_Drawing_Filter* filter, OH_Drawing_ColorFilter* colorFilter)

Description

Obtains an OH_Drawing_ColorFilter object from an OH_Drawing_Filter object.

This API may return an error code. For details, call OH_Drawing_ErrorCodeGet.

If either filter or colorFilter is NULL, OH_DRAWING_ERROR_INVALID_PARAMETER is returned.

System capability: SystemCapability.Graphic.Graphic2D.NativeDrawing

Since: 12

Parameters

Expand
Name Description
OH_Drawing_Filter* filter Pointer to an OH_Drawing_Filter object.
OH_Drawing_ColorFilter* colorFilter Pointer to an OH_Drawing_ColorFilter object.

OH_Drawing_FilterDestroy()

Phone12+PC/2in113+Tablet12+TV19+Wearable18+
Collapse
Word wrap
Dark theme
Copy code
  1. void OH_Drawing_FilterDestroy(OH_Drawing_Filter* filter)

Description

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

System capability: SystemCapability.Graphic.Graphic2D.NativeDrawing

Since: 11

Parameters

Expand
Name Description
OH_Drawing_Filter* filter Pointer to an OH_Drawing_Filter object.
drawing_error_code.h
drawing_font.h
English
©2026 HUAWEI Developers. All rights reserved.
Terms of Use
Statement About HUAWEI Developers and Privacy
Cookies
Cookie Settings
Open-Source Software Notice
Search in References
Enter a keyword.