提供NativeRender接口的类型定义，支持创建和管理渲染节点、设置渲染属性、自定义绘制内容，以及配置遮罩、裁剪和模糊效果，适用于在Native侧构建和管理自定义渲染节点树、扩展自定义绘制效果的场景。更多详细介绍请参考构建渲染节点。
引用文件： <arkui/native_render.h>
库： libace_ndk.z.so
系统能力： SystemCapability.ArkUI.ArkUI.Full
起始版本： 20
相关模块： ArkUI_RenderNodeUtils
相关示例： NativeRenderNodeSample
| 名称 | typedef关键字 | 描述 |
|---|---|---|
| ArkUI_RenderNode* | ArkUI_RenderNodeHandle | 定义渲染节点指针，用于在ArkUI_RenderNodeUtils相关接口中表示和传递渲染节点对象。 |
| ArkUI_RenderContentModifier* | ArkUI_RenderContentModifierHandle | 定义渲染内容修改器指针，用于引用内容修改器。内容修改器可挂载到渲染节点，并附加渲染属性或设置onDraw回调。 |
| ArkUI_FloatProperty* | ArkUI_FloatPropertyHandle | 定义ArkUI原生浮点渲染属性指针，用于创建、传递并管理目标内容修改器上的浮点属性。 |
| ArkUI_Vector2Property* | ArkUI_Vector2PropertyHandle | 定义二维向量属性指针，用于在ArkUI原生渲染属性接口中创建、附加、设置、获取和释放二维向量属性。 |
| ArkUI_ColorProperty* | ArkUI_ColorPropertyHandle | 定义颜色属性指针，用于表示ArkUI中的颜色属性。 |
| ArkUI_FloatAnimatableProperty* | ArkUI_FloatAnimatablePropertyHandle | 可动画的浮点数属性指针。 |
| ArkUI_Vector2AnimatableProperty* | ArkUI_Vector2AnimatablePropertyHandle | 可动画的二维向量属性指针。 |
| ArkUI_ColorAnimatableProperty* | ArkUI_ColorAnimatablePropertyHandle | 可动画的颜色属性指针。 |
| ArkUI_RectShape | ArkUI_RectShapeOption | 定义矩形形状配置项，用于在ArkUI渲染节点中描述矩形或椭圆形的形状范围，可作为创建遮罩或裁剪配置项的输入。 |
| ArkUI_NodeBorderStyle | ArkUI_NodeBorderStyleOption | 定义边框样式配置项，用于设置节点边框的样式类型，支持实线、虚线、点线等多种样式。 |
| ArkUI_NodeBorderWidth | ArkUI_NodeBorderWidthOption | 定义边框宽度配置项，用于配置渲染节点各边的边框宽度。 |
| ArkUI_NodeBorderColor | ArkUI_NodeBorderColorOption | 定义节点边框颜色配置项，用于按边方向设置渲染节点的边框颜色。 |
| ArkUI_NodeBorderRadius | ArkUI_NodeBorderRadiusOption | 边框半径配置项。 |
| ArkUI_CircleShape | ArkUI_CircleShapeOption | 定义圆形形状配置项，用于在ArkUI_RenderNodeUtils中创建圆形形状，并配置圆心坐标和半径，作为RenderNode的遮罩或裁剪形状。 |
| ArkUI_RoundRectShape | ArkUI_RoundRectShapeOption | 定义圆角矩形形状配置项，用于配置圆角矩形形状，并可用于创建渲染节点遮罩或裁剪。 |
| ArkUI_CommandPath | ArkUI_CommandPathOption | 定义自定义绘制路径配置项，用于为渲染节点创建基于路径的遮罩或裁剪效果。 |
| ArkUI_RenderNodeMaskOption | ArkUI_RenderNodeMaskOption | 定义渲染节点遮罩配置项，用于通过矩形、圆角矩形、圆形、椭圆形或自定义绘制路径描述渲染节点的遮罩区域，并作为OH_ArkUI_RenderNodeUtils_SetMask的入参为渲染节点应用遮罩。 |
| ArkUI_RenderNodeClipOption | ArkUI_RenderNodeClipOption | 定义渲染节点裁剪配置项，用于通过矩形、圆角矩形、圆形、椭圆形或自定义绘制路径描述渲染节点的裁剪区域，并作为OH_ArkUI_RenderNodeUtils_SetClip的入参为渲染节点应用裁剪。 |
| ArkUI_RenderBlurStyleOption | ArkUI_RenderBlurStyleOption | 定义模糊样式结构体。 |
int32_t OH_ArkUI_RenderNodeUtils_AddRenderNode(ArkUI_NodeHandle node, ArkUI_RenderNodeHandle child)
描述：
向父自定义节点添加子渲染节点。
父节点仅支持ArkUI_NodeType中ARKUI_NODE_CUSTOM类型的节点。默认使用OH_ARKUI_NODE_MOUNT_POLICY_SINGLE_IF_RENDER_NODE挂载策略时，自定义节点只能挂载一个子渲染节点，且不能同时挂载其他类型的子节点。从API版本26.0.0开始，可通过OH_ArkUI_NativeModule_SetChildMountPolicy将挂载策略设置为OH_ARKUI_NODE_MOUNT_POLICY_MIXED，以支持混合挂载多个子节点。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_NodeHandle node | 目标父节点。 |
| ArkUI_RenderNodeHandle child | 待添加的子渲染节点。 |
返回：
| 类型 | 说明 |
|---|---|
| int32_t | 错误码。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_CAPI_INIT_ERROR CAPI初始化失败。 ARKUI_ERROR_CODE_NOT_CUSTOM_NODE 目标节点非自定义节点。 ARKUI_ERROR_CODE_CHILD_EXISTED 使用非OH_ARKUI_NODE_MOUNT_POLICY_MIXED挂载策略时，父节点已有子节点。 ARKUI_ERROR_CODE_RENDER_PARENT_EXISTED 目标渲染节点存在父节点。 ARKUI_ERROR_CODE_RENDER_HAS_INVALID_FRAME_NODE 当前渲染节点从FrameNode中获取且该FrameNode已被取消接纳为附属节点或销毁。从API version 22开始支持。 |
int32_t OH_ArkUI_RenderNodeUtils_RemoveRenderNode(ArkUI_NodeHandle node, ArkUI_RenderNodeHandle child)
描述：
从父节点移除指定的子渲染节点。
父节点仅支持ArkUI_NodeType中ARKUI_NODE_CUSTOM类型的节点。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_NodeHandle node | 目标父节点。 |
| ArkUI_RenderNodeHandle child | 移除的目标子渲染节点。 |
返回：
| 类型 | 说明 |
|---|---|
| int32_t | 错误码。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_CAPI_INIT_ERROR CAPI初始化失败。 ARKUI_ERROR_CODE_NOT_CUSTOM_NODE 目标节点非自定义节点。 |
int32_t OH_ArkUI_RenderNodeUtils_ClearRenderNodeChildren(ArkUI_NodeHandle node)
描述：
清除父节点内的子渲染节点。
父节点仅支持ArkUI_NodeType中ARKUI_NODE_CUSTOM类型的节点。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_NodeHandle node | 目标父节点。 |
返回：
| 类型 | 说明 |
|---|---|
| int32_t | 错误码。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_CAPI_INIT_ERROR CAPI初始化失败。 ARKUI_ERROR_CODE_NOT_CUSTOM_NODE 目标节点非自定义节点。 |
int32_t OH_ArkUI_RenderNodeUtils_Invalidate(ArkUI_NodeHandle node)
描述：
标记目标节点，触发其生命周期和子节点的重新渲染。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_NodeHandle node | 目标节点。 |
返回：
| 类型 | 说明 |
|---|---|
| int32_t | 错误码。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_CAPI_INIT_ERROR CAPI初始化失败。 |
ArkUI_RenderNodeHandle OH_ArkUI_RenderNodeUtils_CreateNode()
描述：
创建渲染节点。
使用完毕后调用OH_ArkUI_RenderNodeUtils_DisposeNode销毁并释放资源。
起始版本： 20
返回：
| 类型 | 说明 |
|---|---|
| ArkUI_RenderNodeHandle | 目标渲染节点。 |
int32_t OH_ArkUI_RenderNodeUtils_DisposeNode(ArkUI_RenderNodeHandle node)
描述：
销毁渲染节点。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_RenderNodeHandle node | 目标渲染节点。 |
返回：
| 类型 | 说明 |
|---|---|
| int32_t | 错误码。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_CAPI_INIT_ERROR CAPI初始化失败。 |
int32_t OH_ArkUI_RenderNodeUtils_AddChild(ArkUI_RenderNodeHandle node, ArkUI_RenderNodeHandle child)
描述：
向目标父渲染节点上添加子节点。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_RenderNodeHandle node | 目标父渲染节点。 |
| ArkUI_RenderNodeHandle child | 目标添加子渲染节点。 |
返回：
| 类型 | 说明 |
|---|---|
| int32_t | 错误码。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_CAPI_INIT_ERROR CAPI初始化失败。 ARKUI_ERROR_CODE_RENDER_IS_FROM_FRAME_NODE 目标节点是从一个FrameNode获取的。从API version 22开始支持。 ARKUI_ERROR_CODE_RENDER_HAS_INVALID_FRAME_NODE 当前渲染节点从FrameNode中获取且该FrameNode已被取消接纳为附属节点或销毁。从API version 22开始支持。 |
int32_t OH_ArkUI_RenderNodeUtils_InsertChildAfter(ArkUI_RenderNodeHandle node, ArkUI_RenderNodeHandle child, ArkUI_RenderNodeHandle sibling)
描述：
向父节点的目标子节点后添加子节点。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_RenderNodeHandle node | 目标父渲染节点。 |
| ArkUI_RenderNodeHandle child | 待添加的子渲染节点。 |
| ArkUI_RenderNodeHandle sibling | 目标子节点，用于确定插入位置的参考兄弟渲染节点。若该节点不在node的当前子节点列表中，则将child追加到末尾。 |
返回：
| 类型 | 说明 |
|---|---|
| int32_t | 错误码。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_CAPI_INIT_ERROR CAPI初始化失败。 ARKUI_ERROR_CODE_RENDER_IS_FROM_FRAME_NODE 目标节点是从一个FrameNode获取的。从API version 22开始支持。 ARKUI_ERROR_CODE_RENDER_HAS_INVALID_FRAME_NODE 当前渲染节点从FrameNode中获取且该FrameNode已被取消接纳为附属节点或销毁。从API version 22开始支持。 |
int32_t OH_ArkUI_RenderNodeUtils_RemoveChild(ArkUI_RenderNodeHandle node, ArkUI_RenderNodeHandle child)
描述：
从指定渲染节点中移除子节点。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_RenderNodeHandle node | 目标父渲染节点。 |
| ArkUI_RenderNodeHandle child | 目标被移除子渲染节点。 |
返回：
| 类型 | 说明 |
|---|---|
| int32_t | 错误码。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_CAPI_INIT_ERROR CAPI初始化失败。 ARKUI_ERROR_CODE_RENDER_IS_FROM_FRAME_NODE 目标节点是从一个FrameNode获取的。从API version 22开始支持。 |
int32_t OH_ArkUI_RenderNodeUtils_ClearChildren(ArkUI_RenderNodeHandle node)
描述：
清空指定渲染节点的所有子节点。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_RenderNodeHandle node | 目标渲染节点。 |
返回：
| 类型 | 说明 |
|---|---|
| int32_t | 错误码。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_CAPI_INIT_ERROR CAPI初始化失败。 ARKUI_ERROR_CODE_RENDER_IS_FROM_FRAME_NODE 目标节点是从一个FrameNode获取的。从API version 22开始支持。 |
int32_t OH_ArkUI_RenderNodeUtils_GetChild(ArkUI_RenderNodeHandle node, int32_t index, ArkUI_RenderNodeHandle* child)
描述：
获取指定索引位置的子节点。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_RenderNodeHandle node | 目标父渲染节点。 |
| int32_t index | 子节点索引，取值范围为[0, 子节点数量-1]。index小于0时返回ARKUI_ERROR_CODE_PARAM_INVALID；index大于等于子节点数量时返回ARKUI_ERROR_CODE_RENDER_CHILD_NOT_EXIST。 |
| ArkUI_RenderNodeHandle* child | 用于接收子节点的渲染节点指针。 |
返回：
| 类型 | 说明 |
|---|---|
| int32_t | 错误码。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_CAPI_INIT_ERROR CAPI初始化失败。 ARKUI_ERROR_CODE_RENDER_CHILD_NOT_EXIST 未找到对应的渲染子节点。 ARKUI_ERROR_CODE_RENDER_IS_FROM_FRAME_NODE 目标节点是从一个FrameNode获取的。从API version 22开始支持。 |
int32_t OH_ArkUI_RenderNodeUtils_GetFirstChild(ArkUI_RenderNodeHandle node, ArkUI_RenderNodeHandle* child)
描述：
获取指定渲染节点的第一个子节点。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_RenderNodeHandle node | 目标渲染节点。 |
| ArkUI_RenderNodeHandle* child | 用于接收第一个子节点的渲染节点指针。 |
返回：
| 类型 | 说明 |
|---|---|
| int32_t | 错误码。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_CAPI_INIT_ERROR CAPI初始化失败。 ARKUI_ERROR_CODE_RENDER_CHILD_NOT_EXIST 未找到对应的渲染子节点。 ARKUI_ERROR_CODE_RENDER_IS_FROM_FRAME_NODE 目标节点是从一个FrameNode获取的。从API version 22开始支持。 |
int32_t OH_ArkUI_RenderNodeUtils_GetNextSibling(ArkUI_RenderNodeHandle node, ArkUI_RenderNodeHandle* sibling)
描述：
获取指定节点的下一个兄弟节点。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_RenderNodeHandle node | 参考节点。 |
| ArkUI_RenderNodeHandle* sibling | 用于接收下一个兄弟节点的渲染节点指针。 |
返回：
| 类型 | 说明 |
|---|---|
| int32_t | 错误码。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_CAPI_INIT_ERROR CAPI初始化失败。 ARKUI_ERROR_CODE_RENDER_CHILD_NOT_EXIST 未找到对应的渲染子节点。 |
int32_t OH_ArkUI_RenderNodeUtils_GetPreviousSibling(ArkUI_RenderNodeHandle node, ArkUI_RenderNodeHandle* sibling)
描述：
获取指定节点的上一个兄弟节点。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_RenderNodeHandle node | 参考节点。 |
| ArkUI_RenderNodeHandle* sibling | 用于接收上一个兄弟节点的渲染节点指针。 |
返回：
| 类型 | 说明 |
|---|---|
| int32_t | 错误码。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_CAPI_INIT_ERROR CAPI初始化失败。 ARKUI_ERROR_CODE_RENDER_CHILD_NOT_EXIST 未找到对应的渲染子节点。 |
int32_t OH_ArkUI_RenderNodeUtils_GetChildren(ArkUI_RenderNodeHandle node, ArkUI_RenderNodeHandle** children, int32_t* count)
描述：
获取父渲染节点的所有子渲染节点。
调用者负责释放返回的子节点数组。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_RenderNodeHandle node | 目标父渲染节点。 |
| ArkUI_RenderNodeHandle** children | 用于存储所有子渲染节点的指针数组。 |
| int32_t* count | 用于存储获取到的子节点数量的指针。 |
返回：
| 类型 | 说明 |
|---|---|
| int32_t | 错误码。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_CAPI_INIT_ERROR CAPI初始化失败。 ARKUI_ERROR_CODE_RENDER_IS_FROM_FRAME_NODE 目标节点是从一个FrameNode获取的。从API version 22开始支持。 |
int32_t OH_ArkUI_RenderNodeUtils_GetChildrenCount(ArkUI_RenderNodeHandle node, int32_t* count)
描述：
获取指定渲染节点的子渲染节点数量。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_RenderNodeHandle node | 目标父渲染节点。 |
| int32_t* count | 用于存储子节点数量的指针。 |
返回：
| 类型 | 说明 |
|---|---|
| int32_t | 错误码。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_CAPI_INIT_ERROR CAPI初始化失败。 ARKUI_ERROR_CODE_RENDER_IS_FROM_FRAME_NODE 目标节点是从一个FrameNode获取的。从API version 22开始支持。 |
int32_t OH_ArkUI_RenderNodeUtils_SetBackgroundColor(ArkUI_RenderNodeHandle node, uint32_t color)
描述：
为渲染节点设置背景颜色。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_RenderNodeHandle node | 目标渲染节点。 |
| uint32_t color | ARGB 颜色值（32 位无符号整数）。 默认值：0x00000000。 颜色字节布局说明： - 位24-31：Alpha通道（0x00完全透明，0xFF完全不透明）。 - 位16-23：红色通道。 - 位8-15：绿色通道。 - 位0-7：蓝色通道。 |
返回：
| 类型 | 说明 |
|---|---|
| int32_t | 错误码。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_CAPI_INIT_ERROR CAPI初始化失败。 ARKUI_ERROR_CODE_RENDER_IS_FROM_FRAME_NODE 目标节点是从一个FrameNode获取的。从API version 22开始支持。 |
int32_t OH_ArkUI_RenderNodeUtils_GetBackgroundColor(ArkUI_RenderNodeHandle node, uint32_t* color)
描述：
获取渲染节点的背景颜色。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_RenderNodeHandle node | 目标渲染节点。 |
| uint32_t* color | 用于存储获取到的ARGB颜色值的整数指针。 默认值：0x00000000。 颜色字节布局说明： - 位24-31：Alpha通道（0x00完全透明，0xFF完全不透明）。 - 位16-23：红色通道。 - 位8-15：绿色通道。 - 位0-7：蓝色通道。 |
返回：
| 类型 | 说明 |
|---|---|
| int32_t | 错误码。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_CAPI_INIT_ERROR CAPI初始化失败。 ARKUI_ERROR_CODE_RENDER_IS_FROM_FRAME_NODE 目标节点是从一个FrameNode获取的。从API version 22开始支持。 |
int32_t OH_ArkUI_RenderNodeUtils_SetClipToFrame(ArkUI_RenderNodeHandle node, int32_t clipToFrame)
描述：
设置是否按当前渲染节点的frame区域裁剪。
frame区域由节点大小和位置确定。与OH_ArkUI_RenderNodeUtils_SetClipToBounds按节点边界裁剪（配置圆角时使用圆角边界）不同，本接口始终使用frame矩形；如需按自定义形状裁剪，请使用OH_ArkUI_RenderNodeUtils_SetClip。设置为1时，超出裁剪区域的内容会被截断。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_RenderNodeHandle node | 目标渲染节点。 |
| int32_t clipToFrame | 是否按frame区域裁剪。 1：裁剪；0：不裁剪。 默认值：0。 |
返回：
| 类型 | 说明 |
|---|---|
| int32_t | 错误码。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_CAPI_INIT_ERROR CAPI初始化失败。 ARKUI_ERROR_CODE_PARAM_OUT_OF_RANGE 参数值超出范围。 ARKUI_ERROR_CODE_RENDER_IS_FROM_FRAME_NODE 目标节点是从一个FrameNode获取的。从API version 22开始支持。 |
int32_t OH_ArkUI_RenderNodeUtils_GetClipToFrame(ArkUI_RenderNodeHandle node, int32_t* clipToFrame)
描述：
获取是否按当前渲染节点的frame区域裁剪。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_RenderNodeHandle node | 目标渲染节点。 |
| int32_t* clipToFrame | 用于接收是否按frame区域裁剪的状态值。 1：裁剪；0：不裁剪。 默认值：0。 |
返回：
| 类型 | 说明 |
|---|---|
| int32_t | 错误码。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_CAPI_INIT_ERROR CAPI初始化失败。 ARKUI_ERROR_CODE_RENDER_IS_FROM_FRAME_NODE 目标节点是从一个FrameNode获取的。从API version 22开始支持。 |
int32_t OH_ArkUI_RenderNodeUtils_SetClipToBounds(ArkUI_RenderNodeHandle node, int32_t clipToBounds)
描述：
设置是否按当前渲染节点的边界裁剪。
节点配置圆角时，使用圆角边界；设置为1时，超出裁剪区域的内容会被截断。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_RenderNodeHandle node | 目标渲染节点。 |
| int32_t clipToBounds | 是否按节点边界裁剪。 1：裁剪；0：不裁剪。 默认值：0。 |
返回：
| 类型 | 说明 |
|---|---|
| int32_t | 错误码。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_CAPI_INIT_ERROR CAPI初始化失败。 ARKUI_ERROR_CODE_PARAM_OUT_OF_RANGE 参数值超出范围。 ARKUI_ERROR_CODE_RENDER_IS_FROM_FRAME_NODE 目标节点是从一个FrameNode获取的。从API version 22开始支持。 |
int32_t OH_ArkUI_RenderNodeUtils_GetClipToBounds(ArkUI_RenderNodeHandle node, int32_t* clipToBounds)
描述：
获取是否按当前渲染节点的边界裁剪。
节点配置圆角时，使用圆角边界。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_RenderNodeHandle node | 目标渲染节点。 |
| int32_t* clipToBounds | 用于接收是否按节点边界裁剪的状态值。 1：裁剪；0：不裁剪。 默认值：0。 |
返回：
| 类型 | 说明 |
|---|---|
| int32_t | 错误码。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_CAPI_INIT_ERROR CAPI初始化失败。 ARKUI_ERROR_CODE_RENDER_IS_FROM_FRAME_NODE 目标节点是从一个FrameNode获取的。从API version 22开始支持。 |
int32_t OH_ArkUI_RenderNodeUtils_SetOpacity(ArkUI_RenderNodeHandle node, float opacity)
描述：
为渲染节点设置不透明度值。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_RenderNodeHandle node | 目标渲染节点。 |
| float opacity | 不透明度值（0.0-1.0）。 默认值：1。 |
返回：
| 类型 | 说明 |
|---|---|
| int32_t | 错误码。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_CAPI_INIT_ERROR CAPI初始化失败。 ARKUI_ERROR_CODE_PARAM_OUT_OF_RANGE 参数值超出范围。 ARKUI_ERROR_CODE_RENDER_IS_FROM_FRAME_NODE 目标节点是从一个FrameNode获取的。从API version 22开始支持。 |
int32_t OH_ArkUI_RenderNodeUtils_GetOpacity(ArkUI_RenderNodeHandle node, float* opacity)
描述：
获取渲染节点的不透明度值。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_RenderNodeHandle node | 目标渲染节点。 |
| float* opacity | 用于接收不透明度值（0.0-1.0）的指针。 默认值：1。 |
返回：
| 类型 | 说明 |
|---|---|
| int32_t | 错误码。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_CAPI_INIT_ERROR CAPI初始化失败。 ARKUI_ERROR_CODE_RENDER_IS_FROM_FRAME_NODE 目标节点是从一个FrameNode获取的。从API version 22开始支持。 |
int32_t OH_ArkUI_RenderNodeUtils_SetSize(ArkUI_RenderNodeHandle node, int32_t width, int32_t height)
描述：
为渲染节点设置尺寸。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_RenderNodeHandle node | 目标渲染节点。 |
| int32_t width | 宽度值，单位：px。 默认值：0。取值大于等于0，传入负值时返回ARKUI_ERROR_CODE_PARAM_OUT_OF_RANGE。 |
| int32_t height | 高度值，单位：px。 默认值：0。取值大于等于0，传入负值时返回ARKUI_ERROR_CODE_PARAM_OUT_OF_RANGE。 |
返回：
| 类型 | 说明 |
|---|---|
| int32_t | 错误码。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_CAPI_INIT_ERROR CAPI初始化失败。 ARKUI_ERROR_CODE_PARAM_OUT_OF_RANGE 参数值超出范围。 ARKUI_ERROR_CODE_RENDER_IS_FROM_FRAME_NODE 目标节点是从一个FrameNode获取的。从API version 22开始支持。 |
int32_t OH_ArkUI_RenderNodeUtils_GetSize(ArkUI_RenderNodeHandle node, int32_t* width, int32_t* height)
描述：
获取渲染节点的尺寸。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_RenderNodeHandle node | 目标渲染节点。 |
| int32_t* width | 用于接收宽度值的指针，单位：px，接收值的取值范围为[0, INT_MAX]。 默认值：0。 |
| int32_t* height | 用于接收高度值的指针，单位：px，接收值的取值范围为[0, INT_MAX]。 默认值：0。 |
返回：
| 类型 | 说明 |
|---|---|
| int32_t | 错误码。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_CAPI_INIT_ERROR CAPI初始化失败。 ARKUI_ERROR_CODE_RENDER_IS_FROM_FRAME_NODE 目标节点是从一个FrameNode获取的。从API version 22开始支持。 |
int32_t OH_ArkUI_RenderNodeUtils_SetPosition(ArkUI_RenderNodeHandle node, int32_t x, int32_t y)
描述：
为渲染节点设置位置坐标。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_RenderNodeHandle node | 目标渲染节点。 |
| int32_t x | X坐标值（以像素为单位）。 默认值：0，单位：px。 |
| int32_t y | Y坐标值（以像素为单位）。 默认值：0，单位：px。 |
返回：
| 类型 | 说明 |
|---|---|
| int32_t | 错误码。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_CAPI_INIT_ERROR CAPI初始化失败。 ARKUI_ERROR_CODE_RENDER_IS_FROM_FRAME_NODE 目标节点是从一个FrameNode获取的。从API version 22开始支持。 |
int32_t OH_ArkUI_RenderNodeUtils_GetPosition(ArkUI_RenderNodeHandle node, int32_t* x, int32_t* y)
描述：
获取渲染节点的位置坐标。该坐标是父节点布局该节点后得到的、相对父节点的位置偏移，单位为px；布局后生效的offset属性和不参与布局的position属性不影响该坐标。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_RenderNodeHandle node | 目标渲染节点。 |
| int32_t* x | 用于接收X坐标值（以像素为单位）的指针。 默认值：0，单位：px。 |
| int32_t* y | 用于接收Y坐标值（以像素为单位）的指针。 默认值：0，单位：px。 |
返回：
| 类型 | 说明 |
|---|---|
| int32_t | 错误码。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_CAPI_INIT_ERROR CAPI初始化失败。 ARKUI_ERROR_CODE_RENDER_IS_FROM_FRAME_NODE 目标节点是从一个FrameNode获取的。从API version 22开始支持。 |
int32_t OH_ArkUI_RenderNodeUtils_SetPivot(ArkUI_RenderNodeHandle node, float x, float y)
描述：
为渲染节点的变换设置中心点。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_RenderNodeHandle node | 目标渲染节点。 |
| float x | 中心点归一化X坐标，标准取值范围为[0.0, 1.0]。接口不校验该范围，超出范围时仍按传入值设置。 默认值：0.5。 |
| float y | 中心点归一化Y坐标，标准取值范围为[0.0, 1.0]。接口不校验该范围，超出范围时仍按传入值设置。 默认值：0.5。 |
返回：
| 类型 | 说明 |
|---|---|
| int32_t | 错误码。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_CAPI_INIT_ERROR CAPI初始化失败。 ARKUI_ERROR_CODE_RENDER_IS_FROM_FRAME_NODE 目标节点是从一个FrameNode获取的。从API version 22开始支持。 |
int32_t OH_ArkUI_RenderNodeUtils_GetPivot(ArkUI_RenderNodeHandle node, float* x, float* y)
描述：
获取渲染节点的中心点坐标。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_RenderNodeHandle node | 目标渲染节点。 |
| float* x | 用于接收中心点X坐标的指针。 默认值：0.5。 |
| float* y | 用于接收中心点Y坐标的指针。 默认值：0.5。 |
返回：
| 类型 | 说明 |
|---|---|
| int32_t | 错误码。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_CAPI_INIT_ERROR CAPI初始化失败。 ARKUI_ERROR_CODE_RENDER_IS_FROM_FRAME_NODE 目标节点是从一个FrameNode获取的。从API version 22开始支持。 |
int32_t OH_ArkUI_RenderNodeUtils_SetScale(ArkUI_RenderNodeHandle node, float x, float y)
描述：
为渲染节点设置缩放因子。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_RenderNodeHandle node | 目标渲染节点。 |
| float x | 水平缩放因子。 默认值：1。 |
| float y | 垂直缩放因子。 默认值：1。 |
返回：
| 类型 | 说明 |
|---|---|
| int32_t | 错误码。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_CAPI_INIT_ERROR CAPI初始化失败。 ARKUI_ERROR_CODE_RENDER_IS_FROM_FRAME_NODE 目标节点是从一个FrameNode获取的。从API version 22开始支持。 |
int32_t OH_ArkUI_RenderNodeUtils_GetScale(ArkUI_RenderNodeHandle node, float* x, float* y)
描述：
获取渲染节点的缩放因子。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_RenderNodeHandle node | 目标渲染节点。 |
| float* x | 用于接收水平缩放因子的指针。 默认值：1。 |
| float* y | 用于接收垂直缩放因子的指针。 默认值：1。 |
返回：
| 类型 | 说明 |
|---|---|
| int32_t | 错误码。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_CAPI_INIT_ERROR CAPI初始化失败。 ARKUI_ERROR_CODE_RENDER_IS_FROM_FRAME_NODE 目标节点是从一个FrameNode获取的。从API version 22开始支持。 |
int32_t OH_ArkUI_RenderNodeUtils_SetTranslation(ArkUI_RenderNodeHandle node, float x, float y)
描述：
为渲染节点设置平移偏移量。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_RenderNodeHandle node | 目标渲染节点。 |
| float x | 水平平移量（以像素为单位）。 默认值：0。 |
| float y | 垂直平移量（以像素为单位）。 默认值：0。 |
返回：
| 类型 | 说明 |
|---|---|
| int32_t | 错误码。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_CAPI_INIT_ERROR CAPI初始化失败。 ARKUI_ERROR_CODE_RENDER_IS_FROM_FRAME_NODE 目标节点是从一个FrameNode获取的。从API version 22开始支持。 |
int32_t OH_ArkUI_RenderNodeUtils_GetTranslation(ArkUI_RenderNodeHandle node, float* x, float* y)
描述：
获取渲染节点的平移偏移量。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_RenderNodeHandle node | 目标渲染节点。 |
| float* x | 用于接收水平平移量的指针，单位：px。 默认值：0。 |
| float* y | 用于接收垂直平移量的指针，单位：px。 默认值：0。 |
返回：
| 类型 | 说明 |
|---|---|
| int32_t | 错误码。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_CAPI_INIT_ERROR CAPI初始化失败。 ARKUI_ERROR_CODE_RENDER_IS_FROM_FRAME_NODE 目标节点是从一个FrameNode获取的。从API version 22开始支持。 |
int32_t OH_ArkUI_RenderNodeUtils_SetRotation(ArkUI_RenderNodeHandle node, float x, float y, float z)
描述：
为渲染节点设置旋转角度。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_RenderNodeHandle node | 目标渲染节点。 |
| float x | 绕X轴的旋转角度（以度为单位）。 默认值：0。 |
| float y | 绕Y轴的旋转角度（以度为单位）。 默认值：0。 |
| float z | 绕Z轴的旋转角度（以度为单位）。 默认值：0。 |
返回：
| 类型 | 说明 |
|---|---|
| int32_t | 错误码。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_CAPI_INIT_ERROR CAPI初始化失败。 ARKUI_ERROR_CODE_RENDER_IS_FROM_FRAME_NODE 目标节点是从一个FrameNode获取的。从API version 22开始支持。 |
int32_t OH_ArkUI_RenderNodeUtils_GetRotation(ArkUI_RenderNodeHandle node, float* x, float* y, float* z)
描述：
获取渲染节点的旋转角度。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_RenderNodeHandle node | 目标渲染节点。 |
| float* x | 用于接收绕X轴旋转角度（以度为单位）的指针。 默认值：0。 |
| float* y | 用于接收绕Y轴旋转角度（以度为单位）的指针。 默认值：0。 |
| float* z | 用于接收绕Z轴旋转角度（以度为单位）的指针。 默认值：0。 |
返回：
| 类型 | 说明 |
|---|---|
| int32_t | 错误码。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_CAPI_INIT_ERROR CAPI初始化失败。 ARKUI_ERROR_CODE_RENDER_IS_FROM_FRAME_NODE 目标节点是从一个FrameNode获取的。从API version 22开始支持。 |
int32_t OH_ArkUI_RenderNodeUtils_SetTransform(ArkUI_RenderNodeHandle node, float* matrix)
描述：
为渲染节点设置变换矩阵。
该接口用于通过一个4x4矩阵统一控制渲染节点的缩放、旋转、平移、倾斜和透视投影效果。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_RenderNodeHandle node | 目标渲染节点。 |
| float* matrix | 4x4 变换矩阵的浮点数数组（16 个连续值）。 |
变换矩阵应作为 16 个连续的浮点值以行优先顺序提供：
[m00, m01, m02, m03,
m10, m11, m12, m13,
m20, m21, m22, m23,
m30, m31, m32, m33]
其中矩阵表示为：
| m00 m01 m02 m03 |
| m10 m11 m12 m13 |
| m20 m21 m22 m23 |
| m30 m31 m32 m33 |
矩阵组件：
| 矩阵单元 | 描述 |
|---|---|
| m00 | x轴的缩放值。单位矩阵的默认值为1。 |
| m01 | 第二个值，受 x、y、z 轴的旋转或倾斜影响。 |
| m02 | 第三个值，受 x、y、z 轴的旋转影响。 |
| m03 | 第四个值，受透视投影影响。 |
| m10 | 第五个值，受 x、y、z 轴的旋转或倾斜影响。 |
| m11 | y轴的缩放值。单位矩阵的默认值为1。 |
| m12 | 第七个值，受 x、y、z 轴的旋转影响。 |
| m13 | 第八个值，受透视投影影响。 |
| m20 | 第九个值，受 x、y、z 轴的旋转影响。 |
| m21 | 第十个值，受 x、y、z 轴的旋转影响。 |
| m22 | z轴的缩放值。单位矩阵的默认值为1。 |
| m23 | 第 12 个值，受透视投影影响。 |
| m30 | x轴的平移值（以 px 为单位）。单位矩阵的默认值为0。 |
| m31 | y轴的平移值（以 px 为单位）。单位矩阵的默认值为0。 |
| m32 | z轴的平移值（以 px 为单位）。单位矩阵的默认值为0。 |
| m33 | 在齐次坐标中有效，呈现透视投影效果。 |
返回：
| 类型 | 说明 |
|---|---|
| int32_t | 错误码。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_CAPI_INIT_ERROR CAPI初始化失败。 ARKUI_ERROR_CODE_PARAM_OUT_OF_RANGE 参数超出范围。 ARKUI_ERROR_CODE_RENDER_IS_FROM_FRAME_NODE 目标节点是从一个FrameNode获取的。从API version 22开始支持。 |
int32_t OH_ArkUI_RenderNodeUtils_SetShadowColor(ArkUI_RenderNodeHandle node, uint32_t color)
描述：
为渲染节点设置阴影颜色。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_RenderNodeHandle node | 目标渲染节点。 |
| uint32_t color | ARGB 颜色值（32位无符号整数）。 默认值：0x00000000。 颜色字节布局说明： - 位24-31：Alpha通道（0x00完全透明，0xFF完全不透明）。 - 位16-23：红色通道。 - 位8-15：绿色通道。 - 位0-7：蓝色通道。 |
返回：
| 类型 | 说明 |
|---|---|
| int32_t | 错误码。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_CAPI_INIT_ERROR CAPI初始化失败。 ARKUI_ERROR_CODE_RENDER_IS_FROM_FRAME_NODE 目标节点是从一个FrameNode获取的。从API version 22开始支持。 |
int32_t OH_ArkUI_RenderNodeUtils_GetShadowColor(ArkUI_RenderNodeHandle node, uint32_t* color)
描述：
获取渲染节点的阴影颜色。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_RenderNodeHandle node | 目标渲染节点。 |
| uint32_t* color | 用于接收ARGB颜色值的整数指针。未设置阴影颜色时，接收值为0x00000000（完全透明）。 颜色字节布局说明： - 位24-31：Alpha通道（0x00完全透明，0xFF完全不透明）。 - 位16-23：红色通道。 - 位8-15：绿色通道。 - 位0-7：蓝色通道。 |
返回：
| 类型 | 说明 |
|---|---|
| int32_t | 错误码。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_CAPI_INIT_ERROR CAPI初始化失败。 ARKUI_ERROR_CODE_RENDER_IS_FROM_FRAME_NODE 目标节点是从一个FrameNode获取的。从API version 22开始支持。 |
int32_t OH_ArkUI_RenderNodeUtils_SetShadowOffset(ArkUI_RenderNodeHandle node, int32_t x, int32_t y)
描述：
为渲染节点设置阴影偏移量。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_RenderNodeHandle node | 目标渲染节点。 |
| int32_t x | 水平偏移值（以像素为单位）。 默认值：0。 |
| int32_t y | 垂直偏移值（以像素为单位）。 默认值：0。 |
返回：
| 类型 | 说明 |
|---|---|
| int32_t | 错误码。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_CAPI_INIT_ERROR CAPI初始化失败。 ARKUI_ERROR_CODE_RENDER_IS_FROM_FRAME_NODE 目标节点是从一个FrameNode获取的。从API version 22开始支持。 |
int32_t OH_ArkUI_RenderNodeUtils_GetShadowOffset(ArkUI_RenderNodeHandle node, int32_t* x, int32_t* y)
描述：
获取渲染节点的阴影偏移量。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_RenderNodeHandle node | 目标渲染节点。 |
| int32_t* x | 用于接收水平偏移值的指针。 默认值：0，单位：px。 |
| int32_t* y | 用于接收垂直偏移值的指针。 默认值：0，单位：px。 |
返回：
| 类型 | 说明 |
|---|---|
| int32_t | 错误码。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_CAPI_INIT_ERROR CAPI初始化失败。 ARKUI_ERROR_CODE_RENDER_IS_FROM_FRAME_NODE 目标节点是从一个FrameNode获取的。从API version 22开始支持。 |
int32_t OH_ArkUI_RenderNodeUtils_SetShadowAlpha(ArkUI_RenderNodeHandle node, float alpha)
描述：
为渲染节点设置阴影透明度。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_RenderNodeHandle node | 目标渲染节点。 |
| float alpha | 阴影Alpha值，取值范围为[0.0, 1.0]。传入范围外的值时返回ARKUI_ERROR_CODE_PARAM_OUT_OF_RANGE。 |
返回：
| 类型 | 说明 |
|---|---|
| int32_t | 错误码。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_CAPI_INIT_ERROR CAPI初始化失败。 ARKUI_ERROR_CODE_PARAM_OUT_OF_RANGE 参数超出范围。 ARKUI_ERROR_CODE_RENDER_IS_FROM_FRAME_NODE 目标节点是从一个FrameNode获取的。从API version 22开始支持。 |
int32_t OH_ArkUI_RenderNodeUtils_GetShadowAlpha(ArkUI_RenderNodeHandle node, float* alpha)
描述：
获取渲染节点的阴影透明度。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_RenderNodeHandle node | 目标渲染节点。 |
| float* alpha | 用于接收阴影Alpha值的指针。未设置阴影相关属性时，接收值为-1.0，表示未配置；设置阴影相关属性后，接收值的取值范围为[0.0, 1.0]。 |
返回：
| 类型 | 说明 |
|---|---|
| int32_t | 错误码。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_CAPI_INIT_ERROR CAPI初始化失败。 ARKUI_ERROR_CODE_RENDER_IS_FROM_FRAME_NODE 目标节点是从一个FrameNode获取的。从API version 22开始支持。 |
int32_t OH_ArkUI_RenderNodeUtils_SetShadowElevation(ArkUI_RenderNodeHandle node, float elevation)
描述：
为渲染节点设置阴影高度。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_RenderNodeHandle node | 目标渲染节点。 |
| float elevation | 阴影高度值，单位：px。取值范围为[0, +∞)，传入负值时返回ARKUI_ERROR_CODE_PARAM_OUT_OF_RANGE。 默认值：0。 |
返回：
| 类型 | 说明 |
|---|---|
| int32_t | 错误码。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_CAPI_INIT_ERROR CAPI初始化失败。 ARKUI_ERROR_CODE_PARAM_OUT_OF_RANGE 参数超出范围。 ARKUI_ERROR_CODE_RENDER_IS_FROM_FRAME_NODE 目标节点是从一个FrameNode获取的。从API version 22开始支持。 |
int32_t OH_ArkUI_RenderNodeUtils_GetShadowElevation(ArkUI_RenderNodeHandle node, float* elevation)
描述：
获取渲染节点的阴影高度。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_RenderNodeHandle node | 目标渲染节点。 |
| float* elevation | 用于接收阴影高度值的指针，单位：px，接收值的取值范围为[0, +∞)。未设置阴影高度时，接收值为0。 |
返回：
| 类型 | 说明 |
|---|---|
| int32_t | 错误码。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_CAPI_INIT_ERROR CAPI初始化失败。 ARKUI_ERROR_CODE_RENDER_IS_FROM_FRAME_NODE 目标节点是从一个FrameNode获取的。从API version 22开始支持。 |
int32_t OH_ArkUI_RenderNodeUtils_SetShadowRadius(ArkUI_RenderNodeHandle node, float radius)
描述：
为渲染节点设置阴影半径。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_RenderNodeHandle node | 目标渲染节点。 |
| float radius | 阴影半径，单位：px。取值范围为[0, +∞)，传入负值时返回ARKUI_ERROR_CODE_PARAM_OUT_OF_RANGE。 |
返回：
| 类型 | 说明 |
|---|---|
| int32_t | 错误码。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_CAPI_INIT_ERROR CAPI初始化失败。 ARKUI_ERROR_CODE_PARAM_OUT_OF_RANGE 参数超出范围。 ARKUI_ERROR_CODE_RENDER_IS_FROM_FRAME_NODE 目标节点是从一个FrameNode获取的。从API version 22开始支持。 |
int32_t OH_ArkUI_RenderNodeUtils_GetShadowRadius(ArkUI_RenderNodeHandle node, float* radius)
描述：
获取渲染节点的阴影半径。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_RenderNodeHandle node | 目标渲染节点。 |
| float* radius | 用于接收阴影半径值的指针，单位：px。设置阴影半径后，接收值的取值范围为[0, +∞)；未设置阴影半径时，API版本26.0.0之前接收值为0，从API版本26.0.0开始接收值为-1。 |
返回：
| 类型 | 说明 |
|---|---|
| int32_t | 错误码。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_CAPI_INIT_ERROR CAPI初始化失败。 ARKUI_ERROR_CODE_RENDER_IS_FROM_FRAME_NODE 目标节点是从一个FrameNode获取的。从API version 22开始支持。 |
int32_t OH_ArkUI_RenderNodeUtils_SetBorderStyle(ArkUI_RenderNodeHandle node, ArkUI_NodeBorderStyleOption* borderStyle)
描述：
为渲染节点设置边框样式。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_RenderNodeHandle node | 目标渲染节点。 |
| ArkUI_NodeBorderStyleOption* borderStyle | 边框样式的指针。 结构体指针内默认值：ARKUI_BORDER_STYLE_SOLID。 |
返回：
| 类型 | 说明 |
|---|---|
| int32_t | 错误码。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_CAPI_INIT_ERROR CAPI初始化失败。 ARKUI_ERROR_CODE_RENDER_IS_FROM_FRAME_NODE 目标节点是从一个FrameNode获取的。从API version 22开始支持。 |
int32_t OH_ArkUI_RenderNodeUtils_GetBorderStyle(ArkUI_RenderNodeHandle node, ArkUI_NodeBorderStyleOption** borderStyle)
描述：
获取渲染节点的边框样式。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_RenderNodeHandle node | 目标渲染节点。 |
| ArkUI_NodeBorderStyleOption** borderStyle | 用于接收边框样式的指针。 结构体指针内默认值：ARKUI_BORDER_STYLE_SOLID。 |
返回：
| 类型 | 说明 |
|---|---|
| int32_t | 错误码。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_CAPI_INIT_ERROR CAPI初始化失败。 ARKUI_ERROR_CODE_RENDER_IS_FROM_FRAME_NODE 目标节点是从一个FrameNode获取的。从API version 22开始支持。 |
int32_t OH_ArkUI_RenderNodeUtils_SetBorderWidth(ArkUI_RenderNodeHandle node, ArkUI_NodeBorderWidthOption* borderWidth)
描述：
为渲染节点设置边框宽度。
边框宽度需小于节点尺寸。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_RenderNodeHandle node | 目标渲染节点。 |
| ArkUI_NodeBorderWidthOption* borderWidth | 边框宽度的指针。 结构体指针内默认值：0。单位：px。 |
返回：
| 类型 | 说明 |
|---|---|
| int32_t | 错误码。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_CAPI_INIT_ERROR CAPI初始化失败。 ARKUI_ERROR_CODE_RENDER_IS_FROM_FRAME_NODE 目标节点是从一个FrameNode获取的。从API version 22开始支持。 |
int32_t OH_ArkUI_RenderNodeUtils_GetBorderWidth(ArkUI_RenderNodeHandle node, ArkUI_NodeBorderWidthOption** borderWidth)
描述：
获取渲染节点的边框宽度。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_RenderNodeHandle node | 目标渲染节点。 |
| ArkUI_NodeBorderWidthOption** borderWidth | 用于接收边框宽度的指针。 结构体指针内默认值：0。单位：px。 |
返回：
| 类型 | 说明 |
|---|---|
| int32_t | 错误码。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_CAPI_INIT_ERROR CAPI初始化失败。 ARKUI_ERROR_CODE_RENDER_IS_FROM_FRAME_NODE 目标节点是从一个FrameNode获取的。从API version 22开始支持。 |
int32_t OH_ArkUI_RenderNodeUtils_SetBorderColor(ArkUI_RenderNodeHandle node, ArkUI_NodeBorderColorOption* borderColor)
描述：
为渲染节点设置边框颜色。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_RenderNodeHandle node | 目标渲染节点。 |
| ArkUI_NodeBorderColorOption* borderColor | 边框颜色的指针。 结构体指针内默认值：0x00000000。 |
返回：
| 类型 | 说明 |
|---|---|
| int32_t | 错误码。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_CAPI_INIT_ERROR CAPI初始化失败。 ARKUI_ERROR_CODE_RENDER_IS_FROM_FRAME_NODE 目标节点是从一个FrameNode获取的。从API version 22开始支持。 |
int32_t OH_ArkUI_RenderNodeUtils_GetBorderColor(ArkUI_RenderNodeHandle node, ArkUI_NodeBorderColorOption** borderColor)
描述：
获取渲染节点的边框颜色。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_RenderNodeHandle node | 目标渲染节点。 |
| ArkUI_NodeBorderColorOption** borderColor | 用于接收边框颜色的指针。 结构体指针内默认值：0x00000000。 |
返回：
| 类型 | 说明 |
|---|---|
| int32_t | 错误码。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_CAPI_INIT_ERROR CAPI初始化失败。 ARKUI_ERROR_CODE_RENDER_IS_FROM_FRAME_NODE 目标节点是从一个FrameNode获取的。从API version 22开始支持。 |
int32_t OH_ArkUI_RenderNodeUtils_SetBorderRadius(ArkUI_RenderNodeHandle node, ArkUI_NodeBorderRadiusOption* borderRadius)
描述：
为渲染节点设置边框角半径。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_RenderNodeHandle node | 目标渲染节点。 |
| ArkUI_NodeBorderRadiusOption* borderRadius | 边框半径的指针。 各角半径默认值均为0，单位：px。 |
返回：
| 类型 | 说明 |
|---|---|
| int32_t | 错误码。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_CAPI_INIT_ERROR CAPI初始化失败。 ARKUI_ERROR_CODE_RENDER_IS_FROM_FRAME_NODE 目标节点是从一个FrameNode获取的。从API version 22开始支持。 |
int32_t OH_ArkUI_RenderNodeUtils_GetBorderRadius(ArkUI_RenderNodeHandle node, ArkUI_NodeBorderRadiusOption** borderRadius)
描述：
获取渲染节点的边框角半径。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_RenderNodeHandle node | 目标渲染节点。 |
| ArkUI_NodeBorderRadiusOption** borderRadius | 用于接收边框半径的指针。 各角半径默认值均为0，单位：px。 |
返回：
| 类型 | 说明 |
|---|---|
| int32_t | 错误码。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_CAPI_INIT_ERROR CAPI初始化失败。 ARKUI_ERROR_CODE_RENDER_IS_FROM_FRAME_NODE 目标节点是从一个FrameNode获取的。从API version 22开始支持。 |
int32_t OH_ArkUI_RenderNodeUtils_SetMask(ArkUI_RenderNodeHandle node, ArkUI_RenderNodeMaskOption* mask)
描述：
使用遮罩配置为渲染节点应用遮罩。
遮罩图层范围由节点边界确定，遮罩形状超出节点边界的部分不显示。调用OH_ArkUI_RenderNodeUtils_SetDrawRegion不会扩大遮罩图层范围。
遮罩创建方式如下：
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_RenderNodeHandle node | 目标渲染节点。 |
| ArkUI_RenderNodeMaskOption* mask | 遮罩配置的指针。 |
返回：
| 类型 | 说明 |
|---|---|
| int32_t | 错误码。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_CAPI_INIT_ERROR CAPI初始化失败。 ARKUI_ERROR_CODE_RENDER_IS_FROM_FRAME_NODE 目标节点是从一个FrameNode获取的。从API version 22开始支持。 |
int32_t OH_ArkUI_RenderNodeUtils_SetClip(ArkUI_RenderNodeHandle node, ArkUI_RenderNodeClipOption* clip)
描述：
使用裁剪配置为渲染节点应用裁剪。
裁剪形状可超出节点边界；如需显示节点边界外的绘制内容，应调用OH_ArkUI_RenderNodeUtils_SetDrawRegion设置覆盖该内容的绘制区域，最终显示仍受其他裁剪条件影响。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_RenderNodeHandle node | 目标渲染节点。 |
| ArkUI_RenderNodeClipOption* clip | 裁剪配置的指针。 |
返回：
| 类型 | 说明 |
|---|---|
| int32_t | 错误码。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_CAPI_INIT_ERROR CAPI初始化失败。 ARKUI_ERROR_CODE_RENDER_IS_FROM_FRAME_NODE 目标节点是从一个FrameNode获取的。从API version 22开始支持。 |
int32_t OH_ArkUI_RenderNodeUtils_SetMarkNodeGroup(ArkUI_RenderNodeHandle node, bool markNodeGroup)
描述：
设置是否将目标节点及其子树组成节点组。
设置为true时，系统会生成包含该节点及其子树的离屏缓存，以复用绘制结果，适用于子树内容固定、仅对整体应用动效的场景。与截屏、模糊、亮度调节或混合操作同时使用时，可能出现显示异常或性能下降。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_RenderNodeHandle node | 目标渲染节点。 |
| bool markNodeGroup | 是否将目标节点及其子树组成节点组。 true：组成节点组并进行离屏渲染；false：不组成节点组。 |
返回：
| 类型 | 说明 |
|---|---|
| int32_t | 错误码。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_CAPI_INIT_ERROR CAPI初始化失败。 ARKUI_ERROR_CODE_RENDER_IS_FROM_FRAME_NODE 目标节点是从一个FrameNode获取的。从API version 22开始支持。 |
int32_t OH_ArkUI_RenderNodeUtils_SetBounds(ArkUI_RenderNodeHandle node, int32_t x, int32_t y, int32_t width, int32_t height)
描述：
为渲染节点设置边界。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_RenderNodeHandle node | 目标渲染节点。 |
| int32_t x | 边界左上角的X坐标（以像素为单位）。 默认值：0。 |
| int32_t y | 边界左上角的Y坐标（以像素为单位）。 默认值：0。 |
| int32_t width | 边界的宽度（以像素为单位）。 默认值：0。取值大于等于0，传入负值时返回ARKUI_ERROR_CODE_PARAM_OUT_OF_RANGE。 |
| int32_t height | 边界的高度（以像素为单位）。 默认值：0。取值大于等于0，传入负值时返回ARKUI_ERROR_CODE_PARAM_OUT_OF_RANGE。 |
返回：
| 类型 | 说明 |
|---|---|
| int32_t | 错误码。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_CAPI_INIT_ERROR CAPI初始化失败。 ARKUI_ERROR_CODE_PARAM_OUT_OF_RANGE 参数超出范围。 ARKUI_ERROR_CODE_RENDER_IS_FROM_FRAME_NODE 目标节点是从一个FrameNode获取的。从API version 22开始支持。 |
int32_t OH_ArkUI_RenderNodeUtils_GetBounds(ArkUI_RenderNodeHandle node, int32_t* x, int32_t* y, int32_t* width, int32_t* height)
描述：
获取渲染节点的边界。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_RenderNodeHandle node | 目标渲染节点。 |
| int32_t* x | 用于接收边界左上角X坐标（以像素为单位）的指针。 默认值：0。 |
| int32_t* y | 用于接收边界左上角Y坐标（以像素为单位）的指针。 默认值：0。 |
| int32_t* width | 用于接收边界宽度（以像素为单位）的指针，接收值的取值范围为[0, INT_MAX]。 默认值：0。 |
| int32_t* height | 用于接收边界高度（以像素为单位）的指针，接收值的取值范围为[0, INT_MAX]。 默认值：0。 |
返回：
| 类型 | 说明 |
|---|---|
| int32_t | 错误码。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_CAPI_INIT_ERROR CAPI初始化失败。 ARKUI_ERROR_CODE_RENDER_IS_FROM_FRAME_NODE 目标节点是从一个FrameNode获取的。从API version 22开始支持。 |
int32_t OH_ArkUI_RenderNodeUtils_SetDrawRegion(ArkUI_RenderNodeHandle node, float x, float y, float w, float h)
描述：
为渲染节点设置绘制区域。
该绘制区域由节点局部坐标系中的x、y、w、h定义。该区域与节点自身范围合并，参与节点绘制范围和脏区计算；绘制内容超出节点边界时，应使该区域覆盖全部超出部分。该接口不改变节点边界，也不扩大遮罩图层范围。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_RenderNodeHandle node | 目标渲染节点。 |
| float x | 绘制区域左上角相对节点局部坐标系原点的X坐标，单位：px。 |
| float y | 绘制区域左上角相对节点局部坐标系原点的Y坐标，单位：px。 |
| float w | 绘制区域的宽度，单位：px。 |
| float h | 绘制区域的高度，单位：px。 |
返回：
| 类型 | 说明 |
|---|---|
| int32_t | 错误码。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_CAPI_INIT_ERROR CAPI初始化失败。 ARKUI_ERROR_CODE_RENDER_IS_FROM_FRAME_NODE 目标节点是从一个FrameNode获取的。从API version 22开始支持。 |
int32_t OH_ArkUI_RenderNodeUtils_AttachContentModifier(ArkUI_RenderNodeHandle node, ArkUI_RenderContentModifierHandle modifier)
描述：
为渲染节点添加内容修改器。
该接口用于通过onDraw回调扩展节点的自定义绘制内容。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_RenderNodeHandle node | 目标渲染节点。 |
| ArkUI_RenderContentModifierHandle modifier | 内容修改器。 |
返回：
| 类型 | 说明 |
|---|---|
| int32_t | 错误码。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_CAPI_INIT_ERROR CAPI初始化失败。 ARKUI_ERROR_CODE_RENDER_IS_FROM_FRAME_NODE 目标节点是从一个FrameNode获取的。从API version 22开始支持。 |
ArkUI_RenderContentModifierHandle OH_ArkUI_RenderNodeUtils_CreateContentModifier()
描述：
创建内容修改器。
该接口用于保存绘制属性并设置onDraw回调，再附加到渲染节点。使用完毕后调用OH_ArkUI_RenderNodeUtils_DisposeContentModifier释放。
起始版本： 20
返回：
| 类型 | 说明 |
|---|---|
| ArkUI_RenderContentModifierHandle | 内容修改器。 |
void OH_ArkUI_RenderNodeUtils_DisposeContentModifier(ArkUI_RenderContentModifierHandle modifier)
描述：
释放内容修改器。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_RenderContentModifierHandle modifier | 内容修改器。 |
int32_t OH_ArkUI_RenderNodeUtils_AttachFloatProperty(ArkUI_RenderContentModifierHandle modifier, ArkUI_FloatPropertyHandle property)
描述：
为目标内容修改器附加浮点属性。
该接口用于在绘制回调中传递或更新浮点型绘制参数。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_RenderContentModifierHandle modifier | 待附加属性的目标内容修改器。 |
| ArkUI_FloatPropertyHandle property | 浮点属性。 |
返回：
| 类型 | 说明 |
|---|---|
| int32_t | 错误码。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_CAPI_INIT_ERROR CAPI初始化失败。 |
int32_t OH_ArkUI_RenderNodeUtils_AttachVector2Property(ArkUI_RenderContentModifierHandle modifier, ArkUI_Vector2PropertyHandle property)
描述：
为目标内容修改器附加二维向量属性。
该接口用于在绘制回调中传递或更新二维坐标、偏移等绘制参数。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_RenderContentModifierHandle modifier | 待附加属性的目标内容修改器。 |
| ArkUI_Vector2PropertyHandle property | 二维向量属性。 |
返回：
| 类型 | 说明 |
|---|---|
| int32_t | 错误码。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_CAPI_INIT_ERROR CAPI初始化失败。 |
int32_t OH_ArkUI_RenderNodeUtils_AttachColorProperty(ArkUI_RenderContentModifierHandle modifier, ArkUI_ColorPropertyHandle property)
描述：
为目标内容修改器附加颜色属性。
该接口用于在绘制回调中传递或更新颜色绘制参数。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_RenderContentModifierHandle modifier | 待附加属性的目标内容修改器。 |
| ArkUI_ColorPropertyHandle property | 颜色属性。 |
返回：
| 类型 | 说明 |
|---|---|
| int32_t | 错误码。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_CAPI_INIT_ERROR CAPI初始化失败。 |
int32_t OH_ArkUI_RenderNodeUtils_AttachFloatAnimatableProperty(ArkUI_RenderContentModifierHandle modifier, ArkUI_FloatAnimatablePropertyHandle property)
描述：
为目标内容修改器附加可动画的浮点属性。
该接口用于在绘制回调中配置随动画变化的浮点型绘制参数。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_RenderContentModifierHandle modifier | 待附加属性的目标内容修改器。 |
| ArkUI_FloatAnimatablePropertyHandle property | 可动画的浮点属性。 |
返回：
| 类型 | 说明 |
|---|---|
| int32_t | 错误码。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_CAPI_INIT_ERROR CAPI初始化失败。 |
int32_t OH_ArkUI_RenderNodeUtils_AttachVector2AnimatableProperty(ArkUI_RenderContentModifierHandle modifier, ArkUI_Vector2AnimatablePropertyHandle property)
描述：
为目标内容修改器附加可动画的二维向量属性。
该接口用于在绘制回调中配置随动画变化的二维坐标、偏移等绘制参数。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_RenderContentModifierHandle modifier | 待附加属性的目标内容修改器。 |
| ArkUI_Vector2AnimatablePropertyHandle property | 可动画的二维向量属性。 |
返回：
| 类型 | 说明 |
|---|---|
| int32_t | 错误码。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_CAPI_INIT_ERROR CAPI初始化失败。 |
int32_t OH_ArkUI_RenderNodeUtils_AttachColorAnimatableProperty(ArkUI_RenderContentModifierHandle modifier, ArkUI_ColorAnimatablePropertyHandle property)
描述：
为目标内容修改器附加可动画的颜色属性。
该接口用于在绘制回调中配置随动画变化的颜色绘制参数。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_RenderContentModifierHandle modifier | 待附加属性的目标内容修改器。 |
| ArkUI_ColorAnimatablePropertyHandle property | 可动画的颜色属性。 |
返回：
| 类型 | 说明 |
|---|---|
| int32_t | 错误码。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_CAPI_INIT_ERROR CAPI初始化失败。 |
ArkUI_FloatPropertyHandle OH_ArkUI_RenderNodeUtils_CreateFloatProperty(float value)
描述：
创建浮点属性。
使用完毕后调用OH_ArkUI_RenderNodeUtils_DisposeFloatProperty释放。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| float value | 属性值。 |
返回：
| 类型 | 说明 |
|---|---|
| ArkUI_FloatPropertyHandle | 浮点属性。 |
int32_t OH_ArkUI_RenderNodeUtils_SetFloatPropertyValue(ArkUI_FloatPropertyHandle property, float value)
描述：
设置浮点属性的值。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_FloatPropertyHandle property | 浮点属性。 |
| float value | 属性值。 |
返回：
| 类型 | 说明 |
|---|---|
| int32_t | 错误码。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_CAPI_INIT_ERROR CAPI初始化失败。 |
int32_t OH_ArkUI_RenderNodeUtils_GetFloatPropertyValue(ArkUI_FloatPropertyHandle property, float* value)
描述：
获取浮点属性的值。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_FloatPropertyHandle property | 浮点属性。 |
| float* value | 用于接收属性值的指针。 |
返回：
| 类型 | 说明 |
|---|---|
| int32_t | 错误码。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_CAPI_INIT_ERROR CAPI初始化失败。 |
void OH_ArkUI_RenderNodeUtils_DisposeFloatProperty(ArkUI_FloatPropertyHandle property)
描述：
释放浮点属性。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_FloatPropertyHandle property | 浮点属性。 |
ArkUI_Vector2PropertyHandle OH_ArkUI_RenderNodeUtils_CreateVector2Property(float x, float y)
描述：
创建二维向量属性。
使用完毕后调用OH_ArkUI_RenderNodeUtils_DisposeVector2Property释放。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| float x | 属性的X坐标值。 |
| float y | 属性的Y坐标值。 |
返回：
| 类型 | 说明 |
|---|---|
| ArkUI_Vector2PropertyHandle | 二维向量属性。 |
int32_t OH_ArkUI_RenderNodeUtils_SetVector2PropertyValue(ArkUI_Vector2PropertyHandle property, float x, float y)
描述：
设置二维向量属性的值。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_Vector2PropertyHandle property | 二维向量属性。 |
| float x | 属性的X坐标值。 |
| float y | 属性的Y坐标值。 |
返回：
| 类型 | 说明 |
|---|---|
| int32_t | 错误码。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_CAPI_INIT_ERROR CAPI初始化失败。 |
int32_t OH_ArkUI_RenderNodeUtils_GetVector2PropertyValue(ArkUI_Vector2PropertyHandle property, float* x, float* y)
描述：
获取二维向量属性的值。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_Vector2PropertyHandle property | 二维向量属性。 |
| float* x | 用于接收属性X坐标值的指针。 |
| float* y | 用于接收属性Y坐标值的指针。 |
返回：
| 类型 | 说明 |
|---|---|
| int32_t | 错误码。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_CAPI_INIT_ERROR CAPI初始化失败。 |
void OH_ArkUI_RenderNodeUtils_DisposeVector2Property(ArkUI_Vector2PropertyHandle property)
描述：
释放二维向量属性。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_Vector2PropertyHandle property | 二维向量属性。 |
ArkUI_ColorPropertyHandle OH_ArkUI_RenderNodeUtils_CreateColorProperty(uint32_t value)
描述：
创建颜色属性。
使用完毕后调用OH_ArkUI_RenderNodeUtils_DisposeColorProperty释放。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| uint32_t value | 用于初始化颜色属性的ARGB颜色值，格式为0xAARRGGBB，其中A、R、G、B分别表示Alpha、红、绿、蓝通道。 |
返回：
| 类型 | 说明 |
|---|---|
| ArkUI_ColorPropertyHandle | 颜色属性。 |
int32_t OH_ArkUI_RenderNodeUtils_SetColorPropertyValue(ArkUI_ColorPropertyHandle property, uint32_t value)
描述：
设置颜色属性的值。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_ColorPropertyHandle property | 颜色属性。 |
| uint32_t value | 要设置的ARGB颜色值，格式为0xAARRGGBB，其中A、R、G、B分别表示Alpha、红、绿、蓝通道。 |
返回：
| 类型 | 说明 |
|---|---|
| int32_t | 错误码。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_CAPI_INIT_ERROR CAPI初始化失败。 |
int32_t OH_ArkUI_RenderNodeUtils_GetColorPropertyValue(ArkUI_ColorPropertyHandle property, uint32_t* value)
描述：
获取颜色属性的值。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_ColorPropertyHandle property | 颜色属性。 |
| uint32_t* value | 用于接收ARGB颜色值的指针。颜色值格式为0xAARRGGBB，其中A、R、G、B分别表示Alpha、红、绿、蓝通道。 |
返回：
| 类型 | 说明 |
|---|---|
| int32_t | 错误码。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_CAPI_INIT_ERROR CAPI初始化失败。 |
void OH_ArkUI_RenderNodeUtils_DisposeColorProperty(ArkUI_ColorPropertyHandle property)
描述：
释放颜色属性。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_ColorPropertyHandle property | 颜色属性。 |
ArkUI_FloatAnimatablePropertyHandle OH_ArkUI_RenderNodeUtils_CreateFloatAnimatableProperty(float value)
描述：
创建可动画的浮点属性。
该接口用于保存可随动画变化的浮点型绘制参数。使用完毕后调用OH_ArkUI_RenderNodeUtils_DisposeFloatAnimatableProperty释放。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| float value | 属性值。 |
返回：
| 类型 | 说明 |
|---|---|
| ArkUI_FloatAnimatablePropertyHandle | 可动画的浮点属性。 |
int32_t OH_ArkUI_RenderNodeUtils_SetFloatAnimatablePropertyValue(ArkUI_FloatAnimatablePropertyHandle property, float value)
描述：
设置可动画的浮点属性的值。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_FloatAnimatablePropertyHandle property | 可动画的浮点属性。 |
| float value | 属性值。 |
返回：
| 类型 | 说明 |
|---|---|
| int32_t | 错误码。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_CAPI_INIT_ERROR CAPI初始化失败。 |
int32_t OH_ArkUI_RenderNodeUtils_GetFloatAnimatablePropertyValue(ArkUI_FloatAnimatablePropertyHandle property, float* value)
描述：
获取可动画的浮点属性的值。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_FloatAnimatablePropertyHandle property | 可动画的浮点属性。 |
| float* value | 用于接收属性值的指针。 |
返回：
| 类型 | 说明 |
|---|---|
| int32_t | 错误码。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_CAPI_INIT_ERROR CAPI初始化失败。 |
void OH_ArkUI_RenderNodeUtils_DisposeFloatAnimatableProperty(ArkUI_FloatAnimatablePropertyHandle property)
描述：
释放可动画的浮点属性。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_FloatAnimatablePropertyHandle property | 可动画的浮点属性。 |
ArkUI_Vector2AnimatablePropertyHandle OH_ArkUI_RenderNodeUtils_CreateVector2AnimatableProperty(float x, float y)
描述：
创建可动画的二维向量属性。
该接口用于保存可随动画变化的二维坐标、偏移等绘制参数。使用完毕后调用OH_ArkUI_RenderNodeUtils_DisposeVector2AnimatableProperty释放。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| float x | 属性的X坐标值。 |
| float y | 属性的Y坐标值。 |
返回：
| 类型 | 说明 |
|---|---|
| ArkUI_Vector2AnimatablePropertyHandle | 可动画的二维向量属性。 |
int32_t OH_ArkUI_RenderNodeUtils_SetVector2AnimatablePropertyValue(ArkUI_Vector2AnimatablePropertyHandle property, float x, float y)
描述：
设置可动画的二维向量属性的值。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_Vector2AnimatablePropertyHandle property | 可动画的二维向量属性。 |
| float x | 属性的X坐标值。 |
| float y | 属性的Y坐标值。 |
返回：
| 类型 | 说明 |
|---|---|
| int32_t | 错误码。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_CAPI_INIT_ERROR CAPI初始化失败。 |
int32_t OH_ArkUI_RenderNodeUtils_GetVector2AnimatablePropertyValue(ArkUI_Vector2AnimatablePropertyHandle property, float* x, float* y)
描述：
获取可动画的二维向量属性的值。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_Vector2AnimatablePropertyHandle property | 可动画的二维向量属性。 |
| float* x | 用于接收属性X坐标值的指针。 |
| float* y | 用于接收属性Y坐标值的指针。 |
返回：
| 类型 | 说明 |
|---|---|
| int32_t | 错误码。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_CAPI_INIT_ERROR CAPI初始化失败。 |
void OH_ArkUI_RenderNodeUtils_DisposeVector2AnimatableProperty(ArkUI_Vector2AnimatablePropertyHandle property)
描述：
释放可动画的二维向量属性。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_Vector2AnimatablePropertyHandle property | 可动画的二维向量属性。 |
ArkUI_ColorAnimatablePropertyHandle OH_ArkUI_RenderNodeUtils_CreateColorAnimatableProperty(uint32_t value)
描述：
创建可动画的颜色属性。
该接口用于保存可随动画变化的颜色绘制参数。使用完毕后调用OH_ArkUI_RenderNodeUtils_DisposeColorAnimatableProperty释放。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| uint32_t value | 用于初始化可动画颜色属性的ARGB颜色值，格式为0xAARRGGBB，其中A、R、G、B分别表示Alpha、红、绿、蓝通道。 |
返回：
| 类型 | 说明 |
|---|---|
| ArkUI_ColorAnimatablePropertyHandle | 可动画的颜色属性。 |
int32_t OH_ArkUI_RenderNodeUtils_SetColorAnimatablePropertyValue(ArkUI_ColorAnimatablePropertyHandle property, uint32_t value)
描述：
设置可动画的颜色属性的值。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_ColorAnimatablePropertyHandle property | 可动画的颜色属性。 |
| uint32_t value | 要设置的ARGB颜色值，格式为0xAARRGGBB，其中A、R、G、B分别表示Alpha、红、绿、蓝通道。 |
返回：
| 类型 | 说明 |
|---|---|
| int32_t | 错误码。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_CAPI_INIT_ERROR CAPI初始化失败。 |
int32_t OH_ArkUI_RenderNodeUtils_GetColorAnimatablePropertyValue(ArkUI_ColorAnimatablePropertyHandle property, uint32_t* value)
描述：
获取可动画的颜色属性的值。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_ColorAnimatablePropertyHandle property | 可动画的颜色属性。 |
| uint32_t* value | 用于接收ARGB颜色值的指针。颜色值格式为0xAARRGGBB，其中A、R、G、B分别表示Alpha、红、绿、蓝通道。 |
返回：
| 类型 | 说明 |
|---|---|
| int32_t | 错误码。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_CAPI_INIT_ERROR CAPI初始化失败。 |
void OH_ArkUI_RenderNodeUtils_DisposeColorAnimatableProperty(ArkUI_ColorAnimatablePropertyHandle property)
描述：
释放可动画的颜色属性。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_ColorAnimatablePropertyHandle property | 可动画的颜色属性。 |
int32_t OH_ArkUI_RenderNodeUtils_SetContentModifierOnDraw(ArkUI_RenderContentModifierHandle modifier, void* userData, void (*callback)(ArkUI_DrawContext* context, void* userData))
描述：
设置内容修改器的onDraw回调。
该回调用于在内容修改器绘制阶段执行自定义绘制逻辑。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_RenderContentModifierHandle modifier | 目标内容修改器。 |
| void* userData | 要传递给回调的自定义数据。 |
| void (*callback)(ArkUI_DrawContext* context, void* userData) | 绘制事件接收回调。context表示绘制上下文；userData表示调用本接口时传入的自定义数据。 |
返回：
| 类型 | 说明 |
|---|---|
| int32_t | 错误码。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_CAPI_INIT_ERROR CAPI初始化失败。 |
ArkUI_RectShapeOption* OH_ArkUI_RenderNodeUtils_CreateRectShapeOption()
描述：
创建矩形形状。
使用完毕后调用OH_ArkUI_RenderNodeUtils_DisposeRectShapeOption释放。
起始版本： 20
返回：
| 类型 | 说明 |
|---|---|
| ArkUI_RectShapeOption* | 指向矩形形状的指针。 |
void OH_ArkUI_RenderNodeUtils_DisposeRectShapeOption(ArkUI_RectShapeOption* option)
描述：
释放矩形形状。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_RectShapeOption* option | 指向矩形形状的指针。 |
void OH_ArkUI_RenderNodeUtils_SetRectShapeOptionEdgeValue(ArkUI_RectShapeOption* option, float edgeValue, ArkUI_EdgeDirection direction)
描述：
设置矩形形状的边缘值。
左边缘或上边缘可取负值，负值表示对应边缘位于节点原点左侧或上方。形状用于遮罩时，超出节点边界的部分不显示；用于裁剪且需显示节点边界外内容时，应通过OH_ArkUI_RenderNodeUtils_SetDrawRegion设置覆盖该内容的绘制区域。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_RectShapeOption* option | 指向矩形形状的指针。 |
| float edgeValue | 矩形形状的边缘值，单位：px。 |
| ArkUI_EdgeDirection direction | 要设置边缘值的矩形方向。 |
ArkUI_NodeBorderStyleOption* OH_ArkUI_RenderNodeUtils_CreateNodeBorderStyleOption()
描述：
创建节点边框样式。
使用完毕后调用OH_ArkUI_RenderNodeUtils_DisposeNodeBorderStyleOption释放。
起始版本： 20
返回：
| 类型 | 说明 |
|---|---|
| ArkUI_NodeBorderStyleOption* | 指向节点边框样式的指针。 |
void OH_ArkUI_RenderNodeUtils_DisposeNodeBorderStyleOption(ArkUI_NodeBorderStyleOption* option)
描述：
释放节点边框样式。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_NodeBorderStyleOption* option | 指向节点边框样式的指针。 |
void OH_ArkUI_RenderNodeUtils_SetNodeBorderStyleOptionEdgeStyle(ArkUI_NodeBorderStyleOption* option, ArkUI_BorderStyle edgeStyle, ArkUI_EdgeDirection direction)
描述：
设置节点边框的边缘样式。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_NodeBorderStyleOption* option | 指向节点边框样式的指针。 |
| ArkUI_BorderStyle edgeStyle | 节点边框的边缘样式值。 |
| ArkUI_EdgeDirection direction | 边缘的方向。 |
ArkUI_NodeBorderWidthOption* OH_ArkUI_RenderNodeUtils_CreateNodeBorderWidthOption()
描述：
创建节点边框宽度。
使用完毕后调用OH_ArkUI_RenderNodeUtils_DisposeNodeBorderWidthOption释放。
起始版本： 20
返回：
| 类型 | 说明 |
|---|---|
| ArkUI_NodeBorderWidthOption* | 指向节点边框宽度的指针。 |
void OH_ArkUI_RenderNodeUtils_DisposeNodeBorderWidthOption(ArkUI_NodeBorderWidthOption* option)
描述：
释放节点边框宽度。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_NodeBorderWidthOption* option | 指向节点边框宽度的指针。 |
void OH_ArkUI_RenderNodeUtils_SetNodeBorderWidthOptionEdgeWidth(ArkUI_NodeBorderWidthOption* option, float edgeWidth, ArkUI_EdgeDirection direction)
描述：
设置节点边框的边缘宽度。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_NodeBorderWidthOption* option | 指向节点边框宽度的指针。 |
| float edgeWidth | 节点边框的边缘宽度值，单位：px。取值范围为[0, +∞)；传入负值时，对应边缘的宽度保持不变。 |
| ArkUI_EdgeDirection direction | 边缘的方向。 |
ArkUI_NodeBorderColorOption* OH_ArkUI_RenderNodeUtils_CreateNodeBorderColorOption()
描述：
创建节点边框颜色。
使用完毕后调用OH_ArkUI_RenderNodeUtils_DisposeNodeBorderColorOption释放。
起始版本： 20
返回：
| 类型 | 说明 |
|---|---|
| ArkUI_NodeBorderColorOption* | 指向节点边框颜色的指针。 |
void OH_ArkUI_RenderNodeUtils_DisposeNodeBorderColorOption(ArkUI_NodeBorderColorOption* option)
描述：
释放节点边框颜色。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_NodeBorderColorOption* option | 指向节点边框颜色的指针。 |
void OH_ArkUI_RenderNodeUtils_SetNodeBorderColorOptionEdgeColor(ArkUI_NodeBorderColorOption* option, uint32_t edgeColor, ArkUI_EdgeDirection direction)
描述：
设置节点边框的边缘颜色。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_NodeBorderColorOption* option | 指向节点边框颜色的指针。 |
| uint32_t edgeColor | 节点边框的边缘颜色值，ARGB格式为0xAARRGGBB，其中A、R、G、B分别表示Alpha、红、绿、蓝通道。 |
| ArkUI_EdgeDirection direction | 边缘的方向。 |
ArkUI_NodeBorderRadiusOption* OH_ArkUI_RenderNodeUtils_CreateNodeBorderRadiusOption()
描述：
创建节点边框半径。
使用完毕后调用OH_ArkUI_RenderNodeUtils_DisposeNodeBorderRadiusOption释放。
起始版本： 20
返回：
| 类型 | 说明 |
|---|---|
| ArkUI_NodeBorderRadiusOption* | 指向节点边框半径的指针。 |
void OH_ArkUI_RenderNodeUtils_DisposeNodeBorderRadiusOption(ArkUI_NodeBorderRadiusOption* option)
描述：
释放节点边框半径。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_NodeBorderRadiusOption* option | 指向节点边框半径的指针。 |
void OH_ArkUI_RenderNodeUtils_SetNodeBorderRadiusOptionCornerRadius(ArkUI_NodeBorderRadiusOption* option, uint32_t cornerRadius, ArkUI_CornerDirection direction)
描述：
设置节点指定角的边框半径。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_NodeBorderRadiusOption* option | 指向节点边框半径的指针。 |
| uint32_t cornerRadius | 节点指定角的边框半径，单位：px，取值为非负整数。 |
| ArkUI_CornerDirection direction | 角的方向。 |
ArkUI_CircleShapeOption* OH_ArkUI_RenderNodeUtils_CreateCircleShapeOption()
描述：
创建圆形形状。
使用完毕后调用OH_ArkUI_RenderNodeUtils_DisposeCircleShapeOption释放。
起始版本： 20
返回：
| 类型 | 说明 |
|---|---|
| ArkUI_CircleShapeOption* | 指向圆形形状的指针。 |
void OH_ArkUI_RenderNodeUtils_DisposeCircleShapeOption(ArkUI_CircleShapeOption* option)
描述：
释放圆形形状。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_CircleShapeOption* option | 指向圆形形状的指针。 |
void OH_ArkUI_RenderNodeUtils_SetCircleShapeOptionCenterX(ArkUI_CircleShapeOption* option, float centerX)
描述：
设置圆形形状的圆心X轴坐标值。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_CircleShapeOption* option | 指向圆形形状的指针。 |
| float centerX | 圆心X轴坐标值，单位：px。 |
void OH_ArkUI_RenderNodeUtils_SetCircleShapeOptionCenterY(ArkUI_CircleShapeOption* option, float centerY)
描述：
设置圆形形状的圆心Y轴坐标值。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_CircleShapeOption* option | 指向圆形形状的指针。 |
| float centerY | 圆心Y轴坐标值，单位：px。 |
void OH_ArkUI_RenderNodeUtils_SetCircleShapeOptionRadius(ArkUI_CircleShapeOption* option, float radius)
描述：
设置圆形形状的半径值。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_CircleShapeOption* option | 指向圆形形状的指针。 |
| float radius | 半径值（以像素为单位）。 |
ArkUI_RoundRectShapeOption* OH_ArkUI_RenderNodeUtils_CreateRoundRectShapeOption()
描述：
创建圆角矩形形状。
使用完毕后调用OH_ArkUI_RenderNodeUtils_DisposeRoundRectShapeOption释放。
起始版本： 20
返回：
| 类型 | 说明 |
|---|---|
| ArkUI_RoundRectShapeOption* | 指向圆角矩形形状的指针。 |
void OH_ArkUI_RenderNodeUtils_DisposeRoundRectShapeOption(ArkUI_RoundRectShapeOption* option)
描述：
释放圆角矩形形状。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_RoundRectShapeOption* option | 指向圆角矩形形状的指针。 |
void OH_ArkUI_RenderNodeUtils_SetRoundRectShapeOptionEdgeValue(ArkUI_RoundRectShapeOption* option, float edgeValue, ArkUI_EdgeDirection direction)
描述：
设置圆角矩形形状的边缘值。
左边缘或上边缘可取负值，负值表示对应边缘位于节点原点左侧或上方。形状用于遮罩时，超出节点边界的部分不显示；用于裁剪且需显示节点边界外内容时，应通过OH_ArkUI_RenderNodeUtils_SetDrawRegion设置覆盖该内容的绘制区域。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_RoundRectShapeOption* option | 指向圆角矩形形状的指针。 |
| float edgeValue | 圆角矩形形状的边缘值，单位：px。 |
| ArkUI_EdgeDirection direction | 要设置边缘值的矩形方向。 |
void OH_ArkUI_RenderNodeUtils_SetRoundRectShapeOptionCornerXY(ArkUI_RoundRectShapeOption* option, float x, float y, ArkUI_CornerDirection direction)
描述：
设置指定角的X轴和Y轴圆角半径。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_RoundRectShapeOption* option | 指向圆角矩形形状的指针。 |
| float x | 指定角的X轴圆角半径，单位：px。 |
| float y | 指定角的Y轴圆角半径，单位：px。 |
| ArkUI_CornerDirection direction | 角的方向。 |
ArkUI_CommandPathOption* OH_ArkUI_RenderNodeUtils_CreateCommandPathOption()
描述：
创建自定义绘制路径。
使用完毕后调用OH_ArkUI_RenderNodeUtils_DisposeCommandPathOption释放。
起始版本： 20
返回：
| 类型 | 说明 |
|---|---|
| ArkUI_CommandPathOption* | 指向自定义绘制路径的指针。 |
void OH_ArkUI_RenderNodeUtils_DisposeCommandPathOption(ArkUI_CommandPathOption* option)
描述：
释放自定义绘制路径。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_CommandPathOption* option | 指向自定义绘制路径的指针。 |
void OH_ArkUI_RenderNodeUtils_SetCommandPathOptionCommands(ArkUI_CommandPathOption* option, char* commands)
描述：
设置自定义绘制路径的命令值。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_CommandPathOption* option | 指向自定义绘制路径的指针。 |
| char* commands | 命令值。入参格式为SVG基础形状中的<path>形状标签。 |
ArkUI_RenderNodeMaskOption* OH_ArkUI_RenderNodeUtils_CreateRenderNodeMaskOptionFromRectShape(ArkUI_RectShapeOption* shape)
描述：
从矩形形状创建遮罩。
使用完毕后调用OH_ArkUI_RenderNodeUtils_DisposeRenderNodeMaskOption释放。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_RectShapeOption* shape | 指向矩形形状的指针。 |
返回：
| 类型 | 说明 |
|---|---|
| ArkUI_RenderNodeMaskOption* | 指向渲染节点遮罩的指针。 |
ArkUI_RenderNodeMaskOption* OH_ArkUI_RenderNodeUtils_CreateRenderNodeMaskOptionFromRoundRectShape(ArkUI_RoundRectShapeOption* shape)
描述：
从圆角矩形形状创建遮罩。
使用完毕后调用OH_ArkUI_RenderNodeUtils_DisposeRenderNodeMaskOption释放。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_RoundRectShapeOption* shape | 指向圆角矩形形状的指针。 |
返回：
| 类型 | 说明 |
|---|---|
| ArkUI_RenderNodeMaskOption* | 指向渲染节点遮罩的指针。 |
ArkUI_RenderNodeMaskOption* OH_ArkUI_RenderNodeUtils_CreateRenderNodeMaskOptionFromCircleShape(ArkUI_CircleShapeOption* shape)
描述：
从圆形形状创建遮罩。
使用完毕后调用OH_ArkUI_RenderNodeUtils_DisposeRenderNodeMaskOption释放。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_CircleShapeOption* shape | 指向圆形形状的指针。 |
返回：
| 类型 | 说明 |
|---|---|
| ArkUI_RenderNodeMaskOption* | 指向渲染节点遮罩的指针。 |
ArkUI_RenderNodeMaskOption* OH_ArkUI_RenderNodeUtils_CreateRenderNodeMaskOptionFromOvalShape(ArkUI_RectShapeOption* shape)
描述：
从椭圆形形状创建遮罩。
使用完毕后调用OH_ArkUI_RenderNodeUtils_DisposeRenderNodeMaskOption释放。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_RectShapeOption* shape | 指向椭圆形形状的指针。 |
返回：
| 类型 | 说明 |
|---|---|
| ArkUI_RenderNodeMaskOption* | 指向渲染节点遮罩的指针。 |
ArkUI_RenderNodeMaskOption* OH_ArkUI_RenderNodeUtils_CreateRenderNodeMaskOptionFromCommandPath(ArkUI_CommandPathOption* path)
描述：
从自定义绘制路径创建遮罩。
使用完毕后调用OH_ArkUI_RenderNodeUtils_DisposeRenderNodeMaskOption释放。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_CommandPathOption* path | 指向自定义绘制路径的指针。 |
返回：
| 类型 | 说明 |
|---|---|
| ArkUI_RenderNodeMaskOption* | 指向渲染节点遮罩的指针。 |
void OH_ArkUI_RenderNodeUtils_DisposeRenderNodeMaskOption(ArkUI_RenderNodeMaskOption* option)
描述：
释放渲染节点遮罩。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_RenderNodeMaskOption* option | 指向渲染节点遮罩的指针。 |
void OH_ArkUI_RenderNodeUtils_SetRenderNodeMaskOptionFillColor(ArkUI_RenderNodeMaskOption* mask, uint32_t fillColor)
描述：
设置渲染节点遮罩的填充颜色。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_RenderNodeMaskOption* mask | 指向渲染节点遮罩的指针。 |
| uint32_t fillColor | 遮罩的填充颜色，ARGB格式为0xAARRGGBB，其中A、R、G、B分别表示Alpha、红、绿、蓝通道。 |
void OH_ArkUI_RenderNodeUtils_SetRenderNodeMaskOptionStrokeColor(ArkUI_RenderNodeMaskOption* mask, uint32_t strokeColor)
描述：
设置渲染节点遮罩的描边颜色。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_RenderNodeMaskOption* mask | 指向渲染节点遮罩的指针。 |
| uint32_t strokeColor | 遮罩的描边颜色，ARGB格式为0xAARRGGBB，其中A、R、G、B分别表示Alpha、红、绿、蓝通道。 |
void OH_ArkUI_RenderNodeUtils_SetRenderNodeMaskOptionStrokeWidth(ArkUI_RenderNodeMaskOption* mask, float strokeWidth)
描述：
设置渲染节点遮罩的描边宽度。
以边框路径为中心进行相应宽度的绘制。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_RenderNodeMaskOption* mask | 指向渲染节点遮罩的指针。 |
| float strokeWidth | 遮罩的描边宽度，单位：px。取值大于0时按设定宽度绘制；取值为0或负数时，按设备空间1px宽的细线绘制。 |
ArkUI_RenderNodeClipOption* OH_ArkUI_RenderNodeUtils_CreateRenderNodeClipOptionFromRectShape(ArkUI_RectShapeOption* shape)
描述：
从矩形形状创建裁剪。
使用完毕后调用OH_ArkUI_RenderNodeUtils_DisposeRenderNodeClipOption释放。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_RectShapeOption* shape | 指向矩形形状的指针。 |
返回：
| 类型 | 说明 |
|---|---|
| ArkUI_RenderNodeClipOption* | 指向渲染节点裁剪的指针。 |
ArkUI_RenderNodeClipOption* OH_ArkUI_RenderNodeUtils_CreateRenderNodeClipOptionFromRoundRectShape(ArkUI_RoundRectShapeOption* shape)
描述：
从圆角矩形形状创建裁剪。
使用完毕后调用OH_ArkUI_RenderNodeUtils_DisposeRenderNodeClipOption释放。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_RoundRectShapeOption* shape | 指向圆角矩形形状的指针。 |
返回：
| 类型 | 说明 |
|---|---|
| ArkUI_RenderNodeClipOption* | 指向渲染节点裁剪的指针。 |
ArkUI_RenderNodeClipOption* OH_ArkUI_RenderNodeUtils_CreateRenderNodeClipOptionFromCircleShape(ArkUI_CircleShapeOption* shape)
描述：
从圆形形状创建裁剪。
使用完毕后调用OH_ArkUI_RenderNodeUtils_DisposeRenderNodeClipOption释放。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_CircleShapeOption* shape | 指向圆形形状的指针。 |
返回：
| 类型 | 说明 |
|---|---|
| ArkUI_RenderNodeClipOption* | 指向渲染节点裁剪的指针。 |
ArkUI_RenderNodeClipOption* OH_ArkUI_RenderNodeUtils_CreateRenderNodeClipOptionFromOvalShape(ArkUI_RectShapeOption* shape)
描述：
从椭圆形形状创建裁剪。
使用完毕后调用OH_ArkUI_RenderNodeUtils_DisposeRenderNodeClipOption释放。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_RectShapeOption* shape | 指向椭圆形形状的指针。 |
返回：
| 类型 | 说明 |
|---|---|
| ArkUI_RenderNodeClipOption* | 指向渲染节点裁剪的指针。 |
ArkUI_RenderNodeClipOption* OH_ArkUI_RenderNodeUtils_CreateRenderNodeClipOptionFromCommandPath(ArkUI_CommandPathOption* path)
描述：
从自定义绘制路径创建裁剪。
使用完毕后调用OH_ArkUI_RenderNodeUtils_DisposeRenderNodeClipOption释放。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_CommandPathOption* path | 指向自定义绘制路径的指针。 |
返回：
| 类型 | 说明 |
|---|---|
| ArkUI_RenderNodeClipOption* | 指向渲染节点裁剪的指针。 |
void OH_ArkUI_RenderNodeUtils_DisposeRenderNodeClipOption(ArkUI_RenderNodeClipOption* option)
描述：
释放渲染节点裁剪。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_RenderNodeClipOption* option | 指向渲染节点裁剪的指针。 |
int32_t OH_ArkUI_RenderNodeUtils_GetRenderNode(ArkUI_NodeHandle node, ArkUI_RenderNodeHandle* renderNode)
描述：
获取已被接纳为附属节点的目标节点的RenderNode。如果一个RenderNode是通过该接口获取的，调用ArkUI_NativeNodeAPI_1的disposeNode接口主动销毁FrameNode时，需要额外调用OH_ArkUI_RenderNodeUtils_DisposeNode释放该RenderNode。
起始版本： 22
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_NodeHandle node | ArkUI_NodeHandle指针，指定目标节点。 |
| ArkUI_RenderNodeHandle* renderNode | ArkUI_RenderNodeHandle*指针，目标节点的RenderNode。 |
返回：
| 类型 | 说明 |
|---|---|
| int32_t | 错误码。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_CAPI_INIT_ERROR CAPI初始化失败。 ARKUI_ERROR_CODE_RENDER_NOT_ADOPTED_NODE 该节点未被接纳为附属节点。 |
void OH_ArkUI_RenderNodeUtils_SetRectShapeOptionValue(ArkUI_RectShapeOption* option, float x, float y, float width, float height)
描述：
设置矩形形状选项的边框矩形范围。
起始版本： 26.0.0
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_RectShapeOption* option | 指向待配置矩形形状选项的指针。 |
| float x | 矩形左上角的X坐标，用于确定左边界位置。 |
| float y | 矩形左上角的Y坐标，用于确定上边界位置。 |
| float width | 矩形宽度，表示从X坐标起的水平跨度，用于确定右侧边界的位置，即矩形右下角的X坐标 = x + width。 |
| float height | 矩形高度，表示从Y坐标起的垂直跨度，用于确定底部边界的位置，即矩形右下角的Y坐标 = y + height。 |
void OH_ArkUI_RenderNodeUtils_SetRoundRectShapeOptionValue(ArkUI_RoundRectShapeOption* option, float x, float y, float width, float height)
描述：
设置圆角矩形形状选项的边框矩形范围。
起始版本： 26.0.0
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_RoundRectShapeOption* option | 指向待配置圆角矩形形状选项的指针。 |
| float x | 矩形左上角的X坐标，用于确定左边界位置。 |
| float y | 矩形左上角的Y坐标，用于确定上边界位置。 |
| float width | 矩形宽度，表示从X坐标起的水平跨度，用于确定右侧边界的位置，即矩形右下角的X坐标 = x + width。 |
| float height | 矩形高度，表示从Y坐标起的垂直跨度，用于确定底部边界的位置，即矩形右下角的Y坐标 = y + height。 |
ArkUI_RenderBlurStyleOption* OH_ArkUI_RenderNodeUtils_CreateBlurStyleOption()
描述：
创建一个模糊样式对象。
使用完毕后调用OH_ArkUI_RenderNodeUtils_DisposeBlurStyleOption销毁并释放资源。
起始版本： 26.0.0
返回：
| 类型 | 说明 |
|---|---|
| ArkUI_RenderBlurStyleOption* | 模糊样式对象的指针。模糊半径默认值是0.0。 |
void OH_ArkUI_RenderNodeUtils_DisposeBlurStyleOption(ArkUI_RenderBlurStyleOption* option)
描述：
销毁一个模糊样式对象。
起始版本： 26.0.0
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_RenderBlurStyleOption* option | ArkUI_RenderBlurStyleOption指针，待销毁的目标模糊样式对象的指针。 |
int32_t OH_ArkUI_RenderNodeUtils_SetBlurStyleOptionRadius(ArkUI_RenderBlurStyleOption* option, float radius)
描述：
为目标模糊样式设置模糊半径。
模糊半径用于控制模糊的密度，半径越大，模糊处理的密度越大；设置为0时不进行模糊处理。对于背景模糊处理，半径达到80px时可实现良好的磨砂玻璃效果；应避免使用超过200px的模糊半径，否则将导致性能下降。
起始版本： 26.0.0
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_RenderBlurStyleOption* option | ArkUI_RenderBlurStyleOption指针，要设置模糊半径的目标模糊样式的指针。 |
| float radius | 要设置的模糊半径。 取值范围：[0, +∞)。 单位：px。 传入负值时返回ARKUI_ERROR_CODE_PARAM_INVALID。 |
返回：
| 类型 | 说明 |
|---|---|
| int32_t | 错误码。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 |
int32_t OH_ArkUI_RenderNodeUtils_SetBackgroundBlurOption(ArkUI_RenderNodeHandle node, ArkUI_RenderBlurStyleOption* option)
描述：
为渲染节点设置背景模糊样式，适用于模糊节点背后内容的场景。
起始版本： 26.0.0
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_RenderNodeHandle node | ArkUI_RenderNodeHandle指针，要设置背景模糊样式的目标渲染节点。 |
| ArkUI_RenderBlurStyleOption* option | ArkUI_RenderBlurStyleOption指针，要设置的模糊样式的指针。 |
返回：
| 类型 | 说明 |
|---|---|
| int32_t | 错误码。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_RENDER_IS_FROM_FRAME_NODE 目标节点是从一个FrameNode获取的。 ARKUI_ERROR_CODE_CAPI_INIT_ERROR CAPI初始化失败。 |
int32_t OH_ArkUI_RenderNodeUtils_ResetBackgroundBlurOption(ArkUI_RenderNodeHandle node)
描述：
为渲染节点重置背景模糊样式。
重置后无背景模糊样式。
起始版本： 26.0.0
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_RenderNodeHandle node | ArkUI_RenderNodeHandle指针，要重置背景模糊样式的目标渲染节点。 |
返回：
| 类型 | 说明 |
|---|---|
| int32_t | 错误码。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_RENDER_IS_FROM_FRAME_NODE 目标节点是从一个FrameNode获取的。 ARKUI_ERROR_CODE_CAPI_INIT_ERROR CAPI初始化失败。 |
int32_t OH_ArkUI_RenderNodeUtils_SetForegroundBlurOption(ArkUI_RenderNodeHandle node, ArkUI_RenderBlurStyleOption* option)
描述：
为渲染节点设置前景模糊样式，适用于模糊节点前景层的场景。
起始版本： 26.0.0
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_RenderNodeHandle node | ArkUI_RenderNodeHandle指针，要设置前景模糊样式的目标渲染节点。 |
| ArkUI_RenderBlurStyleOption* option | ArkUI_RenderBlurStyleOption指针，要设置的模糊样式的指针。 |
返回：
| 类型 | 说明 |
|---|---|
| int32_t | 错误码。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_RENDER_IS_FROM_FRAME_NODE 目标节点是从一个FrameNode获取的。 ARKUI_ERROR_CODE_CAPI_INIT_ERROR CAPI初始化失败。 |
int32_t OH_ArkUI_RenderNodeUtils_ResetForegroundBlurOption(ArkUI_RenderNodeHandle node)
描述：
为渲染节点重置前景模糊样式。
重置后无前景模糊样式。
起始版本： 26.0.0
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_RenderNodeHandle node | ArkUI_RenderNodeHandle指针，要重置前景模糊样式的目标渲染节点。 |
返回：
| 类型 | 说明 |
|---|---|
| int32_t | 错误码。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_RENDER_IS_FROM_FRAME_NODE 目标节点是从一个FrameNode获取的。 ARKUI_ERROR_CODE_CAPI_INIT_ERROR CAPI初始化失败。 |
int32_t OH_ArkUI_RenderNodeUtils_SetContentBlurOption(ArkUI_RenderNodeHandle node, ArkUI_RenderBlurStyleOption* option)
描述：
为渲染节点设置内容模糊样式，适用于模糊节点自身绘制内容的场景。
起始版本： 26.0.0
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_RenderNodeHandle node | ArkUI_RenderNodeHandle指针，要设置内容模糊样式的目标渲染节点。 |
| ArkUI_RenderBlurStyleOption* option | ArkUI_RenderBlurStyleOption指针，要设置的模糊样式的指针。 |
返回：
| 类型 | 说明 |
|---|---|
| int32_t | 错误码。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_RENDER_IS_FROM_FRAME_NODE 目标节点是从一个FrameNode获取的。 ARKUI_ERROR_CODE_CAPI_INIT_ERROR CAPI初始化失败。 |
int32_t OH_ArkUI_RenderNodeUtils_ResetContentBlurOption(ArkUI_RenderNodeHandle node)
描述：
为渲染节点重置内容模糊样式。
重置后无内容模糊样式。
起始版本： 26.0.0
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_RenderNodeHandle node | ArkUI_RenderNodeHandle指针，要重置内容模糊样式的目标渲染节点。 |
返回：
| 类型 | 说明 |
|---|---|
| int32_t | 错误码。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_RENDER_IS_FROM_FRAME_NODE 目标节点是从一个FrameNode获取的。 ARKUI_ERROR_CODE_CAPI_INIT_ERROR CAPI初始化失败。 |
ArkUI_ErrorCode OH_ArkUI_RenderNodeUtils_InsertRenderNodeAt(ArkUI_NodeHandle node, ArkUI_RenderNodeHandle child, int32_t position)
描述：
在父自定义节点下的指定位置插入子渲染节点。
默认使用OH_ARKUI_NODE_MOUNT_POLICY_SINGLE_IF_RENDER_NODE挂载策略，待插入的子渲染节点必须是父节点的唯一子节点；可通过OH_ArkUI_NativeModule_SetChildMountPolicy将挂载策略设置为OH_ARKUI_NODE_MOUNT_POLICY_MIXED，以混合挂载多个子节点。
起始版本： 26.0.0
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_NodeHandle node | 目标父节点，仅支持ArkUI_NodeType中的ARKUI_NODE_CUSTOM类型。 |
| ArkUI_RenderNodeHandle child | 将要插入的子渲染节点。 |
| int32_t position | 插入子渲染节点的索引，取值范围为[0, 当前子节点数量]；等于当前子节点数量时等同于添加操作。 |
返回：
| 类型 | 说明 |
|---|---|
| ArkUI_ErrorCode | 错误码。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_CAPI_INIT_ERROR CAPI初始化失败。 ARKUI_ERROR_CODE_NOT_CUSTOM_NODE 目标节点非自定义节点。 ARKUI_ERROR_CODE_CHILD_EXISTED 使用非OH_ARKUI_NODE_MOUNT_POLICY_MIXED挂载策略时，父节点已有子节点。 ARKUI_ERROR_CODE_RENDER_PARENT_EXISTED 目标渲染节点存在父节点。 ARKUI_ERROR_CODE_RENDER_HAS_INVALID_FRAME_NODE 当前渲染节点从FrameNode中获取且该FrameNode已被取消接纳为附属节点或销毁。 |
ArkUI_ErrorCode OH_ArkUI_RenderNodeUtils_GetRenderNodeChildrenCount(ArkUI_NodeHandle node, int32_t* count)
描述：
获取父自定义节点在混合挂载顺序中的全部子节点数量。
计数包含普通节点和渲染节点。父节点需为ARKUI_NODE_CUSTOM类型，并已通过OH_ArkUI_NativeModule_SetChildMountPolicy设置OH_ARKUI_NODE_MOUNT_POLICY_MIXED策略；否则返回ARKUI_ERROR_CODE_PARAM_INVALID。
起始版本： 26.0.0
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_NodeHandle node | 待查询的父节点。 |
| int32_t* count | 用于接收子节点数量的指针。 |
返回：
| 类型 | 说明 |
|---|---|
| ArkUI_ErrorCode | 错误码。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_CAPI_INIT_ERROR CAPI初始化失败。 |
ArkUI_ErrorCode OH_ArkUI_RenderNodeUtils_GetRenderNodeAt(ArkUI_NodeHandle node, int32_t position, ArkUI_RenderNodeHandle* child)
描述：
获取父自定义节点在混合挂载顺序中指定位置子节点对应的渲染节点句柄。
父节点需为ARKUI_NODE_CUSTOM类型，并已通过OH_ArkUI_NativeModule_SetChildMountPolicy设置OH_ARKUI_NODE_MOUNT_POLICY_MIXED策略；否则返回ARKUI_ERROR_CODE_PARAM_INVALID。
起始版本： 26.0.0
参数：
| 参数项 | 描述 |
|---|---|
| ArkUI_NodeHandle node | 目标父节点。 |
| int32_t position | 子节点的索引，取值范围为[0, 当前子节点数量-1]。 |
| ArkUI_RenderNodeHandle* child | 用于接收指定位置子节点对应的渲染节点句柄的指针，不可为空。 |
返回：
| 类型 | 说明 |
|---|---|
| ArkUI_ErrorCode | 错误码。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_CAPI_INIT_ERROR CAPI初始化失败。 |