1# drawable_descriptor.h 2 3## 概述 4 5提供NativeDrawableDescriptor接口的类型定义。 6 7**引用文件：** <arkui/drawable_descriptor.h> 8 9**库：** libace_ndk.z.so 10 11**系统能力：** SystemCapability.ArkUI.ArkUI.Full 12 13**起始版本：** 12 14 15**相关模块：** [ArkUI_NativeModule](capi-arkui-nativemodule.md) 16 17## 汇总 18 19### 结构体 20 21| 名称 | typedef关键字 | 描述 | 22| -- | -- | -- | 23| [ArkUI_DrawableDescriptor](capi-arkui-nativemodule-arkui-drawabledescriptor.md) | ArkUI_DrawableDescriptor | 定义DrawableDescriptor对象。 | 24| [OH_PixelmapNative*](capi-arkui-nativemodule-oh-pixelmapnative8h.md) | OH_PixelmapNativeHandle | 定义OH_PixelmapNative对象指针类型。 | 25 26### 函数 27 28| 名称 | 描述 | 29| -- | -- | 30| [ArkUI_DrawableDescriptor* OH_ArkUI_DrawableDescriptor_CreateFromPixelMap(OH_PixelmapNativeHandle pixelMap)](#oh_arkui_drawabledescriptor_createfrompixelmap) | 使用PixelMap创建DrawableDescriptor对象。 | 31| [ArkUI_DrawableDescriptor* OH_ArkUI_DrawableDescriptor_CreateFromAnimatedPixelMap(OH_PixelmapNativeHandle* array, int32_t size)](#oh_arkui_drawabledescriptor_createfromanimatedpixelmap) | 使用PixelMap图片数组创建DrawableDescriptor对象。 | 32| [void OH_ArkUI_DrawableDescriptor_Dispose(ArkUI_DrawableDescriptor* drawableDescriptor)](#oh_arkui_drawabledescriptor_dispose) | 销毁DrawableDescriptor对象指针。 | 33| [OH_PixelmapNativeHandle OH_ArkUI_DrawableDescriptor_GetStaticPixelMap(ArkUI_DrawableDescriptor* drawableDescriptor)](#oh_arkui_drawabledescriptor_getstaticpixelmap) | 获取PixelMap图片对象指针。 | 34| [OH_PixelmapNativeHandle* OH_ArkUI_DrawableDescriptor_GetAnimatedPixelMapArray(ArkUI_DrawableDescriptor* drawableDescriptor)](#oh_arkui_drawabledescriptor_getanimatedpixelmaparray) | 获取用于播放动画的PixelMap图片数组数据。 | 35| [int32_t OH_ArkUI_DrawableDescriptor_GetAnimatedPixelMapArraySize(ArkUI_DrawableDescriptor* drawableDescriptor)](#oh_arkui_drawabledescriptor_getanimatedpixelmaparraysize) | 获取用于播放动画的PixelMap图片数组数据。 | 36| [void OH_ArkUI_DrawableDescriptor_SetAnimationDuration(ArkUI_DrawableDescriptor* drawableDescriptor, int32_t duration)](#oh_arkui_drawabledescriptor_setanimationduration) | 设置PixelMap图片数组播放总时长。 | 37| [int32_t OH_ArkUI_DrawableDescriptor_GetAnimationDuration(ArkUI_DrawableDescriptor* drawableDescriptor)](#oh_arkui_drawabledescriptor_getanimationduration) | 获取PixelMap图片数组播放总时长。 | 38| [void OH_ArkUI_DrawableDescriptor_SetAnimationIteration(ArkUI_DrawableDescriptor* drawableDescriptor, int32_t iteration)](#oh_arkui_drawabledescriptor_setanimationiteration) | 设置PixelMap图片数组播放次数。 | 39| [int32_t OH_ArkUI_DrawableDescriptor_GetAnimationIteration(ArkUI_DrawableDescriptor* drawableDescriptor)](#oh_arkui_drawabledescriptor_getanimationiteration) | 获取PixelMap图片数组播放次数。 | 40 41## 函数说明 42 43### OH_ArkUI_DrawableDescriptor_CreateFromPixelMap() 44 45``` 46ArkUI_DrawableDescriptor* OH_ArkUI_DrawableDescriptor_CreateFromPixelMap(OH_PixelmapNativeHandle pixelMap) 47``` 48 49**描述：** 50 51 52使用PixelMap创建DrawableDescriptor对象。 53 54**起始版本：** 12 55 56 57**参数：** 58 59| 参数项 | 描述 | 60| -- | -- | 61| [OH_PixelmapNativeHandle](capi-arkui-nativemodule-oh-pixelmapnative8h.md) pixelMap | PixelMap对象指针。 | 62 63**返回：** 64 65| 类型 | 说明 | 66|-------------------------------| -- | 67| [ArkUI_DrawableDescriptor](capi-arkui-nativemodule-arkui-drawabledescriptor.md)* | 返回DrawableDescriptor对象指针。 | 68 69### OH_ArkUI_DrawableDescriptor_CreateFromAnimatedPixelMap() 70 71``` 72ArkUI_DrawableDescriptor* OH_ArkUI_DrawableDescriptor_CreateFromAnimatedPixelMap(OH_PixelmapNativeHandle* array, int32_t size) 73``` 74 75**描述：** 76 77 78使用PixelMap图片数组创建DrawableDescriptor对象。 79 80**起始版本：** 12 81 82 83**参数：** 84 85| 参数项 | 描述 | 86| -- | -- | 87| [OH_PixelmapNativeHandle](capi-arkui-nativemodule-oh-pixelmapnative8h.md)* array | PixelMap图片数组对象指针。 | 88| int32_t size | PixelMap图片数组大小。 | 89 90**返回：** 91 92| 类型 | 说明 | 93| -- | -- | 94| [ArkUI_DrawableDescriptor](capi-arkui-nativemodule-arkui-drawabledescriptor.md)* | 返回DrawableDescriptor对象指针。 | 95 96### OH_ArkUI_DrawableDescriptor_Dispose() 97 98``` 99void OH_ArkUI_DrawableDescriptor_Dispose(ArkUI_DrawableDescriptor* drawableDescriptor) 100``` 101 102**描述：** 103 104 105销毁DrawableDescriptor对象指针。 106 107**起始版本：** 12 108 109 110**参数：** 111 112| 参数项 | 描述 | 113| -- | -- | 114| [ArkUI_DrawableDescriptor](capi-arkui-nativemodule-arkui-drawabledescriptor.md)* drawableDescriptor | DrawableDescriptor对象指针。 | 115 116### OH_ArkUI_DrawableDescriptor_GetStaticPixelMap() 117 118``` 119OH_PixelmapNativeHandle OH_ArkUI_DrawableDescriptor_GetStaticPixelMap(ArkUI_DrawableDescriptor* drawableDescriptor) 120``` 121 122**描述：** 123 124 125获取PixelMap图片对象指针。 126 127**起始版本：** 12 128 129 130**参数：** 131 132| 参数项 | 描述 | 133| -- | -- | 134| [ArkUI_DrawableDescriptor](capi-arkui-nativemodule-arkui-drawabledescriptor.md)* drawableDescriptor | DrawableDescriptor对象指针。 | 135 136**返回：** 137 138| 类型 | 说明 | 139| -- | -- | 140| [OH_PixelmapNativeHandle](capi-arkui-nativemodule-oh-pixelmapnative8h.md) | PixelMap对象指针。 | 141 142### OH_ArkUI_DrawableDescriptor_GetAnimatedPixelMapArray() 143 144``` 145OH_PixelmapNativeHandle* OH_ArkUI_DrawableDescriptor_GetAnimatedPixelMapArray(ArkUI_DrawableDescriptor* drawableDescriptor) 146``` 147 148**描述：** 149 150 151获取用于播放动画的PixelMap图片数组数据。 152 153**起始版本：** 12 154 155 156**参数：** 157 158| 参数项 | 描述 | 159| -- | -- | 160| [ArkUI_DrawableDescriptor](capi-arkui-nativemodule-arkui-drawabledescriptor.md)* drawableDescriptor | DrawableDescriptor对象指针。 | 161 162**返回：** 163 164| 类型 | 说明 | 165|------------------------------| -- | 166| [OH_PixelmapNativeHandle](capi-arkui-nativemodule-oh-pixelmapnative8h.md)* | PixelMap图片数组指针。 | 167 168### OH_ArkUI_DrawableDescriptor_GetAnimatedPixelMapArraySize() 169 170``` 171int32_t OH_ArkUI_DrawableDescriptor_GetAnimatedPixelMapArraySize(ArkUI_DrawableDescriptor* drawableDescriptor) 172``` 173 174**描述：** 175 176 177获取用于播放动画的PixelMap图片数组数据。 178 179**起始版本：** 12 180 181 182**参数：** 183 184| 参数项 | 描述 | 185| -- | -- | 186| [ArkUI_DrawableDescriptor](capi-arkui-nativemodule-arkui-drawabledescriptor.md)* drawableDescriptor | DrawableDescriptor对象指针。 | 187 188**返回：** 189 190| 类型 | 说明 | 191| -- | -- | 192| int32_t | PixelMap图片数组大小。 | 193 194### OH_ArkUI_DrawableDescriptor_SetAnimationDuration() 195 196``` 197void OH_ArkUI_DrawableDescriptor_SetAnimationDuration(ArkUI_DrawableDescriptor* drawableDescriptor, int32_t duration) 198``` 199 200**描述：** 201 202 203设置PixelMap图片数组播放总时长。 204 205**起始版本：** 12 206 207 208**参数：** 209 210| 参数项 | 描述 | 211| -- | -- | 212| [ArkUI_DrawableDescriptor](capi-arkui-nativemodule-arkui-drawabledescriptor.md)* drawableDescriptor | DrawableDescriptor对象指针。 | 213| int32_t duration | 播放总时长，单位毫秒。 | 214 215### OH_ArkUI_DrawableDescriptor_GetAnimationDuration() 216 217``` 218int32_t OH_ArkUI_DrawableDescriptor_GetAnimationDuration(ArkUI_DrawableDescriptor* drawableDescriptor) 219``` 220 221**描述：** 222 223 224获取PixelMap图片数组播放总时长。 225 226**起始版本：** 12 227 228 229**参数：** 230 231| 参数项 | 描述 | 232| -- | -- | 233| [ArkUI_DrawableDescriptor](capi-arkui-nativemodule-arkui-drawabledescriptor.md)* drawableDescriptor | DrawableDescriptor对象指针。 | 234 235**返回：** 236 237| 类型 | 说明 | 238| -- | -- | 239| int32_t | 播放总时长，单位毫秒。 | 240 241### OH_ArkUI_DrawableDescriptor_SetAnimationIteration() 242 243``` 244void OH_ArkUI_DrawableDescriptor_SetAnimationIteration(ArkUI_DrawableDescriptor* drawableDescriptor, int32_t iteration) 245``` 246 247**描述：** 248 249 250设置PixelMap图片数组播放次数。 251 252**起始版本：** 12 253 254 255**参数：** 256 257| 参数项 | 描述 | 258| -- | -- | 259| [ArkUI_DrawableDescriptor](capi-arkui-nativemodule-arkui-drawabledescriptor.md)* drawableDescriptor | DrawableDescriptor对象指针。 | 260| int32_t iteration | 播放次数。 | 261 262### OH_ArkUI_DrawableDescriptor_GetAnimationIteration() 263 264``` 265int32_t OH_ArkUI_DrawableDescriptor_GetAnimationIteration(ArkUI_DrawableDescriptor* drawableDescriptor) 266``` 267 268**描述：** 269 270 271获取PixelMap图片数组播放次数。 272 273**起始版本：** 12 274 275 276**参数：** 277 278| 参数项 | 描述 | 279| -- | -- | 280| [ArkUI_DrawableDescriptor](capi-arkui-nativemodule-arkui-drawabledescriptor.md)* drawableDescriptor | DrawableDescriptor对象指针。 | 281 282**返回：** 283 284| 类型 | 说明 | 285| -- | -- | 286| int32_t | 播放次数。 | 287 288 289