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="ch08.html" title="HarfBuzz API">
   9 <link rel="prev" href="harfbuzz-hb-ot-math.html" title="hb-ot-math">
  10 <link rel="next" href="harfbuzz-hb-glib.html" title="hb-glib">
  11 <meta name="generator" content="GTK-Doc V1.27.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><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="ch08.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
  23 <td><a accesskey="p" href="harfbuzz-hb-ot-math.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
  24 <td><a accesskey="n" href="harfbuzz-hb-glib.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</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="/home/behdad/.local/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.description"></a><h2>Description</h2>
 154 </div>
 155 <div class="refsect1">
 156 <a name="harfbuzz-hb-shape-plan.functions_details"></a><h2>Functions</h2>
 157 <div class="refsect2">
 158 <a name="hb-shape-plan-create"></a><h3>hb_shape_plan_create ()</h3>
 159 <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> *
 160 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>,
 161                       <em class="parameter"><code>const <a class="link" href="harfbuzz-Buffers.html#hb-segment-properties-t"><span class="type">hb_segment_properties_t</span></a> *props</code></em>,
 162                       <em class="parameter"><code>const <a class="link" href="harfbuzz-Shaping.html#hb-feature-t"><span class="type">hb_feature_t</span></a> *user_features</code></em>,
 163                       <em class="parameter"><code>unsigned <span class="type">int</span> num_user_features</code></em>,
 164                       <em class="parameter"><code>const <span class="type">char</span> * const *shaper_list</code></em>);</pre>
 165 <p><span class="annotation">[Xconstructor]</span></p>
 166 <div class="refsect3">
 167 <a name="hb-shape-plan-create.parameters"></a><h4>Parameters</h4>
 168 <div class="informaltable"><table class="informaltable" width="100%" border="0">
 169 <colgroup>
 170 <col width="150px" class="parameters_name">
 171 <col class="parameters_description">
 172 <col width="200px" class="parameters_annotations">
 173 </colgroup>
 174 <tbody>
 175 <tr>
 176 <td class="parameter_name"><p>user_features</p></td>
 177 <td class="parameter_description"><p>. </p></td>
 178 <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>
 179 </tr>
 180 <tr>
 181 <td class="parameter_name"><p>shaper_list</p></td>
 182 <td class="parameter_description"><p>. </p></td>
 183 <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>
 184 </tr>
 185 </tbody>
 186 </table></div>
 187 </div>
 188 <div class="refsect3">
 189 <a name="hb-shape-plan-create.returns"></a><h4>Returns</h4>
 190 <p>. </p>
 191 <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
 192 </div>
 193 <p class="since">Since: <a class="link" href="api-index-0-9-7.html#api-index-0.9.7">0.9.7</a></p>
 194 </div>
 195 <hr>
 196 <div class="refsect2">
 197 <a name="hb-shape-plan-create-cached"></a><h3>hb_shape_plan_create_cached ()</h3>
 198 <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> *
 199 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>,
 200                              <em class="parameter"><code>const <a class="link" href="harfbuzz-Buffers.html#hb-segment-properties-t"><span class="type">hb_segment_properties_t</span></a> *props</code></em>,
 201                              <em class="parameter"><code>const <a class="link" href="harfbuzz-Shaping.html#hb-feature-t"><span class="type">hb_feature_t</span></a> *user_features</code></em>,
 202                              <em class="parameter"><code>unsigned <span class="type">int</span> num_user_features</code></em>,
 203                              <em class="parameter"><code>const <span class="type">char</span> * const *shaper_list</code></em>);</pre>
 204 <div class="refsect3">
 205 <a name="hb-shape-plan-create-cached.parameters"></a><h4>Parameters</h4>
 206 <div class="informaltable"><table class="informaltable" width="100%" border="0">
 207 <colgroup>
 208 <col width="150px" class="parameters_name">
 209 <col class="parameters_description">
 210 <col width="200px" class="parameters_annotations">
 211 </colgroup>
 212 <tbody>
 213 <tr>
 214 <td class="parameter_name"><p>user_features</p></td>
 215 <td class="parameter_description"><p>. </p></td>
 216 <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>
 217 </tr>
 218 <tr>
 219 <td class="parameter_name"><p>shaper_list</p></td>
 220 <td class="parameter_description"><p>. </p></td>
 221 <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>
 222 </tr>
 223 </tbody>
 224 </table></div>
 225 </div>
 226 <div class="refsect3">
 227 <a name="hb-shape-plan-create-cached.returns"></a><h4>Returns</h4>
 228 <p>. </p>
 229 <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
 230 </div>
 231 <p class="since">Since: <a class="link" href="api-index-0-9-7.html#api-index-0.9.7">0.9.7</a></p>
 232 </div>
 233 <hr>
 234 <div class="refsect2">
 235 <a name="hb-shape-plan-create2"></a><h3>hb_shape_plan_create2 ()</h3>
 236 <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> *
 237 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>,
 238                        <em class="parameter"><code>const <a class="link" href="harfbuzz-Buffers.html#hb-segment-properties-t"><span class="type">hb_segment_properties_t</span></a> *props</code></em>,
 239                        <em class="parameter"><code>const <a class="link" href="harfbuzz-Shaping.html#hb-feature-t"><span class="type">hb_feature_t</span></a> *user_features</code></em>,
 240                        <em class="parameter"><code>unsigned <span class="type">int</span> num_user_features</code></em>,
 241                        <em class="parameter"><code>const <span class="type">int</span> *coords</code></em>,
 242                        <em class="parameter"><code>unsigned <span class="type">int</span> num_coords</code></em>,
 243                        <em class="parameter"><code>const <span class="type">char</span> * const *shaper_list</code></em>);</pre>
 244 </div>
 245 <hr>
 246 <div class="refsect2">
 247 <a name="hb-shape-plan-create-cached2"></a><h3>hb_shape_plan_create_cached2 ()</h3>
 248 <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> *
 249 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>,
 250                               <em class="parameter"><code>const <a class="link" href="harfbuzz-Buffers.html#hb-segment-properties-t"><span class="type">hb_segment_properties_t</span></a> *props</code></em>,
 251                               <em class="parameter"><code>const <a class="link" href="harfbuzz-Shaping.html#hb-feature-t"><span class="type">hb_feature_t</span></a> *user_features</code></em>,
 252                               <em class="parameter"><code>unsigned <span class="type">int</span> num_user_features</code></em>,
 253                               <em class="parameter"><code>const <span class="type">int</span> *coords</code></em>,
 254                               <em class="parameter"><code>unsigned <span class="type">int</span> num_coords</code></em>,
 255                               <em class="parameter"><code>const <span class="type">char</span> * const *shaper_list</code></em>);</pre>
 256 </div>
 257 <hr>
 258 <div class="refsect2">
 259 <a name="hb-shape-plan-destroy"></a><h3>hb_shape_plan_destroy ()</h3>
 260 <pre class="programlisting"><span class="returnvalue">void</span>
 261 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>
 262 <p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p>
 263 <div class="refsect3">
 264 <a name="hb-shape-plan-destroy.parameters"></a><h4>Parameters</h4>
 265 <div class="informaltable"><table class="informaltable" width="100%" border="0">
 266 <colgroup>
 267 <col width="150px" class="parameters_name">
 268 <col class="parameters_description">
 269 <col width="200px" class="parameters_annotations">
 270 </colgroup>
 271 <tbody><tr>
 272 <td class="parameter_name"><p>shape_plan</p></td>
 273 <td class="parameter_description"><p>a shape plan.</p></td>
 274 <td class="parameter_annotations"> </td>
 275 </tr></tbody>
 276 </table></div>
 277 </div>
 278 <p class="since">Since: <a class="link" href="api-index-0-9-7.html#api-index-0.9.7">0.9.7</a></p>
 279 </div>
 280 <hr>
 281 <div class="refsect2">
 282 <a name="hb-shape-plan-execute"></a><h3>hb_shape_plan_execute ()</h3>
 283 <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>
 284 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>,
 285                        <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>,
 286                        <em class="parameter"><code><a class="link" href="harfbuzz-Buffers.html#hb-buffer-t"><span class="type">hb_buffer_t</span></a> *buffer</code></em>,
 287                        <em class="parameter"><code>const <a class="link" href="harfbuzz-Shaping.html#hb-feature-t"><span class="type">hb_feature_t</span></a> *features</code></em>,
 288                        <em class="parameter"><code>unsigned <span class="type">int</span> num_features</code></em>);</pre>
 289 <div class="refsect3">
 290 <a name="hb-shape-plan-execute.parameters"></a><h4>Parameters</h4>
 291 <div class="informaltable"><table class="informaltable" width="100%" border="0">
 292 <colgroup>
 293 <col width="150px" class="parameters_name">
 294 <col class="parameters_description">
 295 <col width="200px" class="parameters_annotations">
 296 </colgroup>
 297 <tbody>
 298 <tr>
 299 <td class="parameter_name"><p>shape_plan</p></td>
 300 <td class="parameter_description"><p>a shape plan.</p></td>
 301 <td class="parameter_annotations"> </td>
 302 </tr>
 303 <tr>
 304 <td class="parameter_name"><p>font</p></td>
 305 <td class="parameter_description"><p>a font.</p></td>
 306 <td class="parameter_annotations"> </td>
 307 </tr>
 308 <tr>
 309 <td class="parameter_name"><p>buffer</p></td>
 310 <td class="parameter_description"><p>a buffer.</p></td>
 311 <td class="parameter_annotations"> </td>
 312 </tr>
 313 <tr>
 314 <td class="parameter_name"><p>features</p></td>
 315 <td class="parameter_description"><p>. </p></td>
 316 <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>
 317 </tr>
 318 </tbody>
 319 </table></div>
 320 </div>
 321 <p class="since">Since: <a class="link" href="api-index-0-9-7.html#api-index-0.9.7">0.9.7</a></p>
 322 </div>
 323 <hr>
 324 <div class="refsect2">
 325 <a name="hb-shape-plan-get-empty"></a><h3>hb_shape_plan_get_empty ()</h3>
 326 <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> *
 327 hb_shape_plan_get_empty (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
 328 <div class="refsect3">
 329 <a name="hb-shape-plan-get-empty.returns"></a><h4>Returns</h4>
 330 <p>. </p>
 331 <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
 332 </div>
 333 <p class="since">Since: <a class="link" href="api-index-0-9-7.html#api-index-0.9.7">0.9.7</a></p>
 334 </div>
 335 <hr>
 336 <div class="refsect2">
 337 <a name="hb-shape-plan-get-shaper"></a><h3>hb_shape_plan_get_shaper ()</h3>
 338 <pre class="programlisting">const <span class="returnvalue">char</span> *
 339 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>
 340 <div class="refsect3">
 341 <a name="hb-shape-plan-get-shaper.parameters"></a><h4>Parameters</h4>
 342 <div class="informaltable"><table class="informaltable" width="100%" border="0">
 343 <colgroup>
 344 <col width="150px" class="parameters_name">
 345 <col class="parameters_description">
 346 <col width="200px" class="parameters_annotations">
 347 </colgroup>
 348 <tbody><tr>
 349 <td class="parameter_name"><p>shape_plan</p></td>
 350 <td class="parameter_description"><p>a shape plan.</p></td>
 351 <td class="parameter_annotations"> </td>
 352 </tr></tbody>
 353 </table></div>
 354 </div>
 355 <div class="refsect3">
 356 <a name="hb-shape-plan-get-shaper.returns"></a><h4>Returns</h4>
 357 <p>. </p>
 358 <p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
 359 </div>
 360 <p class="since">Since: <a class="link" href="api-index-0-9-7.html#api-index-0.9.7">0.9.7</a></p>
 361 </div>
 362 <hr>
 363 <div class="refsect2">
 364 <a name="hb-shape-plan-get-user-data"></a><h3>hb_shape_plan_get_user_data ()</h3>
 365 <pre class="programlisting"><span class="returnvalue">void</span> *
 366 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>,
 367                              <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>
 368 <p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p>
 369 <div class="refsect3">
 370 <a name="hb-shape-plan-get-user-data.parameters"></a><h4>Parameters</h4>
 371 <div class="informaltable"><table class="informaltable" width="100%" border="0">
 372 <colgroup>
 373 <col width="150px" class="parameters_name">
 374 <col class="parameters_description">
 375 <col width="200px" class="parameters_annotations">
 376 </colgroup>
 377 <tbody><tr>
 378 <td class="parameter_name"><p>shape_plan</p></td>
 379 <td class="parameter_description"><p>a shape plan.</p></td>
 380 <td class="parameter_annotations"> </td>
 381 </tr></tbody>
 382 </table></div>
 383 </div>
 384 <div class="refsect3">
 385 <a name="hb-shape-plan-get-user-data.returns"></a><h4>Returns</h4>
 386 <p>. </p>
 387 <p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
 388 </div>
 389 <p class="since">Since: <a class="link" href="api-index-0-9-7.html#api-index-0.9.7">0.9.7</a></p>
 390 </div>
 391 <hr>
 392 <div class="refsect2">
 393 <a name="hb-shape-plan-reference"></a><h3>hb_shape_plan_reference ()</h3>
 394 <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> *
 395 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>
 396 <p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p>
 397 <div class="refsect3">
 398 <a name="hb-shape-plan-reference.parameters"></a><h4>Parameters</h4>
 399 <div class="informaltable"><table class="informaltable" width="100%" border="0">
 400 <colgroup>
 401 <col width="150px" class="parameters_name">
 402 <col class="parameters_description">
 403 <col width="200px" class="parameters_annotations">
 404 </colgroup>
 405 <tbody><tr>
 406 <td class="parameter_name"><p>shape_plan</p></td>
 407 <td class="parameter_description"><p>a shape plan.</p></td>
 408 <td class="parameter_annotations"> </td>
 409 </tr></tbody>
 410 </table></div>
 411 </div>
 412 <div class="refsect3">
 413 <a name="hb-shape-plan-reference.returns"></a><h4>Returns</h4>
 414 <p>. </p>
 415 <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
 416 </div>
 417 <p class="since">Since: <a class="link" href="api-index-0-9-7.html#api-index-0.9.7">0.9.7</a></p>
 418 </div>
 419 <hr>
 420 <div class="refsect2">
 421 <a name="hb-shape-plan-set-user-data"></a><h3>hb_shape_plan_set_user_data ()</h3>
 422 <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>
 423 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>,
 424                              <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>,
 425                              <em class="parameter"><code><span class="type">void</span> *data</code></em>,
 426                              <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>,
 427                              <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>
 428 <p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p>
 429 <div class="refsect3">
 430 <a name="hb-shape-plan-set-user-data.parameters"></a><h4>Parameters</h4>
 431 <div class="informaltable"><table class="informaltable" width="100%" border="0">
 432 <colgroup>
 433 <col width="150px" class="parameters_name">
 434 <col class="parameters_description">
 435 <col width="200px" class="parameters_annotations">
 436 </colgroup>
 437 <tbody><tr>
 438 <td class="parameter_name"><p>shape_plan</p></td>
 439 <td class="parameter_description"><p>a shape plan.</p></td>
 440 <td class="parameter_annotations"> </td>
 441 </tr></tbody>
 442 </table></div>
 443 </div>
 444 <p class="since">Since: <a class="link" href="api-index-0-9-7.html#api-index-0.9.7">0.9.7</a></p>
 445 </div>
 446 </div>
 447 <div class="refsect1">
 448 <a name="harfbuzz-hb-shape-plan.other_details"></a><h2>Types and Values</h2>
 449 <div class="refsect2">
 450 <a name="hb-shape-plan-t"></a><h3>hb_shape_plan_t</h3>
 451 <pre class="programlisting">typedef struct hb_shape_plan_t hb_shape_plan_t;
 452 </pre>
 453 </div>
 454 </div>
 455 </div>
 456 <div class="footer">
 457 <hr>Generated by GTK-Doc V1.27.1</div>
 458 </body>
 459 </html>