• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# drawing_font_collection.h
2<!--Kit: ArkGraphics 2D-->
3<!--Subsystem: Graphics-->
4<!--Owner: @oh_wangxk; @gmiao522; @Lem0nC-->
5<!--Designer: @liumingxiang-->
6<!--Tester: @yhl0101-->
7<!--Adviser: @ge-yafang-->
8## 概述
9
10定义绘制模块中与字体集合相关的函数。
11
12**引用文件:** <native_drawing/drawing_font_collection.h>
13
14**库:** libnative_drawing.so
15
16**起始版本:** 8
17
18**相关模块:** [Drawing](capi-drawing.md)
19
20## 汇总
21
22### 函数
23
24| 名称 | 描述 |
25| -- | -- |
26| [OH_Drawing_FontCollection* OH_Drawing_CreateFontCollection(void)](#oh_drawing_createfontcollection) | 创建字体集对象[OH_Drawing_FontCollection](capi-drawing-oh-drawing-fontcollection.md)。 |
27| [void OH_Drawing_DestroyFontCollection(OH_Drawing_FontCollection* fontCollection)](#oh_drawing_destroyfontcollection) | 释放被字体集对象占据的内存。 |
28| [void OH_Drawing_DisableFontCollectionFallback(OH_Drawing_FontCollection* fontCollection)](#oh_drawing_disablefontcollectionfallback) | 禁用系统字体。 |
29| [void OH_Drawing_DisableFontCollectionSystemFont(OH_Drawing_FontCollection* fontCollection)](#oh_drawing_disablefontcollectionsystemfont) | 禁用系统字体。 |
30| [OH_Drawing_FontCollection* OH_Drawing_CreateSharedFontCollection(void)](#oh_drawing_createsharedfontcollection) | 创建可共享的字体集对象[OH_Drawing_FontCollection](capi-drawing-oh-drawing-fontcollection.md)。 |
31| [void OH_Drawing_ClearFontCaches(OH_Drawing_FontCollection* fontCollection)](#oh_drawing_clearfontcaches) | 清理字体排版缓存(字体排版缓存本身设有内存上限和清理机制,所占内存有限,如无内存要求,不建议清理)。 |
32| [OH_Drawing_FontCollection* OH_Drawing_GetFontCollectionGlobalInstance(void)](#oh_drawing_getfontcollectionglobalinstance) | 获取全局字体集对象[OH_Drawing_FontCollection](capi-drawing-oh-drawing-fontcollection.md),可感知主题字信息,禁止释放该对象。 |
33
34## 函数说明
35
36### OH_Drawing_CreateFontCollection()
37
38```
39OH_Drawing_FontCollection* OH_Drawing_CreateFontCollection(void)
40```
41
42**描述**
43
44创建字体集对象[OH_Drawing_FontCollection](capi-drawing-oh-drawing-fontcollection.md)。
45
46**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
47
48**起始版本:** 8
49
50**返回:**
51
52| 类型 | 说明 |
53| -- | -- |
54| [OH_Drawing_FontCollection](capi-drawing-oh-drawing-fontcollection.md)* | 指向创建的字体集对象的指针。该函数创建的字体集指针对象OH_Drawing_FontCollection只能被一个[OH_Drawing_TypographyCreate](capi-drawing-oh-drawing-typographycreate.md)对象使用,无法被多个OH_Drawing_TypographyCreate对象共享使用。如需在多个OH_Drawing_TypographyCreate对象间共享同一个OH_Drawing_FontCollection,请使用[OH_Drawing_CreateSharedFontCollection](capi-drawing-font-collection-h.md#oh_drawing_createsharedfontcollection)函数创建OH_Drawing_FontCollection对象。 |
55
56### OH_Drawing_DestroyFontCollection()
57
58```
59void OH_Drawing_DestroyFontCollection(OH_Drawing_FontCollection* fontCollection)
60```
61
62**描述**
63
64释放被字体集对象占据的内存。
65
66**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
67
68**起始版本:** 8
69
70
71**参数:**
72
73| 参数项 | 描述 |
74| -- | -- |
75| [OH_Drawing_FontCollection](capi-drawing-oh-drawing-fontcollection.md)* fontCollection | 指向字体集对象的指针。 |
76
77### OH_Drawing_DisableFontCollectionFallback()
78
79```
80void OH_Drawing_DisableFontCollectionFallback(OH_Drawing_FontCollection* fontCollection)
81```
82
83**描述**
84
85禁用系统字体。
86
87**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
88
89**起始版本:** 12
90
91
92**参数:**
93
94| 参数项 | 描述 |
95| -- | -- |
96| [OH_Drawing_FontCollection](capi-drawing-oh-drawing-fontcollection.md)* fontCollection | 指向字体集对象[OH_Drawing_FontCollection](capi-drawing-oh-drawing-fontcollection.md)的指针。 |
97
98### OH_Drawing_DisableFontCollectionSystemFont()
99
100```
101void OH_Drawing_DisableFontCollectionSystemFont(OH_Drawing_FontCollection* fontCollection)
102```
103
104**描述**
105
106禁用系统字体。
107
108**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
109
110**起始版本:** 12
111
112
113**参数:**
114
115| 参数项 | 描述 |
116| -- | -- |
117| [OH_Drawing_FontCollection](capi-drawing-oh-drawing-fontcollection.md)* fontCollection | 指向字体集对象[OH_Drawing_FontCollection](capi-drawing-oh-drawing-fontcollection.md)的指针。 |
118
119### OH_Drawing_CreateSharedFontCollection()
120
121```
122OH_Drawing_FontCollection* OH_Drawing_CreateSharedFontCollection(void)
123```
124
125**描述**
126
127创建可共享的字体集对象[OH_Drawing_FontCollection](capi-drawing-oh-drawing-fontcollection.md)。
128
129**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
130
131**起始版本:** 12
132
133**返回:**
134
135| 类型 | 说明 |
136| -- | -- |
137| [OH_Drawing_FontCollection](capi-drawing-oh-drawing-fontcollection.md)* | 指向创建的字体集对象的指针。 |
138
139### OH_Drawing_ClearFontCaches()
140
141```
142void OH_Drawing_ClearFontCaches(OH_Drawing_FontCollection* fontCollection)
143```
144
145**描述**
146
147清理字体排版缓存(字体排版缓存本身设有内存上限和清理机制,所占内存有限,如无内存要求,不建议清理)。
148
149**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
150
151**起始版本:** 12
152
153
154**参数:**
155
156| 参数项 | 描述 |
157| -- | -- |
158| [OH_Drawing_FontCollection](capi-drawing-oh-drawing-fontcollection.md)* fontCollection | 指向字体集对象[OH_Drawing_FontCollection](capi-drawing-oh-drawing-fontcollection.md)的指针。 |
159
160### OH_Drawing_GetFontCollectionGlobalInstance()
161
162```
163OH_Drawing_FontCollection* OH_Drawing_GetFontCollectionGlobalInstance(void)
164```
165
166**描述**
167
168获取全局字体集对象[OH_Drawing_FontCollection](capi-drawing-oh-drawing-fontcollection.md),可感知主题字信息,禁止释放该对象。
169
170**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
171
172**起始版本:** 14
173
174**返回:**
175
176| 类型 | 说明 |
177| -- | -- |
178| [OH_Drawing_FontCollection](capi-drawing-oh-drawing-fontcollection.md)* | 指向全局字体集对象的指针。 |