openharmony 鸿蒙 capi-drawing-brush-h

2025-06-12 浏览 (1)

drawing_brush.h

概述

文件中定义了与画刷相关的功能函数。

相关示例： NDKAPIDrawing (API14)

引用文件： <native_drawing/drawing_brush.h>

库： libnative_drawing.so

起始版本： 8

相关模块： Drawing

汇总

函数

名称描述
OH_Drawing_Brush* OH_Drawing_BrushCreate(void)用于创建一个画刷对象。
OH_Drawing_Brush* OH_Drawing_BrushCopy(OH_Drawing_Brush* brush)创建一个画刷对象副本OH_Drawing_Brush，用于拷贝一个已有画刷对象。
本接口会产生错误码，可以通过OH_Drawing_ErrorCodeGet查看错误码的取值。
brush为NULL时返回OH_DRAWING_ERROR_INVALID_PARAMETER。
void OH_Drawing_BrushDestroy(OH_Drawing_Brush* brush)用于销毁画刷对象并回收该对象占有的内存。
bool OH_Drawing_BrushIsAntiAlias(const OH_Drawing_Brush* brush)用于获取画刷是否设置抗锯齿属性，如果为真则说明画刷会启用抗锯齿功能，在绘制图形时会对图形的边缘像素进行半透明的模糊处理。
本接口会产生错误码，可以通过OH_Drawing_ErrorCodeGet查看错误码的取值。
brush为NULL时返回OH_DRAWING_ERROR_INVALID_PARAMETER。
void OH_Drawing_BrushSetAntiAlias(OH_Drawing_Brush* brush, bool antiAlias)用于设置画刷的抗锯齿属性，设置为真则画刷在绘制图形时会对图形的边缘像素进行半透明的模糊处理。
本接口会产生错误码，可以通过OH_Drawing_ErrorCodeGet查看错误码的取值。
brush为NULL时返回OH_DRAWING_ERROR_INVALID_PARAMETER。
uint32_t OH_Drawing_BrushGetColor(const OH_Drawing_Brush* brush)用于获取画刷的颜色属性，颜色属性描述了画刷填充图形时使用的颜色，用一个32位（ARGB）的变量表示。
本接口会产生错误码，可以通过OH_Drawing_ErrorCodeGet查看错误码的取值。
brush为NULL时返回OH_DRAWING_ERROR_INVALID_PARAMETER。
void OH_Drawing_BrushSetColor(OH_Drawing_Brush* brush, uint32_t color)用于设置画刷的颜色属性，颜色属性描述了画刷填充图形时使用的颜色，用一个32位（ARGB）的变量表示。
本接口会产生错误码，可以通过OH_Drawing_ErrorCodeGet查看错误码的取值。
brush为NULL时返回OH_DRAWING_ERROR_INVALID_PARAMETER。
uint8_t OH_Drawing_BrushGetAlpha(const OH_Drawing_Brush* brush)获取画刷的透明度值。画刷在填充形状时透明通道会使用该值。
本接口会产生错误码，可以通过OH_Drawing_ErrorCodeGet查看错误码的取值。
brush为NULL时返回OH_DRAWING_ERROR_INVALID_PARAMETER。
void OH_Drawing_BrushSetAlpha(OH_Drawing_Brush* brush, uint8_t alpha)为画刷设置透明度值。画刷在填充形状时透明通道会使用该值。
本接口会产生错误码，可以通过OH_Drawing_ErrorCodeGet查看错误码的取值。
brush为NULL时返回OH_DRAWING_ERROR_INVALID_PARAMETER。
void OH_Drawing_BrushSetShaderEffect(OH_Drawing_Brush* brush, OH_Drawing_ShaderEffect* shaderEffect)为画刷设置着色器效果。
本接口会产生错误码，可以通过OH_Drawing_ErrorCodeGet查看错误码的取值。
brush为NULL时返回OH_DRAWING_ERROR_INVALID_PARAMETER。
void OH_Drawing_BrushSetShadowLayer(OH_Drawing_Brush* brush, OH_Drawing_ShadowLayer* shadowLayer)为画刷设置阴影层，设置的阴影层效果当前仅在绘制文字时生效。
本接口会产生错误码，可以通过OH_Drawing_ErrorCodeGet查看错误码的取值。
brush为NULL时返回OH_DRAWING_ERROR_INVALID_PARAMETER。
void OH_Drawing_BrushSetFilter(OH_Drawing_Brush* brush, OH_Drawing_Filter* filter)为画刷设置滤波器OH_Drawing_Filter。滤波器是一个容器，可以承载蒙版滤波器和颜色滤波器。
本接口会产生错误码，可以通过OH_Drawing_ErrorCodeGet查看错误码的取值。
brush为NULL时返回OH_DRAWING_ERROR_INVALID_PARAMETER。
void OH_Drawing_BrushGetFilter(OH_Drawing_Brush* brush, OH_Drawing_Filter* filter)从画刷获取滤波器OH_Drawing_Filter。滤波器是一个容器，可以承载蒙版滤波器和颜色滤波器。
本接口会产生错误码，可以通过OH_Drawing_ErrorCodeGet查看错误码的取值。
brush、filter任意一个为NULL时返回OH_DRAWING_ERROR_INVALID_PARAMETER。
void OH_Drawing_BrushSetBlendMode(OH_Drawing_Brush* brush, OH_Drawing_BlendMode blendMode)为画刷设置一个混合器，该混合器实现了指定的混合模式枚举。
本接口会产生错误码，可以通过OH_Drawing_ErrorCodeGet查看错误码的取值。
brush为NULL时返回OH_DRAWING_ERROR_INVALID_PARAMETER；
blendMode不在枚举范围内时返回OH_DRAWING_ERROR_PARAMETER_OUT_OF_RANGE。
void OH_Drawing_BrushReset(OH_Drawing_Brush* brush)将画刷重置至初始状态，清空所有已设置的属性。
本接口会产生错误码，可以通过OH_Drawing_ErrorCodeGet查看错误码的取值。
brush为NULL时返回OH_DRAWING_ERROR_INVALID_PARAMETER。

