drawing_filter.h

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

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()

OH_Drawing_Filter* OH_Drawing_FilterCreate(void)

Description

Creates an OH_Drawing_Filter object.

System capability: SystemCapability.Graphic.Graphic2D.NativeDrawing

Since: 11

Return value

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

OH_Drawing_FilterSetImageFilter()

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

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()

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

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()

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

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()

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

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()

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

Name	Description
OH_Drawing_Filter* filter	Pointer to an OH_Drawing_Filter 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