已合并
添加material系统材质相关文档 #142968
hehongyang3创建于 5月6日
添加material系统材质相关文档 #142968
已合并
共 8 个文件变更+633-0
| @@ -590,6 +590,7 @@ | |||
| 590 | - [native_interface_focus.h](capi-native-interface-focus-h.md) | 590 | - [native_interface_focus.h](capi-native-interface-focus-h.md) |
| 591 | - [native_interface_xcomponent.h](capi-native-interface-xcomponent-h.md) | 591 | - [native_interface_xcomponent.h](capi-native-interface-xcomponent-h.md) |
| 592 | - [native_key_event.h](capi-native-key-event-h.md) | 592 | - [native_key_event.h](capi-native-key-event-h.md) |
| 593 | + - [native_material.h](capi-native-material-h.md) | ||
| 593 | - [native_node.h](capi-native-node-h.md) | 594 | - [native_node.h](capi-native-node-h.md) |
| 594 | - [ArkUI_NodeAttributeType(基础属性)](capi-native-node-h-nodeattributetype-base.md) | 595 | - [ArkUI_NodeAttributeType(基础属性)](capi-native-node-h-nodeattributetype-base.md) |
| 595 | - [ArkUI_NodeAttributeType(通用属性)](capi-native-node-h-nodeattributetype-common.md) | 596 | - [ArkUI_NodeAttributeType(通用属性)](capi-native-node-h-nodeattributetype-common.md) |
| @@ -802,6 +803,10 @@ | |||
| 802 | - [ArkUI_CommandPathOption](capi-arkui-nativemodule-arkui-commandpathoption.md) | 803 | - [ArkUI_CommandPathOption](capi-arkui-nativemodule-arkui-commandpathoption.md) |
| 803 | - [ArkUI_FloatAnimatablePropertyHandle](capi-arkui-nativemodule-arkui-floatanimatablepropertyhandle.md) | 804 | - [ArkUI_FloatAnimatablePropertyHandle](capi-arkui-nativemodule-arkui-floatanimatablepropertyhandle.md) |
| 804 | - [ArkUI_FloatPropertyHandle](capi-arkui-nativemodule-arkui-floatpropertyhandle.md) | 805 | - [ArkUI_FloatPropertyHandle](capi-arkui-nativemodule-arkui-floatpropertyhandle.md) |
| 806 | + - [ArkUI_ImmersiveMaterial](./capi-arkui-nativemodule-arkui-immersivematerial.md) | ||
| 807 | + - [ArkUI_ImmersiveMaterial*](./capi-arkui-nativemodule-arkui-immersivematerialhandle.md) | ||
| 808 | + - [ArkUI_LightEffectOptions](./capi-arkui-nativemodule-arkui-lighteffectoptions.md) | ||
| 809 | + - [ArkUI_LightEffectOptions*](./capi-arkui-nativemodule-arkui-lighteffectoptionshandle.md) | ||
| 805 | - [ArkUI_NodeBorderColorOption](capi-arkui-nativemodule-arkui-nodebordercoloroption.md) | 810 | - [ArkUI_NodeBorderColorOption](capi-arkui-nativemodule-arkui-nodebordercoloroption.md) |
| 806 | - [ArkUI_NodeBorderRadiusOption](capi-arkui-nativemodule-arkui-nodeborderradiusoption.md) | 811 | - [ArkUI_NodeBorderRadiusOption](capi-arkui-nativemodule-arkui-nodeborderradiusoption.md) |
| 807 | - [ArkUI_NodeBorderStyleOption](capi-arkui-nativemodule-arkui-nodeborderstyleoption.md) | 812 | - [ArkUI_NodeBorderStyleOption](capi-arkui-nativemodule-arkui-nodeborderstyleoption.md) |
| @@ -0,0 +1,27 @@ | |||
| 1 | +# ArkUI_ImmersiveMaterial | ||
| 2 | +<!--Kit: ArkUI--> | ||
| 3 | +<!--Subsystem: ArkUI--> | ||
| 4 | +<!--Owner: @hehongyang3--> | ||
| 5 | +<!--Designer: @zhanghaibo0--> | ||
| 6 | +<!--Tester: @lxl007--> | ||
| 7 | +<!--Adviser: @Brilliantry_Rui--> | ||
| 8 | + | ||
| 9 | +```c | ||
| 10 | +typedef struct ArkUI_ImmersiveMaterial ArkUI_ImmersiveMaterial | ||
| 11 | +``` | ||
| 12 | + | ||
| 13 | +## 概述 | ||
| 14 | + | ||
| 15 | +定义Native侧的沉浸式材质对象。 | ||
| 16 | + | ||
| 17 | +沉浸式材质根据设备算力等级分为不同等级。 | ||
| 18 | + | ||
| 19 | +材质等级由[ArkUI_MaterialLevel](./capi-native-material-h.md#arkui_materiallevel)定义,可通过[OH_ArkUI_NativeModule_GetGlobalMaterialLevel](./capi-native-material-h.md#oh_arkui_nativemodule_getglobalmateriallevel)获取。 | ||
| 20 | + | ||
| 21 | +在高算力和中算力设备上,会影响材质层的滤镜效果和阴影([NODE_SHADOW](./capi-native-node-h-nodeattributetype-animator.md#node_shadow)或[NODE_CUSTOM_SHADOW](./capi-native-node-h-nodeattributetype-animator.md#node_custom_shadow))效果。在低算力设备上,会影响背景颜色[NODE_BACKGROUND_COLOR](./capi-native-node-h-nodeattributetype-common.md#node_background_color)、边框颜色[NODE_BORDER_COLOR](./capi-native-node-h-nodeattributetype-layoutattributes.md#node_border_color)、边框宽度[NODE_BORDER_WIDTH](./capi-native-node-h-nodeattributetype-layoutattributes.md#node_border_width)和阴影([NODE_SHADOW](./capi-native-node-h-nodeattributetype-animator.md#node_shadow)或[NODE_CUSTOM_SHADOW](./capi-native-node-h-nodeattributetype-animator.md#node_custom_shadow))效果。 | ||
| 22 | + | ||
| 23 | +**起始版本:** 26.0.0 | ||
| 24 | + | ||
| 25 | +**相关模块:** [ArkUI_NativeModule](capi-arkui-nativemodule.md) | ||
| 26 | + | ||
| 27 | +**所在头文件:** [native_material.h](capi-native-material-h.md) | ||
Azh-cn/application-dev/reference/apis-arkui/capi-arkui-nativemodule-arkui-immersivematerialhandle.md+23-0
| @@ -0,0 +1,23 @@ | |||
| 1 | +# ArkUI_ImmersiveMaterial* | ||
| 2 | +<!--Kit: ArkUI--> | ||
| 3 | +<!--Subsystem: ArkUI--> | ||
| 4 | +<!--Owner: @hehongyang3--> | ||
| 5 | +<!--Designer: @zhanghaibo0--> | ||
| 6 | +<!--Tester: @lxl007--> | ||
| 7 | +<!--Adviser: @Brilliantry_Rui--> | ||
| 8 | + | ||
| 9 | +```c | ||
| 10 | +typedef struct ArkUI_ImmersiveMaterial* ArkUI_ImmersiveMaterialHandle | ||
| 11 | +``` | ||
| 12 | + | ||
| 13 | +## 概述 | ||
| 14 | + | ||
| 15 | +定义指向沉浸式材质对象的指针。 | ||
| 16 | + | ||
| 17 | +可以通过[OH_ArkUI_NativeModule_ImmersiveMaterial_Create](./capi-native-material-h.md#oh_arkui_nativemodule_immersivematerial_create)创建沉浸式材质对象。可以通过[OH_ArkUI_NativeModule_ImmersiveMaterial_Destroy](./capi-native-material-h.md#oh_arkui_nativemodule_immersivematerial_destroy)接口销毁沉浸式材质对象。 | ||
| 18 | + | ||
| 19 | +**起始版本:** 26.0.0 | ||
| 20 | + | ||
| 21 | +**相关模块:** [ArkUI_NativeModule](capi-arkui-nativemodule.md) | ||
| 22 | + | ||
| 23 | +**所在头文件:** [native_material.h](capi-native-material-h.md) | ||
Azh-cn/application-dev/reference/apis-arkui/capi-arkui-nativemodule-arkui-lighteffectoptions.md+23-0
| @@ -0,0 +1,23 @@ | |||
| 1 | +# ArkUI_LightEffectOptions | ||
| 2 | +<!--Kit: ArkUI--> | ||
| 3 | +<!--Subsystem: ArkUI--> | ||
| 4 | +<!--Owner: @hehongyang3--> | ||
| 5 | +<!--Designer: @zhanghaibo0--> | ||
| 6 | +<!--Tester: @lxl007--> | ||
| 7 | +<!--Adviser: @Brilliantry_Rui--> | ||
| 8 | + | ||
| 9 | +```c | ||
| 10 | +typedef struct ArkUI_LightEffectOptions ArkUI_LightEffectOptions | ||
| 11 | +``` | ||
| 12 | + | ||
| 13 | +## 概述 | ||
| 14 | + | ||
| 15 | +定义沉浸式材质的光感交互效果配置对象。 | ||
| 16 | + | ||
| 17 | +创建时默认光感交互颜色为白色(0xffffffff)。 | ||
| 18 | + | ||
| 19 | +**起始版本:** 26.0.0 | ||
| 20 | + | ||
| 21 | +**相关模块:** [ArkUI_NativeModule](capi-arkui-nativemodule.md) | ||
| 22 | + | ||
| 23 | +**所在头文件:** [native_material.h](capi-native-material-h.md) | ||
Azh-cn/application-dev/reference/apis-arkui/capi-arkui-nativemodule-arkui-lighteffectoptionshandle.md+23-0
| @@ -0,0 +1,23 @@ | |||
| 1 | +# ArkUI_LightEffectOptions* | ||
| 2 | +<!--Kit: ArkUI--> | ||
| 3 | +<!--Subsystem: ArkUI--> | ||
| 4 | +<!--Owner: @hehongyang3--> | ||
| 5 | +<!--Designer: @zhanghaibo0--> | ||
| 6 | +<!--Tester: @lxl007--> | ||
| 7 | +<!--Adviser: @Brilliantry_Rui--> | ||
| 8 | + | ||
| 9 | +```c | ||
| 10 | +typedef ArkUI_LightEffectOptions* ArkUI_LightEffectOptionsHandle | ||
| 11 | +``` | ||
| 12 | + | ||
| 13 | +## 概述 | ||
| 14 | + | ||
| 15 | +定义指向光感交互效果配置对象的指针。 | ||
| 16 | + | ||
| 17 | +可以通过[OH_ArkUI_NativeModule_LightEffectOptions_Create](./capi-native-material-h.md#oh_arkui_nativemodule_lighteffectoptions_create)创建光感交互效果配置对象。可以通过[OH_ArkUI_NativeModule_LightEffectOptions_Destroy](./capi-native-material-h.md#oh_arkui_nativemodule_lighteffectoptions_destroy)接口销毁光感交互效果配置对象。 | ||
| 18 | + | ||
| 19 | +**起始版本:** 26.0.0 | ||
| 20 | + | ||
| 21 | +**相关模块:** [ArkUI_NativeModule](capi-arkui-nativemodule.md) | ||
| 22 | + | ||
| 23 | +**所在头文件:** [native_material.h](capi-native-material-h.md) | ||
| @@ -32,6 +32,7 @@ | |||
| 32 | | [native_interface.h](capi-native-interface-h.md) | 提供NativeModule接口的统一入口函数。 | | 32 | | [native_interface.h](capi-native-interface-h.md) | 提供NativeModule接口的统一入口函数。 | |
| 33 | | [native_interface_focus.h](capi-native-interface-focus-h.md) | 定义焦点管理的相关接口,主要用于主动转移焦点或管理控制焦点转移默认行为,控制焦点激活态。 | | 33 | | [native_interface_focus.h](capi-native-interface-focus-h.md) | 定义焦点管理的相关接口,主要用于主动转移焦点或管理控制焦点转移默认行为,控制焦点激活态。 | |
| 34 | | [native_key_event.h](capi-native-key-event-h.md) | 提供NativeKeyEvent相关接口定义。 | | 34 | | [native_key_event.h](capi-native-key-event-h.md) | 提供NativeKeyEvent相关接口定义。 | |
| 35 | +| [native_material.h](capi-native-material-h.md) | 提供ArkUI在Native侧的沉浸式材质类型和API声明。 | | ||
| 35 | | [native_node.h](capi-native-node-h.md) | 提供NativeNode接口的类型定义。 | | 36 | | [native_node.h](capi-native-node-h.md) | 提供NativeNode接口的类型定义。 | |
| 36 | | [native_node_napi.h](capi-native-node-napi-h.md) | 提供ArkTS侧的FrameNode转换NodeHandle的方式。 | | 37 | | [native_node_napi.h](capi-native-node-napi-h.md) | 提供ArkTS侧的FrameNode转换NodeHandle的方式。 | |
| 37 | | [native_type.h](capi-native-type-h.md) | 提供NativeModule公共的类型定义。 | | 38 | | [native_type.h](capi-native-type-h.md) | 提供NativeModule公共的类型定义。 | |
| @@ -0,0 +1,503 @@ | |||||||
| 1 | +# native_material.h | ||||||
| 2 | + | ||||||
| 3 | +<!--Kit: ArkUI--> | ||||||
| 4 | +<!--Subsystem: ArkUI--> | ||||||
| 5 | +<!--Owner: @hehongyang3--> | ||||||
| 6 | +<!--Designer: @zhanghaibo0--> | ||||||
| 7 | +<!--Tester: @lxl007--> | ||||||
| 8 | +<!--Adviser: @Brilliantry_Rui--> | ||||||
| 9 | + | ||||||
| 10 | +## 概述 | ||||||
| 11 | + | ||||||
| 12 | +提供ArkUI在Native侧的沉浸式材质类型和API声明。 | ||||||
改动建议
![]() ![]() | |||||||
| 13 | + | ||||||
| 14 | +**引用文件:** <arkui/native_material.h> | ||||||
| 15 | + | ||||||
| 16 | +**库:** libace_ndk.z.so | ||||||
| 17 | + | ||||||
| 18 | +**系统能力:** SystemCapability.ArkUI.ArkUI.Full | ||||||
| 19 | + | ||||||
| 20 | +**相关模块:** [ArkUI_NativeModule](capi-arkui-nativemodule.md) | ||||||
| 21 | + | ||||||
| 22 | +**起始版本:** 26.0.0 | ||||||
[🟡中] 头文件页缺少相关模块字段 同目录已有 C API 头文件页(如 建议补充: ![]() ![]() | |||||||
| 23 | + | ||||||
| 24 | +## 汇总 | ||||||
[🟡中] 汇总章节遗漏本头文件定义的类型 配套 建议在“汇总”中补充结构体/类型列表,并链接到这 4 个新增页面。 ![]() ![]() | |||||||
| 25 | + | ||||||
| 26 | +### 枚举 | ||||||
| 27 | + | ||||||
| 28 | +| 名称 | typedef关键字 | 描述 | | ||||||
| 29 | +| -- | -- | -- | | ||||||
| 30 | +| [ArkUI_ImmersiveStyle](#arkui_immersivestyle) | ArkUI_ImmersiveStyle | 沉浸式材质样式枚举。不同样式对应不同的材质参数,影响材质的薄厚程度。 | | ||||||
| 31 | +| [ArkUI_MaterialLevel](#arkui_materiallevel) | ArkUI_MaterialLevel | 材质等级枚举,与设备的算力等级相关。使用[OH_ArkUI_NativeModule_GetGlobalMaterialLevel](#oh_arkui_nativemodule_getglobalmateriallevel)可获取当前设备的材质等级。 | | ||||||
| 32 | + | ||||||
| 33 | +### 结构体 | ||||||
| 34 | + | ||||||
| 35 | +| 名称 | typedef关键字 | 描述 | | ||||||
| 36 | +| -- | -- | -- | | ||||||
| 37 | +| [ArkUI_ImmersiveMaterial](./capi-arkui-nativemodule-arkui-immersivematerial.md) | ArkUI_ImmersiveMaterial | 定义Native侧的沉浸式材质对象。沉浸式材质根据设备算力等级分为不同等级。材质等级由[ArkUI_MaterialLevel](#arkui_materiallevel)定义,可通过[OH_ArkUI_NativeModule_GetGlobalMaterialLevel](#oh_arkui_nativemodule_getglobalmateriallevel)获取。在高算力和中算力设备上,会影响材质层的滤镜效果和阴影([NODE_SHADOW](./capi-native-node-h-nodeattributetype-animator.md#node_shadow)或[NODE_CUSTOM_SHADOW](./capi-native-node-h-nodeattributetype-animator.md#node_custom_shadow))效果。在低算力设备上,会影响背景颜色[NODE_BACKGROUND_COLOR](./capi-native-node-h-nodeattributetype-common.md#node_background_color)、边框颜色[NODE_BORDER_COLOR](./capi-native-node-h-nodeattributetype-layoutattributes.md#node_border_color)、边框宽度[NODE_BORDER_WIDTH](./capi-native-node-h-nodeattributetype-layoutattributes.md#node_border_width)和阴影([NODE_SHADOW](./capi-native-node-h-nodeattributetype-animator.md#node_shadow)或[NODE_CUSTOM_SHADOW](./capi-native-node-h-nodeattributetype-animator.md#node_custom_shadow))效果。 | | ||||||
| 38 | +| [ArkUI_ImmersiveMaterial*](./capi-arkui-nativemodule-arkui-immersivematerialhandle.md) | ArkUI_ImmersiveMaterialHandle | 定义指向沉浸式材质对象的指针。可以通过[OH_ArkUI_NativeModule_ImmersiveMaterial_Create](#oh_arkui_nativemodule_immersivematerial_create)创建沉浸式材质对象。可以通过[OH_ArkUI_NativeModule_ImmersiveMaterial_Destroy](#oh_arkui_nativemodule_immersivematerial_destroy)接口销毁沉浸式材质对象。 | | ||||||
| 39 | +| [ArkUI_LightEffectOptions](./capi-arkui-nativemodule-arkui-lighteffectoptions.md) | ArkUI_LightEffectOptions | 定义沉浸式材质的光感交互效果配置对象。创建时默认光感交互颜色为白色(0xffffffff)。 | | ||||||
| 40 | +| [ArkUI_LightEffectOptions*](./capi-arkui-nativemodule-arkui-lighteffectoptionshandle.md) | ArkUI_LightEffectOptionsHandle | 定义指向光感交互效果配置对象的指针。可以通过[OH_ArkUI_NativeModule_LightEffectOptions_Create](#oh_arkui_nativemodule_lighteffectoptions_create)创建光感交互效果配置对象。可以通过[OH_ArkUI_NativeModule_LightEffectOptions_Destroy](#oh_arkui_nativemodule_lighteffectoptions_destroy)接口销毁光感交互效果配置对象。 | | ||||||
| 41 | + | ||||||
| 42 | +### 函数 | ||||||
| 43 | + | ||||||
| 44 | +| 名称 | typedef关键字 | 描述 | | ||||||
| 45 | +| -- | -- | -- | | ||||||
| 46 | +| [bool OH_ArkUI_NativeModule_GetSystemMaterialSupported()](#oh_arkui_nativemodule_getsystemmaterialsupported) | - | 检查当前设备是否支持系统材质。如果返回true,则可以使用[NODE_SYSTEM_MATERIAL](./capi-native-node-h-nodeattributetype-animator.md#node_system_material)属性,否则设置该属性将无效。该配置项由设备定义,不可修改。 | | ||||||
| 47 | +| [ArkUI_MaterialLevel OH_ArkUI_NativeModule_GetGlobalMaterialLevel()](#oh_arkui_nativemodule_getglobalmateriallevel) | - | 获取全局材质等级,与设备的算力相关。该配置项由设备定义,不可修改。 | | ||||||
| 48 | +| [ArkUI_ImmersiveMaterialHandle OH_ArkUI_NativeModule_ImmersiveMaterial_Create(ArkUI_ImmersiveStyle style)](#oh_arkui_nativemodule_immersivematerial_create) | - | 创建具有指定样式的沉浸式材质对象。创建的材质等级跟随全局材质等级,可通过[OH_ArkUI_NativeModule_GetGlobalMaterialLevel](#oh_arkui_nativemodule_getglobalmateriallevel)获取。 | | ||||||
| 49 | +| [void OH_ArkUI_NativeModule_ImmersiveMaterial_Destroy(ArkUI_ImmersiveMaterialHandle material)](#oh_arkui_nativemodule_immersivematerial_destroy) | - | 销毁沉浸式材质对象。 | | ||||||
| 50 | +| [ArkUI_ErrorCode OH_ArkUI_NativeModule_ImmersiveMaterial_SetStyle(ArkUI_ImmersiveMaterialHandle material, ArkUI_ImmersiveStyle style)](#oh_arkui_nativemodule_immersivematerial_setstyle) | - | 设置沉浸式材质对象的样式。该参数仅对高算力和中算力设备的显示效果有效,对低算力设备不生效但不会报错。 | | ||||||
| 51 | +| [ArkUI_ErrorCode OH_ArkUI_NativeModule_ImmersiveMaterial_GetStyle(ArkUI_ImmersiveMaterialHandle material, ArkUI_ImmersiveStyle* style)](#oh_arkui_nativemodule_immersivematerial_getstyle) | - | 获取沉浸式材质对象的样式。 | | ||||||
| 52 | +| [ArkUI_ErrorCode OH_ArkUI_NativeModule_ImmersiveMaterial_SetMaterialColor(ArkUI_ImmersiveMaterialHandle material, uint32_t color)](#oh_arkui_nativemodule_immersivematerial_setmaterialcolor) | - | 设置沉浸式材质对象的材质颜色。该参数仅对高算力和中算力设备的显示效果有效,对低算力设备不生效但不会报错。如果不设置,默认值为0,表示透明色。 | | ||||||
| 53 | +| [ArkUI_ErrorCode OH_ArkUI_NativeModule_ImmersiveMaterial_GetMaterialColor(ArkUI_ImmersiveMaterialHandle material, uint32_t* color)](#oh_arkui_nativemodule_immersivematerial_getmaterialcolor) | - | 获取沉浸式材质对象的材质颜色。 | | ||||||
| 54 | +| [ArkUI_ErrorCode OH_ArkUI_NativeModule_ImmersiveMaterial_SetApplyShadow(ArkUI_ImmersiveMaterialHandle material, bool applyShadow)](#oh_arkui_nativemodule_immersivematerial_setapplyshadow) | - | 设置沉浸式材质对象的是否应用阴影属性。该参数对所有等级材质都生效。当该参数为true时,材质中的阴影效果生效,优先于阴影通用属性。当该参数为false时,阴影通用属性生效,材质无阴影效果。如果不设置,默认值为true。 | | ||||||
| 55 | +| [ArkUI_ErrorCode OH_ArkUI_NativeModule_ImmersiveMaterial_GetApplyShadow(ArkUI_ImmersiveMaterialHandle material, bool* applyShadow)](#oh_arkui_nativemodule_immersivematerial_getapplyshadow) | - | 获取沉浸式材质对象的是否应用阴影属性。 | | ||||||
| 56 | +| [ArkUI_ErrorCode OH_ArkUI_NativeModule_ImmersiveMaterial_SetInteractive(ArkUI_ImmersiveMaterialHandle material, bool interactive)](#oh_arkui_nativemodule_immersivematerial_setinteractive) | - | 设置沉浸式材质对象的是否可交互形变属性。该参数对所有等级材质都生效。当该参数为true时,材质可交互形变。当该参数为false时,材质不可交互形变。如果不设置,遵循组件的行为。 | | ||||||
| 57 | +| [ArkUI_ErrorCode OH_ArkUI_NativeModule_ImmersiveMaterial_GetInteractive(ArkUI_ImmersiveMaterialHandle material, bool* interactive)](#oh_arkui_nativemodule_immersivematerial_getinteractive) | - | 获取沉浸式材质对象的是否可交互形变属性。如果从未设置过该属性,函数将返回[ARKUI_ERROR_CODE_PARAM_ERROR](./capi-native-type-h.md#arkui_errorcode)。 | | ||||||
| 58 | +| [ArkUI_LightEffectOptionsHandle OH_ArkUI_NativeModule_LightEffectOptions_Create()](#oh_arkui_nativemodule_lighteffectoptions_create) | - | 创建光感交互效果配置对象,默认颜色为白色(0xffffffff)。 | | ||||||
| 59 | +| [void OH_ArkUI_NativeModule_LightEffectOptions_Destroy(ArkUI_LightEffectOptionsHandle options)](#oh_arkui_nativemodule_lighteffectoptions_destroy) | - | 销毁光感交互效果配置对象。 | | ||||||
| 60 | +| [ArkUI_ErrorCode OH_ArkUI_NativeModule_LightEffectOptions_SetColor(ArkUI_LightEffectOptionsHandle options, uint32_t color)](#oh_arkui_nativemodule_lighteffectoptions_setcolor) | - | 设置光感交互效果的颜色。如果不设置,默认颜色为白色(0xffffffff)。 | | ||||||
| 61 | +| [ArkUI_ErrorCode OH_ArkUI_NativeModule_ImmersiveMaterial_SetLightEffect(ArkUI_ImmersiveMaterialHandle material, const ArkUI_LightEffectOptionsHandle options)](#oh_arkui_nativemodule_immersivematerial_setlighteffect) | - | 设置沉浸式材质对象的光感交互效果。该参数对所有等级材质都生效。传入NULL的光感交互效果配置指针表示禁用光感交互效果,传入非NULL的光感交互效果配置指针表示使用该配置参数进行光感交互。如果不调用该接口设置,光感交互效果遵循组件的行为。 | | ||||||
| 62 | +| [ArkUI_ErrorCode OH_ArkUI_NativeModule_ImmersiveMaterial_GetLightEffectColor(ArkUI_ImmersiveMaterialHandle material, uint32_t* color)](#oh_arkui_nativemodule_immersivematerial_getlighteffectcolor) | - | 获取沉浸式材质对象的光感交互效果颜色。只有在调用[OH_ArkUI_NativeModule_ImmersiveMaterial_SetLightEffect](#oh_arkui_nativemodule_immersivematerial_setlighteffect)成功设置非NULL的光感交互效果配置指针后,此接口才能成功获取颜色值。如果从未设置过光感交互效果或已禁用(传入NULL的光感交互效果配置指针),函数将返回[ARKUI_ERROR_CODE_PARAM_ERROR](./capi-native-type-h.md#arkui_errorcode)。 | | ||||||
| 63 | + | ||||||
| 64 | +## 枚举类型说明 | ||||||
| 65 | + | ||||||
| 66 | +### ArkUI_ImmersiveStyle | ||||||
| 67 | + | ||||||
| 68 | +```c | ||||||
| 69 | +enum ArkUI_ImmersiveStyle | ||||||
| 70 | +``` | ||||||
| 71 | + | ||||||
| 72 | +沉浸式材质样式枚举。不同样式对应不同的材质参数,影响材质的薄厚程度。 | ||||||
| 73 | + | ||||||
| 74 | +**起始版本:** 26.0.0 | ||||||
| 75 | + | ||||||
| 76 | +| 枚举项 | 描述 | | ||||||
| 77 | +| -- | -- | | ||||||
| 78 | +| ARKUI_IMMERSIVE_STYLE_ULTRA_THIN = 0 | 超薄样式。材质层极薄,透明度效果极强。 | | ||||||
| 79 | +| ARKUI_IMMERSIVE_STYLE_THIN = 1 | 薄样式。材质层较薄,透明度效果强。 | | ||||||
| 80 | +| ARKUI_IMMERSIVE_STYLE_REGULAR = 2 | 常规样式。材质层厚度标准,视觉效果均衡。 | | ||||||
| 81 | +| ARKUI_IMMERSIVE_STYLE_THICK = 3 | 厚样式。模糊效果强。 | | ||||||
| 82 | +| ARKUI_IMMERSIVE_STYLE_ULTRA_THICK = 4 | 超厚样式。 | | ||||||
| 83 | + | ||||||
| 84 | +### ArkUI_MaterialLevel | ||||||
| 85 | + | ||||||
| 86 | +```c | ||||||
| 87 | +enum ArkUI_MaterialLevel | ||||||
| 88 | +``` | ||||||
| 89 | + | ||||||
| 90 | +材质等级枚举,与设备的算力等级相关。 | ||||||
| 91 | + | ||||||
| 92 | +使用[OH_ArkUI_NativeModule_GetGlobalMaterialLevel](#oh_arkui_nativemodule_getglobalmateriallevel)可获取当前设备的材质等级。 | ||||||
| 93 | + | ||||||
| 94 | +**起始版本:** 26.0.0 | ||||||
| 95 | + | ||||||
| 96 | +| 枚举项 | 描述 | | ||||||
| 97 | +| -- | -- | | ||||||
| 98 | +| ARKUI_MATERIAL_LEVEL_EXQUISITE = 0 | 高算力设备材质等级。 | | ||||||
| 99 | +| ARKUI_MATERIAL_LEVEL_GENTLE = 1 | 中算力设备材质等级。 | | ||||||
| 100 | +| ARKUI_MATERIAL_LEVEL_SMOOTH = 2 | 低算力设备材质等级。 | | ||||||
| 101 | + | ||||||
| 102 | +## 函数说明 | ||||||
| 103 | + | ||||||
| 104 | +### OH_ArkUI_NativeModule_GetSystemMaterialSupported() | ||||||
| 105 | + | ||||||
| 106 | +```c | ||||||
| 107 | +bool OH_ArkUI_NativeModule_GetSystemMaterialSupported() | ||||||
| 108 | +``` | ||||||
| 109 | + | ||||||
| 110 | +**描述:** | ||||||
| 111 | + | ||||||
| 112 | +检查当前设备是否支持系统材质。 | ||||||
| 113 | + | ||||||
| 114 | +如果返回true,则可以使用[NODE_SYSTEM_MATERIAL](./capi-native-node-h-nodeattributetype-animator.md#node_system_material)属性,否则设置该属性将无效。该配置项由设备定义,不可修改。 | ||||||
| 115 | + | ||||||
| 116 | +**起始版本:** 26.0.0 | ||||||
| 117 | + | ||||||
| 118 | +**返回:** | ||||||
| 119 | + | ||||||
| 120 | +| 类型 | 说明 | | ||||||
| 121 | +| -- | -- | | ||||||
| 122 | +| bool | 返回当前设备是否支持系统材质。true表示当前设备支持系统材质,false表示当前设备不支持系统材质。 | | ||||||
| 123 | + | ||||||
| 124 | +### OH_ArkUI_NativeModule_GetGlobalMaterialLevel() | ||||||
| 125 | + | ||||||
| 126 | +```c | ||||||
| 127 | +ArkUI_MaterialLevel OH_ArkUI_NativeModule_GetGlobalMaterialLevel() | ||||||
| 128 | +``` | ||||||
| 129 | + | ||||||
| 130 | +**描述:** | ||||||
| 131 | + | ||||||
| 132 | +获取全局材质等级,与设备的算力相关。该配置项由设备定义,不可修改。 | ||||||
| 133 | + | ||||||
| 134 | +**起始版本:** 26.0.0 | ||||||
| 135 | + | ||||||
| 136 | +**返回:** | ||||||
| 137 | + | ||||||
| 138 | +| 类型 | 说明 | | ||||||
| 139 | +| -- | -- | | ||||||
| 140 | +| [ArkUI_MaterialLevel](#arkui_materiallevel) | 返回设备的材质等级。返回类型为[ArkUI_MaterialLevel](#arkui_materiallevel)。 | | ||||||
| 141 | + | ||||||
| 142 | +### OH_ArkUI_NativeModule_ImmersiveMaterial_Create() | ||||||
| 143 | + | ||||||
| 144 | +```c | ||||||
| 145 | +ArkUI_ImmersiveMaterialHandle OH_ArkUI_NativeModule_ImmersiveMaterial_Create(ArkUI_ImmersiveStyle style) | ||||||
| 146 | +``` | ||||||
| 147 | + | ||||||
| 148 | +**描述:** | ||||||
| 149 | + | ||||||
| 150 | +创建具有指定样式的沉浸式材质对象。创建的材质等级跟随全局材质等级,可通过[OH_ArkUI_NativeModule_GetGlobalMaterialLevel](#oh_arkui_nativemodule_getglobalmateriallevel)获取。 | ||||||
| 151 | + | ||||||
| 152 | +**起始版本:** 26.0.0 | ||||||
| 153 | + | ||||||
| 154 | +**参数:** | ||||||
| 155 | + | ||||||
| 156 | +| 参数项 | 描述 | | ||||||
| 157 | +| -- | -- | | ||||||
| 158 | +| [ArkUI_ImmersiveStyle](#arkui_immersivestyle) style | 材质样式。 | | ||||||
| 159 | + | ||||||
| 160 | +**返回:** | ||||||
| 161 | + | ||||||
| 162 | +| 类型 | 说明 | | ||||||
| 163 | +| -- | -- | | ||||||
| 164 | +| [ArkUI_ImmersiveMaterialHandle](./capi-arkui-nativemodule-arkui-immersivematerialhandle.md) | 返回指向创建的沉浸式材质对象的指针。如果创建失败或材质样式无效,返回NULL。<br>返回的对象使用完后需要通过[OH_ArkUI_NativeModule_ImmersiveMaterial_Destroy](#oh_arkui_nativemodule_immersivematerial_destroy)释放。 | | ||||||
| 165 | + | ||||||
| 166 | +### OH_ArkUI_NativeModule_ImmersiveMaterial_Destroy() | ||||||
| 167 | + | ||||||
| 168 | +```c | ||||||
| 169 | +void OH_ArkUI_NativeModule_ImmersiveMaterial_Destroy(ArkUI_ImmersiveMaterialHandle material) | ||||||
| 170 | +``` | ||||||
| 171 | + | ||||||
| 172 | +**描述:** | ||||||
| 173 | + | ||||||
| 174 | +销毁沉浸式材质对象。 | ||||||
| 175 | + | ||||||
| 176 | +**起始版本:** 26.0.0 | ||||||
| 177 | + | ||||||
| 178 | +**参数:** | ||||||
| 179 | + | ||||||
| 180 | +| 参数项 | 描述 | | ||||||
| 181 | +| -- | -- | | ||||||
| 182 | +| [ArkUI_ImmersiveMaterialHandle](./capi-arkui-nativemodule-arkui-immersivematerialhandle.md) material | 指向沉浸式材质对象的指针。 | | ||||||
| 183 | + | ||||||
| 184 | +### OH_ArkUI_NativeModule_ImmersiveMaterial_SetStyle() | ||||||
| 185 | + | ||||||
| 186 | +```c | ||||||
| 187 | +ArkUI_ErrorCode OH_ArkUI_NativeModule_ImmersiveMaterial_SetStyle(ArkUI_ImmersiveMaterialHandle material, ArkUI_ImmersiveStyle style) | ||||||
| 188 | +``` | ||||||
| 189 | + | ||||||
| 190 | +**描述:** | ||||||
| 191 | + | ||||||
| 192 | +设置沉浸式材质对象的样式。该参数仅对高算力和中算力设备的显示效果有效,对低算力设备不生效但不会报错。 | ||||||
| 193 | + | ||||||
| 194 | +**起始版本:** 26.0.0 | ||||||
| 195 | + | ||||||
| 196 | +**参数:** | ||||||
| 197 | + | ||||||
| 198 | +| 参数项 | 描述 | | ||||||
| 199 | +| -- | -- | | ||||||
| 200 | +| [ArkUI_ImmersiveMaterialHandle](./capi-arkui-nativemodule-arkui-immersivematerialhandle.md) material | 指向沉浸式材质对象的指针。 | | ||||||
| 201 | +| [ArkUI_ImmersiveStyle](#arkui_immersivestyle) style | 材质样式。 | | ||||||
| 202 | + | ||||||
| 203 | +**返回:** | ||||||
| 204 | + | ||||||
| 205 | +| 类型 | 说明 | | ||||||
| 206 | +| -- | -- | | ||||||
| 207 | +| [ArkUI_ErrorCode](./capi-native-type-h.md#arkui_errorcode) | [ARKUI_ERROR_CODE_NO_ERROR](./capi-native-type-h.md#arkui_errorcode) 操作成功。<br>[ARKUI_ERROR_CODE_PARAM_INVALID](./capi-native-type-h.md#arkui_errorcode) 参数异常(material为NULL或style无效)。 | | ||||||
| 208 | + | ||||||
| 209 | +### OH_ArkUI_NativeModule_ImmersiveMaterial_GetStyle() | ||||||
| 210 | + | ||||||
| 211 | +```c | ||||||
| 212 | +ArkUI_ErrorCode OH_ArkUI_NativeModule_ImmersiveMaterial_GetStyle(ArkUI_ImmersiveMaterialHandle material, ArkUI_ImmersiveStyle* style) | ||||||
| 213 | +``` | ||||||
| 214 | + | ||||||
| 215 | +**描述:** | ||||||
| 216 | + | ||||||
| 217 | +获取沉浸式材质对象的样式。 | ||||||
| 218 | + | ||||||
| 219 | +**起始版本:** 26.0.0 | ||||||
| 220 | + | ||||||
| 221 | +**参数:** | ||||||
| 222 | + | ||||||
| 223 | +| 参数项 | 描述 | | ||||||
| 224 | +| -- | -- | | ||||||
| 225 | +| [ArkUI_ImmersiveMaterialHandle](./capi-arkui-nativemodule-arkui-immersivematerialhandle.md) material | 指向沉浸式材质对象的指针。 | | ||||||
| 226 | +| [ArkUI_ImmersiveStyle](#arkui_immersivestyle) style | 指向用于接收材质样式的变量的指针。 | | ||||||
| 227 | + | ||||||
| 228 | +**返回:** | ||||||
| 229 | + | ||||||
| 230 | +| 类型 | 说明 | | ||||||
| 231 | +| -- | -- | | ||||||
| 232 | +| [ArkUI_ErrorCode](./capi-native-type-h.md#arkui_errorcode) | [ARKUI_ERROR_CODE_NO_ERROR](./capi-native-type-h.md#arkui_errorcode) 操作成功。<br>[ARKUI_ERROR_CODE_PARAM_INVALID](./capi-native-type-h.md#arkui_errorcode) 参数异常(material为NULL或style为NULL)。 | | ||||||
| 233 | + | ||||||
| 234 | +### OH_ArkUI_NativeModule_ImmersiveMaterial_SetMaterialColor() | ||||||
| 235 | + | ||||||
| 236 | +```c | ||||||
| 237 | +ArkUI_ErrorCode OH_ArkUI_NativeModule_ImmersiveMaterial_SetMaterialColor(ArkUI_ImmersiveMaterialHandle material, uint32_t color) | ||||||
| 238 | +``` | ||||||
| 239 | + | ||||||
| 240 | +**描述:** | ||||||
| 241 | + | ||||||
| 242 | +设置沉浸式材质对象的材质颜色。该参数仅对高算力和中算力设备的显示效果有效,对低算力设备不生效但不会报错。如果不设置,默认值为0,表示透明色。 | ||||||
| 243 | + | ||||||
| 244 | +**起始版本:** 26.0.0 | ||||||
| 245 | + | ||||||
| 246 | +**参数:** | ||||||
| 247 | + | ||||||
| 248 | +| 参数项 | 描述 | | ||||||
| 249 | +| -- | -- | | ||||||
| 250 | +| [ArkUI_ImmersiveMaterialHandle](./capi-arkui-nativemodule-arkui-immersivematerialhandle.md) material | 指向沉浸式材质对象的指针。 | | ||||||
| 251 | +| uint32_t color | 材质颜色,0xAARRGGBB格式。传入0表示透明(默认值)。 | | ||||||
| 252 | + | ||||||
| 253 | +**返回:** | ||||||
| 254 | + | ||||||
| 255 | +| 类型 | 说明 | | ||||||
| 256 | +| -- | -- | | ||||||
| 257 | +| [ArkUI_ErrorCode](./capi-native-type-h.md#arkui_errorcode) | [ARKUI_ERROR_CODE_NO_ERROR](./capi-native-type-h.md#arkui_errorcode) 操作成功。<br>[ARKUI_ERROR_CODE_PARAM_INVALID](./capi-native-type-h.md#arkui_errorcode) 参数异常(material为NULL)。 | | ||||||
| 258 | + | ||||||
| 259 | +### OH_ArkUI_NativeModule_ImmersiveMaterial_GetMaterialColor() | ||||||
| 260 | + | ||||||
| 261 | +```c | ||||||
| 262 | +ArkUI_ErrorCode OH_ArkUI_NativeModule_ImmersiveMaterial_GetMaterialColor(ArkUI_ImmersiveMaterialHandle material, uint32_t* color) | ||||||
| 263 | +``` | ||||||
| 264 | + | ||||||
| 265 | +**描述:** | ||||||
| 266 | + | ||||||
| 267 | +获取沉浸式材质对象的材质颜色。 | ||||||
| 268 | + | ||||||
| 269 | +**起始版本:** 26.0.0 | ||||||
| 270 | + | ||||||
| 271 | +**参数:** | ||||||
| 272 | + | ||||||
| 273 | +| 参数项 | 描述 | | ||||||
| 274 | +| -- | -- | | ||||||
| 275 | +| [ArkUI_ImmersiveMaterialHandle](./capi-arkui-nativemodule-arkui-immersivematerialhandle.md) material | 指向沉浸式材质对象的指针。 | | ||||||
| 276 | +| uint32_t* color | 指向用于接收0xAARRGGBB格式的材质颜色的变量的指针。 | | ||||||
| 277 | + | ||||||
| 278 | +**返回:** | ||||||
| 279 | + | ||||||
| 280 | +| 类型 | 说明 | | ||||||
| 281 | +| -- | -- | | ||||||
| 282 | +| [ArkUI_ErrorCode](./capi-native-type-h.md#arkui_errorcode) | [ARKUI_ERROR_CODE_NO_ERROR](./capi-native-type-h.md#arkui_errorcode) 操作成功。<br>[ARKUI_ERROR_CODE_PARAM_INVALID](./capi-native-type-h.md#arkui_errorcode) 参数异常(material为NULL或color为NULL)。 | | ||||||
| 283 | + | ||||||
| 284 | +### OH_ArkUI_NativeModule_ImmersiveMaterial_SetApplyShadow() | ||||||
| 285 | + | ||||||
| 286 | +```c | ||||||
| 287 | +ArkUI_ErrorCode OH_ArkUI_NativeModule_ImmersiveMaterial_SetApplyShadow(ArkUI_ImmersiveMaterialHandle material, bool applyShadow) | ||||||
| 288 | +``` | ||||||
| 289 | + | ||||||
| 290 | +**描述:** | ||||||
| 291 | + | ||||||
| 292 | +设置沉浸式材质对象的是否应用阴影属性。该参数对所有等级材质都生效。 | ||||||
| 293 | + | ||||||
| 294 | +当该参数为true时,材质中的阴影效果生效,优先于阴影通用属性。当该参数为false时,阴影通用属性生效,材质无阴影效果。如果不设置,默认值为true。 | ||||||
| 295 | + | ||||||
| 296 | +**起始版本:** 26.0.0 | ||||||
| 297 | + | ||||||
| 298 | +**参数:** | ||||||
| 299 | + | ||||||
| 300 | +| 参数项 | 描述 | | ||||||
| 301 | +| -- | -- | | ||||||
| 302 | +| [ArkUI_ImmersiveMaterialHandle](./capi-arkui-nativemodule-arkui-immersivematerialhandle.md) material | 指向沉浸式材质对象的指针。 | | ||||||
| 303 | +| bool applyShadow | 是否添加材质效果的阴影。true表示添加材质效果的阴影,false表示不添加材质效果的阴影。默认值为true。 | | ||||||
| 304 | + | ||||||
| 305 | +**返回:** | ||||||
| 306 | + | ||||||
| 307 | +| 类型 | 说明 | | ||||||
| 308 | +| -- | -- | | ||||||
| 309 | +| [ArkUI_ErrorCode](./capi-native-type-h.md#arkui_errorcode) | [ARKUI_ERROR_CODE_NO_ERROR](./capi-native-type-h.md#arkui_errorcode) 操作成功。<br>[ARKUI_ERROR_CODE_PARAM_INVALID](./capi-native-type-h.md#arkui_errorcode) 参数异常(material为NULL)。 | | ||||||
| 310 | + | ||||||
| 311 | +### OH_ArkUI_NativeModule_ImmersiveMaterial_GetApplyShadow() | ||||||
| 312 | + | ||||||
| 313 | +```c | ||||||
| 314 | +ArkUI_ErrorCode OH_ArkUI_NativeModule_ImmersiveMaterial_GetApplyShadow(ArkUI_ImmersiveMaterialHandle material, bool* applyShadow) | ||||||
| 315 | +``` | ||||||
| 316 | + | ||||||
| 317 | +**描述:** | ||||||
| 318 | + | ||||||
| 319 | +获取沉浸式材质对象的是否应用阴影属性。 | ||||||
| 320 | + | ||||||
| 321 | +**起始版本:** 26.0.0 | ||||||
| 322 | + | ||||||
| 323 | +**参数:** | ||||||
| 324 | + | ||||||
| 325 | +| 参数项 | 描述 | | ||||||
| 326 | +| -- | -- | | ||||||
| 327 | +| [ArkUI_ImmersiveMaterialHandle](./capi-arkui-nativemodule-arkui-immersivematerialhandle.md) material | 指向沉浸式材质对象的指针。 | | ||||||
| 328 | +| bool* applyShadow | 指向用于接收是否应用阴影的变量的指针。默认值为true。 | | ||||||
| 329 | + | ||||||
| 330 | +**返回:** | ||||||
| 331 | + | ||||||
| 332 | +| 类型 | 说明 | | ||||||
| 333 | +| -- | -- | | ||||||
| 334 | +| [ArkUI_ErrorCode](./capi-native-type-h.md#arkui_errorcode) | [ARKUI_ERROR_CODE_NO_ERROR](./capi-native-type-h.md#arkui_errorcode) 操作成功。<br>[ARKUI_ERROR_CODE_PARAM_INVALID](./capi-native-type-h.md#arkui_errorcode) 参数异常(material为NULL或applyShadow为NULL)。 | | ||||||
| 335 | + | ||||||
| 336 | +### OH_ArkUI_NativeModule_ImmersiveMaterial_SetInteractive() | ||||||
| 337 | + | ||||||
| 338 | +```c | ||||||
| 339 | +ArkUI_ErrorCode OH_ArkUI_NativeModule_ImmersiveMaterial_SetInteractive(ArkUI_ImmersiveMaterialHandle material, bool interactive) | ||||||
| 340 | +``` | ||||||
| 341 | + | ||||||
| 342 | +**描述:** | ||||||
| 343 | + | ||||||
| 344 | +设置沉浸式材质对象的是否可交互形变属性。该参数对所有等级的材质都生效。 | ||||||
| 345 | + | ||||||
| 346 | +当该参数为true时,材质可交互形变。当该参数为false时,材质不可交互形变。如果不设置,遵循组件的行为。 | ||||||
| 347 | + | ||||||
| 348 | +**起始版本:** 26.0.0 | ||||||
| 349 | + | ||||||
| 350 | +**参数:** | ||||||
| 351 | + | ||||||
| 352 | +| 参数项 | 描述 | | ||||||
| 353 | +| -- | -- | | ||||||
| 354 | +| [ArkUI_ImmersiveMaterialHandle](./capi-arkui-nativemodule-arkui-immersivematerialhandle.md) material | 指向沉浸式材质对象的指针。 | | ||||||
| 355 | +| bool interactive | 材质是否可交互形变。true表示材质可交互形变,false表示材质不可交互形变。 | | ||||||
| 356 | + | ||||||
| 357 | +**返回:** | ||||||
| 358 | + | ||||||
| 359 | +| 类型 | 说明 | | ||||||
| 360 | +| -- | -- | | ||||||
| 361 | +| [ArkUI_ErrorCode](./capi-native-type-h.md#arkui_errorcode) | [ARKUI_ERROR_CODE_NO_ERROR](./capi-native-type-h.md#arkui_errorcode) 操作成功。<br>[ARKUI_ERROR_CODE_PARAM_INVALID](./capi-native-type-h.md#arkui_errorcode) 参数异常(material为NULL)。 | | ||||||
| 362 | + | ||||||
| 363 | +### OH_ArkUI_NativeModule_ImmersiveMaterial_GetInteractive() | ||||||
| 364 | + | ||||||
| 365 | +```c | ||||||
| 366 | +ArkUI_ErrorCode OH_ArkUI_NativeModule_ImmersiveMaterial_GetInteractive(ArkUI_ImmersiveMaterialHandle material, bool* interactive) | ||||||
| 367 | +``` | ||||||
| 368 | + | ||||||
| 369 | +**描述:** | ||||||
| 370 | + | ||||||
| 371 | +获取沉浸式材质对象的是否可交互形变属性。 | ||||||
| 372 | + | ||||||
| 373 | +如果从未设置过该属性,函数将返回[ARKUI_ERROR_CODE_PARAM_ERROR](./capi-native-type-h.md#arkui_errorcode)。 | ||||||
| 374 | + | ||||||
| 375 | +**起始版本:** 26.0.0 | ||||||
| 376 | + | ||||||
| 377 | +**参数:** | ||||||
| 378 | + | ||||||
| 379 | +| 参数项 | 描述 | | ||||||
| 380 | +| -- | -- | | ||||||
| 381 | +| [ArkUI_ImmersiveMaterialHandle](./capi-arkui-nativemodule-arkui-immersivematerialhandle.md) material | 指向沉浸式材质对象的指针。 | | ||||||
| 382 | +| bool* interactive | 指向用于接收材质是否可交互形变的变量的指针。 | | ||||||
| 383 | + | ||||||
| 384 | +**返回:** | ||||||
| 385 | + | ||||||
| 386 | +| 类型 | 说明 | | ||||||
| 387 | +| -- | -- | | ||||||
| 388 | +| [ArkUI_ErrorCode](./capi-native-type-h.md#arkui_errorcode) | [ARKUI_ERROR_CODE_NO_ERROR](./capi-native-type-h.md#arkui_errorcode) 操作成功。<br>[ARKUI_ERROR_CODE_PARAM_INVALID](./capi-native-type-h.md#arkui_errorcode) 参数异常(material为NULL或interactive为NULL)。<br>[ARKUI_ERROR_CODE_PARAM_ERROR](./capi-native-type-h.md#arkui_errorcode) 从未设置过该属性。 | | ||||||
| 389 | + | ||||||
| 390 | +### OH_ArkUI_NativeModule_LightEffectOptions_Create() | ||||||
| 391 | + | ||||||
| 392 | +```c | ||||||
| 393 | +ArkUI_LightEffectOptionsHandle OH_ArkUI_NativeModule_LightEffectOptions_Create() | ||||||
| 394 | +``` | ||||||
| 395 | + | ||||||
| 396 | +**描述:** | ||||||
| 397 | + | ||||||
| 398 | +创建光感交互效果配置对象,默认颜色为白色(0xffffffff)。 | ||||||
| 399 | + | ||||||
| 400 | +**起始版本:** 26.0.0 | ||||||
| 401 | + | ||||||
| 402 | +**返回:** | ||||||
| 403 | + | ||||||
| 404 | +| 类型 | 说明 | | ||||||
| 405 | +| -- | -- | | ||||||
| 406 | +| [ArkUI_LightEffectOptionsHandle](./capi-arkui-nativemodule-arkui-lighteffectoptionshandle.md) | 返回指向创建的光感交互效果配置对象的指针。返回的对象使用完后需要通过[OH_ArkUI_NativeModule_LightEffectOptions_Destroy](#oh_arkui_nativemodule_lighteffectoptions_destroy)释放。 | | ||||||
| 407 | + | ||||||
| 408 | +### OH_ArkUI_NativeModule_LightEffectOptions_Destroy() | ||||||
| 409 | + | ||||||
| 410 | +```c | ||||||
| 411 | +void OH_ArkUI_NativeModule_LightEffectOptions_Destroy(ArkUI_LightEffectOptionsHandle options) | ||||||
| 412 | +``` | ||||||
| 413 | + | ||||||
| 414 | +**描述:** | ||||||
| 415 | + | ||||||
| 416 | +销毁光感交互效果配置对象。 | ||||||
| 417 | + | ||||||
| 418 | +**起始版本:** 26.0.0 | ||||||
| 419 | + | ||||||
| 420 | +**参数:** | ||||||
| 421 | + | ||||||
| 422 | +| 参数项 | 描述 | | ||||||
| 423 | +| -- | -- | | ||||||
| 424 | +| [ArkUI_LightEffectOptionsHandle](./capi-arkui-nativemodule-arkui-lighteffectoptionshandle.md) options | 指向光感交互效果配置对象的指针。 | | ||||||
| 425 | + | ||||||
| 426 | +### OH_ArkUI_NativeModule_LightEffectOptions_SetColor() | ||||||
| 427 | + | ||||||
| 428 | +```c | ||||||
| 429 | +ArkUI_ErrorCode OH_ArkUI_NativeModule_LightEffectOptions_SetColor(ArkUI_LightEffectOptionsHandle options, uint32_t color) | ||||||
| 430 | +``` | ||||||
| 431 | + | ||||||
| 432 | +**描述:** | ||||||
| 433 | + | ||||||
| 434 | +设置光感交互效果的颜色。如果不设置,默认颜色为白色(0xffffffff)。 | ||||||
| 435 | + | ||||||
| 436 | +**起始版本:** 26.0.0 | ||||||
| 437 | + | ||||||
| 438 | +**参数:** | ||||||
| 439 | + | ||||||
| 440 | +| 参数项 | 描述 | | ||||||
| 441 | +| -- | -- | | ||||||
| 442 | +| [ArkUI_LightEffectOptionsHandle](./capi-arkui-nativemodule-arkui-lighteffectoptionshandle.md) options | 指向光感交互效果配置对象的指针。 | | ||||||
| 443 | +| uint32_t color | 光感交互效果颜色,0xAARRGGBB格式。 | | ||||||
| 444 | + | ||||||
| 445 | +**返回:** | ||||||
| 446 | + | ||||||
| 447 | +| 类型 | 说明 | | ||||||
| 448 | +| -- | -- | | ||||||
| 449 | +| [ArkUI_ErrorCode](./capi-native-type-h.md#arkui_errorcode) | [ARKUI_ERROR_CODE_NO_ERROR](./capi-native-type-h.md#arkui_errorcode) 操作成功。<br>[ARKUI_ERROR_CODE_PARAM_INVALID](./capi-native-type-h.md#arkui_errorcode) 参数异常(options为NULL)。 | | ||||||
| 450 | + | ||||||
| 451 | +### OH_ArkUI_NativeModule_ImmersiveMaterial_SetLightEffect() | ||||||
| 452 | + | ||||||
| 453 | +```c | ||||||
| 454 | +ArkUI_ErrorCode OH_ArkUI_NativeModule_ImmersiveMaterial_SetLightEffect(ArkUI_ImmersiveMaterialHandle material, const ArkUI_LightEffectOptionsHandle options) | ||||||
| 455 | +``` | ||||||
| 456 | + | ||||||
| 457 | +**描述:** | ||||||
| 458 | + | ||||||
| 459 | +设置沉浸式材质对象的光感交互效果。该参数对所有等级材质都生效。 | ||||||
| 460 | + | ||||||
| 461 | +传入NULL的光感交互效果配置指针表示禁用光感交互效果,传入非NULL的光感交互效果配置指针表示使用该配置参数进行光感交互。如果不调用该接口设置,光感交互效果遵循组件的行为。 | ||||||
| 462 | + | ||||||
| 463 | +**起始版本:** 26.0.0 | ||||||
| 464 | + | ||||||
| 465 | +**参数:** | ||||||
| 466 | + | ||||||
| 467 | +| 参数项 | 描述 | | ||||||
| 468 | +| -- | -- | | ||||||
| 469 | +| [ArkUI_ImmersiveMaterialHandle](./capi-arkui-nativemodule-arkui-immersivematerialhandle.md) material | 指向沉浸式材质对象的指针。 | | ||||||
| 470 | +| const [ArkUI_LightEffectOptionsHandle](./capi-arkui-nativemodule-arkui-lighteffectoptionshandle.md) options | 指向光感交互效果配置对象的指针。传入NULL禁用光感交互效果,传入非NULL启用。 | | ||||||
| 471 | + | ||||||
| 472 | +**返回:** | ||||||
| 473 | + | ||||||
| 474 | +| 类型 | 说明 | | ||||||
| 475 | +| -- | -- | | ||||||
| 476 | +| [ArkUI_ErrorCode](./capi-native-type-h.md#arkui_errorcode) | [ARKUI_ERROR_CODE_NO_ERROR](./capi-native-type-h.md#arkui_errorcode) 操作成功。<br>[ARKUI_ERROR_CODE_PARAM_INVALID](./capi-native-type-h.md#arkui_errorcode) 参数异常(material为NULL)。 | | ||||||
| 477 | + | ||||||
| 478 | +### OH_ArkUI_NativeModule_ImmersiveMaterial_GetLightEffectColor() | ||||||
| 479 | + | ||||||
| 480 | +```c | ||||||
| 481 | +ArkUI_ErrorCode OH_ArkUI_NativeModule_ImmersiveMaterial_GetLightEffectColor(ArkUI_ImmersiveMaterialHandle material, uint32_t* color) | ||||||
| 482 | +``` | ||||||
| 483 | + | ||||||
| 484 | +**描述:** | ||||||
| 485 | + | ||||||
| 486 | +获取沉浸式材质对象的光感交互效果颜色。 | ||||||
| 487 | + | ||||||
| 488 | +只有在调用[OH_ArkUI_NativeModule_ImmersiveMaterial_SetLightEffect](#oh_arkui_nativemodule_immersivematerial_setlighteffect)成功设置非NULL的光感交互效果配置指针后,此接口才能成功获取颜色值。如果从未设置过光感交互效果或已禁用(传入NULL的光感交互效果配置指针),函数将返回[ARKUI_ERROR_CODE_PARAM_ERROR](./capi-native-type-h.md#arkui_errorcode)。 | ||||||
| 489 | + | ||||||
| 490 | +**起始版本:** 26.0.0 | ||||||
| 491 | + | ||||||
| 492 | +**参数:** | ||||||
| 493 | + | ||||||
| 494 | +| 参数项 | 描述 | | ||||||
| 495 | +| -- | -- | | ||||||
| 496 | +| [ArkUI_ImmersiveMaterialHandle](./capi-arkui-nativemodule-arkui-immersivematerialhandle.md) material | 指向沉浸式材质对象的指针。 | | ||||||
| 497 | +| uint32_t* color | 指向用于接收光感交互效果颜色的变量的指针。 | | ||||||
| 498 | + | ||||||
| 499 | +**返回:** | ||||||
| 500 | + | ||||||
| 501 | +| 类型 | 说明 | | ||||||
| 502 | +| -- | -- | | ||||||
| 503 | +| [ArkUI_ErrorCode](./capi-native-type-h.md#arkui_errorcode) | [ARKUI_ERROR_CODE_NO_ERROR](./capi-native-type-h.md#arkui_errorcode) 操作成功。<br>[ARKUI_ERROR_CODE_PARAM_INVALID](./capi-native-type-h.md#arkui_errorcode) 参数异常(material为NULL或color为NULL)。<br>[ARKUI_ERROR_CODE_PARAM_ERROR](./capi-native-type-h.md#arkui_errorcode) 光感交互效果从未设置或已禁用。 | | ||||||
| @@ -1380,3 +1380,31 @@ NODE_PIXEL_ROUND = 109 | |||
| 1380 | | 类型 | 说明 | | 1380 | | 类型 | 说明 | |
| 1381 | | -- | -- | | 1381 | | -- | -- | |
| 1382 | | .object | 组件的像素取整策略;参数类型为[ArkUI_PixelRoundPolicy](capi-arkui-nativemodule-arkui-pixelroundpolicy.md)。 | | 1382 | | .object | 组件的像素取整策略;参数类型为[ArkUI_PixelRoundPolicy](capi-arkui-nativemodule-arkui-pixelroundpolicy.md)。 | |
| 1383 | + | ||
| 1384 | +## NODE_SYSTEM_MATERIAL | ||
| 1385 | + | ||
| 1386 | +```c | ||
| 1387 | +NODE_SYSTEM_MATERIAL = 127 | ||
| 1388 | +``` | ||
| 1389 | + | ||
| 1390 | +定义系统材质属性,支持属性设置,属性重置和属性获取接口。 | ||
| 1391 | + | ||
| 1392 | +仅支持系统材质的设备可使用此属性。否则,当设置此属性时,将返回错误码[ARKUI_ERROR_CODE_ATTRIBUTE_OR_EVENT_NOT_SUPPORTED](./capi-native-type-h.md#arkui_errorcode)。设备是否支持系统材质可通过调用[OH_ArkUI_NativeModule_GetSystemMaterialSupported](./capi-native-material-h.md#oh_arkui_nativemodule_getsystemmaterialsupported)获取。 | ||
| 1393 | + | ||
| 1394 | +材质效果在不同算力的设备上表现不同。算力等级由[ArkUI_MaterialLevel](./capi-native-material-h.md#arkui_materiallevel)定义,可通过[OH_ArkUI_NativeModule_GetGlobalMaterialLevel](./capi-native-material-h.md#oh_arkui_nativemodule_getglobalmateriallevel)获取。在算力等级为[ARKUI_MATERIAL_LEVEL_SMOOTH](./capi-native-material-h.md#arkui_materiallevel)的设备上,会影响背景颜色、边框宽度、边框颜色、阴影等属性。在算力等级为[ARKUI_MATERIAL_LEVEL_EXQUISITE](./capi-native-material-h.md#arkui_materiallevel)或[ARKUI_MATERIAL_LEVEL_GENTLE](./capi-native-material-h.md#arkui_materiallevel)的设备上,会影响阴影属性并在系统材质层添加滤镜效果,可产生类似玻璃的效果。 | ||
| 1395 | + | ||
| 1396 | +作为属性设置方法参数、属性获取方法返回值[ArkUI_AttributeItem](capi-arkui-nativemodule-arkui-attributeitem.md)格式如下。 | ||
| 1397 | + | ||
| 1398 | +**起始版本:** 26.0.0 | ||
| 1399 | + | ||
| 1400 | +**参数:** | ||
| 1401 | + | ||
| 1402 | +| 参数项 | 描述 | | ||
| 1403 | +| -- | -- | | ||
| 1404 | +| .object | 系统材质对象。参数类型为[ArkUI_ImmersiveMaterialHandle](./capi-arkui-nativemodule-arkui-immersivematerialhandle.md)。 | | ||
| 1405 | + | ||
| 1406 | +**返回:** | ||
| 1407 | + | ||
| 1408 | +| 类型 | 说明 | | ||
| 1409 | +| -- | -- | | ||
| 1410 | +| .object | 系统材质对象。参数类型为[ArkUI_ImmersiveMaterialHandle](./capi-arkui-nativemodule-arkui-immersivematerialhandle.md)。返回值中的ArkUI_ImmersiveMaterialHandle对象是指向静态成员的指针,因此无需也禁止通过[OH_ArkUI_NativeModule_ImmersiveMaterial_Destroy](capi-native-material-h.md#oh_arkui_nativemodule_immersivematerial_destroy)释放返回对象。 | | ||


描述问题排查修改。
Native侧的沉浸式材质类型和API声明。 |