函数说明

OH_Drawing_BrushCreate()

OH_Drawing_Brush* OH_Drawing_BrushCreate(void)

描述

用于创建一个画刷对象。

系统能力： SystemCapability.Graphic.Graphic2D.NativeDrawing

起始版本： 8

返回：

类型说明
OH_Drawing_Brush*函数会返回一个指针，指针指向创建的画刷对象。

OH_Drawing_BrushCopy()

OH_Drawing_Brush* OH_Drawing_BrushCopy(OH_Drawing_Brush* brush)

描述

创建一个画刷对象副本OH_Drawing_Brush，用于拷贝一个已有画刷对象。
本接口会产生错误码，可以通过OH_Drawing_ErrorCodeGet查看错误码的取值。
brush为NULL时返回OH_DRAWING_ERROR_INVALID_PARAMETER。

系统能力： SystemCapability.Graphic.Graphic2D.NativeDrawing

起始版本： 12

参数：

参数项描述
OH_Drawing_Brush* brush指向画刷对象的指针。

返回：

类型说明
OH_Drawing_Brush*函数会返回一个指针，指针指向创建的画刷对象副本OH_Drawing_Brush。如果对象返回NULL，表示创建失败；可能的原因是可用内存为空，或者是brush为NULL。

OH_Drawing_BrushDestroy()

void OH_Drawing_BrushDestroy(OH_Drawing_Brush* brush)

描述

用于销毁画刷对象并回收该对象占有的内存。

系统能力： SystemCapability.Graphic.Graphic2D.NativeDrawing

起始版本： 8

参数：

参数项描述
OH_Drawing_Brush* brush指向画刷对象的指针。

OH_Drawing_BrushIsAntiAlias()

bool OH_Drawing_BrushIsAntiAlias(const OH_Drawing_Brush* brush)

描述

用于获取画刷是否设置抗锯齿属性，如果为真则说明画刷会启用抗锯齿功能，在绘制图形时会对图形的边缘像素进行半透明的模糊处理。
本接口会产生错误码，可以通过OH_Drawing_ErrorCodeGet查看错误码的取值。
brush为NULL时返回OH_DRAWING_ERROR_INVALID_PARAMETER。

系统能力： SystemCapability.Graphic.Graphic2D.NativeDrawing

起始版本： 8

参数：

参数项描述
const OH_Drawing_Brush* brush指向画刷对象的指针。

返回：

类型说明
bool函数返回画刷对象是否设置抗锯齿属性，返回真则设置了抗锯齿，返回假则没有设置抗锯齿。

OH_Drawing_BrushSetAntiAlias()

void OH_Drawing_BrushSetAntiAlias(OH_Drawing_Brush* brush, bool antiAlias)

描述

