Imported Upstream version 0.9.35
[platform/upstream/harfbuzz.git] / docs / reference / html / harfbuzz-hb-shape.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</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-font.html" title="hb-font">
10 <link rel="next" href="harfbuzz-hb-version.html" title="hb-version">
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.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
19                   <a href="#harfbuzz-hb-shape.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-font.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
24 <td><a accesskey="n" href="harfbuzz-hb-version.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"></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.top_of_page"></a>hb-shape</span></h2>
31 <p>hb-shape</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.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-common.html#hb-bool-t" title="hb_bool_t"><span class="returnvalue">hb_bool_t</span></a>
46 </td>
47 <td class="function_name">
48 <a class="link" href="harfbuzz-hb-shape.html#hb-feature-from-string" title="hb_feature_from_string ()">hb_feature_from_string</a> <span class="c_punctuation">()</span>
49 </td>
50 </tr>
51 <tr>
52 <td class="function_type">
53 <span class="returnvalue">void</span>
54 </td>
55 <td class="function_name">
56 <a class="link" href="harfbuzz-hb-shape.html#hb-feature-to-string" title="hb_feature_to_string ()">hb_feature_to_string</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.html#hb-shape" title="hb_shape ()">hb_shape</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.html#hb-shape-full" title="hb_shape_full ()">hb_shape_full</a> <span class="c_punctuation">()</span>
73 </td>
74 </tr>
75 <tr>
76 <td class="function_type">const <span class="returnvalue">char</span> **
77 </td>
78 <td class="function_name">
79 <a class="link" href="harfbuzz-hb-shape.html#hb-shape-list-shapers" title="hb_shape_list_shapers ()">hb_shape_list_shapers</a> <span class="c_punctuation">()</span>
80 </td>
81 </tr>
82 </tbody>
83 </table></div>
84 </div>
85 <a name="hb-feature-t"></a><div class="refsect1">
86 <a name="harfbuzz-hb-shape.other"></a><h2>Types and Values</h2>
87 <div class="informaltable"><table width="100%" border="0">
88 <colgroup>
89 <col width="150px" class="name">
90 <col class="description">
91 </colgroup>
92 <tbody><tr>
93 <td class="datatype_keyword"> </td>
94 <td class="function_name"><a class="link" href="harfbuzz-hb-shape.html#hb-feature-t-struct" title="hb_feature_t">hb_feature_t</a></td>
95 </tr></tbody>
96 </table></div>
97 </div>
98 <div class="refsect1">
99 <a name="harfbuzz-hb-shape.object-hierarchy"></a><h2>Object Hierarchy</h2>
100 <pre class="screen">    GBoxed
101     <span class="lineart">╰──</span> hb_feature_t
102 </pre>
103 </div>
104 <div class="refsect1">
105 <a name="harfbuzz-hb-shape.description"></a><h2>Description</h2>
106 <p>
107 </p>
108 </div>
109 <div class="refsect1">
110 <a name="harfbuzz-hb-shape.functions_details"></a><h2>Functions</h2>
111 <div class="refsect2">
112 <a name="hb-feature-from-string"></a><h3>hb_feature_from_string ()</h3>
113 <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>
114 hb_feature_from_string (<em class="parameter"><code>const <span class="type">char</span> *str</code></em>,
115                         <em class="parameter"><code><span class="type">int</span> len</code></em>,
116                         <em class="parameter"><code><a class="link" href="harfbuzz-hb-shape.html#hb-feature-t"><span class="type">hb_feature_t</span></a> *feature</code></em>);</pre>
117 <div class="refsect3">
118 <a name="idp17629440"></a><h4>Parameters</h4>
119 <div class="informaltable"><table width="100%" border="0">
120 <colgroup>
121 <col width="150px" class="parameters_name">
122 <col class="parameters_description">
123 <col width="200px" class="parameters_annotations">
124 </colgroup>
125 <tbody>
126 <tr>
127 <td class="parameter_name"><p>str</p></td>
128 <td class="parameter_description"><p>. </p></td>
129 <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=len]</span></td>
130 </tr>
131 <tr>
132 <td class="parameter_name"><p>feature</p></td>
133 <td class="parameter_description"><p>. </p></td>
134 <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
135 </tr>
136 </tbody>
137 </table></div>
138 </div>
139 <div class="refsect3">
140 <a name="idp15995600"></a><h4>Returns</h4>
141 <p></p>
142 </div>
143 <p class="since">Since 1.0</p>
144 </div>
145 <hr>
146 <div class="refsect2">
147 <a name="hb-feature-to-string"></a><h3>hb_feature_to_string ()</h3>
148 <pre class="programlisting"><span class="returnvalue">void</span>
149 hb_feature_to_string (<em class="parameter"><code><a class="link" href="harfbuzz-hb-shape.html#hb-feature-t"><span class="type">hb_feature_t</span></a> *feature</code></em>,
150                       <em class="parameter"><code><span class="type">char</span> *buf</code></em>,
151                       <em class="parameter"><code>unsigned <span class="type">int</span> size</code></em>);</pre>
152 <div class="refsect3">
153 <a name="idp17672592"></a><h4>Parameters</h4>
154 <div class="informaltable"><table width="100%" border="0">
155 <colgroup>
156 <col width="150px" class="parameters_name">
157 <col class="parameters_description">
158 <col width="200px" class="parameters_annotations">
159 </colgroup>
160 <tbody><tr>
161 <td class="parameter_name"><p>buf</p></td>
162 <td class="parameter_description"><p>. </p></td>
163 <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=size]</span></td>
164 </tr></tbody>
165 </table></div>
166 </div>
167 <p class="since">Since 1.0</p>
168 </div>
169 <hr>
170 <div class="refsect2">
171 <a name="hb-shape"></a><h3>hb_shape ()</h3>
172 <pre class="programlisting"><span class="returnvalue">void</span>
173 hb_shape (<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>,
174           <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>,
175           <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>,
176           <em class="parameter"><code>unsigned <span class="type">int</span> num_features</code></em>);</pre>
177 <div class="refsect3">
178 <a name="idp16399600"></a><h4>Parameters</h4>
179 <div class="informaltable"><table width="100%" border="0">
180 <colgroup>
181 <col width="150px" class="parameters_name">
182 <col class="parameters_description">
183 <col width="200px" class="parameters_annotations">
184 </colgroup>
185 <tbody>
186 <tr>
187 <td class="parameter_name"><p>font</p></td>
188 <td class="parameter_description"><p>a font.</p></td>
189 <td class="parameter_annotations"> </td>
190 </tr>
191 <tr>
192 <td class="parameter_name"><p>buffer</p></td>
193 <td class="parameter_description"><p>a buffer.</p></td>
194 <td class="parameter_annotations"> </td>
195 </tr>
196 <tr>
197 <td class="parameter_name"><p>features</p></td>
198 <td class="parameter_description"><p>. </p></td>
199 <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>
200 </tr>
201 </tbody>
202 </table></div>
203 </div>
204 <p class="since">Since 1.0</p>
205 </div>
206 <hr>
207 <div class="refsect2">
208 <a name="hb-shape-full"></a><h3>hb_shape_full ()</h3>
209 <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>
210 hb_shape_full (<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>,
211                <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>,
212                <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>,
213                <em class="parameter"><code>unsigned <span class="type">int</span> num_features</code></em>,
214                <em class="parameter"><code>const <span class="type">char</span> * const *shaper_list</code></em>);</pre>
215 <div class="refsect3">
216 <a name="idp14558768"></a><h4>Parameters</h4>
217 <div class="informaltable"><table width="100%" border="0">
218 <colgroup>
219 <col width="150px" class="parameters_name">
220 <col class="parameters_description">
221 <col width="200px" class="parameters_annotations">
222 </colgroup>
223 <tbody>
224 <tr>
225 <td class="parameter_name"><p>font</p></td>
226 <td class="parameter_description"><p>a font.</p></td>
227 <td class="parameter_annotations"> </td>
228 </tr>
229 <tr>
230 <td class="parameter_name"><p>buffer</p></td>
231 <td class="parameter_description"><p>a buffer.</p></td>
232 <td class="parameter_annotations"> </td>
233 </tr>
234 <tr>
235 <td class="parameter_name"><p>features</p></td>
236 <td class="parameter_description"><p>. </p></td>
237 <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>
238 </tr>
239 <tr>
240 <td class="parameter_name"><p>shaper_list</p></td>
241 <td class="parameter_description"><p>. </p></td>
242 <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>
243 </tr>
244 </tbody>
245 </table></div>
246 </div>
247 <div class="refsect3">
248 <a name="idp22383984"></a><h4>Returns</h4>
249 <p></p>
250 </div>
251 <p class="since">Since 1.0</p>
252 </div>
253 <hr>
254 <div class="refsect2">
255 <a name="hb-shape-list-shapers"></a><h3>hb_shape_list_shapers ()</h3>
256 <pre class="programlisting">const <span class="returnvalue">char</span> **
257 hb_shape_list_shapers (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
258 <div class="refsect3">
259 <a name="idp22392608"></a><h4>Returns</h4>
260 <p>. </p>
261 <p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
262 </div>
263 <p class="since">Since 1.0</p>
264 </div>
265 </div>
266 <div class="refsect1">
267 <a name="harfbuzz-hb-shape.other_details"></a><h2>Types and Values</h2>
268 <div class="refsect2">
269 <a name="hb-feature-t-struct"></a><h3>hb_feature_t</h3>
270 <pre class="programlisting">typedef struct {
271   hb_tag_t      tag;
272   uint32_t      value;
273   unsigned int  start;
274   unsigned int  end;
275 } hb_feature_t;
276 </pre>
277 <p>
278 </p>
279 </div>
280 </div>
281 </div>
282 <div class="footer">
283 <hr>
284           Generated by GTK-Doc V1.20.1</div>
285 </body>
286 </html>