docs/html/harfbuzz-hb-shape-plan.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-shape-plan: 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="ch09.html" title="Core API">
   9 <link rel="prev" href="harfbuzz-hb-set.html" title="hb-set">
  10 <link rel="next" href="harfbuzz-hb-shape.html" title="hb-shape">
  11 <meta name="generator" content="GTK-Doc V1.25 (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-shape-plan.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span>
  19                   <a href="#harfbuzz-hb-shape-plan.object-hierarchy" class="shortcut">Object Hierarchy</a></span>
  20 </td>
  21 <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
  22 <td><a accesskey="u" href="ch09.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
  23 <td><a accesskey="p" href="harfbuzz-hb-set.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
  24 <td><a accesskey="n" href="harfbuzz-hb-shape.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
  25 </tr></table>
  26 <div class="refentry">
  27 <a name="harfbuzz-hb-shape-plan"></a><div class="titlepage"></div>
  28 <div class="refnamediv"><table width="100%"><tr>
  29 <td valign="top">
  30 <h2><span class="refentrytitle"><a name="harfbuzz-hb-shape-plan.top_of_page"></a>hb-shape-plan</span></h2>
  31 <p>hb-shape-plan — Object representing a shaping plan</p>
  32 </td>
  33 <td class="gallery_image" valign="top" align="right"></td>
  34 </tr></table></div>
  35 <div class="refsect1">
  36 <a name="harfbuzz-hb-shape-plan.functions"></a><h2>Functions</h2>
  37 <div class="informaltable"><table class="informaltable" width="100%" border="0">
  38 <colgroup>
  39 <col width="150px" class="functions_return">
  40 <col class="functions_name">
  41 </colgroup>
  42 <tbody>
  43 <tr>
  44 <td class="function_type">
  45 <a class="link" href="harfbuzz-hb-shape-plan.html#hb-shape-plan-t"><span class="returnvalue">hb_shape_plan_t</span></a> *
  46 </td>
  47 <td class="function_name">
  48 <a class="link" href="harfbuzz-hb-shape-plan.html#hb-shape-plan-create" title="hb_shape_plan_create ()">hb_shape_plan_create</a> <span class="c_punctuation">()</span>
  49 </td>
  50 </tr>
  51 <tr>
  52 <td class="function_type">
  53 <a class="link" href="harfbuzz-hb-shape-plan.html#hb-shape-plan-t"><span class="returnvalue">hb_shape_plan_t</span></a> *
  54 </td>
  55 <td class="function_name">
  56 <a class="link" href="harfbuzz-hb-shape-plan.html#hb-shape-plan-create-cached" title="hb_shape_plan_create_cached ()">hb_shape_plan_create_cached</a> <span class="c_punctuation">()</span>
  57 </td>
  58 </tr>
  59 <tr>
  60 <td class="function_type">
  61 <a class="link" href="harfbuzz-hb-shape-plan.html#hb-shape-plan-t"><span class="returnvalue">hb_shape_plan_t</span></a> *
  62 </td>
  63 <td class="function_name">
  64 <a class="link" href="harfbuzz-hb-shape-plan.html#hb-shape-plan-create2" title="hb_shape_plan_create2 ()">hb_shape_plan_create2</a> <span class="c_punctuation">()</span>
  65 </td>
  66 </tr>
  67 <tr>
  68 <td class="function_type">
  69 <a class="link" href="harfbuzz-hb-shape-plan.html#hb-shape-plan-t"><span class="returnvalue">hb_shape_plan_t</span></a> *
  70 </td>
  71 <td class="function_name">
  72 <a class="link" href="harfbuzz-hb-shape-plan.html#hb-shape-plan-create-cached2" title="hb_shape_plan_create_cached2 ()">hb_shape_plan_create_cached2</a> <span class="c_punctuation">()</span>
  73 </td>
  74 </tr>
  75 <tr>
  76 <td class="function_type">
  77 <span class="returnvalue">void</span>
  78 </td>
  79 <td class="function_name">
  80 <a class="link" href="harfbuzz-hb-shape-plan.html#hb-shape-plan-destroy" title="hb_shape_plan_destroy ()">hb_shape_plan_destroy</a> <span class="c_punctuation">()</span>
  81 </td>
  82 </tr>
  83 <tr>
  84 <td class="function_type">
  85 <a class="link" href="harfbuzz-hb-common.html#hb-bool-t" title="hb_bool_t"><span class="returnvalue">hb_bool_t</span></a>
  86 </td>
  87 <td class="function_name">
  88 <a class="link" href="harfbuzz-hb-shape-plan.html#hb-shape-plan-execute" title="hb_shape_plan_execute ()">hb_shape_plan_execute</a> <span class="c_punctuation">()</span>
  89 </td>
  90 </tr>
  91 <tr>
  92 <td class="function_type">
  93 <a class="link" href="harfbuzz-hb-shape-plan.html#hb-shape-plan-t"><span class="returnvalue">hb_shape_plan_t</span></a> *
  94 </td>
  95 <td class="function_name">
  96 <a class="link" href="harfbuzz-hb-shape-plan.html#hb-shape-plan-get-empty" title="hb_shape_plan_get_empty ()">hb_shape_plan_get_empty</a> <span class="c_punctuation">()</span>
  97 </td>
  98 </tr>
  99 <tr>
 100 <td class="function_type">const <span class="returnvalue">char</span> *
 101 </td>
 102 <td class="function_name">
 103 <a class="link" href="harfbuzz-hb-shape-plan.html#hb-shape-plan-get-shaper" title="hb_shape_plan_get_shaper ()">hb_shape_plan_get_shaper</a> <span class="c_punctuation">()</span>
 104 </td>
 105 </tr>
 106 <tr>
 107 <td class="function_type">
 108 <span class="returnvalue">void</span> *
 109 </td>
 110 <td class="function_name">
 111 <a class="link" href="harfbuzz-hb-shape-plan.html#hb-shape-plan-get-user-data" title="hb_shape_plan_get_user_data ()">hb_shape_plan_get_user_data</a> <span class="c_punctuation">()</span>
 112 </td>
 113 </tr>
 114 <tr>
 115 <td class="function_type">
 116 <a class="link" href="harfbuzz-hb-shape-plan.html#hb-shape-plan-t"><span class="returnvalue">hb_shape_plan_t</span></a> *
 117 </td>
 118 <td class="function_name">
 119 <a class="link" href="harfbuzz-hb-shape-plan.html#hb-shape-plan-reference" title="hb_shape_plan_reference ()">hb_shape_plan_reference</a> <span class="c_punctuation">()</span>
 120 </td>
 121 </tr>
 122 <tr>
 123 <td class="function_type">
 124 <a class="link" href="harfbuzz-hb-common.html#hb-bool-t" title="hb_bool_t"><span class="returnvalue">hb_bool_t</span></a>
 125 </td>
 126 <td class="function_name">
 127 <a class="link" href="harfbuzz-hb-shape-plan.html#hb-shape-plan-set-user-data" title="hb_shape_plan_set_user_data ()">hb_shape_plan_set_user_data</a> <span class="c_punctuation">()</span>
 128 </td>
 129 </tr>
 130 </tbody>
 131 </table></div>
 132 </div>
 133 <a name="hb-shape-plan-t"></a><div class="refsect1">
 134 <a name="harfbuzz-hb-shape-plan.other"></a><h2>Types and Values</h2>
 135 <div class="informaltable"><table class="informaltable" width="100%" border="0">
 136 <colgroup>
 137 <col width="150px" class="name">
 138 <col class="description">
 139 </colgroup>
 140 <tbody><tr>
 141 <td class="typedef_keyword">typedef</td>
 142 <td class="function_name"><a class="link" href="harfbuzz-hb-shape-plan.html#hb-shape-plan-t">hb_shape_plan_t</a></td>
 143 </tr></tbody>
 144 </table></div>
 145 </div>
 146 <div class="refsect1">
 147 <a name="harfbuzz-hb-shape-plan.object-hierarchy"></a><h2>Object Hierarchy</h2>
 148 <pre class="screen">    <a href="/usr/share/gtk-doc/html/gobject/gobject-Boxed-Types.html">GBoxed</a>
 149     <span class="lineart">╰──</span> hb_shape_plan_t
 150 </pre>
 151 </div>
 152 <div class="refsect1">
 153 <a name="harfbuzz-hb-shape-plan.includes"></a><h2>Includes</h2>
 154 <pre class="synopsis">#include &lt;hb.h&gt;
 155 </pre>
 156 </div>
 157 <div class="refsect1">
 158 <a name="harfbuzz-hb-shape-plan.description"></a><h2>Description</h2>
 159 <p>Shape plans are not used for shaping directly, but can be access to query
 160 certain information about how shaping will perform given a set of input
 161 parameters (script, language, direction, features, etc.)
 162 Most client would not need to deal with shape plans directly.</p>
 163 </div>
 164 <div class="refsect1">
 165 <a name="harfbuzz-hb-shape-plan.functions_details"></a><h2>Functions</h2>
 166 <div class="refsect2">
 167 <a name="hb-shape-plan-create"></a><h3>hb_shape_plan_create ()</h3>
 168 <pre class="programlisting"><a class="link" href="harfbuzz-hb-shape-plan.html#hb-shape-plan-t"><span class="returnvalue">hb_shape_plan_t</span></a> *
 169 hb_shape_plan_create (<em class="parameter"><code><a class="link" href="harfbuzz-hb-face.html#hb-face-t"><span class="type">hb_face_t</span></a> *face</code></em>,
 170                       <em class="parameter"><code>const <a class="link" href="harfbuzz-hb-buffer.html#hb-segment-properties-t"><span class="type">hb_segment_properties_t</span></a> *props</code></em>,
 171                       <em class="parameter"><code>const <a class="link" href="harfbuzz-hb-shape.html#hb-feature-t"><span class="type">hb_feature_t</span></a> *user_features</code></em>,
 172                       <em class="parameter"><code>unsigned <span class="type">int</span> num_user_features</code></em>,
 173                       <em class="parameter"><code>const <span class="type">char</span> * const *shaper_list</code></em>);</pre>
 174 <p><span class="annotation">[Xconstructor]</span></p>
 175 <div class="refsect3">
 176 <a name="hb-shape-plan-create.parameters"></a><h4>Parameters</h4>
 177 <div class="informaltable"><table class="informaltable" width="100%" border="0">
 178 <colgroup>
 179 <col width="150px" class="parameters_name">
 180 <col class="parameters_description">
 181 <col width="200px" class="parameters_annotations">
 182 </colgroup>
 183 <tbody>
 184 <tr>
 185 <td class="parameter_name"><p>user_features</p></td>
 186 <td class="parameter_description"><p>. </p></td>
 187 <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=num_user_features]</span></td>
 188 </tr>
 189 <tr>
 190 <td class="parameter_name"><p>shaper_list</p></td>
 191 <td class="parameter_description"><p>. </p></td>
 192 <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> zero-terminated=1]</span></td>
 193 </tr>
 194 </tbody>
 195 </table></div>
 196 </div>
 197 <div class="refsect3">
 198 <a name="hb-shape-plan-create.returns"></a><h4>Returns</h4>
 199 <p>. </p>
 200 <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
 201 </div>
 202 <p class="since">Since: <a class="link" href="api-index-0-9-7.html#api-index-0.9.7">0.9.7</a></p>
 203 </div>
 204 <hr>
 205 <div class="refsect2">
 206 <a name="hb-shape-plan-create-cached"></a><h3>hb_shape_plan_create_cached ()</h3>
 207 <pre class="programlisting"><a class="link" href="harfbuzz-hb-shape-plan.html#hb-shape-plan-t"><span class="returnvalue">hb_shape_plan_t</span></a> *
 208 hb_shape_plan_create_cached (<em class="parameter"><code><a class="link" href="harfbuzz-hb-face.html#hb-face-t"><span class="type">hb_face_t</span></a> *face</code></em>,
 209                              <em class="parameter"><code>const <a class="link" href="harfbuzz-hb-buffer.html#hb-segment-properties-t"><span class="type">hb_segment_properties_t</span></a> *props</code></em>,
 210                              <em class="parameter"><code>const <a class="link" href="harfbuzz-hb-shape.html#hb-feature-t"><span class="type">hb_feature_t</span></a> *user_features</code></em>,
 211                              <em class="parameter"><code>unsigned <span class="type">int</span> num_user_features</code></em>,
 212                              <em class="parameter"><code>const <span class="type">char</span> * const *shaper_list</code></em>);</pre>
 213 <div class="refsect3">
 214 <a name="hb-shape-plan-create-cached.parameters"></a><h4>Parameters</h4>
 215 <div class="informaltable"><table class="informaltable" width="100%" border="0">
 216 <colgroup>
 217 <col width="150px" class="parameters_name">
 218 <col class="parameters_description">
 219 <col width="200px" class="parameters_annotations">
 220 </colgroup>
 221 <tbody>
 222 <tr>
 223 <td class="parameter_name"><p>user_features</p></td>
 224 <td class="parameter_description"><p>. </p></td>
 225 <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=num_user_features]</span></td>
 226 </tr>
 227 <tr>
 228 <td class="parameter_name"><p>shaper_list</p></td>
 229 <td class="parameter_description"><p>. </p></td>
 230 <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> zero-terminated=1]</span></td>
 231 </tr>
 232 </tbody>
 233 </table></div>
 234 </div>
 235 <div class="refsect3">
 236 <a name="hb-shape-plan-create-cached.returns"></a><h4>Returns</h4>
 237 <p>. </p>
 238 <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
 239 </div>
 240 <p class="since">Since: <a class="link" href="api-index-0-9-7.html#api-index-0.9.7">0.9.7</a></p>
 241 </div>
 242 <hr>
 243 <div class="refsect2">
 244 <a name="hb-shape-plan-create2"></a><h3>hb_shape_plan_create2 ()</h3>
 245 <pre class="programlisting"><a class="link" href="harfbuzz-hb-shape-plan.html#hb-shape-plan-t"><span class="returnvalue">hb_shape_plan_t</span></a> *
 246 hb_shape_plan_create2 (<em class="parameter"><code><a class="link" href="harfbuzz-hb-face.html#hb-face-t"><span class="type">hb_face_t</span></a> *face</code></em>,
 247                        <em class="parameter"><code>const <a class="link" href="harfbuzz-hb-buffer.html#hb-segment-properties-t"><span class="type">hb_segment_properties_t</span></a> *props</code></em>,
 248                        <em class="parameter"><code>const <a class="link" href="harfbuzz-hb-shape.html#hb-feature-t"><span class="type">hb_feature_t</span></a> *user_features</code></em>,
 249                        <em class="parameter"><code>unsigned <span class="type">int</span> num_user_features</code></em>,
 250                        <em class="parameter"><code>const <span class="type">int</span> *coords</code></em>,
 251                        <em class="parameter"><code>unsigned <span class="type">int</span> num_coords</code></em>,
 252                        <em class="parameter"><code>const <span class="type">char</span> * const *shaper_list</code></em>);</pre>
 253 </div>
 254 <hr>
 255 <div class="refsect2">
 256 <a name="hb-shape-plan-create-cached2"></a><h3>hb_shape_plan_create_cached2 ()</h3>
 257 <pre class="programlisting"><a class="link" href="harfbuzz-hb-shape-plan.html#hb-shape-plan-t"><span class="returnvalue">hb_shape_plan_t</span></a> *
 258 hb_shape_plan_create_cached2 (<em class="parameter"><code><a class="link" href="harfbuzz-hb-face.html#hb-face-t"><span class="type">hb_face_t</span></a> *face</code></em>,
 259                               <em class="parameter"><code>const <a class="link" href="harfbuzz-hb-buffer.html#hb-segment-properties-t"><span class="type">hb_segment_properties_t</span></a> *props</code></em>,
 260                               <em class="parameter"><code>const <a class="link" href="harfbuzz-hb-shape.html#hb-feature-t"><span class="type">hb_feature_t</span></a> *user_features</code></em>,
 261                               <em class="parameter"><code>unsigned <span class="type">int</span> num_user_features</code></em>,
 262                               <em class="parameter"><code>const <span class="type">int</span> *coords</code></em>,
 263                               <em class="parameter"><code>unsigned <span class="type">int</span> num_coords</code></em>,
 264                               <em class="parameter"><code>const <span class="type">char</span> * const *shaper_list</code></em>);</pre>
 265 </div>
 266 <hr>
 267 <div class="refsect2">
 268 <a name="hb-shape-plan-destroy"></a><h3>hb_shape_plan_destroy ()</h3>
 269 <pre class="programlisting"><span class="returnvalue">void</span>
 270 hb_shape_plan_destroy (<em class="parameter"><code><a class="link" href="harfbuzz-hb-shape-plan.html#hb-shape-plan-t"><span class="type">hb_shape_plan_t</span></a> *shape_plan</code></em>);</pre>
 271 <p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p>
 272 <div class="refsect3">
 273 <a name="hb-shape-plan-destroy.parameters"></a><h4>Parameters</h4>
 274 <div class="informaltable"><table class="informaltable" width="100%" border="0">
 275 <colgroup>
 276 <col width="150px" class="parameters_name">
 277 <col class="parameters_description">
 278 <col width="200px" class="parameters_annotations">
 279 </colgroup>
 280 <tbody><tr>
 281 <td class="parameter_name"><p>shape_plan</p></td>
 282 <td class="parameter_description"><p>a shape plan.</p></td>
 283 <td class="parameter_annotations"> </td>
 284 </tr></tbody>
 285 </table></div>
 286 </div>
 287 <p class="since">Since: <a class="link" href="api-index-0-9-7.html#api-index-0.9.7">0.9.7</a></p>
 288 </div>
 289 <hr>
 290 <div class="refsect2">
 291 <a name="hb-shape-plan-execute"></a><h3>hb_shape_plan_execute ()</h3>
 292 <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>
 293 hb_shape_plan_execute (<em class="parameter"><code><a class="link" href="harfbuzz-hb-shape-plan.html#hb-shape-plan-t"><span class="type">hb_shape_plan_t</span></a> *shape_plan</code></em>,
 294                        <em class="parameter"><code><a class="link" href="harfbuzz-hb-font.html#hb-font-t"><span class="type">hb_font_t</span></a> *font</code></em>,
 295                        <em class="parameter"><code><a class="link" href="harfbuzz-hb-buffer.html#hb-buffer-t"><span class="type">hb_buffer_t</span></a> *buffer</code></em>,
 296                        <em class="parameter"><code>const <a class="link" href="harfbuzz-hb-shape.html#hb-feature-t"><span class="type">hb_feature_t</span></a> *features</code></em>,
 297                        <em class="parameter"><code>unsigned <span class="type">int</span> num_features</code></em>);</pre>
 298 <div class="refsect3">
 299 <a name="hb-shape-plan-execute.parameters"></a><h4>Parameters</h4>
 300 <div class="informaltable"><table class="informaltable" width="100%" border="0">
 301 <colgroup>
 302 <col width="150px" class="parameters_name">
 303 <col class="parameters_description">
 304 <col width="200px" class="parameters_annotations">
 305 </colgroup>
 306 <tbody>
 307 <tr>
 308 <td class="parameter_name"><p>shape_plan</p></td>
 309 <td class="parameter_description"><p>a shape plan.</p></td>
 310 <td class="parameter_annotations"> </td>
 311 </tr>
 312 <tr>
 313 <td class="parameter_name"><p>font</p></td>
 314 <td class="parameter_description"><p>a font.</p></td>
 315 <td class="parameter_annotations"> </td>
 316 </tr>
 317 <tr>
 318 <td class="parameter_name"><p>buffer</p></td>
 319 <td class="parameter_description"><p>a buffer.</p></td>
 320 <td class="parameter_annotations"> </td>
 321 </tr>
 322 <tr>
 323 <td class="parameter_name"><p>features</p></td>
 324 <td class="parameter_description"><p>. </p></td>
 325 <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=num_features]</span></td>
 326 </tr>
 327 </tbody>
 328 </table></div>
 329 </div>
 330 <p class="since">Since: <a class="link" href="api-index-0-9-7.html#api-index-0.9.7">0.9.7</a></p>
 331 </div>
 332 <hr>
 333 <div class="refsect2">
 334 <a name="hb-shape-plan-get-empty"></a><h3>hb_shape_plan_get_empty ()</h3>
 335 <pre class="programlisting"><a class="link" href="harfbuzz-hb-shape-plan.html#hb-shape-plan-t"><span class="returnvalue">hb_shape_plan_t</span></a> *
 336 hb_shape_plan_get_empty (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
 337 <div class="refsect3">
 338 <a name="hb-shape-plan-get-empty.returns"></a><h4>Returns</h4>
 339 <p>. </p>
 340 <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
 341 </div>
 342 <p class="since">Since: <a class="link" href="api-index-0-9-7.html#api-index-0.9.7">0.9.7</a></p>
 343 </div>
 344 <hr>
 345 <div class="refsect2">
 346 <a name="hb-shape-plan-get-shaper"></a><h3>hb_shape_plan_get_shaper ()</h3>
 347 <pre class="programlisting">const <span class="returnvalue">char</span> *
 348 hb_shape_plan_get_shaper (<em class="parameter"><code><a class="link" href="harfbuzz-hb-shape-plan.html#hb-shape-plan-t"><span class="type">hb_shape_plan_t</span></a> *shape_plan</code></em>);</pre>
 349 <div class="refsect3">
 350 <a name="hb-shape-plan-get-shaper.parameters"></a><h4>Parameters</h4>
 351 <div class="informaltable"><table class="informaltable" width="100%" border="0">
 352 <colgroup>
 353 <col width="150px" class="parameters_name">
 354 <col class="parameters_description">
 355 <col width="200px" class="parameters_annotations">
 356 </colgroup>
 357 <tbody><tr>
 358 <td class="parameter_name"><p>shape_plan</p></td>
 359 <td class="parameter_description"><p>a shape plan.</p></td>
 360 <td class="parameter_annotations"> </td>
 361 </tr></tbody>
 362 </table></div>
 363 </div>
 364 <div class="refsect3">
 365 <a name="hb-shape-plan-get-shaper.returns"></a><h4>Returns</h4>
 366 <p>. </p>
 367 <p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
 368 </div>
 369 <p class="since">Since: <a class="link" href="api-index-0-9-7.html#api-index-0.9.7">0.9.7</a></p>
 370 </div>
 371 <hr>
 372 <div class="refsect2">
 373 <a name="hb-shape-plan-get-user-data"></a><h3>hb_shape_plan_get_user_data ()</h3>
 374 <pre class="programlisting"><span class="returnvalue">void</span> *
 375 hb_shape_plan_get_user_data (<em class="parameter"><code><a class="link" href="harfbuzz-hb-shape-plan.html#hb-shape-plan-t"><span class="type">hb_shape_plan_t</span></a> *shape_plan</code></em>,
 376                              <em class="parameter"><code><a class="link" href="harfbuzz-hb-common.html#hb-user-data-key-t"><span class="type">hb_user_data_key_t</span></a> *key</code></em>);</pre>
 377 <p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p>
 378 <div class="refsect3">
 379 <a name="hb-shape-plan-get-user-data.parameters"></a><h4>Parameters</h4>
 380 <div class="informaltable"><table class="informaltable" width="100%" border="0">
 381 <colgroup>
 382 <col width="150px" class="parameters_name">
 383 <col class="parameters_description">
 384 <col width="200px" class="parameters_annotations">
 385 </colgroup>
 386 <tbody><tr>
 387 <td class="parameter_name"><p>shape_plan</p></td>
 388 <td class="parameter_description"><p>a shape plan.</p></td>
 389 <td class="parameter_annotations"> </td>
 390 </tr></tbody>
 391 </table></div>
 392 </div>
 393 <div class="refsect3">
 394 <a name="hb-shape-plan-get-user-data.returns"></a><h4>Returns</h4>
 395 <p>. </p>
 396 <p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
 397 </div>
 398 <p class="since">Since: <a class="link" href="api-index-0-9-7.html#api-index-0.9.7">0.9.7</a></p>
 399 </div>
 400 <hr>
 401 <div class="refsect2">
 402 <a name="hb-shape-plan-reference"></a><h3>hb_shape_plan_reference ()</h3>
 403 <pre class="programlisting"><a class="link" href="harfbuzz-hb-shape-plan.html#hb-shape-plan-t"><span class="returnvalue">hb_shape_plan_t</span></a> *
 404 hb_shape_plan_reference (<em class="parameter"><code><a class="link" href="harfbuzz-hb-shape-plan.html#hb-shape-plan-t"><span class="type">hb_shape_plan_t</span></a> *shape_plan</code></em>);</pre>
 405 <p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p>
 406 <div class="refsect3">
 407 <a name="hb-shape-plan-reference.parameters"></a><h4>Parameters</h4>
 408 <div class="informaltable"><table class="informaltable" width="100%" border="0">
 409 <colgroup>
 410 <col width="150px" class="parameters_name">
 411 <col class="parameters_description">
 412 <col width="200px" class="parameters_annotations">
 413 </colgroup>
 414 <tbody><tr>
 415 <td class="parameter_name"><p>shape_plan</p></td>
 416 <td class="parameter_description"><p>a shape plan.</p></td>
 417 <td class="parameter_annotations"> </td>
 418 </tr></tbody>
 419 </table></div>
 420 </div>
 421 <div class="refsect3">
 422 <a name="hb-shape-plan-reference.returns"></a><h4>Returns</h4>
 423 <p>. </p>
 424 <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
 425 </div>
 426 <p class="since">Since: <a class="link" href="api-index-0-9-7.html#api-index-0.9.7">0.9.7</a></p>
 427 </div>
 428 <hr>
 429 <div class="refsect2">
 430 <a name="hb-shape-plan-set-user-data"></a><h3>hb_shape_plan_set_user_data ()</h3>
 431 <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>
 432 hb_shape_plan_set_user_data (<em class="parameter"><code><a class="link" href="harfbuzz-hb-shape-plan.html#hb-shape-plan-t"><span class="type">hb_shape_plan_t</span></a> *shape_plan</code></em>,
 433                              <em class="parameter"><code><a class="link" href="harfbuzz-hb-common.html#hb-user-data-key-t"><span class="type">hb_user_data_key_t</span></a> *key</code></em>,
 434                              <em class="parameter"><code><span class="type">void</span> *data</code></em>,
 435                              <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>,
 436                              <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>
 437 <p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p>
 438 <div class="refsect3">
 439 <a name="hb-shape-plan-set-user-data.parameters"></a><h4>Parameters</h4>
 440 <div class="informaltable"><table class="informaltable" width="100%" border="0">
 441 <colgroup>
 442 <col width="150px" class="parameters_name">
 443 <col class="parameters_description">
 444 <col width="200px" class="parameters_annotations">
 445 </colgroup>
 446 <tbody><tr>
 447 <td class="parameter_name"><p>shape_plan</p></td>
 448 <td class="parameter_description"><p>a shape plan.</p></td>
 449 <td class="parameter_annotations"> </td>
 450 </tr></tbody>
 451 </table></div>
 452 </div>
 453 <p class="since">Since: <a class="link" href="api-index-0-9-7.html#api-index-0.9.7">0.9.7</a></p>
 454 </div>
 455 </div>
 456 <div class="refsect1">
 457 <a name="harfbuzz-hb-shape-plan.other_details"></a><h2>Types and Values</h2>
 458 <div class="refsect2">
 459 <a name="hb-shape-plan-t"></a><h3>hb_shape_plan_t</h3>
 460 <pre class="programlisting">typedef struct hb_shape_plan_t hb_shape_plan_t;
 461 </pre>
 462 </div>
 463 </div>
 464 </div>
 465 <div class="footer">
 466 <hr>Generated by GTK-Doc V1.25</div>
 467 </body>
 468 </html>