Root Zanli
Home
Console
Upload
information
Create File
Create Folder
About
Tools
:
/
usr
/
share
/
gtk-doc
/
html
/
harfbuzz
/
Filename :
harfbuzz-hb-shape-plan.html
back
Copy
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <title>hb-shape-plan: HarfBuzz Manual</title> <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> <link rel="home" href="index.html" title="HarfBuzz Manual"> <link rel="up" href="ch12.html" title="Core API"> <link rel="prev" href="harfbuzz-hb-set.html" title="hb-set"> <link rel="next" href="harfbuzz-hb-shape.html" title="hb-shape"> <meta name="generator" content="GTK-Doc V1.32 (XML mode)"> <link rel="stylesheet" href="style.css" type="text/css"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle"> <td width="100%" align="left" class="shortcuts"> <a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> <a href="#harfbuzz-hb-shape-plan.description" class="shortcut">Description</a></span> </td> <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> <td><a accesskey="u" href="ch12.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> <td><a accesskey="p" href="harfbuzz-hb-set.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> <td><a accesskey="n" href="harfbuzz-hb-shape.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> </tr></table> <div class="refentry"> <a name="harfbuzz-hb-shape-plan"></a><div class="titlepage"></div> <div class="refnamediv"><table width="100%"><tr> <td valign="top"> <h2><span class="refentrytitle"><a name="harfbuzz-hb-shape-plan.top_of_page"></a>hb-shape-plan</span></h2> <p>hb-shape-plan — Object representing a shaping plan</p> </td> <td class="gallery_image" valign="top" align="right"></td> </tr></table></div> <div class="refsect1"> <a name="harfbuzz-hb-shape-plan.functions"></a><h2>Functions</h2> <div class="informaltable"><table class="informaltable" width="100%" border="0"> <colgroup> <col width="150px" class="functions_proto_type"> <col class="functions_proto_name"> </colgroup> <tbody> <tr> <td class="function_type"> <a class="link" href="harfbuzz-hb-shape-plan.html#hb-shape-plan-t" title="hb_shape_plan_t"><span class="returnvalue">hb_shape_plan_t</span></a> * </td> <td class="function_name"> <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> </td> </tr> <tr> <td class="function_type"> <a class="link" href="harfbuzz-hb-shape-plan.html#hb-shape-plan-t" title="hb_shape_plan_t"><span class="returnvalue">hb_shape_plan_t</span></a> * </td> <td class="function_name"> <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> </td> </tr> <tr> <td class="function_type"> <a class="link" href="harfbuzz-hb-shape-plan.html#hb-shape-plan-t" title="hb_shape_plan_t"><span class="returnvalue">hb_shape_plan_t</span></a> * </td> <td class="function_name"> <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> </td> </tr> <tr> <td class="function_type"> <a class="link" href="harfbuzz-hb-shape-plan.html#hb-shape-plan-t" title="hb_shape_plan_t"><span class="returnvalue">hb_shape_plan_t</span></a> * </td> <td class="function_name"> <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> </td> </tr> <tr> <td class="function_type"> <span class="returnvalue">void</span> </td> <td class="function_name"> <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> </td> </tr> <tr> <td class="function_type"> <a class="link" href="harfbuzz-hb-common.html#hb-bool-t" title="hb_bool_t"><span class="returnvalue">hb_bool_t</span></a> </td> <td class="function_name"> <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> </td> </tr> <tr> <td class="function_type"> <a class="link" href="harfbuzz-hb-shape-plan.html#hb-shape-plan-t" title="hb_shape_plan_t"><span class="returnvalue">hb_shape_plan_t</span></a> * </td> <td class="function_name"> <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> </td> </tr> <tr> <td class="function_type">const <span class="returnvalue">char</span> * </td> <td class="function_name"> <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> </td> </tr> <tr> <td class="function_type"> <span class="returnvalue">void</span> * </td> <td class="function_name"> <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> </td> </tr> <tr> <td class="function_type"> <a class="link" href="harfbuzz-hb-shape-plan.html#hb-shape-plan-t" title="hb_shape_plan_t"><span class="returnvalue">hb_shape_plan_t</span></a> * </td> <td class="function_name"> <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> </td> </tr> <tr> <td class="function_type"> <a class="link" href="harfbuzz-hb-common.html#hb-bool-t" title="hb_bool_t"><span class="returnvalue">hb_bool_t</span></a> </td> <td class="function_name"> <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> </td> </tr> </tbody> </table></div> </div> <div class="refsect1"> <a name="harfbuzz-hb-shape-plan.other"></a><h2>Types and Values</h2> <div class="informaltable"><table class="informaltable" width="100%" border="0"> <colgroup> <col width="150px" class="other_proto_type"> <col class="other_proto_name"> </colgroup> <tbody><tr> <td class="typedef_keyword">typedef</td> <td class="function_name"><a class="link" href="harfbuzz-hb-shape-plan.html#hb-shape-plan-t" title="hb_shape_plan_t">hb_shape_plan_t</a></td> </tr></tbody> </table></div> </div> <div class="refsect1"> <a name="harfbuzz-hb-shape-plan.includes"></a><h2>Includes</h2> <pre class="synopsis">#include <hb.h> </pre> </div> <div class="refsect1"> <a name="harfbuzz-hb-shape-plan.description"></a><h2>Description</h2> <p>Shape plans are an internal mechanism. Each plan contains state describing how HarfBuzz will shape a particular text segment, based on the combination of segment properties and the capabilities in the font face in use.</p> <p>Shape plans are not used for shaping directly, but can be queried to access certain information about how shaping will perform, given a set of specific input parameters (script, language, direction, features, etc.).</p> <p>Most client programs will not need to deal with shape plans directly.</p> </div> <div class="refsect1"> <a name="harfbuzz-hb-shape-plan.functions_details"></a><h2>Functions</h2> <div class="refsect2"> <a name="hb-shape-plan-create"></a><h3>hb_shape_plan_create ()</h3> <pre class="programlisting"><a class="link" href="harfbuzz-hb-shape-plan.html#hb-shape-plan-t" title="hb_shape_plan_t"><span class="returnvalue">hb_shape_plan_t</span></a> * hb_shape_plan_create (<em class="parameter"><code><a class="link" href="harfbuzz-hb-face.html#hb-face-t" title="hb_face_t"><span class="type">hb_face_t</span></a> *face</code></em>, <em class="parameter"><code>const <a class="link" href="harfbuzz-hb-buffer.html#hb-segment-properties-t" title="hb_segment_properties_t"><span class="type">hb_segment_properties_t</span></a> *props</code></em>, <em class="parameter"><code>const <a class="link" href="harfbuzz-hb-common.html#hb-feature-t" title="hb_feature_t"><span class="type">hb_feature_t</span></a> *user_features</code></em>, <em class="parameter"><code>unsigned <span class="type">int</span> num_user_features</code></em>, <em class="parameter"><code>const <span class="type">char</span> * const *shaper_list</code></em>);</pre> <p>Constructs a shaping plan for a combination of <em class="parameter"><code>face</code></em> , <em class="parameter"><code>user_features</code></em> , <em class="parameter"><code>props</code></em> , and <em class="parameter"><code>shaper_list</code></em> .</p> <p><span class="annotation">[Xconstructor]</span></p> <div class="refsect3"> <a name="hb-shape-plan-create.parameters"></a><h4>Parameters</h4> <div class="informaltable"><table class="informaltable" width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> <col class="parameters_description"> <col width="200px" class="parameters_annotations"> </colgroup> <tbody> <tr> <td class="parameter_name"><p>face</p></td> <td class="parameter_description"><p><a class="link" href="harfbuzz-hb-face.html#hb-face-t" title="hb_face_t"><span class="type">hb_face_t</span></a> to use</p></td> <td class="parameter_annotations"> </td> </tr> <tr> <td class="parameter_name"><p>props</p></td> <td class="parameter_description"><p>The <a class="link" href="harfbuzz-hb-buffer.html#hb-segment-properties-t" title="hb_segment_properties_t"><span class="type">hb_segment_properties_t</span></a> of the segment</p></td> <td class="parameter_annotations"> </td> </tr> <tr> <td class="parameter_name"><p>user_features</p></td> <td class="parameter_description"><p>The list of user-selected features. </p></td> <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> </tr> <tr> <td class="parameter_name"><p>num_user_features</p></td> <td class="parameter_description"><p>The number of user-selected features</p></td> <td class="parameter_annotations"> </td> </tr> <tr> <td class="parameter_name"><p>shaper_list</p></td> <td class="parameter_description"><p>List of shapers to try. </p></td> <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> </tr> </tbody> </table></div> </div> <div class="refsect3"> <a name="hb-shape-plan-create.returns"></a><h4>Returns</h4> <p>The shaping plan. </p> <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> </div> <p class="since">Since: <a class="link" href="api-index-0-9-7.html#api-index-0.9.7">0.9.7</a></p> </div> <hr> <div class="refsect2"> <a name="hb-shape-plan-create-cached"></a><h3>hb_shape_plan_create_cached ()</h3> <pre class="programlisting"><a class="link" href="harfbuzz-hb-shape-plan.html#hb-shape-plan-t" title="hb_shape_plan_t"><span class="returnvalue">hb_shape_plan_t</span></a> * hb_shape_plan_create_cached (<em class="parameter"><code><a class="link" href="harfbuzz-hb-face.html#hb-face-t" title="hb_face_t"><span class="type">hb_face_t</span></a> *face</code></em>, <em class="parameter"><code>const <a class="link" href="harfbuzz-hb-buffer.html#hb-segment-properties-t" title="hb_segment_properties_t"><span class="type">hb_segment_properties_t</span></a> *props</code></em>, <em class="parameter"><code>const <a class="link" href="harfbuzz-hb-common.html#hb-feature-t" title="hb_feature_t"><span class="type">hb_feature_t</span></a> *user_features</code></em>, <em class="parameter"><code>unsigned <span class="type">int</span> num_user_features</code></em>, <em class="parameter"><code>const <span class="type">char</span> * const *shaper_list</code></em>);</pre> <p>Creates a cached shaping plan suitable for reuse, for a combination of <em class="parameter"><code>face</code></em> , <em class="parameter"><code>user_features</code></em> , <em class="parameter"><code>props</code></em> , and <em class="parameter"><code>shaper_list</code></em> .</p> <div class="refsect3"> <a name="hb-shape-plan-create-cached.parameters"></a><h4>Parameters</h4> <div class="informaltable"><table class="informaltable" width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> <col class="parameters_description"> <col width="200px" class="parameters_annotations"> </colgroup> <tbody> <tr> <td class="parameter_name"><p>face</p></td> <td class="parameter_description"><p><a class="link" href="harfbuzz-hb-face.html#hb-face-t" title="hb_face_t"><span class="type">hb_face_t</span></a> to use</p></td> <td class="parameter_annotations"> </td> </tr> <tr> <td class="parameter_name"><p>props</p></td> <td class="parameter_description"><p>The <a class="link" href="harfbuzz-hb-buffer.html#hb-segment-properties-t" title="hb_segment_properties_t"><span class="type">hb_segment_properties_t</span></a> of the segment</p></td> <td class="parameter_annotations"> </td> </tr> <tr> <td class="parameter_name"><p>user_features</p></td> <td class="parameter_description"><p>The list of user-selected features. </p></td> <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> </tr> <tr> <td class="parameter_name"><p>num_user_features</p></td> <td class="parameter_description"><p>The number of user-selected features</p></td> <td class="parameter_annotations"> </td> </tr> <tr> <td class="parameter_name"><p>shaper_list</p></td> <td class="parameter_description"><p>List of shapers to try. </p></td> <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> </tr> </tbody> </table></div> </div> <div class="refsect3"> <a name="hb-shape-plan-create-cached.returns"></a><h4>Returns</h4> <p>The shaping plan. </p> <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> </div> <p class="since">Since: <a class="link" href="api-index-0-9-7.html#api-index-0.9.7">0.9.7</a></p> </div> <hr> <div class="refsect2"> <a name="hb-shape-plan-create2"></a><h3>hb_shape_plan_create2 ()</h3> <pre class="programlisting"><a class="link" href="harfbuzz-hb-shape-plan.html#hb-shape-plan-t" title="hb_shape_plan_t"><span class="returnvalue">hb_shape_plan_t</span></a> * hb_shape_plan_create2 (<em class="parameter"><code><a class="link" href="harfbuzz-hb-face.html#hb-face-t" title="hb_face_t"><span class="type">hb_face_t</span></a> *face</code></em>, <em class="parameter"><code>const <a class="link" href="harfbuzz-hb-buffer.html#hb-segment-properties-t" title="hb_segment_properties_t"><span class="type">hb_segment_properties_t</span></a> *props</code></em>, <em class="parameter"><code>const <a class="link" href="harfbuzz-hb-common.html#hb-feature-t" title="hb_feature_t"><span class="type">hb_feature_t</span></a> *user_features</code></em>, <em class="parameter"><code>unsigned <span class="type">int</span> num_user_features</code></em>, <em class="parameter"><code>const <span class="type">int</span> *coords</code></em>, <em class="parameter"><code>unsigned <span class="type">int</span> num_coords</code></em>, <em class="parameter"><code>const <span class="type">char</span> * const *shaper_list</code></em>);</pre> <p>The variable-font version of <a class="link" href="harfbuzz-hb-shape-plan.html#hb-shape-plan-create" title="hb_shape_plan_create ()"><span class="type">hb_shape_plan_create</span></a>. Constructs a shaping plan for a combination of <em class="parameter"><code>face</code></em> , <em class="parameter"><code>user_features</code></em> , <em class="parameter"><code>props</code></em> , and <em class="parameter"><code>shaper_list</code></em> , plus the variation-space coordinates <em class="parameter"><code>coords</code></em> .</p> <p><span class="annotation">[Xconstructor]</span></p> <div class="refsect3"> <a name="hb-shape-plan-create2.parameters"></a><h4>Parameters</h4> <div class="informaltable"><table class="informaltable" width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> <col class="parameters_description"> <col width="200px" class="parameters_annotations"> </colgroup> <tbody> <tr> <td class="parameter_name"><p>face</p></td> <td class="parameter_description"><p><a class="link" href="harfbuzz-hb-face.html#hb-face-t" title="hb_face_t"><span class="type">hb_face_t</span></a> to use</p></td> <td class="parameter_annotations"> </td> </tr> <tr> <td class="parameter_name"><p>props</p></td> <td class="parameter_description"><p>The <a class="link" href="harfbuzz-hb-buffer.html#hb-segment-properties-t" title="hb_segment_properties_t"><span class="type">hb_segment_properties_t</span></a> of the segment</p></td> <td class="parameter_annotations"> </td> </tr> <tr> <td class="parameter_name"><p>user_features</p></td> <td class="parameter_description"><p>The list of user-selected features. </p></td> <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> </tr> <tr> <td class="parameter_name"><p>num_user_features</p></td> <td class="parameter_description"><p>The number of user-selected features</p></td> <td class="parameter_annotations"> </td> </tr> <tr> <td class="parameter_name"><p>coords</p></td> <td class="parameter_description"><p>The list of variation-space coordinates. </p></td> <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=num_coords]</span></td> </tr> <tr> <td class="parameter_name"><p>num_coords</p></td> <td class="parameter_description"><p>The number of variation-space coordinates</p></td> <td class="parameter_annotations"> </td> </tr> <tr> <td class="parameter_name"><p>shaper_list</p></td> <td class="parameter_description"><p>List of shapers to try. </p></td> <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> </tr> </tbody> </table></div> </div> <div class="refsect3"> <a name="hb-shape-plan-create2.returns"></a><h4>Returns</h4> <p>The shaping plan. </p> <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> </div> <p class="since">Since: <a class="link" href="api-index-1-4-0.html#api-index-1.4.0">1.4.0</a></p> </div> <hr> <div class="refsect2"> <a name="hb-shape-plan-create-cached2"></a><h3>hb_shape_plan_create_cached2 ()</h3> <pre class="programlisting"><a class="link" href="harfbuzz-hb-shape-plan.html#hb-shape-plan-t" title="hb_shape_plan_t"><span class="returnvalue">hb_shape_plan_t</span></a> * hb_shape_plan_create_cached2 (<em class="parameter"><code><a class="link" href="harfbuzz-hb-face.html#hb-face-t" title="hb_face_t"><span class="type">hb_face_t</span></a> *face</code></em>, <em class="parameter"><code>const <a class="link" href="harfbuzz-hb-buffer.html#hb-segment-properties-t" title="hb_segment_properties_t"><span class="type">hb_segment_properties_t</span></a> *props</code></em>, <em class="parameter"><code>const <a class="link" href="harfbuzz-hb-common.html#hb-feature-t" title="hb_feature_t"><span class="type">hb_feature_t</span></a> *user_features</code></em>, <em class="parameter"><code>unsigned <span class="type">int</span> num_user_features</code></em>, <em class="parameter"><code>const <span class="type">int</span> *coords</code></em>, <em class="parameter"><code>unsigned <span class="type">int</span> num_coords</code></em>, <em class="parameter"><code>const <span class="type">char</span> * const *shaper_list</code></em>);</pre> <p>The variable-font version of <a class="link" href="harfbuzz-hb-shape-plan.html#hb-shape-plan-create-cached" title="hb_shape_plan_create_cached ()"><span class="type">hb_shape_plan_create_cached</span></a>. Creates a cached shaping plan suitable for reuse, for a combination of <em class="parameter"><code>face</code></em> , <em class="parameter"><code>user_features</code></em> , <em class="parameter"><code>props</code></em> , and <em class="parameter"><code>shaper_list</code></em> , plus the variation-space coordinates <em class="parameter"><code>coords</code></em> .</p> <div class="refsect3"> <a name="hb-shape-plan-create-cached2.parameters"></a><h4>Parameters</h4> <div class="informaltable"><table class="informaltable" width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> <col class="parameters_description"> <col width="200px" class="parameters_annotations"> </colgroup> <tbody> <tr> <td class="parameter_name"><p>face</p></td> <td class="parameter_description"><p><a class="link" href="harfbuzz-hb-face.html#hb-face-t" title="hb_face_t"><span class="type">hb_face_t</span></a> to use</p></td> <td class="parameter_annotations"> </td> </tr> <tr> <td class="parameter_name"><p>props</p></td> <td class="parameter_description"><p>The <a class="link" href="harfbuzz-hb-buffer.html#hb-segment-properties-t" title="hb_segment_properties_t"><span class="type">hb_segment_properties_t</span></a> of the segment</p></td> <td class="parameter_annotations"> </td> </tr> <tr> <td class="parameter_name"><p>user_features</p></td> <td class="parameter_description"><p>The list of user-selected features. </p></td> <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> </tr> <tr> <td class="parameter_name"><p>num_user_features</p></td> <td class="parameter_description"><p>The number of user-selected features</p></td> <td class="parameter_annotations"> </td> </tr> <tr> <td class="parameter_name"><p>coords</p></td> <td class="parameter_description"><p>The list of variation-space coordinates. </p></td> <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=num_coords]</span></td> </tr> <tr> <td class="parameter_name"><p>num_coords</p></td> <td class="parameter_description"><p>The number of variation-space coordinates</p></td> <td class="parameter_annotations"> </td> </tr> <tr> <td class="parameter_name"><p>shaper_list</p></td> <td class="parameter_description"><p>List of shapers to try. </p></td> <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> </tr> </tbody> </table></div> </div> <div class="refsect3"> <a name="hb-shape-plan-create-cached2.returns"></a><h4>Returns</h4> <p>The shaping plan. </p> <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> </div> <p class="since">Since: <a class="link" href="api-index-1-4-0.html#api-index-1.4.0">1.4.0</a></p> </div> <hr> <div class="refsect2"> <a name="hb-shape-plan-destroy"></a><h3>hb_shape_plan_destroy ()</h3> <pre class="programlisting"><span class="returnvalue">void</span> hb_shape_plan_destroy (<em class="parameter"><code><a class="link" href="harfbuzz-hb-shape-plan.html#hb-shape-plan-t" title="hb_shape_plan_t"><span class="type">hb_shape_plan_t</span></a> *shape_plan</code></em>);</pre> <p>Decreases the reference count on the given shaping plan. When the reference count reaches zero, the shaping plan is destroyed, freeing all memory.</p> <p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p> <div class="refsect3"> <a name="hb-shape-plan-destroy.parameters"></a><h4>Parameters</h4> <div class="informaltable"><table class="informaltable" width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> <col class="parameters_description"> <col width="200px" class="parameters_annotations"> </colgroup> <tbody><tr> <td class="parameter_name"><p>shape_plan</p></td> <td class="parameter_description"><p>A shaping plan</p></td> <td class="parameter_annotations"> </td> </tr></tbody> </table></div> </div> <p class="since">Since: <a class="link" href="api-index-0-9-7.html#api-index-0.9.7">0.9.7</a></p> </div> <hr> <div class="refsect2"> <a name="hb-shape-plan-execute"></a><h3>hb_shape_plan_execute ()</h3> <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> hb_shape_plan_execute (<em class="parameter"><code><a class="link" href="harfbuzz-hb-shape-plan.html#hb-shape-plan-t" title="hb_shape_plan_t"><span class="type">hb_shape_plan_t</span></a> *shape_plan</code></em>, <em class="parameter"><code><a class="link" href="harfbuzz-hb-font.html#hb-font-t" title="hb_font_t"><span class="type">hb_font_t</span></a> *font</code></em>, <em class="parameter"><code><a class="link" href="harfbuzz-hb-buffer.html#hb-buffer-t" title="hb_buffer_t"><span class="type">hb_buffer_t</span></a> *buffer</code></em>, <em class="parameter"><code>const <a class="link" href="harfbuzz-hb-common.html#hb-feature-t" title="hb_feature_t"><span class="type">hb_feature_t</span></a> *features</code></em>, <em class="parameter"><code>unsigned <span class="type">int</span> num_features</code></em>);</pre> <p>Executes the given shaping plan on the specified buffer, using the given <em class="parameter"><code>font</code></em> and <em class="parameter"><code>features</code></em> .</p> <div class="refsect3"> <a name="hb-shape-plan-execute.parameters"></a><h4>Parameters</h4> <div class="informaltable"><table class="informaltable" width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> <col class="parameters_description"> <col width="200px" class="parameters_annotations"> </colgroup> <tbody> <tr> <td class="parameter_name"><p>shape_plan</p></td> <td class="parameter_description"><p>A shaping plan</p></td> <td class="parameter_annotations"> </td> </tr> <tr> <td class="parameter_name"><p>font</p></td> <td class="parameter_description"><p>The <a class="link" href="harfbuzz-hb-font.html#hb-font-t" title="hb_font_t"><span class="type">hb_font_t</span></a> to use</p></td> <td class="parameter_annotations"> </td> </tr> <tr> <td class="parameter_name"><p>buffer</p></td> <td class="parameter_description"><p>The <a class="link" href="harfbuzz-hb-buffer.html#hb-buffer-t" title="hb_buffer_t"><span class="type">hb_buffer_t</span></a> to work upon</p></td> <td class="parameter_annotations"> </td> </tr> <tr> <td class="parameter_name"><p>features</p></td> <td class="parameter_description"><p>Features to enable. </p></td> <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> </tr> <tr> <td class="parameter_name"><p>num_features</p></td> <td class="parameter_description"><p>The number of features to enable</p></td> <td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> <p class="since">Since: <a class="link" href="api-index-0-9-7.html#api-index-0.9.7">0.9.7</a></p> </div> <hr> <div class="refsect2"> <a name="hb-shape-plan-get-empty"></a><h3>hb_shape_plan_get_empty ()</h3> <pre class="programlisting"><a class="link" href="harfbuzz-hb-shape-plan.html#hb-shape-plan-t" title="hb_shape_plan_t"><span class="returnvalue">hb_shape_plan_t</span></a> * hb_shape_plan_get_empty (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> <p>Fetches the singleton empty shaping plan.</p> <div class="refsect3"> <a name="hb-shape-plan-get-empty.returns"></a><h4>Returns</h4> <p>The empty shaping plan. </p> <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> </div> <p class="since">Since: <a class="link" href="api-index-0-9-7.html#api-index-0.9.7">0.9.7</a></p> </div> <hr> <div class="refsect2"> <a name="hb-shape-plan-get-shaper"></a><h3>hb_shape_plan_get_shaper ()</h3> <pre class="programlisting">const <span class="returnvalue">char</span> * hb_shape_plan_get_shaper (<em class="parameter"><code><a class="link" href="harfbuzz-hb-shape-plan.html#hb-shape-plan-t" title="hb_shape_plan_t"><span class="type">hb_shape_plan_t</span></a> *shape_plan</code></em>);</pre> <p>Fetches the shaper from a given shaping plan.</p> <div class="refsect3"> <a name="hb-shape-plan-get-shaper.parameters"></a><h4>Parameters</h4> <div class="informaltable"><table class="informaltable" width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> <col class="parameters_description"> <col width="200px" class="parameters_annotations"> </colgroup> <tbody><tr> <td class="parameter_name"><p>shape_plan</p></td> <td class="parameter_description"><p>A shaping plan</p></td> <td class="parameter_annotations"> </td> </tr></tbody> </table></div> </div> <div class="refsect3"> <a name="hb-shape-plan-get-shaper.returns"></a><h4>Returns</h4> <p>The shaper. </p> <p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p> </div> <p class="since">Since: <a class="link" href="api-index-0-9-7.html#api-index-0.9.7">0.9.7</a></p> </div> <hr> <div class="refsect2"> <a name="hb-shape-plan-get-user-data"></a><h3>hb_shape_plan_get_user_data ()</h3> <pre class="programlisting"><span class="returnvalue">void</span> * hb_shape_plan_get_user_data (<em class="parameter"><code><a class="link" href="harfbuzz-hb-shape-plan.html#hb-shape-plan-t" title="hb_shape_plan_t"><span class="type">hb_shape_plan_t</span></a> *shape_plan</code></em>, <em class="parameter"><code><a class="link" href="harfbuzz-hb-common.html#hb-user-data-key-t" title="hb_user_data_key_t"><span class="type">hb_user_data_key_t</span></a> *key</code></em>);</pre> <p>Fetches the user data associated with the specified key, attached to the specified shaping plan.</p> <p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p> <div class="refsect3"> <a name="hb-shape-plan-get-user-data.parameters"></a><h4>Parameters</h4> <div class="informaltable"><table class="informaltable" width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> <col class="parameters_description"> <col width="200px" class="parameters_annotations"> </colgroup> <tbody> <tr> <td class="parameter_name"><p>shape_plan</p></td> <td class="parameter_description"><p>A shaping plan</p></td> <td class="parameter_annotations"> </td> </tr> <tr> <td class="parameter_name"><p>key</p></td> <td class="parameter_description"><p>The user-data key to query</p></td> <td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> <div class="refsect3"> <a name="hb-shape-plan-get-user-data.returns"></a><h4>Returns</h4> <p>A pointer to the user data. </p> <p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p> </div> <p class="since">Since: <a class="link" href="api-index-0-9-7.html#api-index-0.9.7">0.9.7</a></p> </div> <hr> <div class="refsect2"> <a name="hb-shape-plan-reference"></a><h3>hb_shape_plan_reference ()</h3> <pre class="programlisting"><a class="link" href="harfbuzz-hb-shape-plan.html#hb-shape-plan-t" title="hb_shape_plan_t"><span class="returnvalue">hb_shape_plan_t</span></a> * hb_shape_plan_reference (<em class="parameter"><code><a class="link" href="harfbuzz-hb-shape-plan.html#hb-shape-plan-t" title="hb_shape_plan_t"><span class="type">hb_shape_plan_t</span></a> *shape_plan</code></em>);</pre> <p>Increases the reference count on the given shaping plan.</p> <p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p> <div class="refsect3"> <a name="hb-shape-plan-reference.parameters"></a><h4>Parameters</h4> <div class="informaltable"><table class="informaltable" width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> <col class="parameters_description"> <col width="200px" class="parameters_annotations"> </colgroup> <tbody><tr> <td class="parameter_name"><p>shape_plan</p></td> <td class="parameter_description"><p>A shaping plan</p></td> <td class="parameter_annotations"> </td> </tr></tbody> </table></div> </div> <div class="refsect3"> <a name="hb-shape-plan-reference.returns"></a><h4>Returns</h4> <p><em class="parameter"><code>shape_plan</code></em> . </p> <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> </div> <p class="since">Since: <a class="link" href="api-index-0-9-7.html#api-index-0.9.7">0.9.7</a></p> </div> <hr> <div class="refsect2"> <a name="hb-shape-plan-set-user-data"></a><h3>hb_shape_plan_set_user_data ()</h3> <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> hb_shape_plan_set_user_data (<em class="parameter"><code><a class="link" href="harfbuzz-hb-shape-plan.html#hb-shape-plan-t" title="hb_shape_plan_t"><span class="type">hb_shape_plan_t</span></a> *shape_plan</code></em>, <em class="parameter"><code><a class="link" href="harfbuzz-hb-common.html#hb-user-data-key-t" title="hb_user_data_key_t"><span class="type">hb_user_data_key_t</span></a> *key</code></em>, <em class="parameter"><code><span class="type">void</span> *data</code></em>, <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>, <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> <p>Attaches a user-data key/data pair to the given shaping plan.</p> <p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p> <div class="refsect3"> <a name="hb-shape-plan-set-user-data.parameters"></a><h4>Parameters</h4> <div class="informaltable"><table class="informaltable" width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> <col class="parameters_description"> <col width="200px" class="parameters_annotations"> </colgroup> <tbody> <tr> <td class="parameter_name"><p>shape_plan</p></td> <td class="parameter_description"><p>A shaping plan</p></td> <td class="parameter_annotations"> </td> </tr> <tr> <td class="parameter_name"><p>key</p></td> <td class="parameter_description"><p>The user-data key to set</p></td> <td class="parameter_annotations"> </td> </tr> <tr> <td class="parameter_name"><p>data</p></td> <td class="parameter_description"><p>A pointer to the user data</p></td> <td class="parameter_annotations"> </td> </tr> <tr> <td class="parameter_name"><p>destroy</p></td> <td class="parameter_description"><p>A callback to call when <em class="parameter"><code>data</code></em> is not needed anymore. </p></td> <td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed instead of a pointer to a location."><span class="acronym">optional</span></acronym>]</span></td> </tr> <tr> <td class="parameter_name"><p>replace</p></td> <td class="parameter_description"><p>Whether to replace an existing data with the same key</p></td> <td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> <p class="since">Since: <a class="link" href="api-index-0-9-7.html#api-index-0.9.7">0.9.7</a></p> </div> </div> <div class="refsect1"> <a name="harfbuzz-hb-shape-plan.other_details"></a><h2>Types and Values</h2> <div class="refsect2"> <a name="hb-shape-plan-t"></a><h3>hb_shape_plan_t</h3> <pre class="programlisting">typedef struct hb_shape_plan_t hb_shape_plan_t; </pre> <p>Data type for holding a shaping plan. </p> <p>Shape plans contain information about how HarfBuzz will shape a particular text segment, based on the segment's properties and the capabilities in the font face in use.</p> <p>Shape plans can be queried about how shaping will perform, given a set of specific input parameters (script, language, direction, features, etc.).</p> </div> </div> </div> <div class="footer"> <hr>Generated by GTK-Doc V1.32</div> </body> </html>