1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5 <title>hb-face: HarfBuzz Manual</title>
6 <meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
7 <link rel="home" href="index.html" title="HarfBuzz Manual">
8 <link rel="up" href="ch09.html" title="Core API">
9 <link rel="prev" href="harfbuzz-hb-deprecated.html" title="hb-deprecated">
10 <link rel="next" href="harfbuzz-hb-font.html" title="hb-font">
11 <meta name="generator" content="GTK-Doc V1.29 (XML mode)">
12 <link rel="stylesheet" href="style.css" type="text/css">
14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
16 <td width="100%" align="left" class="shortcuts">
17 <a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
18 <a href="#harfbuzz-hb-face.description" class="shortcut">Description</a></span>
20 <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
21 <td><a accesskey="u" href="ch09.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
22 <td><a accesskey="p" href="harfbuzz-hb-deprecated.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
23 <td><a accesskey="n" href="harfbuzz-hb-font.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
25 <div class="refentry">
26 <a name="harfbuzz-hb-face"></a><div class="titlepage"></div>
27 <div class="refnamediv"><table width="100%"><tr>
29 <h2><span class="refentrytitle"><a name="harfbuzz-hb-face.top_of_page"></a>hb-face</span></h2>
30 <p>hb-face — Font face objects</p>
32 <td class="gallery_image" valign="top" align="right"></td>
34 <div class="refsect1">
35 <a name="harfbuzz-hb-face.functions"></a><h2>Functions</h2>
36 <div class="informaltable"><table class="informaltable" width="100%" border="0">
38 <col width="150px" class="functions_return">
39 <col class="functions_name">
43 <td class="function_type">unsigned <span class="returnvalue">int</span>
45 <td class="function_name">
46 <a class="link" href="harfbuzz-hb-face.html#hb-face-count" title="hb_face_count ()">hb_face_count</a> <span class="c_punctuation">()</span>
50 <td class="function_type">
51 <a class="link" href="harfbuzz-hb-face.html#hb-face-t" title="hb_face_t"><span class="returnvalue">hb_face_t</span></a> *
53 <td class="function_name">
54 <a class="link" href="harfbuzz-hb-face.html#hb-face-create" title="hb_face_create ()">hb_face_create</a> <span class="c_punctuation">()</span>
58 <td class="function_type">
59 <a class="link" href="harfbuzz-hb-face.html#hb-face-t" title="hb_face_t"><span class="returnvalue">hb_face_t</span></a> *
61 <td class="function_name">
62 <a class="link" href="harfbuzz-hb-face.html#hb-face-create-for-tables" title="hb_face_create_for_tables ()">hb_face_create_for_tables</a> <span class="c_punctuation">()</span>
66 <td class="function_type">
67 <span class="returnvalue">void</span>
69 <td class="function_name">
70 <a class="link" href="harfbuzz-hb-face.html#hb-face-destroy" title="hb_face_destroy ()">hb_face_destroy</a> <span class="c_punctuation">()</span>
74 <td class="function_type">
75 <a class="link" href="harfbuzz-hb-face.html#hb-face-t" title="hb_face_t"><span class="returnvalue">hb_face_t</span></a> *
77 <td class="function_name">
78 <a class="link" href="harfbuzz-hb-face.html#hb-face-get-empty" title="hb_face_get_empty ()">hb_face_get_empty</a> <span class="c_punctuation">()</span>
82 <td class="function_type">unsigned <span class="returnvalue">int</span>
84 <td class="function_name">
85 <a class="link" href="harfbuzz-hb-face.html#hb-face-get-table-tags" title="hb_face_get_table_tags ()">hb_face_get_table_tags</a> <span class="c_punctuation">()</span>
89 <td class="function_type">unsigned <span class="returnvalue">int</span>
91 <td class="function_name">
92 <a class="link" href="harfbuzz-hb-face.html#hb-face-get-glyph-count" title="hb_face_get_glyph_count ()">hb_face_get_glyph_count</a> <span class="c_punctuation">()</span>
96 <td class="function_type">unsigned <span class="returnvalue">int</span>
98 <td class="function_name">
99 <a class="link" href="harfbuzz-hb-face.html#hb-face-get-index" title="hb_face_get_index ()">hb_face_get_index</a> <span class="c_punctuation">()</span>
103 <td class="function_type">unsigned <span class="returnvalue">int</span>
105 <td class="function_name">
106 <a class="link" href="harfbuzz-hb-face.html#hb-face-get-upem" title="hb_face_get_upem ()">hb_face_get_upem</a> <span class="c_punctuation">()</span>
110 <td class="function_type">
111 <span class="returnvalue">void</span> *
113 <td class="function_name">
114 <a class="link" href="harfbuzz-hb-face.html#hb-face-get-user-data" title="hb_face_get_user_data ()">hb_face_get_user_data</a> <span class="c_punctuation">()</span>
118 <td class="function_type">
119 <a class="link" href="harfbuzz-hb-common.html#hb-bool-t" title="hb_bool_t"><span class="returnvalue">hb_bool_t</span></a>
121 <td class="function_name">
122 <a class="link" href="harfbuzz-hb-face.html#hb-face-is-immutable" title="hb_face_is_immutable ()">hb_face_is_immutable</a> <span class="c_punctuation">()</span>
126 <td class="function_type">
127 <span class="returnvalue">void</span>
129 <td class="function_name">
130 <a class="link" href="harfbuzz-hb-face.html#hb-face-make-immutable" title="hb_face_make_immutable ()">hb_face_make_immutable</a> <span class="c_punctuation">()</span>
134 <td class="function_type">
135 <a class="link" href="harfbuzz-hb-face.html#hb-face-t" title="hb_face_t"><span class="returnvalue">hb_face_t</span></a> *
137 <td class="function_name">
138 <a class="link" href="harfbuzz-hb-face.html#hb-face-reference" title="hb_face_reference ()">hb_face_reference</a> <span class="c_punctuation">()</span>
142 <td class="function_type">
143 <a class="link" href="harfbuzz-hb-blob.html#hb-blob-t" title="hb_blob_t"><span class="returnvalue">hb_blob_t</span></a> *
145 <td class="function_name">
146 <a class="link" href="harfbuzz-hb-face.html#hb-face-reference-blob" title="hb_face_reference_blob ()">hb_face_reference_blob</a> <span class="c_punctuation">()</span>
150 <td class="function_type">
151 <a class="link" href="harfbuzz-hb-blob.html#hb-blob-t" title="hb_blob_t"><span class="returnvalue">hb_blob_t</span></a> *
153 <td class="function_name">
154 <a class="link" href="harfbuzz-hb-face.html#hb-face-reference-table" title="hb_face_reference_table ()">hb_face_reference_table</a> <span class="c_punctuation">()</span>
158 <td class="function_type">
159 <span class="returnvalue">void</span>
161 <td class="function_name">
162 <a class="link" href="harfbuzz-hb-face.html#hb-face-set-glyph-count" title="hb_face_set_glyph_count ()">hb_face_set_glyph_count</a> <span class="c_punctuation">()</span>
166 <td class="function_type">
167 <span class="returnvalue">void</span>
169 <td class="function_name">
170 <a class="link" href="harfbuzz-hb-face.html#hb-face-set-index" title="hb_face_set_index ()">hb_face_set_index</a> <span class="c_punctuation">()</span>
174 <td class="function_type">
175 <span class="returnvalue">void</span>
177 <td class="function_name">
178 <a class="link" href="harfbuzz-hb-face.html#hb-face-set-upem" title="hb_face_set_upem ()">hb_face_set_upem</a> <span class="c_punctuation">()</span>
182 <td class="function_type">
183 <a class="link" href="harfbuzz-hb-common.html#hb-bool-t" title="hb_bool_t"><span class="returnvalue">hb_bool_t</span></a>
185 <td class="function_name">
186 <a class="link" href="harfbuzz-hb-face.html#hb-face-set-user-data" title="hb_face_set_user_data ()">hb_face_set_user_data</a> <span class="c_punctuation">()</span>
190 <td class="function_type">
191 <span class="returnvalue">void</span>
193 <td class="function_name">
194 <a class="link" href="harfbuzz-hb-face.html#hb-face-collect-unicodes" title="hb_face_collect_unicodes ()">hb_face_collect_unicodes</a> <span class="c_punctuation">()</span>
198 <td class="function_type">
199 <span class="returnvalue">void</span>
201 <td class="function_name">
202 <a class="link" href="harfbuzz-hb-face.html#hb-face-collect-variation-selectors" title="hb_face_collect_variation_selectors ()">hb_face_collect_variation_selectors</a> <span class="c_punctuation">()</span>
206 <td class="function_type">
207 <span class="returnvalue">void</span>
209 <td class="function_name">
210 <a class="link" href="harfbuzz-hb-face.html#hb-face-collect-variation-unicodes" title="hb_face_collect_variation_unicodes ()">hb_face_collect_variation_unicodes</a> <span class="c_punctuation">()</span>
214 <td class="function_type">
215 <a class="link" href="harfbuzz-hb-face.html#hb-face-t" title="hb_face_t"><span class="returnvalue">hb_face_t</span></a> *
217 <td class="function_name">
218 <a class="link" href="harfbuzz-hb-face.html#hb-face-builder-create" title="hb_face_builder_create ()">hb_face_builder_create</a> <span class="c_punctuation">()</span>
222 <td class="function_type">
223 <a class="link" href="harfbuzz-hb-common.html#hb-bool-t" title="hb_bool_t"><span class="returnvalue">hb_bool_t</span></a>
225 <td class="function_name">
226 <a class="link" href="harfbuzz-hb-face.html#hb-face-builder-add-table" title="hb_face_builder_add_table ()">hb_face_builder_add_table</a> <span class="c_punctuation">()</span>
232 <div class="refsect1">
233 <a name="harfbuzz-hb-face.other"></a><h2>Types and Values</h2>
234 <div class="informaltable"><table class="informaltable" width="100%" border="0">
236 <col width="150px" class="name">
237 <col class="description">
240 <td class="typedef_keyword">typedef</td>
241 <td class="function_name"><a class="link" href="harfbuzz-hb-face.html#hb-face-t" title="hb_face_t">hb_face_t</a></td>
245 <div class="refsect1">
246 <a name="harfbuzz-hb-face.includes"></a><h2>Includes</h2>
247 <pre class="synopsis">#include <hb.h>
250 <div class="refsect1">
251 <a name="harfbuzz-hb-face.description"></a><h2>Description</h2>
252 <p>Font face is objects represent a single face in a font family.
253 More exactly, a font face represents a single face in a binary font file.
254 Font faces are typically built from a binary blob and a face index.
255 Font faces are used to create fonts.</p>
257 <div class="refsect1">
258 <a name="harfbuzz-hb-face.functions_details"></a><h2>Functions</h2>
259 <div class="refsect2">
260 <a name="hb-face-count"></a><h3>hb_face_count ()</h3>
261 <pre class="programlisting">unsigned <span class="returnvalue">int</span>
262 hb_face_count (<em class="parameter"><code><a class="link" href="harfbuzz-hb-blob.html#hb-blob-t" title="hb_blob_t"><span class="type">hb_blob_t</span></a> *blob</code></em>);</pre>
263 <p>Get number of faces in a blob.</p>
264 <div class="refsect3">
265 <a name="hb-face-count.parameters"></a><h4>Parameters</h4>
266 <div class="informaltable"><table class="informaltable" width="100%" border="0">
268 <col width="150px" class="parameters_name">
269 <col class="parameters_description">
270 <col width="200px" class="parameters_annotations">
273 <td class="parameter_name"><p>blob</p></td>
274 <td class="parameter_description"><p>a blob.</p></td>
275 <td class="parameter_annotations"> </td>
279 <div class="refsect3">
280 <a name="hb-face-count.returns"></a><h4>Returns</h4>
281 <p> Number of faces in <em class="parameter"><code>blob</code></em>
284 <p class="since">Since: <a class="link" href="api-index-1-7-7.html#api-index-1.7.7">1.7.7</a></p>
287 <div class="refsect2">
288 <a name="hb-face-create"></a><h3>hb_face_create ()</h3>
289 <pre class="programlisting"><a class="link" href="harfbuzz-hb-face.html#hb-face-t" title="hb_face_t"><span class="returnvalue">hb_face_t</span></a> *
290 hb_face_create (<em class="parameter"><code><a class="link" href="harfbuzz-hb-blob.html#hb-blob-t" title="hb_blob_t"><span class="type">hb_blob_t</span></a> *blob</code></em>,
291 <em class="parameter"><code>unsigned <span class="type">int</span> index</code></em>);</pre>
292 <p><span class="annotation">[Xconstructor]</span></p>
293 <div class="refsect3">
294 <a name="hb-face-create.returns"></a><h4>Returns</h4>
296 <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
298 <p class="since">Since: <a class="link" href="api-index-0-9-2.html#api-index-0.9.2">0.9.2</a></p>
301 <div class="refsect2">
302 <a name="hb-face-create-for-tables"></a><h3>hb_face_create_for_tables ()</h3>
303 <pre class="programlisting"><a class="link" href="harfbuzz-hb-face.html#hb-face-t" title="hb_face_t"><span class="returnvalue">hb_face_t</span></a> *
304 hb_face_create_for_tables (<em class="parameter"><code><a class="link" href="harfbuzz-hb-font.html#hb-reference-table-func-t" title="hb_reference_table_func_t ()"><span class="type">hb_reference_table_func_t</span></a> reference_table_func</code></em>,
305 <em class="parameter"><code><span class="type">void</span> *user_data</code></em>,
306 <em class="parameter"><code><a class="link" href="harfbuzz-hb-common.html#hb-destroy-func-t" title="hb_destroy_func_t ()"><span class="type">hb_destroy_func_t</span></a> destroy</code></em>);</pre>
307 <div class="refsect3">
308 <a name="hb-face-create-for-tables.parameters"></a><h4>Parameters</h4>
309 <div class="informaltable"><table class="informaltable" width="100%" border="0">
311 <col width="150px" class="parameters_name">
312 <col class="parameters_description">
313 <col width="200px" class="parameters_annotations">
316 <td class="parameter_name"><p>reference_table_func</p></td>
317 <td class="parameter_description"><p>. </p></td>
318 <td class="parameter_annotations"><span class="annotation">[<acronym title="This parameter is a 'user_data', for callbacks; many bindings can pass NULL here."><span class="acronym">closure</span></acronym> user_data][<acronym title="This parameter is a 'destroy_data', for callbacks."><span class="acronym">destroy</span></acronym> destroy][<acronym title="The callback is valid until the GDestroyNotify argument is called."><span class="acronym">scope notified</span></acronym>]</span></td>
322 <div class="refsect3">
323 <a name="hb-face-create-for-tables.returns"></a><h4>Returns</h4>
324 <p> (transfer full)</p>
326 <p class="since">Since: <a class="link" href="api-index-0-9-2.html#api-index-0.9.2">0.9.2</a></p>
329 <div class="refsect2">
330 <a name="hb-face-destroy"></a><h3>hb_face_destroy ()</h3>
331 <pre class="programlisting"><span class="returnvalue">void</span>
332 hb_face_destroy (<em class="parameter"><code><a class="link" href="harfbuzz-hb-face.html#hb-face-t" title="hb_face_t"><span class="type">hb_face_t</span></a> *face</code></em>);</pre>
333 <p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p>
334 <div class="refsect3">
335 <a name="hb-face-destroy.parameters"></a><h4>Parameters</h4>
336 <div class="informaltable"><table class="informaltable" width="100%" border="0">
338 <col width="150px" class="parameters_name">
339 <col class="parameters_description">
340 <col width="200px" class="parameters_annotations">
343 <td class="parameter_name"><p>face</p></td>
344 <td class="parameter_description"><p>a face.</p></td>
345 <td class="parameter_annotations"> </td>
349 <p class="since">Since: <a class="link" href="api-index-0-9-2.html#api-index-0.9.2">0.9.2</a></p>
352 <div class="refsect2">
353 <a name="hb-face-get-empty"></a><h3>hb_face_get_empty ()</h3>
354 <pre class="programlisting"><a class="link" href="harfbuzz-hb-face.html#hb-face-t" title="hb_face_t"><span class="returnvalue">hb_face_t</span></a> *
355 hb_face_get_empty (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
356 <div class="refsect3">
357 <a name="hb-face-get-empty.returns"></a><h4>Returns</h4>
358 <p> (transfer full)</p>
360 <p class="since">Since: <a class="link" href="api-index-0-9-2.html#api-index-0.9.2">0.9.2</a></p>
363 <div class="refsect2">
364 <a name="hb-face-get-table-tags"></a><h3>hb_face_get_table_tags ()</h3>
365 <pre class="programlisting">unsigned <span class="returnvalue">int</span>
366 hb_face_get_table_tags (<em class="parameter"><code>const <a class="link" href="harfbuzz-hb-face.html#hb-face-t" title="hb_face_t"><span class="type">hb_face_t</span></a> *face</code></em>,
367 <em class="parameter"><code>unsigned <span class="type">int</span> start_offset</code></em>,
368 <em class="parameter"><code>unsigned <span class="type">int</span> *table_count</code></em>,
369 <em class="parameter"><code><a class="link" href="harfbuzz-hb-common.html#hb-tag-t" title="hb_tag_t"><span class="type">hb_tag_t</span></a> *table_tags</code></em>);</pre>
370 <p>Retrieves table tags for a face, if possible.</p>
371 <div class="refsect3">
372 <a name="hb-face-get-table-tags.parameters"></a><h4>Parameters</h4>
373 <div class="informaltable"><table class="informaltable" width="100%" border="0">
375 <col width="150px" class="parameters_name">
376 <col class="parameters_description">
377 <col width="200px" class="parameters_annotations">
381 <td class="parameter_name"><p>face</p></td>
382 <td class="parameter_description"><p>a face.</p></td>
383 <td class="parameter_annotations"> </td>
386 <td class="parameter_name"><p>start_offset</p></td>
387 <td class="parameter_description"><p>index of first tag to return.</p></td>
388 <td class="parameter_annotations"> </td>
391 <td class="parameter_name"><p>table_count</p></td>
392 <td class="parameter_description"><p>input length of <em class="parameter"><code>table_tags</code></em>
393 array, output number of items written.</p></td>
394 <td class="parameter_annotations"> </td>
397 <td class="parameter_name"><p>table_tags</p></td>
398 <td class="parameter_description"><p>array to write tags into.</p></td>
399 <td class="parameter_annotations"> </td>
404 <div class="refsect3">
405 <a name="hb-face-get-table-tags.returns"></a><h4>Returns</h4>
406 <p> total number of tables, or 0 if not possible to list.</p>
408 <p class="since">Since: <a class="link" href="api-index-1-6-0.html#api-index-1.6.0">1.6.0</a></p>
411 <div class="refsect2">
412 <a name="hb-face-get-glyph-count"></a><h3>hb_face_get_glyph_count ()</h3>
413 <pre class="programlisting">unsigned <span class="returnvalue">int</span>
414 hb_face_get_glyph_count (<em class="parameter"><code>const <a class="link" href="harfbuzz-hb-face.html#hb-face-t" title="hb_face_t"><span class="type">hb_face_t</span></a> *face</code></em>);</pre>
415 <div class="refsect3">
416 <a name="hb-face-get-glyph-count.parameters"></a><h4>Parameters</h4>
417 <div class="informaltable"><table class="informaltable" width="100%" border="0">
419 <col width="150px" class="parameters_name">
420 <col class="parameters_description">
421 <col width="200px" class="parameters_annotations">
424 <td class="parameter_name"><p>face</p></td>
425 <td class="parameter_description"><p>a face.</p></td>
426 <td class="parameter_annotations"> </td>
430 <p class="since">Since: <a class="link" href="api-index-0-9-7.html#api-index-0.9.7">0.9.7</a></p>
433 <div class="refsect2">
434 <a name="hb-face-get-index"></a><h3>hb_face_get_index ()</h3>
435 <pre class="programlisting">unsigned <span class="returnvalue">int</span>
436 hb_face_get_index (<em class="parameter"><code>const <a class="link" href="harfbuzz-hb-face.html#hb-face-t" title="hb_face_t"><span class="type">hb_face_t</span></a> *face</code></em>);</pre>
437 <div class="refsect3">
438 <a name="hb-face-get-index.parameters"></a><h4>Parameters</h4>
439 <div class="informaltable"><table class="informaltable" width="100%" border="0">
441 <col width="150px" class="parameters_name">
442 <col class="parameters_description">
443 <col width="200px" class="parameters_annotations">
446 <td class="parameter_name"><p>face</p></td>
447 <td class="parameter_description"><p>a face.</p></td>
448 <td class="parameter_annotations"> </td>
452 <p class="since">Since: <a class="link" href="api-index-0-9-2.html#api-index-0.9.2">0.9.2</a></p>
455 <div class="refsect2">
456 <a name="hb-face-get-upem"></a><h3>hb_face_get_upem ()</h3>
457 <pre class="programlisting">unsigned <span class="returnvalue">int</span>
458 hb_face_get_upem (<em class="parameter"><code>const <a class="link" href="harfbuzz-hb-face.html#hb-face-t" title="hb_face_t"><span class="type">hb_face_t</span></a> *face</code></em>);</pre>
459 <div class="refsect3">
460 <a name="hb-face-get-upem.parameters"></a><h4>Parameters</h4>
461 <div class="informaltable"><table class="informaltable" width="100%" border="0">
463 <col width="150px" class="parameters_name">
464 <col class="parameters_description">
465 <col width="200px" class="parameters_annotations">
468 <td class="parameter_name"><p>face</p></td>
469 <td class="parameter_description"><p>a face.</p></td>
470 <td class="parameter_annotations"> </td>
474 <p class="since">Since: <a class="link" href="api-index-0-9-2.html#api-index-0.9.2">0.9.2</a></p>
477 <div class="refsect2">
478 <a name="hb-face-get-user-data"></a><h3>hb_face_get_user_data ()</h3>
479 <pre class="programlisting"><span class="returnvalue">void</span> *
480 hb_face_get_user_data (<em class="parameter"><code>const <a class="link" href="harfbuzz-hb-face.html#hb-face-t" title="hb_face_t"><span class="type">hb_face_t</span></a> *face</code></em>,
481 <em class="parameter"><code><a class="link" href="harfbuzz-hb-common.html#hb-user-data-key-t" title="hb_user_data_key_t"><span class="type">hb_user_data_key_t</span></a> *key</code></em>);</pre>
482 <p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p>
483 <div class="refsect3">
484 <a name="hb-face-get-user-data.parameters"></a><h4>Parameters</h4>
485 <div class="informaltable"><table class="informaltable" width="100%" border="0">
487 <col width="150px" class="parameters_name">
488 <col class="parameters_description">
489 <col width="200px" class="parameters_annotations">
492 <td class="parameter_name"><p>face</p></td>
493 <td class="parameter_description"><p>a face.</p></td>
494 <td class="parameter_annotations"> </td>
498 <div class="refsect3">
499 <a name="hb-face-get-user-data.returns"></a><h4>Returns</h4>
501 <p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
503 <p class="since">Since: <a class="link" href="api-index-0-9-2.html#api-index-0.9.2">0.9.2</a></p>
506 <div class="refsect2">
507 <a name="hb-face-is-immutable"></a><h3>hb_face_is_immutable ()</h3>
508 <pre class="programlisting"><a class="link" href="harfbuzz-hb-common.html#hb-bool-t" title="hb_bool_t"><span class="returnvalue">hb_bool_t</span></a>
509 hb_face_is_immutable (<em class="parameter"><code>const <a class="link" href="harfbuzz-hb-face.html#hb-face-t" title="hb_face_t"><span class="type">hb_face_t</span></a> *face</code></em>);</pre>
510 <div class="refsect3">
511 <a name="hb-face-is-immutable.parameters"></a><h4>Parameters</h4>
512 <div class="informaltable"><table class="informaltable" width="100%" border="0">
514 <col width="150px" class="parameters_name">
515 <col class="parameters_description">
516 <col width="200px" class="parameters_annotations">
519 <td class="parameter_name"><p>face</p></td>
520 <td class="parameter_description"><p>a face.</p></td>
521 <td class="parameter_annotations"> </td>
525 <p class="since">Since: <a class="link" href="api-index-0-9-2.html#api-index-0.9.2">0.9.2</a></p>
528 <div class="refsect2">
529 <a name="hb-face-make-immutable"></a><h3>hb_face_make_immutable ()</h3>
530 <pre class="programlisting"><span class="returnvalue">void</span>
531 hb_face_make_immutable (<em class="parameter"><code><a class="link" href="harfbuzz-hb-face.html#hb-face-t" title="hb_face_t"><span class="type">hb_face_t</span></a> *face</code></em>);</pre>
532 <div class="refsect3">
533 <a name="hb-face-make-immutable.parameters"></a><h4>Parameters</h4>
534 <div class="informaltable"><table class="informaltable" width="100%" border="0">
536 <col width="150px" class="parameters_name">
537 <col class="parameters_description">
538 <col width="200px" class="parameters_annotations">
541 <td class="parameter_name"><p>face</p></td>
542 <td class="parameter_description"><p>a face.</p></td>
543 <td class="parameter_annotations"> </td>
547 <p class="since">Since: <a class="link" href="api-index-0-9-2.html#api-index-0.9.2">0.9.2</a></p>
550 <div class="refsect2">
551 <a name="hb-face-reference"></a><h3>hb_face_reference ()</h3>
552 <pre class="programlisting"><a class="link" href="harfbuzz-hb-face.html#hb-face-t" title="hb_face_t"><span class="returnvalue">hb_face_t</span></a> *
553 hb_face_reference (<em class="parameter"><code><a class="link" href="harfbuzz-hb-face.html#hb-face-t" title="hb_face_t"><span class="type">hb_face_t</span></a> *face</code></em>);</pre>
554 <p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p>
555 <div class="refsect3">
556 <a name="hb-face-reference.parameters"></a><h4>Parameters</h4>
557 <div class="informaltable"><table class="informaltable" width="100%" border="0">
559 <col width="150px" class="parameters_name">
560 <col class="parameters_description">
561 <col width="200px" class="parameters_annotations">
564 <td class="parameter_name"><p>face</p></td>
565 <td class="parameter_description"><p>a face.</p></td>
566 <td class="parameter_annotations"> </td>
570 <p class="since">Since: <a class="link" href="api-index-0-9-2.html#api-index-0.9.2">0.9.2</a></p>
573 <div class="refsect2">
574 <a name="hb-face-reference-blob"></a><h3>hb_face_reference_blob ()</h3>
575 <pre class="programlisting"><a class="link" href="harfbuzz-hb-blob.html#hb-blob-t" title="hb_blob_t"><span class="returnvalue">hb_blob_t</span></a> *
576 hb_face_reference_blob (<em class="parameter"><code><a class="link" href="harfbuzz-hb-face.html#hb-face-t" title="hb_face_t"><span class="type">hb_face_t</span></a> *face</code></em>);</pre>
577 <div class="refsect3">
578 <a name="hb-face-reference-blob.parameters"></a><h4>Parameters</h4>
579 <div class="informaltable"><table class="informaltable" width="100%" border="0">
581 <col width="150px" class="parameters_name">
582 <col class="parameters_description">
583 <col width="200px" class="parameters_annotations">
586 <td class="parameter_name"><p>face</p></td>
587 <td class="parameter_description"><p>a face.</p></td>
588 <td class="parameter_annotations"> </td>
592 <div class="refsect3">
593 <a name="hb-face-reference-blob.returns"></a><h4>Returns</h4>
595 <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
597 <p class="since">Since: <a class="link" href="api-index-0-9-2.html#api-index-0.9.2">0.9.2</a></p>
600 <div class="refsect2">
601 <a name="hb-face-reference-table"></a><h3>hb_face_reference_table ()</h3>
602 <pre class="programlisting"><a class="link" href="harfbuzz-hb-blob.html#hb-blob-t" title="hb_blob_t"><span class="returnvalue">hb_blob_t</span></a> *
603 hb_face_reference_table (<em class="parameter"><code>const <a class="link" href="harfbuzz-hb-face.html#hb-face-t" title="hb_face_t"><span class="type">hb_face_t</span></a> *face</code></em>,
604 <em class="parameter"><code><a class="link" href="harfbuzz-hb-common.html#hb-tag-t" title="hb_tag_t"><span class="type">hb_tag_t</span></a> tag</code></em>);</pre>
605 <div class="refsect3">
606 <a name="hb-face-reference-table.parameters"></a><h4>Parameters</h4>
607 <div class="informaltable"><table class="informaltable" width="100%" border="0">
609 <col width="150px" class="parameters_name">
610 <col class="parameters_description">
611 <col width="200px" class="parameters_annotations">
614 <td class="parameter_name"><p>face</p></td>
615 <td class="parameter_description"><p>a face.</p></td>
616 <td class="parameter_annotations"> </td>
620 <div class="refsect3">
621 <a name="hb-face-reference-table.returns"></a><h4>Returns</h4>
623 <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
625 <p class="since">Since: <a class="link" href="api-index-0-9-2.html#api-index-0.9.2">0.9.2</a></p>
628 <div class="refsect2">
629 <a name="hb-face-set-glyph-count"></a><h3>hb_face_set_glyph_count ()</h3>
630 <pre class="programlisting"><span class="returnvalue">void</span>
631 hb_face_set_glyph_count (<em class="parameter"><code><a class="link" href="harfbuzz-hb-face.html#hb-face-t" title="hb_face_t"><span class="type">hb_face_t</span></a> *face</code></em>,
632 <em class="parameter"><code>unsigned <span class="type">int</span> glyph_count</code></em>);</pre>
633 <div class="refsect3">
634 <a name="hb-face-set-glyph-count.parameters"></a><h4>Parameters</h4>
635 <div class="informaltable"><table class="informaltable" width="100%" border="0">
637 <col width="150px" class="parameters_name">
638 <col class="parameters_description">
639 <col width="200px" class="parameters_annotations">
642 <td class="parameter_name"><p>face</p></td>
643 <td class="parameter_description"><p>a face.</p></td>
644 <td class="parameter_annotations"> </td>
648 <p class="since">Since: <a class="link" href="api-index-0-9-7.html#api-index-0.9.7">0.9.7</a></p>
651 <div class="refsect2">
652 <a name="hb-face-set-index"></a><h3>hb_face_set_index ()</h3>
653 <pre class="programlisting"><span class="returnvalue">void</span>
654 hb_face_set_index (<em class="parameter"><code><a class="link" href="harfbuzz-hb-face.html#hb-face-t" title="hb_face_t"><span class="type">hb_face_t</span></a> *face</code></em>,
655 <em class="parameter"><code>unsigned <span class="type">int</span> index</code></em>);</pre>
656 <div class="refsect3">
657 <a name="hb-face-set-index.parameters"></a><h4>Parameters</h4>
658 <div class="informaltable"><table class="informaltable" width="100%" border="0">
660 <col width="150px" class="parameters_name">
661 <col class="parameters_description">
662 <col width="200px" class="parameters_annotations">
665 <td class="parameter_name"><p>face</p></td>
666 <td class="parameter_description"><p>a face.</p></td>
667 <td class="parameter_annotations"> </td>
671 <p class="since">Since: <a class="link" href="api-index-0-9-2.html#api-index-0.9.2">0.9.2</a></p>
674 <div class="refsect2">
675 <a name="hb-face-set-upem"></a><h3>hb_face_set_upem ()</h3>
676 <pre class="programlisting"><span class="returnvalue">void</span>
677 hb_face_set_upem (<em class="parameter"><code><a class="link" href="harfbuzz-hb-face.html#hb-face-t" title="hb_face_t"><span class="type">hb_face_t</span></a> *face</code></em>,
678 <em class="parameter"><code>unsigned <span class="type">int</span> upem</code></em>);</pre>
679 <div class="refsect3">
680 <a name="hb-face-set-upem.parameters"></a><h4>Parameters</h4>
681 <div class="informaltable"><table class="informaltable" width="100%" border="0">
683 <col width="150px" class="parameters_name">
684 <col class="parameters_description">
685 <col width="200px" class="parameters_annotations">
688 <td class="parameter_name"><p>face</p></td>
689 <td class="parameter_description"><p>a face.</p></td>
690 <td class="parameter_annotations"> </td>
694 <p class="since">Since: <a class="link" href="api-index-0-9-2.html#api-index-0.9.2">0.9.2</a></p>
697 <div class="refsect2">
698 <a name="hb-face-set-user-data"></a><h3>hb_face_set_user_data ()</h3>
699 <pre class="programlisting"><a class="link" href="harfbuzz-hb-common.html#hb-bool-t" title="hb_bool_t"><span class="returnvalue">hb_bool_t</span></a>
700 hb_face_set_user_data (<em class="parameter"><code><a class="link" href="harfbuzz-hb-face.html#hb-face-t" title="hb_face_t"><span class="type">hb_face_t</span></a> *face</code></em>,
701 <em class="parameter"><code><a class="link" href="harfbuzz-hb-common.html#hb-user-data-key-t" title="hb_user_data_key_t"><span class="type">hb_user_data_key_t</span></a> *key</code></em>,
702 <em class="parameter"><code><span class="type">void</span> *data</code></em>,
703 <em class="parameter"><code><a class="link" href="harfbuzz-hb-common.html#hb-destroy-func-t" title="hb_destroy_func_t ()"><span class="type">hb_destroy_func_t</span></a> destroy</code></em>,
704 <em class="parameter"><code><a class="link" href="harfbuzz-hb-common.html#hb-bool-t" title="hb_bool_t"><span class="type">hb_bool_t</span></a> replace</code></em>);</pre>
705 <p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p>
706 <div class="refsect3">
707 <a name="hb-face-set-user-data.parameters"></a><h4>Parameters</h4>
708 <div class="informaltable"><table class="informaltable" width="100%" border="0">
710 <col width="150px" class="parameters_name">
711 <col class="parameters_description">
712 <col width="200px" class="parameters_annotations">
715 <td class="parameter_name"><p>face</p></td>
716 <td class="parameter_description"><p>a face.</p></td>
717 <td class="parameter_annotations"> </td>
721 <p class="since">Since: <a class="link" href="api-index-0-9-2.html#api-index-0.9.2">0.9.2</a></p>
724 <div class="refsect2">
725 <a name="hb-face-collect-unicodes"></a><h3>hb_face_collect_unicodes ()</h3>
726 <pre class="programlisting"><span class="returnvalue">void</span>
727 hb_face_collect_unicodes (<em class="parameter"><code><a class="link" href="harfbuzz-hb-face.html#hb-face-t" title="hb_face_t"><span class="type">hb_face_t</span></a> *face</code></em>,
728 <em class="parameter"><code><a class="link" href="harfbuzz-hb-set.html#hb-set-t" title="hb_set_t"><span class="type">hb_set_t</span></a> *out</code></em>);</pre>
729 <div class="refsect3">
730 <a name="hb-face-collect-unicodes.parameters"></a><h4>Parameters</h4>
731 <div class="informaltable"><table class="informaltable" width="100%" border="0">
733 <col width="150px" class="parameters_name">
734 <col class="parameters_description">
735 <col width="200px" class="parameters_annotations">
739 <td class="parameter_name"><p>face</p></td>
740 <td class="parameter_description"><p>font face.</p></td>
741 <td class="parameter_annotations"> </td>
744 <td class="parameter_name"><p>out</p></td>
745 <td class="parameter_description"><p>set to add Unicode characters covered by <em class="parameter"><code>face</code></em>
747 <td class="parameter_annotations"> </td>
752 <p class="since">Since: <a class="link" href="api-index-1-9-0.html#api-index-1.9.0">1.9.0</a></p>
755 <div class="refsect2">
756 <a name="hb-face-collect-variation-selectors"></a><h3>hb_face_collect_variation_selectors ()</h3>
757 <pre class="programlisting"><span class="returnvalue">void</span>
758 hb_face_collect_variation_selectors (<em class="parameter"><code><a class="link" href="harfbuzz-hb-face.html#hb-face-t" title="hb_face_t"><span class="type">hb_face_t</span></a> *face</code></em>,
759 <em class="parameter"><code><a class="link" href="harfbuzz-hb-set.html#hb-set-t" title="hb_set_t"><span class="type">hb_set_t</span></a> *out</code></em>);</pre>
760 <div class="refsect3">
761 <a name="hb-face-collect-variation-selectors.parameters"></a><h4>Parameters</h4>
762 <div class="informaltable"><table class="informaltable" width="100%" border="0">
764 <col width="150px" class="parameters_name">
765 <col class="parameters_description">
766 <col width="200px" class="parameters_annotations">
770 <td class="parameter_name"><p>face</p></td>
771 <td class="parameter_description"><p>font face.</p></td>
772 <td class="parameter_annotations"> </td>
775 <td class="parameter_name"><p>out</p></td>
776 <td class="parameter_description"><p>set to add Variation Selector characters covered by <em class="parameter"><code>face</code></em>
778 <td class="parameter_annotations"> </td>
783 <p class="since">Since: <a class="link" href="api-index-1-9-0.html#api-index-1.9.0">1.9.0</a></p>
786 <div class="refsect2">
787 <a name="hb-face-collect-variation-unicodes"></a><h3>hb_face_collect_variation_unicodes ()</h3>
788 <pre class="programlisting"><span class="returnvalue">void</span>
789 hb_face_collect_variation_unicodes (<em class="parameter"><code><a class="link" href="harfbuzz-hb-face.html#hb-face-t" title="hb_face_t"><span class="type">hb_face_t</span></a> *face</code></em>,
790 <em class="parameter"><code><a class="link" href="harfbuzz-hb-common.html#hb-codepoint-t" title="hb_codepoint_t"><span class="type">hb_codepoint_t</span></a> variation_selector</code></em>,
791 <em class="parameter"><code><a class="link" href="harfbuzz-hb-set.html#hb-set-t" title="hb_set_t"><span class="type">hb_set_t</span></a> *out</code></em>);</pre>
792 <div class="refsect3">
793 <a name="hb-face-collect-variation-unicodes.parameters"></a><h4>Parameters</h4>
794 <div class="informaltable"><table class="informaltable" width="100%" border="0">
796 <col width="150px" class="parameters_name">
797 <col class="parameters_description">
798 <col width="200px" class="parameters_annotations">
802 <td class="parameter_name"><p>face</p></td>
803 <td class="parameter_description"><p>font face.</p></td>
804 <td class="parameter_annotations"> </td>
807 <td class="parameter_name"><p>out</p></td>
808 <td class="parameter_description"><p>set to add Unicode characters for <em class="parameter"><code>variation_selector</code></em>
809 covered by <em class="parameter"><code>face</code></em>
811 <td class="parameter_annotations"> </td>
816 <p class="since">Since: <a class="link" href="api-index-1-9-0.html#api-index-1.9.0">1.9.0</a></p>
819 <div class="refsect2">
820 <a name="hb-face-builder-create"></a><h3>hb_face_builder_create ()</h3>
821 <pre class="programlisting"><a class="link" href="harfbuzz-hb-face.html#hb-face-t" title="hb_face_t"><span class="returnvalue">hb_face_t</span></a> *
822 hb_face_builder_create (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
823 <p>Creates a <a class="link" href="harfbuzz-hb-face.html#hb-face-t" title="hb_face_t"><span class="type">hb_face_t</span></a> that can be used with <a class="link" href="harfbuzz-hb-face.html#hb-face-builder-add-table" title="hb_face_builder_add_table ()"><code class="function">hb_face_builder_add_table()</code></a>.
824 After tables are added to the face, it can be compiled to a binary
825 font file by calling <a class="link" href="harfbuzz-hb-face.html#hb-face-reference-blob" title="hb_face_reference_blob ()"><code class="function">hb_face_reference_blob()</code></a>.</p>
826 <div class="refsect3">
827 <a name="hb-face-builder-create.returns"></a><h4>Returns</h4>
829 <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
831 <p class="since">Since: <a class="link" href="api-index-1-9-0.html#api-index-1.9.0">1.9.0</a></p>
834 <div class="refsect2">
835 <a name="hb-face-builder-add-table"></a><h3>hb_face_builder_add_table ()</h3>
836 <pre class="programlisting"><a class="link" href="harfbuzz-hb-common.html#hb-bool-t" title="hb_bool_t"><span class="returnvalue">hb_bool_t</span></a>
837 hb_face_builder_add_table (<em class="parameter"><code><a class="link" href="harfbuzz-hb-face.html#hb-face-t" title="hb_face_t"><span class="type">hb_face_t</span></a> *face</code></em>,
838 <em class="parameter"><code><a class="link" href="harfbuzz-hb-common.html#hb-tag-t" title="hb_tag_t"><span class="type">hb_tag_t</span></a> tag</code></em>,
839 <em class="parameter"><code><a class="link" href="harfbuzz-hb-blob.html#hb-blob-t" title="hb_blob_t"><span class="type">hb_blob_t</span></a> *blob</code></em>);</pre>
840 <p>Add table for <em class="parameter"><code>tag</code></em>
841 with data provided by <em class="parameter"><code>blob</code></em>
842 to the face. <em class="parameter"><code>face</code></em>
844 be created using <a class="link" href="harfbuzz-hb-face.html#hb-face-builder-create" title="hb_face_builder_create ()"><code class="function">hb_face_builder_create()</code></a>.</p>
845 <p class="since">Since: <a class="link" href="api-index-1-9-0.html#api-index-1.9.0">1.9.0</a></p>
848 <div class="refsect1">
849 <a name="harfbuzz-hb-face.other_details"></a><h2>Types and Values</h2>
850 <div class="refsect2">
851 <a name="hb-face-t"></a><h3>hb_face_t</h3>
852 <pre class="programlisting">typedef struct hb_face_t hb_face_t;
858 <hr>Generated by GTK-Doc V1.29</div>