# asset_info_t
# 概述
单个资源的描述信息。
# 函数
| 函数名称 | 说明 |
|---|---|
| asset_info_create | 创建asset_info对象。 |
| asset_info_destroy | 销毁asset_info对象。 |
| asset_info_get_formatted_name | 把资源名字格式化为符合标准长度的字符串。 |
| asset_info_get_name | 获取名称。 |
| asset_info_get_type | 获取类型。 |
| asset_info_is_in_rom | 资源是否在ROM中。 |
| asset_info_ref | 增加asset_info对象的引用计数。 |
| asset_info_set_is_in_rom | 设置资源是否在ROM中的标记位。 |
| asset_info_unref | 减少asset_info对象的引用计数。 |
# 属性
| 属性名称 | 类型 | 说明 |
|---|---|---|
| flags | uint8_t | 资源标志。 |
| refcount | uint32_t | 引用计数。 |
| size | uint32_t | 大小。 |
| subtype | uint8_t | 子类型。 |
| type | uint16_t | 类型。 |
# asset_info_create 函数
- 函数功能：
创建asset_info对象。
主要供脚本语言使用。
- 函数原型：
asset_info_t* asset_info_create (uint16_t type, uint16_t subtype, const char* name, int32_t size);
- 参数说明：
| 参数 | 类型 | 说明 |
|---|---|---|
| 返回值 | asset_info_t* | asset_info对象。 |
| type | uint16_t | 资源的类型。 |
| subtype | uint16_t | 资源的子类型。 |
| name | const char* | 资源的名称。 |
| size | int32_t | 资源的数据长度(用于分配空间)。 |
# asset_info_destroy 函数
- 函数功能：
销毁asset_info对象。
- 函数原型：
ret_t asset_info_destroy (asset_info_t* info);
- 参数说明：
| 参数 | 类型 | 说明 |
|---|---|---|
| 返回值 | ret_t | 返回RET_OK表示成功，否则表示失败。 |
| info | asset_info_t* | asset_info对象。 |
# asset_info_get_formatted_name 函数
- 函数功能：
把资源名字格式化为符合标准长度的字符串。
- 函数原型：
const char* asset_info_get_formatted_name (const char* name);
- 参数说明：
| 参数 | 类型 | 说明 |
|---|---|---|
| 返回值 | const char* | 返回格式化后的名字。 |
| name | const char* | 未格式化名字。 |
# asset_info_get_name 函数
- 函数功能：
获取名称。
- 函数原型：
const char* asset_info_get_name (const asset_info_t* info);
- 参数说明：
| 参数 | 类型 | 说明 |
|---|---|---|
| 返回值 | const char* | 返回名称。 |
| info | const asset_info_t* | asset_info对象。 |
# asset_info_get_type 函数
- 函数功能：
获取类型。
- 函数原型：
uint16_t asset_info_get_type (asset_info_t* info);
- 参数说明：
| 参数 | 类型 | 说明 |
|---|---|---|
| 返回值 | uint16_t | 返回类型。 |
| info | asset_info_t* | asset_info对象。 |
# asset_info_is_in_rom 函数
- 函数功能：
资源是否在ROM中。
- 函数原型：
bool_t asset_info_is_in_rom (const asset_info_t* info);
- 参数说明：
| 参数 | 类型 | 说明 |
|---|---|---|
| 返回值 | bool_t | 返回 TRUE 为在 ROM 中，返回 FALSE 则不在。 |
| info | const asset_info_t* | asset_info对象。 |
# asset_info_ref 函数
- 函数功能：
增加asset_info对象的引用计数。
- 函数原型：
ret_t asset_info_ref (asset_info_t* info);
- 参数说明：
| 参数 | 类型 | 说明 |
|---|---|---|
| 返回值 | ret_t | 返回RET_OK表示成功，否则表示失败。 |
| info | asset_info_t* | asset_info对象。 |
# asset_info_set_is_in_rom 函数
- 函数功能：
设置资源是否在ROM中的标记位。
- 函数原型：
ret_t asset_info_set_is_in_rom (asset_info_t* info, bool_t is_in_rom);
- 参数说明：
| 参数 | 类型 | 说明 |
|---|---|---|
| 返回值 | ret_t | 返回RET_OK表示成功，否则表示失败。 |
| info | asset_info_t* | asset_info对象。 |
| is_in_rom | bool_t | 资源是否在ROM中。 |
# asset_info_unref 函数
- 函数功能：
减少asset_info对象的引用计数。
- 函数原型：
ret_t asset_info_unref (asset_info_t* info);
- 参数说明：
| 参数 | 类型 | 说明 |
|---|---|---|
| 返回值 | ret_t | 返回RET_OK表示成功，否则表示失败。 |
| info | asset_info_t* | asset_info对象。 |
# flags 属性
资源标志。
- 类型：uint8_t
| 特性 | 是否支持 |
|---|---|
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可脚本化 | 是 |
# refcount 属性
引用计数。 is_in_rom == FALSE时才有效。
- 类型：uint32_t
| 特性 | 是否支持 |
|---|---|
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可脚本化 | 是 |
# size 属性
大小。
- 类型：uint32_t
| 特性 | 是否支持 |
|---|---|
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可脚本化 | 是 |
# subtype 属性
子类型。
- 类型：uint8_t
| 特性 | 是否支持 |
|---|---|
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可脚本化 | 是 |
# type 属性
类型。
- 类型：uint16_t
| 特性 | 是否支持 |
|---|---|
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可脚本化 | 是 |