awtk/docs/manual/glyph_t.md

162 lines
3.5 KiB
Markdown
Raw Normal View History

2018-12-28 17:43:54 +08:00
## glyph\_t
### 概述
2019-11-15 11:33:43 +08:00
代表一个字符的字模。
2019-01-15 14:34:05 +08:00
----------------------------------
2018-12-28 17:43:54 +08:00
### 函数
<p id="glyph_t_methods">
| 函数名称 | 说明 |
| -------- | ------------ |
| <a href="#glyph_t_glyph_clone">glyph\_clone</a> | 克隆glyph对象。 |
| <a href="#glyph_t_glyph_create">glyph\_create</a> | 创建glyph对象。 |
| <a href="#glyph_t_glyph_destroy">glyph\_destroy</a> | 销毁glyph对象。 |
### 属性
<p id="glyph_t_properties">
2019-01-17 15:56:15 +08:00
| 属性名称 | 类型 | 说明 |
2018-12-28 17:43:54 +08:00
| -------- | ----- | ------------ |
2019-08-24 10:35:53 +08:00
| <a href="#glyph_t_advance">advance</a> | uint16\_t | 占位宽度。 |
2018-12-28 17:43:54 +08:00
| <a href="#glyph_t_data">data</a> | const uint8\_t* | 数据。 |
2019-08-24 10:35:53 +08:00
| <a href="#glyph_t_format">format</a> | uint8\_t | 格式。 |
2019-10-16 09:02:32 +08:00
| <a href="#glyph_t_h">h</a> | uint16\_t | 高度。 |
2019-08-24 10:35:53 +08:00
| <a href="#glyph_t_pitch">pitch</a> | uint8\_t | pitch。 |
2019-10-16 09:02:32 +08:00
| <a href="#glyph_t_w">w</a> | uint16\_t | 宽度。 |
| <a href="#glyph_t_x">x</a> | int16\_t | x坐标。 |
| <a href="#glyph_t_y">y</a> | int16\_t | y坐标。 |
2018-12-28 17:43:54 +08:00
#### glyph\_clone 函数
-----------------------
* 函数功能:
2019-11-15 11:33:43 +08:00
> <p id="glyph_t_glyph_clone">克隆glyph对象。
2019-10-16 09:02:32 +08:00
2018-12-28 17:43:54 +08:00
* 函数原型:
```
2023-06-29 10:44:29 +08:00
glyph_t* glyph_clone (glyph_t* g);
2018-12-28 17:43:54 +08:00
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | glyph\_t* | glyph对象。 |
2023-06-29 10:44:29 +08:00
| g | glyph\_t* | glyph对象。 |
2018-12-28 17:43:54 +08:00
#### glyph\_create 函数
-----------------------
* 函数功能:
2019-11-15 11:33:43 +08:00
> <p id="glyph_t_glyph_create">创建glyph对象。
2019-10-16 09:02:32 +08:00
2018-12-28 17:43:54 +08:00
* 函数原型:
```
glyph_t* glyph_create ();
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | glyph\_t* | glyph对象。 |
#### glyph\_destroy 函数
-----------------------
* 函数功能:
2019-11-15 11:33:43 +08:00
> <p id="glyph_t_glyph_destroy">销毁glyph对象。
2019-10-16 09:02:32 +08:00
2018-12-28 17:43:54 +08:00
* 函数原型:
```
2023-06-29 10:44:29 +08:00
ret_t glyph_destroy (glyph_t* g);
2018-12-28 17:43:54 +08:00
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功否则表示失败。 |
2023-06-29 10:44:29 +08:00
| g | glyph\_t* | glyph对象。 |
2018-12-28 17:43:54 +08:00
#### advance 属性
-----------------------
2019-11-15 11:33:43 +08:00
> <p id="glyph_t_advance">占位宽度。
2019-10-16 09:02:32 +08:00
2019-08-24 10:35:53 +08:00
* 类型uint16\_t
2018-12-28 17:43:54 +08:00
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
#### data 属性
-----------------------
2019-11-15 11:33:43 +08:00
> <p id="glyph_t_data">数据。
2019-10-16 09:02:32 +08:00
2018-12-28 17:43:54 +08:00
* 类型const uint8\_t*
2019-08-24 10:35:53 +08:00
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
#### format 属性
-----------------------
2019-11-15 11:33:43 +08:00
> <p id="glyph_t_format">格式。
2019-10-16 09:02:32 +08:00
2019-08-24 10:35:53 +08:00
* 类型uint8\_t
2018-12-28 17:43:54 +08:00
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
#### h 属性
-----------------------
2019-11-15 11:33:43 +08:00
> <p id="glyph_t_h">高度。
2018-12-28 17:43:54 +08:00
2019-10-16 09:02:32 +08:00
* 类型uint16\_t
2019-08-24 10:35:53 +08:00
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
#### pitch 属性
-----------------------
2019-11-15 11:33:43 +08:00
> <p id="glyph_t_pitch">pitch。
2019-10-16 09:02:32 +08:00
2018-12-28 17:43:54 +08:00
* 类型uint8\_t
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
#### w 属性
-----------------------
2019-11-15 11:33:43 +08:00
> <p id="glyph_t_w">宽度。
2018-12-28 17:43:54 +08:00
2019-10-16 09:02:32 +08:00
* 类型uint16\_t
2018-12-28 17:43:54 +08:00
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
#### x 属性
-----------------------
2019-11-15 11:33:43 +08:00
> <p id="glyph_t_x">x坐标。
2018-12-28 17:43:54 +08:00
2019-10-16 09:02:32 +08:00
* 类型int16\_t
2018-12-28 17:43:54 +08:00
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
#### y 属性
-----------------------
2019-11-15 11:33:43 +08:00
> <p id="glyph_t_y">y坐标。
2019-10-16 09:02:32 +08:00
* 类型int16\_t
2018-12-28 17:43:54 +08:00
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |