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>HarfBuzz Manual: hb-shape-plan</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
   7 <link rel="home" href="index.html" title="HarfBuzz Manual">
   8 <link rel="up" href="ch07.html" title="Harfbuzz API">
   9 <link rel="prev" href="harfbuzz-hb-ot-shape.html" title="hb-ot-shape">
  10 <link rel="next" href="harfbuzz-hb-glib.html" title="hb-glib">
  11 <meta name="generator" content="GTK-Doc V1.20 (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="10"><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="ch07.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
  23 <td><a accesskey="p" href="harfbuzz-hb-ot-shape.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 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 <span class="returnvalue">void</span>
  62 </td>
  63 <td class="function_name">
  64 <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>
  65 </td>
  66 </tr>
  67 <tr>
  68 <td class="function_type">
  69 <a class="link" href="harfbuzz-hb-common.html#hb-bool-t" title="hb_bool_t"><span class="returnvalue">hb_bool_t</span></a>
  70 </td>
  71 <td class="function_name">
  72 <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>
  73 </td>
  74 </tr>
  75 <tr>
  76 <td class="function_type">
  77 <a class="link" href="harfbuzz-hb-shape-plan.html#hb-shape-plan-t"><span class="returnvalue">hb_shape_plan_t</span></a> *
  78 </td>
  79 <td class="function_name">
  80 <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>
  81 </td>
  82 </tr>
  83 <tr>
  84 <td class="function_type">const <span class="returnvalue">char</span> *
  85 </td>
  86 <td class="function_name">
  87 <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>
  88 </td>
  89 </tr>
  90 <tr>
  91 <td class="function_type">
  92 <span class="returnvalue">void</span> *
  93 </td>
  94 <td class="function_name">
  95 <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>
  96 </td>
  97 </tr>
  98 <tr>
  99 <td class="function_type">
 100 <a class="link" href="harfbuzz-hb-shape-plan.html#hb-shape-plan-t"><span class="returnvalue">hb_shape_plan_t</span></a> *
 101 </td>
 102 <td class="function_name">
 103 <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>
 104 </td>
 105 </tr>
 106 <tr>
 107 <td class="function_type">
 108 <a class="link" href="harfbuzz-hb-common.html#hb-bool-t" title="hb_bool_t"><span class="returnvalue">hb_bool_t</span></a>
 109 </td>
 110 <td class="function_name">
 111 <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>
 112 </td>
 113 </tr>
 114 </tbody>
 115 </table></div>
 116 </div>
 117 <a name="hb-shape-plan-t"></a><div class="refsect1">
 118 <a name="harfbuzz-hb-shape-plan.other"></a><h2>Types and Values</h2>
 119 <div class="informaltable"><table width="100%" border="0">
 120 <colgroup>
 121 <col width="150px" class="name">
 122 <col class="description">
 123 </colgroup>
 124 <tbody><tr>
 125 <td class="typedef_keyword">typedef</td>
 126 <td class="function_name"><a class="link" href="harfbuzz-hb-shape-plan.html#hb-shape-plan-t">hb_shape_plan_t</a></td>
 127 </tr></tbody>
 128 </table></div>
 129 </div>
 130 <div class="refsect1">
 131 <a name="harfbuzz-hb-shape-plan.object-hierarchy"></a><h2>Object Hierarchy</h2>
 132 <pre class="screen">    GBoxed
 133     <span class="lineart">╰──</span> hb_shape_plan_t
 134 </pre>
 135 </div>
 136 <div class="refsect1">
 137 <a name="harfbuzz-hb-shape-plan.description"></a><h2>Description</h2>
 138 </div>
 139 <div class="refsect1">
 140 <a name="harfbuzz-hb-shape-plan.functions_details"></a><h2>Functions</h2>
 141 <div class="refsect2">
 142 <a name="hb-shape-plan-create"></a><h3>hb_shape_plan_create ()</h3>
 143 <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> *
 144 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>,
 145                       <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>,
 146                       <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>,
 147                       <em class="parameter"><code>unsigned <span class="type">int</span> num_user_features</code></em>,
 148                       <em class="parameter"><code>const <span class="type">char</span> * const *shaper_list</code></em>);</pre>
 149 </div>
 150 <hr>
 151 <div class="refsect2">
 152 <a name="hb-shape-plan-create-cached"></a><h3>hb_shape_plan_create_cached ()</h3>
 153 <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> *
 154 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>,
 155                              <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>,
 156                              <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>,
 157                              <em class="parameter"><code>unsigned <span class="type">int</span> num_user_features</code></em>,
 158                              <em class="parameter"><code>const <span class="type">char</span> * const *shaper_list</code></em>);</pre>
 159 <div class="refsect3">
 160 <a name="id-1.3.3.18.8.3.4"></a><h4>Parameters</h4>
 161 <div class="informaltable"><table width="100%" border="0">
 162 <colgroup>
 163 <col width="150px" class="parameters_name">
 164 <col class="parameters_description">
 165 <col width="200px" class="parameters_annotations">
 166 </colgroup>
 167 <tbody>
 168 <tr>
 169 <td class="parameter_name"><p>user_features</p></td>
 170 <td class="parameter_description"><p>. </p></td>
 171 <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>
 172 </tr>
 173 <tr>
 174 <td class="parameter_name"><p>shaper_list</p></td>
 175 <td class="parameter_description"><p>. </p></td>
 176 <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>
 177 </tr>
 178 </tbody>
 179 </table></div>
 180 </div>
 181 <div class="refsect3">
 182 <a name="id-1.3.3.18.8.3.5"></a><h4>Returns</h4>
 183 <p>. </p>
 184 <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
 185 </div>
 186 <p class="since">Since 0.9.7</p>
 187 </div>
 188 <hr>
 189 <div class="refsect2">
 190 <a name="hb-shape-plan-destroy"></a><h3>hb_shape_plan_destroy ()</h3>
 191 <pre class="programlisting"><span class="returnvalue">void</span>
 192 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>
 193 <div class="refsect3">
 194 <a name="id-1.3.3.18.8.4.4"></a><h4>Parameters</h4>
 195 <div class="informaltable"><table width="100%" border="0">
 196 <colgroup>
 197 <col width="150px" class="parameters_name">
 198 <col class="parameters_description">
 199 <col width="200px" class="parameters_annotations">
 200 </colgroup>
 201 <tbody><tr>
 202 <td class="parameter_name"><p>shape_plan</p></td>
 203 <td class="parameter_description"><p>a shape plan.</p></td>
 204 <td class="parameter_annotations"> </td>
 205 </tr></tbody>
 206 </table></div>
 207 </div>
 208 <p class="since">Since 0.9.7</p>
 209 </div>
 210 <hr>
 211 <div class="refsect2">
 212 <a name="hb-shape-plan-execute"></a><h3>hb_shape_plan_execute ()</h3>
 213 <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>
 214 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>,
 215                        <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>,
 216                        <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>,
 217                        <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>,
 218                        <em class="parameter"><code>unsigned <span class="type">int</span> num_features</code></em>);</pre>
 219 <div class="refsect3">
 220 <a name="id-1.3.3.18.8.5.4"></a><h4>Parameters</h4>
 221 <div class="informaltable"><table width="100%" border="0">
 222 <colgroup>
 223 <col width="150px" class="parameters_name">
 224 <col class="parameters_description">
 225 <col width="200px" class="parameters_annotations">
 226 </colgroup>
 227 <tbody>
 228 <tr>
 229 <td class="parameter_name"><p>shape_plan</p></td>
 230 <td class="parameter_description"><p>a shape plan.</p></td>
 231 <td class="parameter_annotations"> </td>
 232 </tr>
 233 <tr>
 234 <td class="parameter_name"><p>font</p></td>
 235 <td class="parameter_description"><p>a font.</p></td>
 236 <td class="parameter_annotations"> </td>
 237 </tr>
 238 <tr>
 239 <td class="parameter_name"><p>buffer</p></td>
 240 <td class="parameter_description"><p>a buffer.</p></td>
 241 <td class="parameter_annotations"> </td>
 242 </tr>
 243 <tr>
 244 <td class="parameter_name"><p>features</p></td>
 245 <td class="parameter_description"><p>. </p></td>
 246 <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>
 247 </tr>
 248 </tbody>
 249 </table></div>
 250 </div>
 251 <div class="refsect3">
 252 <a name="id-1.3.3.18.8.5.5"></a><h4>Returns</h4>
 253 <p></p>
 254 </div>
 255 <p class="since">Since 0.9.7</p>
 256 </div>
 257 <hr>
 258 <div class="refsect2">
 259 <a name="hb-shape-plan-get-empty"></a><h3>hb_shape_plan_get_empty ()</h3>
 260 <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> *
 261 hb_shape_plan_get_empty (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
 262 <div class="refsect3">
 263 <a name="id-1.3.3.18.8.6.4"></a><h4>Returns</h4>
 264 <p>. </p>
 265 <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
 266 </div>
 267 <p class="since">Since 0.9.7</p>
 268 </div>
 269 <hr>
 270 <div class="refsect2">
 271 <a name="hb-shape-plan-get-shaper"></a><h3>hb_shape_plan_get_shaper ()</h3>
 272 <pre class="programlisting">const <span class="returnvalue">char</span> *
 273 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>
 274 <div class="refsect3">
 275 <a name="id-1.3.3.18.8.7.4"></a><h4>Parameters</h4>
 276 <div class="informaltable"><table width="100%" border="0">
 277 <colgroup>
 278 <col width="150px" class="parameters_name">
 279 <col class="parameters_description">
 280 <col width="200px" class="parameters_annotations">
 281 </colgroup>
 282 <tbody><tr>
 283 <td class="parameter_name"><p>shape_plan</p></td>
 284 <td class="parameter_description"><p>a shape plan.</p></td>
 285 <td class="parameter_annotations"> </td>
 286 </tr></tbody>
 287 </table></div>
 288 </div>
 289 <div class="refsect3">
 290 <a name="id-1.3.3.18.8.7.5"></a><h4>Returns</h4>
 291 <p>. </p>
 292 <p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
 293 </div>
 294 <p class="since">Since 0.9.7</p>
 295 </div>
 296 <hr>
 297 <div class="refsect2">
 298 <a name="hb-shape-plan-get-user-data"></a><h3>hb_shape_plan_get_user_data ()</h3>
 299 <pre class="programlisting"><span class="returnvalue">void</span> *
 300 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>,
 301                              <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>
 302 <div class="refsect3">
 303 <a name="id-1.3.3.18.8.8.4"></a><h4>Parameters</h4>
 304 <div class="informaltable"><table width="100%" border="0">
 305 <colgroup>
 306 <col width="150px" class="parameters_name">
 307 <col class="parameters_description">
 308 <col width="200px" class="parameters_annotations">
 309 </colgroup>
 310 <tbody><tr>
 311 <td class="parameter_name"><p>shape_plan</p></td>
 312 <td class="parameter_description"><p>a shape plan.</p></td>
 313 <td class="parameter_annotations"> </td>
 314 </tr></tbody>
 315 </table></div>
 316 </div>
 317 <div class="refsect3">
 318 <a name="id-1.3.3.18.8.8.5"></a><h4>Returns</h4>
 319 <p>. </p>
 320 <p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
 321 </div>
 322 <p class="since">Since 0.9.7</p>
 323 </div>
 324 <hr>
 325 <div class="refsect2">
 326 <a name="hb-shape-plan-reference"></a><h3>hb_shape_plan_reference ()</h3>
 327 <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> *
 328 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>
 329 <div class="refsect3">
 330 <a name="id-1.3.3.18.8.9.4"></a><h4>Parameters</h4>
 331 <div class="informaltable"><table width="100%" border="0">
 332 <colgroup>
 333 <col width="150px" class="parameters_name">
 334 <col class="parameters_description">
 335 <col width="200px" class="parameters_annotations">
 336 </colgroup>
 337 <tbody><tr>
 338 <td class="parameter_name"><p>shape_plan</p></td>
 339 <td class="parameter_description"><p>a shape plan.</p></td>
 340 <td class="parameter_annotations"> </td>
 341 </tr></tbody>
 342 </table></div>
 343 </div>
 344 <div class="refsect3">
 345 <a name="id-1.3.3.18.8.9.5"></a><h4>Returns</h4>
 346 <p>. </p>
 347 <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
 348 </div>
 349 <p class="since">Since 0.9.7</p>
 350 </div>
 351 <hr>
 352 <div class="refsect2">
 353 <a name="hb-shape-plan-set-user-data"></a><h3>hb_shape_plan_set_user_data ()</h3>
 354 <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>
 355 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>,
 356                              <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>,
 357                              <em class="parameter"><code><span class="type">void</span> *data</code></em>,
 358                              <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>,
 359                              <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>
 360 <div class="refsect3">
 361 <a name="id-1.3.3.18.8.10.4"></a><h4>Parameters</h4>
 362 <div class="informaltable"><table width="100%" border="0">
 363 <colgroup>
 364 <col width="150px" class="parameters_name">
 365 <col class="parameters_description">
 366 <col width="200px" class="parameters_annotations">
 367 </colgroup>
 368 <tbody><tr>
 369 <td class="parameter_name"><p>shape_plan</p></td>
 370 <td class="parameter_description"><p>a shape plan.</p></td>
 371 <td class="parameter_annotations"> </td>
 372 </tr></tbody>
 373 </table></div>
 374 </div>
 375 <div class="refsect3">
 376 <a name="id-1.3.3.18.8.10.5"></a><h4>Returns</h4>
 377 <p></p>
 378 </div>
 379 <p class="since">Since 0.9.7</p>
 380 </div>
 381 </div>
 382 <div class="refsect1">
 383 <a name="harfbuzz-hb-shape-plan.other_details"></a><h2>Types and Values</h2>
 384 <div class="refsect2">
 385 <a name="hb-shape-plan-t"></a><h3>hb_shape_plan_t</h3>
 386 <pre class="programlisting">typedef struct hb_shape_plan_t hb_shape_plan_t;
 387 </pre>
 388 </div>
 389 </div>
 390 </div>
 391 <div class="footer">
 392 <hr>
 393           Generated by GTK-Doc V1.20</div>
 394 </body>
 395 </html>