Imported Upstream version 2.6.7
[platform/upstream/harfbuzz.git] / docs / html / harfbuzz-hb-graphite2.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 <html>
3 <head>
4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5 <title>hb-graphite2: 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="ch15.html" title="Integration API">
9 <link rel="prev" href="harfbuzz-hb-gobject.html" title="hb-gobject">
10 <link rel="next" href="harfbuzz-hb-icu.html" title="hb-icu">
11 <meta name="generator" content="GTK-Doc V1.32.1 (XML mode)">
12 <link rel="stylesheet" href="style.css" type="text/css">
13 </head>
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-graphite2.description" class="shortcut">Description</a></span>
19 </td>
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="ch15.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
22 <td><a accesskey="p" href="harfbuzz-hb-gobject.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
23 <td><a accesskey="n" href="harfbuzz-hb-icu.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
24 </tr></table>
25 <div class="refentry">
26 <a name="harfbuzz-hb-graphite2"></a><div class="titlepage"></div>
27 <div class="refnamediv"><table width="100%"><tr>
28 <td valign="top">
29 <h2><span class="refentrytitle"><a name="harfbuzz-hb-graphite2.top_of_page"></a>hb-graphite2</span></h2>
30 <p>hb-graphite2 — Graphite2 integration</p>
31 </td>
32 <td class="gallery_image" valign="top" align="right"></td>
33 </tr></table></div>
34 <div class="refsect1">
35 <a name="harfbuzz-hb-graphite2.functions"></a><h2>Functions</h2>
36 <div class="informaltable"><table class="informaltable" width="100%" border="0">
37 <colgroup>
38 <col width="150px" class="functions_proto_type">
39 <col class="functions_proto_name">
40 </colgroup>
41 <tbody><tr>
42 <td class="function_type">
43 <span class="returnvalue">gr_face</span> *
44 </td>
45 <td class="function_name">
46 <a class="link" href="harfbuzz-hb-graphite2.html#hb-graphite2-face-get-gr-face" title="hb_graphite2_face_get_gr_face ()">hb_graphite2_face_get_gr_face</a> <span class="c_punctuation">()</span>
47 </td>
48 </tr></tbody>
49 </table></div>
50 </div>
51 <div class="refsect1">
52 <a name="harfbuzz-hb-graphite2.other"></a><h2>Types and Values</h2>
53 <div class="informaltable"><table class="informaltable" width="100%" border="0">
54 <colgroup>
55 <col width="150px" class="other_proto_type">
56 <col class="other_proto_name">
57 </colgroup>
58 <tbody><tr>
59 <td class="define_keyword">#define</td>
60 <td class="function_name"><a class="link" href="harfbuzz-hb-graphite2.html#HB-GRAPHITE2-TAG-SILF:CAPS" title="HB_GRAPHITE2_TAG_SILF">HB_GRAPHITE2_TAG_SILF</a></td>
61 </tr></tbody>
62 </table></div>
63 </div>
64 <div class="refsect1">
65 <a name="harfbuzz-hb-graphite2.includes"></a><h2>Includes</h2>
66 <pre class="synopsis">#include &lt;hb-graphite2.h&gt;
67 </pre>
68 </div>
69 <div class="refsect1">
70 <a name="harfbuzz-hb-graphite2.description"></a><h2>Description</h2>
71 <p>Functions for using HarfBuzz with fonts that include Graphite features.</p>
72 <p>For Graphite features to work, you must be sure that HarfBuzz was compiled
73 with the <code class="literal">graphite2</code> shaping engine enabled. Currently, the default is to
74 not enable <code class="literal">graphite2</code> shaping.</p>
75 </div>
76 <div class="refsect1">
77 <a name="harfbuzz-hb-graphite2.functions_details"></a><h2>Functions</h2>
78 <div class="refsect2">
79 <a name="hb-graphite2-face-get-gr-face"></a><h3>hb_graphite2_face_get_gr_face ()</h3>
80 <pre class="programlisting"><span class="returnvalue">gr_face</span> *
81 hb_graphite2_face_get_gr_face (<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>
82 <p>Fetches the Graphite2 gr_face corresponding to the specified
83 <a class="link" href="harfbuzz-hb-face.html#hb-face-t" title="hb_face_t"><span class="type">hb_face_t</span></a> face object.</p>
84 <div class="refsect3">
85 <a name="hb-graphite2-face-get-gr-face.parameters"></a><h4>Parameters</h4>
86 <div class="informaltable"><table class="informaltable" width="100%" border="0">
87 <colgroup>
88 <col width="150px" class="parameters_name">
89 <col class="parameters_description">
90 <col width="200px" class="parameters_annotations">
91 </colgroup>
92 <tbody><tr>
93 <td class="parameter_name"><p>face</p></td>
94 <td class="parameter_description"><p><em class="parameter"><code>hb_face_t</code></em>
95 to query</p></td>
96 <td class="parameter_annotations"> </td>
97 </tr></tbody>
98 </table></div>
99 </div>
100 <div class="refsect3">
101 <a name="hb-graphite2-face-get-gr-face.returns"></a><h4>Returns</h4>
102 <p> the gr_face found</p>
103 </div>
104 <p class="since">Since: <a class="link" href="api-index-0-9-10.html#api-index-0.9.10">0.9.10</a></p>
105 </div>
106 </div>
107 <div class="refsect1">
108 <a name="harfbuzz-hb-graphite2.other_details"></a><h2>Types and Values</h2>
109 <div class="refsect2">
110 <a name="HB-GRAPHITE2-TAG-SILF:CAPS"></a><h3>HB_GRAPHITE2_TAG_SILF</h3>
111 <pre class="programlisting">#define HB_GRAPHITE2_TAG_SILF HB_TAG('S','i','l','f')
112 </pre>
113 <p>The <a class="link" href="harfbuzz-hb-common.html#hb-tag-t" title="hb_tag_t"><span class="type">hb_tag_t</span></a> tag for the <code class="literal">Silf</code> table, which holds Graphite
114 features. </p>
115 <p>For more information, see http://graphite.sil.org/</p>
116 </div>
117 </div>
118 </div>
119 <div class="footer">
120 <hr>Generated by GTK-Doc V1.32.1</div>
121 </body>
122 </html>