1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
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.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.24.1 (XML mode)">
12 <link rel="stylesheet" href="style.css" type="text/css">
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>
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>
26 <div class="refentry">
27 <a name="harfbuzz-hb-shape-plan"></a><div class="titlepage"></div>
28 <div class="refnamediv"><table width="100%"><tr>
30 <h2><span class="refentrytitle"><a name="harfbuzz-hb-shape-plan.top_of_page"></a>hb-shape-plan</span></h2>
33 <td class="gallery_image" valign="top" align="right"></td>
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">
39 <col width="150px" class="functions_return">
40 <col class="functions_name">
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> *
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>
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> *
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>
60 <td class="function_type">
61 <span class="returnvalue">void</span>
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>
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>
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>
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> *
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>
84 <td class="function_type">const <span class="returnvalue">char</span> *
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>
91 <td class="function_type">
92 <span class="returnvalue">void</span> *
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>
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> *
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>
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>
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>
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">
121 <col width="150px" class="name">
122 <col class="description">
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>
130 <div class="refsect1">
131 <a name="harfbuzz-hb-shape-plan.object-hierarchy"></a><h2>Object Hierarchy</h2>
132 <pre class="screen"> <a href="/home/behdad/.local/share/gtk-doc/html/gobject/gobject-Boxed-Types.html">GBoxed</a>
133 <span class="lineart">╰──</span> hb_shape_plan_t
136 <div class="refsect1">
137 <a name="harfbuzz-hb-shape-plan.description"></a><h2>Description</h2>
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 <p><span class="annotation">[Xconstructor]</span></p>
150 <div class="refsect3">
151 <a name="hb-shape-plan-create.parameters"></a><h4>Parameters</h4>
152 <div class="informaltable"><table width="100%" border="0">
154 <col width="150px" class="parameters_name">
155 <col class="parameters_description">
156 <col width="200px" class="parameters_annotations">
160 <td class="parameter_name"><p>user_features</p></td>
161 <td class="parameter_description"><p>. </p></td>
162 <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>
165 <td class="parameter_name"><p>shaper_list</p></td>
166 <td class="parameter_description"><p>. </p></td>
167 <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>
172 <div class="refsect3">
173 <a name="hb-shape-plan-create.returns"></a><h4>Returns</h4>
175 <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
177 <p class="since">Since: <a class="link" href="api-index-0-9-7.html#api-index-0.9.7">0.9.7</a></p>
180 <div class="refsect2">
181 <a name="hb-shape-plan-create-cached"></a><h3>hb_shape_plan_create_cached ()</h3>
182 <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> *
183 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>,
184 <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>,
185 <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>,
186 <em class="parameter"><code>unsigned <span class="type">int</span> num_user_features</code></em>,
187 <em class="parameter"><code>const <span class="type">char</span> * const *shaper_list</code></em>);</pre>
188 <div class="refsect3">
189 <a name="hb-shape-plan-create-cached.parameters"></a><h4>Parameters</h4>
190 <div class="informaltable"><table width="100%" border="0">
192 <col width="150px" class="parameters_name">
193 <col class="parameters_description">
194 <col width="200px" class="parameters_annotations">
198 <td class="parameter_name"><p>user_features</p></td>
199 <td class="parameter_description"><p>. </p></td>
200 <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>
203 <td class="parameter_name"><p>shaper_list</p></td>
204 <td class="parameter_description"><p>. </p></td>
205 <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>
210 <div class="refsect3">
211 <a name="hb-shape-plan-create-cached.returns"></a><h4>Returns</h4>
213 <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
215 <p class="since">Since: <a class="link" href="api-index-0-9-7.html#api-index-0.9.7">0.9.7</a></p>
218 <div class="refsect2">
219 <a name="hb-shape-plan-destroy"></a><h3>hb_shape_plan_destroy ()</h3>
220 <pre class="programlisting"><span class="returnvalue">void</span>
221 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>
222 <p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p>
223 <div class="refsect3">
224 <a name="hb-shape-plan-destroy.parameters"></a><h4>Parameters</h4>
225 <div class="informaltable"><table width="100%" border="0">
227 <col width="150px" class="parameters_name">
228 <col class="parameters_description">
229 <col width="200px" class="parameters_annotations">
232 <td class="parameter_name"><p>shape_plan</p></td>
233 <td class="parameter_description"><p>a shape plan.</p></td>
234 <td class="parameter_annotations"> </td>
238 <p class="since">Since: <a class="link" href="api-index-0-9-7.html#api-index-0.9.7">0.9.7</a></p>
241 <div class="refsect2">
242 <a name="hb-shape-plan-execute"></a><h3>hb_shape_plan_execute ()</h3>
243 <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>
244 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>,
245 <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>,
246 <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>,
247 <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>,
248 <em class="parameter"><code>unsigned <span class="type">int</span> num_features</code></em>);</pre>
249 <div class="refsect3">
250 <a name="hb-shape-plan-execute.parameters"></a><h4>Parameters</h4>
251 <div class="informaltable"><table width="100%" border="0">
253 <col width="150px" class="parameters_name">
254 <col class="parameters_description">
255 <col width="200px" class="parameters_annotations">
259 <td class="parameter_name"><p>shape_plan</p></td>
260 <td class="parameter_description"><p>a shape plan.</p></td>
261 <td class="parameter_annotations"> </td>
264 <td class="parameter_name"><p>font</p></td>
265 <td class="parameter_description"><p>a font.</p></td>
266 <td class="parameter_annotations"> </td>
269 <td class="parameter_name"><p>buffer</p></td>
270 <td class="parameter_description"><p>a buffer.</p></td>
271 <td class="parameter_annotations"> </td>
274 <td class="parameter_name"><p>features</p></td>
275 <td class="parameter_description"><p>. </p></td>
276 <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>
281 <p class="since">Since: <a class="link" href="api-index-0-9-7.html#api-index-0.9.7">0.9.7</a></p>
284 <div class="refsect2">
285 <a name="hb-shape-plan-get-empty"></a><h3>hb_shape_plan_get_empty ()</h3>
286 <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> *
287 hb_shape_plan_get_empty (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
288 <div class="refsect3">
289 <a name="hb-shape-plan-get-empty.returns"></a><h4>Returns</h4>
291 <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
293 <p class="since">Since: <a class="link" href="api-index-0-9-7.html#api-index-0.9.7">0.9.7</a></p>
296 <div class="refsect2">
297 <a name="hb-shape-plan-get-shaper"></a><h3>hb_shape_plan_get_shaper ()</h3>
298 <pre class="programlisting">const <span class="returnvalue">char</span> *
299 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>
300 <div class="refsect3">
301 <a name="hb-shape-plan-get-shaper.parameters"></a><h4>Parameters</h4>
302 <div class="informaltable"><table width="100%" border="0">
304 <col width="150px" class="parameters_name">
305 <col class="parameters_description">
306 <col width="200px" class="parameters_annotations">
309 <td class="parameter_name"><p>shape_plan</p></td>
310 <td class="parameter_description"><p>a shape plan.</p></td>
311 <td class="parameter_annotations"> </td>
315 <div class="refsect3">
316 <a name="hb-shape-plan-get-shaper.returns"></a><h4>Returns</h4>
318 <p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
320 <p class="since">Since: <a class="link" href="api-index-0-9-7.html#api-index-0.9.7">0.9.7</a></p>
323 <div class="refsect2">
324 <a name="hb-shape-plan-get-user-data"></a><h3>hb_shape_plan_get_user_data ()</h3>
325 <pre class="programlisting"><span class="returnvalue">void</span> *
326 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>,
327 <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>
328 <p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p>
329 <div class="refsect3">
330 <a name="hb-shape-plan-get-user-data.parameters"></a><h4>Parameters</h4>
331 <div class="informaltable"><table width="100%" border="0">
333 <col width="150px" class="parameters_name">
334 <col class="parameters_description">
335 <col width="200px" class="parameters_annotations">
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>
344 <div class="refsect3">
345 <a name="hb-shape-plan-get-user-data.returns"></a><h4>Returns</h4>
347 <p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
349 <p class="since">Since: <a class="link" href="api-index-0-9-7.html#api-index-0.9.7">0.9.7</a></p>
352 <div class="refsect2">
353 <a name="hb-shape-plan-reference"></a><h3>hb_shape_plan_reference ()</h3>
354 <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> *
355 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>
356 <p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p>
357 <div class="refsect3">
358 <a name="hb-shape-plan-reference.parameters"></a><h4>Parameters</h4>
359 <div class="informaltable"><table width="100%" border="0">
361 <col width="150px" class="parameters_name">
362 <col class="parameters_description">
363 <col width="200px" class="parameters_annotations">
366 <td class="parameter_name"><p>shape_plan</p></td>
367 <td class="parameter_description"><p>a shape plan.</p></td>
368 <td class="parameter_annotations"> </td>
372 <div class="refsect3">
373 <a name="hb-shape-plan-reference.returns"></a><h4>Returns</h4>
375 <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
377 <p class="since">Since: <a class="link" href="api-index-0-9-7.html#api-index-0.9.7">0.9.7</a></p>
380 <div class="refsect2">
381 <a name="hb-shape-plan-set-user-data"></a><h3>hb_shape_plan_set_user_data ()</h3>
382 <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>
383 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>,
384 <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>,
385 <em class="parameter"><code><span class="type">void</span> *data</code></em>,
386 <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>,
387 <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>
388 <p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p>
389 <div class="refsect3">
390 <a name="hb-shape-plan-set-user-data.parameters"></a><h4>Parameters</h4>
391 <div class="informaltable"><table width="100%" border="0">
393 <col width="150px" class="parameters_name">
394 <col class="parameters_description">
395 <col width="200px" class="parameters_annotations">
398 <td class="parameter_name"><p>shape_plan</p></td>
399 <td class="parameter_description"><p>a shape plan.</p></td>
400 <td class="parameter_annotations"> </td>
404 <p class="since">Since: <a class="link" href="api-index-0-9-7.html#api-index-0.9.7">0.9.7</a></p>
407 <div class="refsect1">
408 <a name="harfbuzz-hb-shape-plan.other_details"></a><h2>Types and Values</h2>
409 <div class="refsect2">
410 <a name="hb-shape-plan-t"></a><h3>hb_shape_plan_t</h3>
411 <pre class="programlisting">typedef struct hb_shape_plan_t hb_shape_plan_t;
417 <hr>Generated by GTK-Doc V1.24.1</div>