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