用于设置画刷的抗锯齿属性，设置为真则画刷在绘制图形时会对图形的边缘像素进行半透明的模糊处理。
本接口会产生错误码，可以通过OH_Drawing_ErrorCodeGet查看错误码的取值。
brush为NULL时返回OH_DRAWING_ERROR_INVALID_PARAMETER。

系统能力： SystemCapability.Graphic.Graphic2D.NativeDrawing

起始版本： 8

参数：

参数项描述
OH_Drawing_Brush* brush指向画刷对象的指针。
bool antiAlias真为抗锯齿，假则不做抗锯齿处理。

OH_Drawing_BrushGetColor()

uint32_t OH_Drawing_BrushGetColor(const OH_Drawing_Brush* brush)

描述

用于获取画刷的颜色属性，颜色属性描述了画刷填充图形时使用的颜色，用一个32位（ARGB）的变量表示。
本接口会产生错误码，可以通过OH_Drawing_ErrorCodeGet查看错误码的取值。
brush为NULL时返回OH_DRAWING_ERROR_INVALID_PARAMETER。

系统能力： SystemCapability.Graphic.Graphic2D.NativeDrawing

起始版本： 8

参数：

参数项描述
const OH_Drawing_Brush* brush指向画刷对象的指针。

返回：

类型说明
uint32_t函数返回一个描述颜色的32位（ARGB）变量。

OH_Drawing_BrushSetColor()

void OH_Drawing_BrushSetColor(OH_Drawing_Brush* brush, uint32_t color)

描述

用于设置画刷的颜色属性，颜色属性描述了画刷填充图形时使用的颜色，用一个32位（ARGB）的变量表示。
本接口会产生错误码，可以通过OH_Drawing_ErrorCodeGet查看错误码的取值。
brush为NULL时返回OH_DRAWING_ERROR_INVALID_PARAMETER。

系统能力： SystemCapability.Graphic.Graphic2D.NativeDrawing

起始版本： 8

参数：

参数项描述
OH_Drawing_Brush* brush指向画刷对象的指针。
uint32_t color描述颜色的32位（ARGB）变量。

OH_Drawing_BrushGetAlpha()

uint8_t OH_Drawing_BrushGetAlpha(const OH_Drawing_Brush* brush)

描述

获取画刷的透明度值。画刷在填充形状时透明通道会使用该值。
本接口会产生错误码，可以通过OH_Drawing_ErrorCodeGet查看错误码的取值。
brush为NULL时返回OH_DRAWING_ERROR_INVALID_PARAMETER。

系统能力： SystemCapability.Graphic.Graphic2D.NativeDrawing

起始版本： 11

参数：

参数项描述
const OH_Drawing_Brush* brush表示指向画刷对象的指针。

返回：

类型说明
uint8_t返回一个8位变量，用于表示透明度值。

OH_Drawing_BrushSetAlpha()

void OH_Drawing_BrushSetAlpha(OH_Drawing_Brush* brush, uint8_t alpha)

描述

为画刷设置透明度值。画刷在填充形状时透明通道会使用该值。
本接口会产生错误码，可以通过OH_Drawing_ErrorCodeGet查看错误码的取值。
brush为NULL时返回OH_DRAWING_ERROR_INVALID_PARAMETER。

系统能力： SystemCapability.Graphic.Graphic2D.NativeDrawing

起始版本： 11

参数：

参数项描述
OH_Drawing_Brush* brush指向画刷对象的指针。
uint8_t alpha表示要设置的透明度值，是一个8位变量。

OH_Drawing_BrushSetShaderEffect()

void OH_Drawing_BrushSetShaderEffect(OH_Drawing_Brush* brush, OH_Drawing_ShaderEffect* shaderEffect)

描述

为画刷设置着色器效果。
本接口会产生错误码，可以通过OH_Drawing_ErrorCodeGet查看错误码的取值。
brush为NULL时返回OH_DRAWING_ERROR_INVALID_PARAMETER。

系统能力： SystemCapability.Graphic.Graphic2D.NativeDrawing

起始版本： 11

参数：

参数项描述
OH_Drawing_Brush* brush指向画刷对象的指针。
OH_Drawing_ShaderEffect* shaderEffect表示指向着色器对象的指针，为NULL表示清空画刷的着色器效果。

OH_Drawing_BrushSetShadowLayer()

void OH_Drawing_BrushSetShadowLayer(OH_Drawing_Brush* brush, OH_Drawing_ShadowLayer* shadowLayer)

描述

