docs/reference/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</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
   7 <link rel="home" href="index.html" title="HarfBuzz Reference Manual">
   8 <link rel="up" href="ch01.html" title="[Insert title here]">
   9 <link rel="prev" href="harfbuzz-hb-ot-tag.html" title="hb-ot-tag">
  10 <link rel="next" href="harfbuzz-hb-glib.html" title="hb-glib">
  11 <meta name="generator" content="GTK-Doc V1.20.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="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
  23 <td><a accesskey="p" href="harfbuzz-hb-ot-tag.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 <p>
 139 </p>
 140 </div>
 141 <div class="refsect1">
 142 <a name="harfbuzz-hb-shape-plan.functions_details"></a><h2>Functions</h2>
 143 <div class="refsect2">
 144 <a name="hb-shape-plan-create"></a><h3>hb_shape_plan_create ()</h3>
 145 <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> *
 146 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>,
 147                       <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>,
 148                       <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>,
 149                       <em class="parameter"><code>unsigned <span class="type">int</span> num_user_features</code></em>,
 150                       <em class="parameter"><code>const <span class="type">char</span> * const *shaper_list</code></em>);</pre>
 151 <p>
 152 </p>
 153 <div class="refsect3">
 154 <a name="idp14878704"></a><h4>Returns</h4>
 155 <p></p>
 156 </div>
 157 </div>
 158 <hr>
 159 <div class="refsect2">
 160 <a name="hb-shape-plan-create-cached"></a><h3>hb_shape_plan_create_cached ()</h3>
 161 <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> *
 162 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>,
 163                              <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>,
 164                              <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>,
 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 <div class="refsect3">
 168 <a name="idp16920256"></a><h4>Parameters</h4>
 169 <div class="informaltable"><table width="100%" border="0">
 170 <colgroup>
 171 <col width="150px" class="parameters_name">
 172 <col class="parameters_description">
 173 <col width="200px" class="parameters_annotations">
 174 </colgroup>
 175 <tbody>
 176 <tr>
 177 <td class="parameter_name"><p>user_features</p></td>
 178 <td class="parameter_description"><p>. </p></td>
 179 <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>
 180 </tr>
 181 <tr>
 182 <td class="parameter_name"><p>shaper_list</p></td>
 183 <td class="parameter_description"><p>. </p></td>
 184 <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>
 185 </tr>
 186 </tbody>
 187 </table></div>
 188 </div>
 189 <div class="refsect3">
 190 <a name="idp14478448"></a><h4>Returns</h4>
 191 <p>. </p>
 192 <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
 193 </div>
 194 <p class="since">Since 1.0</p>
 195 </div>
 196 <hr>
 197 <div class="refsect2">
 198 <a name="hb-shape-plan-destroy"></a><h3>hb_shape_plan_destroy ()</h3>
 199 <pre class="programlisting"><span class="returnvalue">void</span>
 200 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>
 201 <div class="refsect3">
 202 <a name="idp16259760"></a><h4>Parameters</h4>
 203 <div class="informaltable"><table width="100%" border="0">
 204 <colgroup>
 205 <col width="150px" class="parameters_name">
 206 <col class="parameters_description">
 207 <col width="200px" class="parameters_annotations">
 208 </colgroup>
 209 <tbody><tr>
 210 <td class="parameter_name"><p>shape_plan</p></td>
 211 <td class="parameter_description"><p>a shape plan.</p></td>
 212 <td class="parameter_annotations"> </td>
 213 </tr></tbody>
 214 </table></div>
 215 </div>
 216 <p class="since">Since 1.0</p>
 217 </div>
 218 <hr>
 219 <div class="refsect2">
 220 <a name="hb-shape-plan-execute"></a><h3>hb_shape_plan_execute ()</h3>
 221 <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>
 222 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>,
 223                        <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>,
 224                        <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>,
 225                        <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>,
 226                        <em class="parameter"><code>unsigned <span class="type">int</span> num_features</code></em>);</pre>
 227 <div class="refsect3">
 228 <a name="idp24238496"></a><h4>Parameters</h4>
 229 <div class="informaltable"><table width="100%" border="0">
 230 <colgroup>
 231 <col width="150px" class="parameters_name">
 232 <col class="parameters_description">
 233 <col width="200px" class="parameters_annotations">
 234 </colgroup>
 235 <tbody>
 236 <tr>
 237 <td class="parameter_name"><p>shape_plan</p></td>
 238 <td class="parameter_description"><p>a shape plan.</p></td>
 239 <td class="parameter_annotations"> </td>
 240 </tr>
 241 <tr>
 242 <td class="parameter_name"><p>font</p></td>
 243 <td class="parameter_description"><p>a font.</p></td>
 244 <td class="parameter_annotations"> </td>
 245 </tr>
 246 <tr>
 247 <td class="parameter_name"><p>buffer</p></td>
 248 <td class="parameter_description"><p>a buffer.</p></td>
 249 <td class="parameter_annotations"> </td>
 250 </tr>
 251 <tr>
 252 <td class="parameter_name"><p>features</p></td>
 253 <td class="parameter_description"><p>. </p></td>
 254 <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>
 255 </tr>
 256 </tbody>
 257 </table></div>
 258 </div>
 259 <div class="refsect3">
 260 <a name="idp23522512"></a><h4>Returns</h4>
 261 <p></p>
 262 </div>
 263 <p class="since">Since 1.0</p>
 264 </div>
 265 <hr>
 266 <div class="refsect2">
 267 <a name="hb-shape-plan-get-empty"></a><h3>hb_shape_plan_get_empty ()</h3>
 268 <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> *
 269 hb_shape_plan_get_empty (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
 270 <div class="refsect3">
 271 <a name="idp23531024"></a><h4>Returns</h4>
 272 <p>. </p>
 273 <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
 274 </div>
 275 <p class="since">Since 1.0</p>
 276 </div>
 277 <hr>
 278 <div class="refsect2">
 279 <a name="hb-shape-plan-get-shaper"></a><h3>hb_shape_plan_get_shaper ()</h3>
 280 <pre class="programlisting">const <span class="returnvalue">char</span> *
 281 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>
 282 <div class="refsect3">
 283 <a name="idp23541920"></a><h4>Parameters</h4>
 284 <div class="informaltable"><table width="100%" border="0">
 285 <colgroup>
 286 <col width="150px" class="parameters_name">
 287 <col class="parameters_description">
 288 <col width="200px" class="parameters_annotations">
 289 </colgroup>
 290 <tbody><tr>
 291 <td class="parameter_name"><p>shape_plan</p></td>
 292 <td class="parameter_description"><p>a shape plan.</p></td>
 293 <td class="parameter_annotations"> </td>
 294 </tr></tbody>
 295 </table></div>
 296 </div>
 297 <div class="refsect3">
 298 <a name="idp23550320"></a><h4>Returns</h4>
 299 <p>. </p>
 300 <p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
 301 </div>
 302 <p class="since">Since 1.0</p>
 303 </div>
 304 <hr>
 305 <div class="refsect2">
 306 <a name="hb-shape-plan-get-user-data"></a><h3>hb_shape_plan_get_user_data ()</h3>
 307 <pre class="programlisting"><span class="returnvalue">void</span> *
 308 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>,
 309                              <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>
 310 <div class="refsect3">
 311 <a name="idp23562672"></a><h4>Parameters</h4>
 312 <div class="informaltable"><table width="100%" border="0">
 313 <colgroup>
 314 <col width="150px" class="parameters_name">
 315 <col class="parameters_description">
 316 <col width="200px" class="parameters_annotations">
 317 </colgroup>
 318 <tbody><tr>
 319 <td class="parameter_name"><p>shape_plan</p></td>
 320 <td class="parameter_description"><p>a shape plan.</p></td>
 321 <td class="parameter_annotations"> </td>
 322 </tr></tbody>
 323 </table></div>
 324 </div>
 325 <div class="refsect3">
 326 <a name="idp23571072"></a><h4>Returns</h4>
 327 <p>. </p>
 328 <p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
 329 </div>
 330 <p class="since">Since 1.0</p>
 331 </div>
 332 <hr>
 333 <div class="refsect2">
 334 <a name="hb-shape-plan-reference"></a><h3>hb_shape_plan_reference ()</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_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>
 337 <div class="refsect3">
 338 <a name="idp23581792"></a><h4>Parameters</h4>
 339 <div class="informaltable"><table width="100%" border="0">
 340 <colgroup>
 341 <col width="150px" class="parameters_name">
 342 <col class="parameters_description">
 343 <col width="200px" class="parameters_annotations">
 344 </colgroup>
 345 <tbody><tr>
 346 <td class="parameter_name"><p>shape_plan</p></td>
 347 <td class="parameter_description"><p>a shape plan.</p></td>
 348 <td class="parameter_annotations"> </td>
 349 </tr></tbody>
 350 </table></div>
 351 </div>
 352 <div class="refsect3">
 353 <a name="idp23590192"></a><h4>Returns</h4>
 354 <p>. </p>
 355 <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
 356 </div>
 357 <p class="since">Since 1.0</p>
 358 </div>
 359 <hr>
 360 <div class="refsect2">
 361 <a name="hb-shape-plan-set-user-data"></a><h3>hb_shape_plan_set_user_data ()</h3>
 362 <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>
 363 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>,
 364                              <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>,
 365                              <em class="parameter"><code><span class="type">void</span> *data</code></em>,
 366                              <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>,
 367                              <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>
 368 <div class="refsect3">
 369 <a name="idp23607440"></a><h4>Parameters</h4>
 370 <div class="informaltable"><table width="100%" border="0">
 371 <colgroup>
 372 <col width="150px" class="parameters_name">
 373 <col class="parameters_description">
 374 <col width="200px" class="parameters_annotations">
 375 </colgroup>
 376 <tbody><tr>
 377 <td class="parameter_name"><p>shape_plan</p></td>
 378 <td class="parameter_description"><p>a shape plan.</p></td>
 379 <td class="parameter_annotations"> </td>
 380 </tr></tbody>
 381 </table></div>
 382 </div>
 383 <div class="refsect3">
 384 <a name="idp23615840"></a><h4>Returns</h4>
 385 <p></p>
 386 </div>
 387 <p class="since">Since 1.0</p>
 388 </div>
 389 </div>
 390 <div class="refsect1">
 391 <a name="harfbuzz-hb-shape-plan.other_details"></a><h2>Types and Values</h2>
 392 <div class="refsect2">
 393 <a name="hb-shape-plan-t"></a><h3>hb_shape_plan_t</h3>
 394 <pre class="programlisting">typedef struct hb_shape_plan_t hb_shape_plan_t;
 395 </pre>
 396 <p>
 397 </p>
 398 </div>
 399 </div>
 400 </div>
 401 <div class="footer">
 402 <hr>
 403           Generated by GTK-Doc V1.20.1</div>
 404 </body>
 405 </html>