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 V1.79.1">
   7 <link rel="home" href="index.html" title="HarfBuzz Manual">
   8 <link rel="up" href="integration-api.html" title="Integration API">
   9 <link rel="prev" href="harfbuzz-hb-glib.html" title="hb-glib">
  10 <link rel="next" href="harfbuzz-hb-icu.html" title="hb-icu">
  11 <meta name="generator" content="GTK-Doc V1.32 (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="integration-api.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
  22 <td><a accesskey="p" href="harfbuzz-hb-glib.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>
  42 <tr>
  43 <td class="function_type">
  44 <span class="returnvalue">gr_face</span> *
  45 </td>
  46 <td class="function_name">
  47 <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>
  48 </td>
  49 </tr>
  50 <tr>
  51 <td class="function_type">
  52 <span class="returnvalue">gr_font</span> *
  53 </td>
  54 <td class="function_name">
  55 <a class="link" href="harfbuzz-hb-graphite2.html#hb-graphite2-font-get-gr-font" title="hb_graphite2_font_get_gr_font ()">hb_graphite2_font_get_gr_font</a> <span class="c_punctuation">()</span>
  56 </td>
  57 </tr>
  58 </tbody>
  59 </table></div>
  60 </div>
  61 <div class="refsect1">
  62 <a name="harfbuzz-hb-graphite2.other"></a><h2>Types and Values</h2>
  63 <div class="informaltable"><table class="informaltable" width="100%" border="0">
  64 <colgroup>
  65 <col width="150px" class="other_proto_type">
  66 <col class="other_proto_name">
  67 </colgroup>
  68 <tbody><tr>
  69 <td class="define_keyword">#define</td>
  70 <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>
  71 </tr></tbody>
  72 </table></div>
  73 </div>
  74 <div class="refsect1">
  75 <a name="harfbuzz-hb-graphite2.includes"></a><h2>Includes</h2>
  76 <pre class="synopsis">#include &lt;hb-graphite2.h&gt;
  77 </pre>
  78 </div>
  79 <div class="refsect1">
  80 <a name="harfbuzz-hb-graphite2.description"></a><h2>Description</h2>
  81 <p>Functions for using HarfBuzz with fonts that include Graphite features.</p>
  82 <p>For Graphite features to work, you must be sure that HarfBuzz was compiled
  83 with the <code class="literal">graphite2</code> shaping engine enabled. Currently, the default is to
  84 not enable <code class="literal">graphite2</code> shaping.</p>
  85 </div>
  86 <div class="refsect1">
  87 <a name="harfbuzz-hb-graphite2.functions_details"></a><h2>Functions</h2>
  88 <div class="refsect2">
  89 <a name="hb-graphite2-face-get-gr-face"></a><h3>hb_graphite2_face_get_gr_face ()</h3>
  90 <pre class="programlisting"><span class="returnvalue">gr_face</span> *
  91 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>
  92 <p>Fetches the Graphite2 gr_face corresponding to the specified
  93 <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>
  94 <p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p>
  95 <div class="refsect3">
  96 <a name="hb-graphite2-face-get-gr-face.parameters"></a><h4>Parameters</h4>
  97 <div class="informaltable"><table class="informaltable" width="100%" border="0">
  98 <colgroup>
  99 <col width="150px" class="parameters_name">
 100 <col class="parameters_description">
 101 <col width="200px" class="parameters_annotations">
 102 </colgroup>
 103 <tbody><tr>
 104 <td class="parameter_name"><p>face</p></td>
 105 <td class="parameter_description"><p><em class="parameter"><code>hb_face_t</code></em>
 106 to query</p></td>
 107 <td class="parameter_annotations"> </td>
 108 </tr></tbody>
 109 </table></div>
 110 </div>
 111 <div class="refsect3">
 112 <a name="hb-graphite2-face-get-gr-face.returns"></a><h4>Returns</h4>
 113 <p> the gr_face found</p>
 114 </div>
 115 <p class="since">Since: <a class="link" href="api-index-0-9-10.html#api-index-0.9.10">0.9.10</a></p>
 116 </div>
 117 <hr>
 118 <div class="refsect2">
 119 <a name="hb-graphite2-font-get-gr-font"></a><h3>hb_graphite2_font_get_gr_font ()</h3>
 120 <pre class="programlisting"><span class="returnvalue">gr_font</span> *
 121 hb_graphite2_font_get_gr_font (<em class="parameter"><code><a class="link" href="harfbuzz-hb-font.html#hb-font-t" title="hb_font_t"><span class="type">hb_font_t</span></a> *font</code></em>);</pre>
 122 <div class="warning"><p><code class="literal">hb_graphite2_font_get_gr_font</code> has been deprecated since version 1.4.2 and should not be used in newly-written code.</p></div>
 123 <p>Always returns <code class="literal">NULL</code>. Use <a class="link" href="harfbuzz-hb-graphite2.html#hb-graphite2-face-get-gr-face" title="hb_graphite2_face_get_gr_face ()"><code class="function">hb_graphite2_face_get_gr_face()</code></a> instead.</p>
 124 <p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p>
 125 <div class="refsect3">
 126 <a name="hb-graphite2-font-get-gr-font.parameters"></a><h4>Parameters</h4>
 127 <div class="informaltable"><table class="informaltable" width="100%" border="0">
 128 <colgroup>
 129 <col width="150px" class="parameters_name">
 130 <col class="parameters_description">
 131 <col width="200px" class="parameters_annotations">
 132 </colgroup>
 133 <tbody><tr>
 134 <td class="parameter_name"><p>font</p></td>
 135 <td class="parameter_description"><p>An <a class="link" href="harfbuzz-hb-font.html#hb-font-t" title="hb_font_t"><span class="type">hb_font_t</span></a></p></td>
 136 <td class="parameter_annotations"> </td>
 137 </tr></tbody>
 138 </table></div>
 139 </div>
 140 <div class="refsect3">
 141 <a name="hb-graphite2-font-get-gr-font.returns"></a><h4>Returns</h4>
 142 <p>Graphite2 font associated with <em class="parameter"><code>font</code></em>
 143 . </p>
 144 <p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></p>
 145 </div>
 146 <p class="since">Since: <a class="link" href="api-index-0-9-10.html#api-index-0.9.10">0.9.10</a></p>
 147 </div>
 148 </div>
 149 <div class="refsect1">
 150 <a name="harfbuzz-hb-graphite2.other_details"></a><h2>Types and Values</h2>
 151 <div class="refsect2">
 152 <a name="HB-GRAPHITE2-TAG-SILF:CAPS"></a><h3>HB_GRAPHITE2_TAG_SILF</h3>
 153 <pre class="programlisting">#define HB_GRAPHITE2_TAG_SILF HB_TAG('S','i','l','f')
 154 </pre>
 155 <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
 156 features. </p>
 157 <p>For more information, see http://graphite.sil.org/</p>
 158 </div>
 159 </div>
 160 </div>
 161 <div class="footer">
 162 <hr>Generated by GTK-Doc V1.32</div>
 163 </body>
 164 </html>