1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
2 "http://www.w3.org/TR/html4/loose.dtd">
5 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
6 <title>FreeType-2.4.9 API Reference</title>
7 <style type="text/css">
8 body { font-family: Verdana, Geneva, Arial, Helvetica, serif;
10 background: #FFFFFF; }
12 p { text-align: justify; }
13 h1 { text-align: center; }
14 li { text-align: justify; }
15 td { padding: 0 0.5em 0 0.5em; }
16 td.left { padding: 0 0.5em 0 0.5em;
19 a:link { color: #0000EF; }
20 a:visited { color: #51188E; }
21 a:hover { color: #FF0000; }
23 span.keyword { font-family: monospace;
28 pre.colored { color: blue; }
30 ul.empty { list-style-type: none; }
35 <table align=center><tr><td><font size=-1>[<a href="ft2-index.html">Index</a>]</font></td>
36 <td width="100%"></td>
37 <td><font size=-1>[<a href="ft2-toc.html">TOC</a>]</font></td></tr></table>
38 <center><h1>FreeType-2.4.9 API Reference</h1></center>
44 <table align=center cellspacing=5 cellpadding=0 border=0>
45 <tr><td></td><td><a href="#FT_List">FT_List</a></td><td></td><td><a href="#FT_List_Add">FT_List_Add</a></td><td></td><td><a href="#FT_List_Iterate">FT_List_Iterate</a></td></tr>
46 <tr><td></td><td><a href="#FT_ListNode">FT_ListNode</a></td><td></td><td><a href="#FT_List_Insert">FT_List_Insert</a></td><td></td><td><a href="#FT_List_Destructor">FT_List_Destructor</a></td></tr>
47 <tr><td></td><td><a href="#FT_ListRec">FT_ListRec</a></td><td></td><td><a href="#FT_List_Remove">FT_List_Remove</a></td><td></td><td><a href="#FT_List_Finalize">FT_List_Finalize</a></td></tr>
48 <tr><td></td><td><a href="#FT_ListNodeRec">FT_ListNodeRec</a></td><td></td><td><a href="#FT_List_Up">FT_List_Up</a></td><td></td><td></td></tr>
49 <tr><td></td><td><a href="#FT_List_Find">FT_List_Find</a></td><td></td><td><a href="#FT_List_Iterator">FT_List_Iterator</a></td><td></td><td></td></tr>
52 <table align=center width="87%"><tr><td>
53 <p>This section contains various definitions related to list processing using doubly-linked nodes.</p>
54 </td></tr></table><br>
55 <table align=center width="75%"><tr><td>
56 <h4><a name="FT_List">FT_List</a></h4>
57 <table align=center width="87%"><tr><td>
58 Defined in FT_TYPES_H (freetype/fttypes.h).
59 </td></tr></table><br>
60 <table align=center width="87%"><tr bgcolor="#D6E8FF"><td><pre>
62 <span class="keyword">typedef</span> <span class="keyword">struct</span> FT_ListRec_* <b>FT_List</b>;
65 <table align=center width="87%"><tr><td>
66 <p>A handle to a list record (see <a href="ft2-list_processing.html#FT_ListRec">FT_ListRec</a>).</p>
67 </td></tr></table><br>
70 <table align=center width="75%"><tr><td><font size=-2>[<a href="ft2-index.html">Index</a>]</font></td>
71 <td width="100%"></td>
72 <td><font size=-2>[<a href="ft2-toc.html">TOC</a>]</font></td></tr></table>
74 <table align=center width="75%"><tr><td>
75 <h4><a name="FT_ListNode">FT_ListNode</a></h4>
76 <table align=center width="87%"><tr><td>
77 Defined in FT_TYPES_H (freetype/fttypes.h).
78 </td></tr></table><br>
79 <table align=center width="87%"><tr bgcolor="#D6E8FF"><td><pre>
81 <span class="keyword">typedef</span> <span class="keyword">struct</span> FT_ListNodeRec_* <b>FT_ListNode</b>;
84 <table align=center width="87%"><tr><td>
85 <p>Many elements and objects in FreeType are listed through an <a href="ft2-list_processing.html#FT_List">FT_List</a> record (see <a href="ft2-list_processing.html#FT_ListRec">FT_ListRec</a>). As its name suggests, an FT_ListNode is a handle to a single list element.</p>
86 </td></tr></table><br>
89 <table align=center width="75%"><tr><td><font size=-2>[<a href="ft2-index.html">Index</a>]</font></td>
90 <td width="100%"></td>
91 <td><font size=-2>[<a href="ft2-toc.html">TOC</a>]</font></td></tr></table>
93 <table align=center width="75%"><tr><td>
94 <h4><a name="FT_ListRec">FT_ListRec</a></h4>
95 <table align=center width="87%"><tr><td>
96 Defined in FT_TYPES_H (freetype/fttypes.h).
97 </td></tr></table><br>
98 <table align=center width="87%"><tr bgcolor="#D6E8FF"><td><pre>
100 <span class="keyword">typedef</span> <span class="keyword">struct</span> FT_ListRec_
102 <a href="ft2-list_processing.html#FT_ListNode">FT_ListNode</a> head;
103 <a href="ft2-list_processing.html#FT_ListNode">FT_ListNode</a> tail;
108 <table align=center width="87%"><tr><td>
109 <p>A structure used to hold a simple doubly-linked list. These are used in many parts of FreeType.</p>
110 </td></tr></table><br>
111 <table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>fields</b></em></td></tr><tr><td>
113 <table cellpadding=3 border=0>
114 <tr valign=top><td><b>head</b></td><td>
115 <p>The head (first element) of doubly-linked list.</p>
117 <tr valign=top><td><b>tail</b></td><td>
118 <p>The tail (last element) of doubly-linked list.</p>
124 <table align=center width="75%"><tr><td><font size=-2>[<a href="ft2-index.html">Index</a>]</font></td>
125 <td width="100%"></td>
126 <td><font size=-2>[<a href="ft2-toc.html">TOC</a>]</font></td></tr></table>
128 <table align=center width="75%"><tr><td>
129 <h4><a name="FT_ListNodeRec">FT_ListNodeRec</a></h4>
130 <table align=center width="87%"><tr><td>
131 Defined in FT_TYPES_H (freetype/fttypes.h).
132 </td></tr></table><br>
133 <table align=center width="87%"><tr bgcolor="#D6E8FF"><td><pre>
135 <span class="keyword">typedef</span> <span class="keyword">struct</span> FT_ListNodeRec_
137 <a href="ft2-list_processing.html#FT_ListNode">FT_ListNode</a> prev;
138 <a href="ft2-list_processing.html#FT_ListNode">FT_ListNode</a> next;
139 <span class="keyword">void</span>* data;
141 } <b>FT_ListNodeRec</b>;
144 <table align=center width="87%"><tr><td>
145 <p>A structure used to hold a single list element.</p>
146 </td></tr></table><br>
147 <table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>fields</b></em></td></tr><tr><td>
149 <table cellpadding=3 border=0>
150 <tr valign=top><td><b>prev</b></td><td>
151 <p>The previous element in the list. NULL if first.</p>
153 <tr valign=top><td><b>next</b></td><td>
154 <p>The next element in the list. NULL if last.</p>
156 <tr valign=top><td><b>data</b></td><td>
157 <p>A typeless pointer to the listed object.</p>
163 <table align=center width="75%"><tr><td><font size=-2>[<a href="ft2-index.html">Index</a>]</font></td>
164 <td width="100%"></td>
165 <td><font size=-2>[<a href="ft2-toc.html">TOC</a>]</font></td></tr></table>
167 <table align=center width="75%"><tr><td>
168 <h4><a name="FT_List_Find">FT_List_Find</a></h4>
169 <table align=center width="87%"><tr><td>
170 Defined in FT_LIST_H (freetype/ftlist.h).
171 </td></tr></table><br>
172 <table align=center width="87%"><tr bgcolor="#D6E8FF"><td><pre>
174 FT_EXPORT( <a href="ft2-list_processing.html#FT_ListNode">FT_ListNode</a> )
175 <b>FT_List_Find</b>( <a href="ft2-list_processing.html#FT_List">FT_List</a> list,
176 <span class="keyword">void</span>* data );
179 <table align=center width="87%"><tr><td>
180 <p>Find the list node for a given listed object.</p>
181 </td></tr></table><br>
182 <table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>input</b></em></td></tr><tr><td>
184 <table cellpadding=3 border=0>
185 <tr valign=top><td><b>list</b></td><td>
186 <p>A pointer to the parent list.</p>
188 <tr valign=top><td><b>data</b></td><td>
189 <p>The address of the listed object.</p>
193 <table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>return</b></em></td></tr><tr><td>
194 <p>List node. NULL if it wasn't found.</p>
198 <table align=center width="75%"><tr><td><font size=-2>[<a href="ft2-index.html">Index</a>]</font></td>
199 <td width="100%"></td>
200 <td><font size=-2>[<a href="ft2-toc.html">TOC</a>]</font></td></tr></table>
202 <table align=center width="75%"><tr><td>
203 <h4><a name="FT_List_Add">FT_List_Add</a></h4>
204 <table align=center width="87%"><tr><td>
205 Defined in FT_LIST_H (freetype/ftlist.h).
206 </td></tr></table><br>
207 <table align=center width="87%"><tr bgcolor="#D6E8FF"><td><pre>
209 FT_EXPORT( <span class="keyword">void</span> )
210 <b>FT_List_Add</b>( <a href="ft2-list_processing.html#FT_List">FT_List</a> list,
211 <a href="ft2-list_processing.html#FT_ListNode">FT_ListNode</a> node );
214 <table align=center width="87%"><tr><td>
215 <p>Append an element to the end of a list.</p>
216 </td></tr></table><br>
217 <table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>inout</b></em></td></tr><tr><td>
219 <table cellpadding=3 border=0>
220 <tr valign=top><td><b>list</b></td><td>
221 <p>A pointer to the parent list.</p>
223 <tr valign=top><td><b>node</b></td><td>
224 <p>The node to append.</p>
230 <table align=center width="75%"><tr><td><font size=-2>[<a href="ft2-index.html">Index</a>]</font></td>
231 <td width="100%"></td>
232 <td><font size=-2>[<a href="ft2-toc.html">TOC</a>]</font></td></tr></table>
234 <table align=center width="75%"><tr><td>
235 <h4><a name="FT_List_Insert">FT_List_Insert</a></h4>
236 <table align=center width="87%"><tr><td>
237 Defined in FT_LIST_H (freetype/ftlist.h).
238 </td></tr></table><br>
239 <table align=center width="87%"><tr bgcolor="#D6E8FF"><td><pre>
241 FT_EXPORT( <span class="keyword">void</span> )
242 <b>FT_List_Insert</b>( <a href="ft2-list_processing.html#FT_List">FT_List</a> list,
243 <a href="ft2-list_processing.html#FT_ListNode">FT_ListNode</a> node );
246 <table align=center width="87%"><tr><td>
247 <p>Insert an element at the head of a list.</p>
248 </td></tr></table><br>
249 <table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>inout</b></em></td></tr><tr><td>
251 <table cellpadding=3 border=0>
252 <tr valign=top><td><b>list</b></td><td>
253 <p>A pointer to parent list.</p>
255 <tr valign=top><td><b>node</b></td><td>
256 <p>The node to insert.</p>
262 <table align=center width="75%"><tr><td><font size=-2>[<a href="ft2-index.html">Index</a>]</font></td>
263 <td width="100%"></td>
264 <td><font size=-2>[<a href="ft2-toc.html">TOC</a>]</font></td></tr></table>
266 <table align=center width="75%"><tr><td>
267 <h4><a name="FT_List_Remove">FT_List_Remove</a></h4>
268 <table align=center width="87%"><tr><td>
269 Defined in FT_LIST_H (freetype/ftlist.h).
270 </td></tr></table><br>
271 <table align=center width="87%"><tr bgcolor="#D6E8FF"><td><pre>
273 FT_EXPORT( <span class="keyword">void</span> )
274 <b>FT_List_Remove</b>( <a href="ft2-list_processing.html#FT_List">FT_List</a> list,
275 <a href="ft2-list_processing.html#FT_ListNode">FT_ListNode</a> node );
278 <table align=center width="87%"><tr><td>
279 <p>Remove a node from a list. This function doesn't check whether the node is in the list!</p>
280 </td></tr></table><br>
281 <table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>input</b></em></td></tr><tr><td>
283 <table cellpadding=3 border=0>
284 <tr valign=top><td><b>node</b></td><td>
285 <p>The node to remove.</p>
289 <table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>inout</b></em></td></tr><tr><td>
291 <table cellpadding=3 border=0>
292 <tr valign=top><td><b>list</b></td><td>
293 <p>A pointer to the parent list.</p>
299 <table align=center width="75%"><tr><td><font size=-2>[<a href="ft2-index.html">Index</a>]</font></td>
300 <td width="100%"></td>
301 <td><font size=-2>[<a href="ft2-toc.html">TOC</a>]</font></td></tr></table>
303 <table align=center width="75%"><tr><td>
304 <h4><a name="FT_List_Up">FT_List_Up</a></h4>
305 <table align=center width="87%"><tr><td>
306 Defined in FT_LIST_H (freetype/ftlist.h).
307 </td></tr></table><br>
308 <table align=center width="87%"><tr bgcolor="#D6E8FF"><td><pre>
310 FT_EXPORT( <span class="keyword">void</span> )
311 <b>FT_List_Up</b>( <a href="ft2-list_processing.html#FT_List">FT_List</a> list,
312 <a href="ft2-list_processing.html#FT_ListNode">FT_ListNode</a> node );
315 <table align=center width="87%"><tr><td>
316 <p>Move a node to the head/top of a list. Used to maintain LRU lists.</p>
317 </td></tr></table><br>
318 <table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>inout</b></em></td></tr><tr><td>
320 <table cellpadding=3 border=0>
321 <tr valign=top><td><b>list</b></td><td>
322 <p>A pointer to the parent list.</p>
324 <tr valign=top><td><b>node</b></td><td>
325 <p>The node to move.</p>
331 <table align=center width="75%"><tr><td><font size=-2>[<a href="ft2-index.html">Index</a>]</font></td>
332 <td width="100%"></td>
333 <td><font size=-2>[<a href="ft2-toc.html">TOC</a>]</font></td></tr></table>
335 <table align=center width="75%"><tr><td>
336 <h4><a name="FT_List_Iterator">FT_List_Iterator</a></h4>
337 <table align=center width="87%"><tr><td>
338 Defined in FT_LIST_H (freetype/ftlist.h).
339 </td></tr></table><br>
340 <table align=center width="87%"><tr bgcolor="#D6E8FF"><td><pre>
342 <span class="keyword">typedef</span> <a href="ft2-basic_types.html#FT_Error">FT_Error</a>
343 (*<b>FT_List_Iterator</b>)( <a href="ft2-list_processing.html#FT_ListNode">FT_ListNode</a> node,
344 <span class="keyword">void</span>* user );
347 <table align=center width="87%"><tr><td>
348 <p>An FT_List iterator function which is called during a list parse by <a href="ft2-list_processing.html#FT_List_Iterate">FT_List_Iterate</a>.</p>
349 </td></tr></table><br>
350 <table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>input</b></em></td></tr><tr><td>
352 <table cellpadding=3 border=0>
353 <tr valign=top><td><b>node</b></td><td>
354 <p>The current iteration list node.</p>
356 <tr valign=top><td><b>user</b></td><td>
357 <p>A typeless pointer passed to <a href="ft2-list_processing.html#FT_List_Iterate">FT_List_Iterate</a>. Can be used to point to the iteration's state.</p>
363 <table align=center width="75%"><tr><td><font size=-2>[<a href="ft2-index.html">Index</a>]</font></td>
364 <td width="100%"></td>
365 <td><font size=-2>[<a href="ft2-toc.html">TOC</a>]</font></td></tr></table>
367 <table align=center width="75%"><tr><td>
368 <h4><a name="FT_List_Iterate">FT_List_Iterate</a></h4>
369 <table align=center width="87%"><tr><td>
370 Defined in FT_LIST_H (freetype/ftlist.h).
371 </td></tr></table><br>
372 <table align=center width="87%"><tr bgcolor="#D6E8FF"><td><pre>
374 FT_EXPORT( <a href="ft2-basic_types.html#FT_Error">FT_Error</a> )
375 <b>FT_List_Iterate</b>( <a href="ft2-list_processing.html#FT_List">FT_List</a> list,
376 <a href="ft2-list_processing.html#FT_List_Iterator">FT_List_Iterator</a> iterator,
377 <span class="keyword">void</span>* user );
380 <table align=center width="87%"><tr><td>
381 <p>Parse a list and calls a given iterator function on each element. Note that parsing is stopped as soon as one of the iterator calls returns a non-zero value.</p>
382 </td></tr></table><br>
383 <table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>input</b></em></td></tr><tr><td>
385 <table cellpadding=3 border=0>
386 <tr valign=top><td><b>list</b></td><td>
387 <p>A handle to the list.</p>
389 <tr valign=top><td><b>iterator</b></td><td>
390 <p>An iterator function, called on each node of the list.</p>
392 <tr valign=top><td><b>user</b></td><td>
393 <p>A user-supplied field which is passed as the second argument to the iterator.</p>
397 <table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>return</b></em></td></tr><tr><td>
398 <p>The result (a FreeType error code) of the last iterator call.</p>
402 <table align=center width="75%"><tr><td><font size=-2>[<a href="ft2-index.html">Index</a>]</font></td>
403 <td width="100%"></td>
404 <td><font size=-2>[<a href="ft2-toc.html">TOC</a>]</font></td></tr></table>
406 <table align=center width="75%"><tr><td>
407 <h4><a name="FT_List_Destructor">FT_List_Destructor</a></h4>
408 <table align=center width="87%"><tr><td>
409 Defined in FT_LIST_H (freetype/ftlist.h).
410 </td></tr></table><br>
411 <table align=center width="87%"><tr bgcolor="#D6E8FF"><td><pre>
413 <span class="keyword">typedef</span> <span class="keyword">void</span>
414 (*<b>FT_List_Destructor</b>)( <a href="ft2-system_interface.html#FT_Memory">FT_Memory</a> memory,
415 <span class="keyword">void</span>* data,
416 <span class="keyword">void</span>* user );
419 <table align=center width="87%"><tr><td>
420 <p>An <a href="ft2-list_processing.html#FT_List">FT_List</a> iterator function which is called during a list finalization by <a href="ft2-list_processing.html#FT_List_Finalize">FT_List_Finalize</a> to destroy all elements in a given list.</p>
421 </td></tr></table><br>
422 <table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>input</b></em></td></tr><tr><td>
424 <table cellpadding=3 border=0>
425 <tr valign=top><td><b>system</b></td><td>
426 <p>The current system object.</p>
428 <tr valign=top><td><b>data</b></td><td>
429 <p>The current object to destroy.</p>
431 <tr valign=top><td><b>user</b></td><td>
432 <p>A typeless pointer passed to <a href="ft2-list_processing.html#FT_List_Iterate">FT_List_Iterate</a>. It can be used to point to the iteration's state.</p>
438 <table align=center width="75%"><tr><td><font size=-2>[<a href="ft2-index.html">Index</a>]</font></td>
439 <td width="100%"></td>
440 <td><font size=-2>[<a href="ft2-toc.html">TOC</a>]</font></td></tr></table>
442 <table align=center width="75%"><tr><td>
443 <h4><a name="FT_List_Finalize">FT_List_Finalize</a></h4>
444 <table align=center width="87%"><tr><td>
445 Defined in FT_LIST_H (freetype/ftlist.h).
446 </td></tr></table><br>
447 <table align=center width="87%"><tr bgcolor="#D6E8FF"><td><pre>
449 FT_EXPORT( <span class="keyword">void</span> )
450 <b>FT_List_Finalize</b>( <a href="ft2-list_processing.html#FT_List">FT_List</a> list,
451 <a href="ft2-list_processing.html#FT_List_Destructor">FT_List_Destructor</a> destroy,
452 <a href="ft2-system_interface.html#FT_Memory">FT_Memory</a> memory,
453 <span class="keyword">void</span>* user );
456 <table align=center width="87%"><tr><td>
457 <p>Destroy all elements in the list as well as the list itself.</p>
458 </td></tr></table><br>
459 <table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>input</b></em></td></tr><tr><td>
461 <table cellpadding=3 border=0>
462 <tr valign=top><td><b>list</b></td><td>
463 <p>A handle to the list.</p>
465 <tr valign=top><td><b>destroy</b></td><td>
466 <p>A list destructor that will be applied to each element of the list.</p>
468 <tr valign=top><td><b>memory</b></td><td>
469 <p>The current memory object which handles deallocation.</p>
471 <tr valign=top><td><b>user</b></td><td>
472 <p>A user-supplied field which is passed as the last argument to the destructor.</p>
476 <table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>note</b></em></td></tr><tr><td>
477 <p>This function expects that all nodes added by <a href="ft2-list_processing.html#FT_List_Add">FT_List_Add</a> or <a href="ft2-list_processing.html#FT_List_Insert">FT_List_Insert</a> have been dynamically allocated.</p>
481 <table align=center width="75%"><tr><td><font size=-2>[<a href="ft2-index.html">Index</a>]</font></td>
482 <td width="100%"></td>
483 <td><font size=-2>[<a href="ft2-toc.html">TOC</a>]</font></td></tr></table>