awtk/docs/manual/font_t.md

108 lines
2.5 KiB
Markdown
Raw Normal View History

2018-12-28 17:43:54 +08:00
## font\_t
### 概述
代表一种字体。
2019-01-15 14:34:05 +08:00
----------------------------------
2018-12-28 17:43:54 +08:00
### 函数
<p id="font_t_methods">
| 函数名称 | 说明 |
| -------- | ------------ |
| <a href="#font_t_font_destroy">font\_destroy</a> | 销毁font对象。 |
| <a href="#font_t_font_get_baseline">font\_get\_baseline</a> | 获取字体的基线。 |
| <a href="#font_t_font_get_glyph">font\_get\_glyph</a> | 获取指定字符和大小的字模。 |
| <a href="#font_t_font_match">font\_match</a> | 检查当前字体是否与指定名称和大小相匹配。 |
#### font\_destroy 函数
-----------------------
* 函数功能:
> <p id="font_t_font_destroy"> 销毁font对象。
* 函数原型:
```
ret_t font_destroy (font_t* font);
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功否则表示失败。 |
| font | font\_t* | font对象。 |
#### font\_get\_baseline 函数
-----------------------
* 函数功能:
> <p id="font_t_font_get_baseline"> 获取字体的基线。
* 函数原型:
```
2019-01-09 13:52:36 +08:00
int32_t font_get_baseline (font_t* font, font_size_t font_size);
2018-12-28 17:43:54 +08:00
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | int32\_t | 返回字体的基线。 |
| font | font\_t* | font对象。 |
2019-01-09 13:52:36 +08:00
| font\_size | font\_size\_t | 字体大小。 |
2018-12-28 17:43:54 +08:00
#### font\_get\_glyph 函数
-----------------------
* 函数功能:
> <p id="font_t_font_get_glyph"> 获取指定字符和大小的字模。
* 函数原型:
```
2019-01-09 13:52:36 +08:00
ret_t font_get_glyph (font_t* font, wchar_t chr, font_size_t font_size, glyph_t* glyph);
2018-12-28 17:43:54 +08:00
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功否则表示失败。 |
| font | font\_t* | font对象。 |
| chr | wchar\_t | 字符。 |
2019-01-09 13:52:36 +08:00
| font\_size | font\_size\_t | 字体大小。 |
2018-12-28 17:43:54 +08:00
| glyph | glyph\_t* | 返回字模数据。 |
#### font\_match 函数
-----------------------
* 函数功能:
> <p id="font_t_font_match"> 检查当前字体是否与指定名称和大小相匹配。
* 函数原型:
```
2019-01-09 13:52:36 +08:00
int32_t font_match (font_t* font, const char* font_name, font_size_t font_size);
2018-12-28 17:43:54 +08:00
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | int32\_t | 返回TRUE表示成功FALSE表示失败。 |
| font | font\_t* | font对象。 |
| font\_name | const char* | 字体名称。 |
2019-01-09 13:52:36 +08:00
| font\_size | font\_size\_t | 字体大小。 |