为画刷设置阴影层，设置的阴影层效果当前仅在绘制文字时生效。
本接口会产生错误码，可以通过OH_Drawing_ErrorCodeGet查看错误码的取值。
brush为NULL时返回OH_DRAWING_ERROR_INVALID_PARAMETER。

系统能力： SystemCapability.Graphic.Graphic2D.NativeDrawing

起始版本： 12

参数：

参数项描述
OH_Drawing_Brush* brush指向画刷对象的指针。
OH_Drawing_ShadowLayer* shadowLayer表示指向阴影层的指针，为NULL表示清空画刷的阴影层效果。

OH_Drawing_BrushSetFilter()

void OH_Drawing_BrushSetFilter(OH_Drawing_Brush* brush, OH_Drawing_Filter* filter)

描述

为画刷设置滤波器OH_Drawing_Filter。滤波器是一个容器，可以承载蒙版滤波器和颜色滤波器。
本接口会产生错误码，可以通过OH_Drawing_ErrorCodeGet查看错误码的取值。
brush为NULL时返回OH_DRAWING_ERROR_INVALID_PARAMETER。

系统能力： SystemCapability.Graphic.Graphic2D.NativeDrawing

起始版本： 11

参数：

参数项描述
OH_Drawing_Brush* brush指向画刷对象的指针。
OH_Drawing_Filter* filter表示指向滤波器对象的指针，为NULL表示清空画刷滤波器。

OH_Drawing_BrushGetFilter()

void OH_Drawing_BrushGetFilter(OH_Drawing_Brush* brush, OH_Drawing_Filter* filter)

描述

从画刷获取滤波器OH_Drawing_Filter。滤波器是一个容器，可以承载蒙版滤波器和颜色滤波器。
本接口会产生错误码，可以通过OH_Drawing_ErrorCodeGet查看错误码的取值。
brush、filter任意一个为NULL时返回OH_DRAWING_ERROR_INVALID_PARAMETER。

系统能力： SystemCapability.Graphic.Graphic2D.NativeDrawing

起始版本： 12

参数：

参数项描述
OH_Drawing_Brush* brush指向画刷对象OH_Drawing_Brush的指针。
OH_Drawing_Filter* filter表示指向滤波器对象OH_Drawing_Filter的指针。

OH_Drawing_BrushSetBlendMode()

void OH_Drawing_BrushSetBlendMode(OH_Drawing_Brush* brush, OH_Drawing_BlendMode blendMode)

描述

为画刷设置一个混合器，该混合器实现了指定的混合模式枚举。
本接口会产生错误码，可以通过OH_Drawing_ErrorCodeGet查看错误码的取值。
brush为NULL时返回OH_DRAWING_ERROR_INVALID_PARAMETER；
blendMode不在枚举范围内时返回OH_DRAWING_ERROR_PARAMETER_OUT_OF_RANGE。

系统能力： SystemCapability.Graphic.Graphic2D.NativeDrawing

起始版本： 12

参数：

参数项描述
OH_Drawing_Brush* brush指向画刷对象OH_Drawing_Brush的指针。
OH_Drawing_BlendMode blendMode混合模式枚举类型OH_Drawing_BlendMode。

OH_Drawing_BrushReset()

void OH_Drawing_BrushReset(OH_Drawing_Brush* brush)

描述

将画刷重置至初始状态，清空所有已设置的属性。
本接口会产生错误码，可以通过OH_Drawing_ErrorCodeGet查看错误码的取值。
brush为NULL时返回OH_DRAWING_ERROR_INVALID_PARAMETER。

系统能力： SystemCapability.Graphic.Graphic2D.NativeDrawing

起始版本： 12

参数：

参数项描述
OH_Drawing_Brush* brush指向画刷对象OH_Drawing_Brush的指针。

你可能感兴趣的鸿蒙文章

harmony 鸿蒙ArkGraphics 2D（方舟2D图形服务）

harmony 鸿蒙buffer_common.h

harmony 鸿蒙buffer_handle.h

harmony 鸿蒙BufferHandle

harmony 鸿蒙ColorSpacePrimaries

harmony 鸿蒙DisplaySoloist_ExpectedRateRange

harmony 鸿蒙drawing_bitmap.h

harmony 鸿蒙drawing_canvas.h

harmony 鸿蒙drawing_color_filter.h

harmony 鸿蒙drawing_color.h

  • 所属分类： 后端技术
  • 本文标签： 鸿蒙 软件
  • 版权声明： 本文链接 https://seaxiang.com/blog/QgxE1g