b169b3169cda84e9f76afac44c90c00647d40e59
[platform/upstream/freetype2.git] / docs / reference / ft2-toc.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
2 "https://www.w3.org/TR/html4/loose.dtd">
3 <html>
4 <head>
5 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
6 <title>FreeType-2.9 API Reference</title>
7 <style type="text/css">
8   a:link { color: #0000EF; }
9   a:visited { color: #51188E; }
10   a:hover { color: #FF0000; }
11
12   body { font-family: Verdana, Geneva, Arial, Helvetica, serif;
13          color: #000000;
14          background: #FFFFFF;
15          width: 87%;
16          margin: auto; }
17
18   div.section { width: 75%;
19                 margin: auto; }
20   div.section hr { margin: 4ex 0 1ex 0; }
21   div.section h4 { background-color: #EEEEFF;
22                    font-size: medium;
23                    font-style: oblique;
24                    font-weight: bold;
25                    margin: 3ex 0 1.5ex 9%;
26                    padding: 0.3ex 0 0.3ex 1%; }
27   div.section p { margin: 1.5ex 0 1.5ex 10%; }
28   div.section pre { margin: 3ex 0 3ex 9%;
29                     background-color: #D6E8FF;
30                     padding: 2ex 0 2ex 1%; }
31   div.section table.fields { width: 90%;
32                              margin: 1.5ex 0 1.5ex 10%; }
33   div.section table.toc { width: 95%;
34                           margin: 1.5ex 0 1.5ex 5%; }
35   div.timestamp { text-align: center;
36                   font-size: 69%;
37                   margin: 1.5ex 0 1.5ex 0; }
38
39   h1 { text-align: center; }
40   h3 { font-size: medium;
41        margin: 4ex 0 1.5ex 0; }
42
43   p { text-align: justify; }
44
45   pre.colored { color: blue; }
46
47   span.keyword { font-family: monospace;
48                  text-align: left;
49                  white-space: pre;
50                  color: darkblue; }
51
52   table.fields td.val { font-weight: bold;
53                         text-align: right;
54                         width: 30%;
55                         vertical-align: baseline;
56                         padding: 1ex 1em 1ex 0; }
57   table.fields td.desc { vertical-align: baseline;
58                          padding: 1ex 0 1ex 1em; }
59   table.fields td.desc p:first-child { margin: 0; }
60   table.fields td.desc p { margin: 1.5ex 0 0 0; }
61   table.index { margin: 6ex auto 6ex auto;
62                 border: 0;
63                 border-collapse: separate;
64                 border-spacing: 1em 0.3ex; }
65   table.index tr { padding: 0; }
66   table.index td { padding: 0; }
67   table.index-toc-link { width: 100%;
68                          border: 0;
69                          border-spacing: 0;
70                          margin: 1ex 0 1ex 0; }
71   table.index-toc-link td.left { padding: 0 0.5em 0 0.5em;
72                                  font-size: 83%;
73                                  text-align: left; }
74   table.index-toc-link td.middle { padding: 0 0.5em 0 0.5em;
75                                    font-size: 83%;
76                                    text-align: center; }
77   table.index-toc-link td.right { padding: 0 0.5em 0 0.5em;
78                                   font-size: 83%;
79                                   text-align: right; }
80   table.synopsis { margin: 6ex auto 6ex auto;
81                    border: 0;
82                    border-collapse: separate;
83                    border-spacing: 2em 0.6ex; }
84   table.synopsis tr { padding: 0; }
85   table.synopsis td { padding: 0; }
86   table.toc td.link { width: 30%;
87                       text-align: right;
88                       vertical-align: baseline;
89                       padding: 1ex 1em 1ex 0; }
90   table.toc td.desc { vertical-align: baseline;
91                       padding: 1ex 0 1ex 1em;
92                       text-align: left; }
93   table.toc td.desc p:first-child { margin: 0;
94                                     text-align: left; }
95   table.toc td.desc p { margin: 1.5ex 0 0 0;
96                         text-align: left; }
97
98 </style>
99 </head>
100 <body>
101
102 <table class="index-toc-link"><tr><td class="left">[<a href="ft2-index.html">Index</a>]</td></tr></table>
103 <h1>FreeType-2.9 API Reference</h1>
104
105 <h1>Table of Contents</h1>
106 <div class="section">
107 <h2>General Remarks</h2>
108 <table class="toc">
109 <tr><td class="link"><a href="ft2-header_inclusion.html">FreeType's header inclusion scheme</a></td><td class="desc">
110 <p>How client applications should include FreeType header files.</p>
111 </td></tr>
112 <tr><td class="link"><a href="ft2-user_allocation.html">User allocation</a></td><td class="desc">
113 <p>How client applications should allocate FreeType data structures.</p>
114 </td></tr>
115 </table>
116 </div>
117 <div class="section">
118 <h2>Core API</h2>
119 <table class="toc">
120 <tr><td class="link"><a href="ft2-version.html">FreeType Version</a></td><td class="desc">
121 <p>Functions and macros related to FreeType versions.</p>
122 </td></tr>
123 <tr><td class="link"><a href="ft2-basic_types.html">Basic Data Types</a></td><td class="desc">
124 <p>The basic data types defined by the library.</p>
125 </td></tr>
126 <tr><td class="link"><a href="ft2-base_interface.html">Base Interface</a></td><td class="desc">
127 <p>The FreeType&nbsp;2 base font interface.</p>
128 </td></tr>
129 <tr><td class="link"><a href="ft2-glyph_variants.html">Unicode Variation Sequences</a></td><td class="desc">
130 <p>The FreeType&nbsp;2 interface to Unicode Variation Sequences (UVS), using the SFNT cmap format&nbsp;14.</p>
131 </td></tr>
132 <tr><td class="link"><a href="ft2-glyph_management.html">Glyph Management</a></td><td class="desc">
133 <p>Generic interface to manage individual glyph data.</p>
134 </td></tr>
135 <tr><td class="link"><a href="ft2-mac_specific.html">Mac Specific Interface</a></td><td class="desc">
136 <p>Only available on the Macintosh.</p>
137 </td></tr>
138 <tr><td class="link"><a href="ft2-sizes_management.html">Size Management</a></td><td class="desc">
139 <p>Managing multiple sizes per face.</p>
140 </td></tr>
141 <tr><td class="link"><a href="ft2-header_file_macros.html">Header File Macros</a></td><td class="desc">
142 <p>Macro definitions used to #include specific header files.</p>
143 </td></tr>
144 </table>
145 </div>
146 <div class="section">
147 <h2>Format-Specific API</h2>
148 <table class="toc">
149 <tr><td class="link"><a href="ft2-multiple_masters.html">Multiple Masters</a></td><td class="desc">
150 <p>How to manage Multiple Masters fonts.</p>
151 </td></tr>
152 <tr><td class="link"><a href="ft2-truetype_tables.html">TrueType Tables</a></td><td class="desc">
153 <p>TrueType specific table types and functions.</p>
154 </td></tr>
155 <tr><td class="link"><a href="ft2-type1_tables.html">Type 1 Tables</a></td><td class="desc">
156 <p>Type&nbsp;1 (PostScript) specific font tables.</p>
157 </td></tr>
158 <tr><td class="link"><a href="ft2-sfnt_names.html">SFNT Names</a></td><td class="desc">
159 <p>Access the names embedded in TrueType and OpenType files.</p>
160 </td></tr>
161 <tr><td class="link"><a href="ft2-bdf_fonts.html">BDF and PCF Files</a></td><td class="desc">
162 <p>BDF and PCF specific API.</p>
163 </td></tr>
164 <tr><td class="link"><a href="ft2-cid_fonts.html">CID Fonts</a></td><td class="desc">
165 <p>CID-keyed font specific API.</p>
166 </td></tr>
167 <tr><td class="link"><a href="ft2-pfr_fonts.html">PFR Fonts</a></td><td class="desc">
168 <p>PFR/TrueDoc specific API.</p>
169 </td></tr>
170 <tr><td class="link"><a href="ft2-winfnt_fonts.html">Window FNT Files</a></td><td class="desc">
171 <p>Windows FNT specific API.</p>
172 </td></tr>
173 <tr><td class="link"><a href="ft2-font_formats.html">Font Formats</a></td><td class="desc">
174 <p>Getting the font format.</p>
175 </td></tr>
176 <tr><td class="link"><a href="ft2-gasp_table.html">Gasp Table</a></td><td class="desc">
177 <p>Retrieving TrueType &lsquo;gasp&rsquo; table entries.</p>
178 </td></tr>
179 </table>
180 </div>
181 <div class="section">
182 <h2>Controlling FreeType Modules</h2>
183 <table class="toc">
184 <tr><td class="link"><a href="ft2-auto_hinter.html">The auto-hinter</a></td><td class="desc">
185 <p>Controlling the auto-hinting module.</p>
186 </td></tr>
187 <tr><td class="link"><a href="ft2-cff_driver.html">The CFF driver</a></td><td class="desc">
188 <p>Controlling the CFF driver module.</p>
189 </td></tr>
190 <tr><td class="link"><a href="ft2-t1_cid_driver.html">The Type 1 and CID drivers</a></td><td class="desc">
191 <p>Controlling the Type&nbsp;1 and CID driver modules.</p>
192 </td></tr>
193 <tr><td class="link"><a href="ft2-tt_driver.html">The TrueType driver</a></td><td class="desc">
194 <p>Controlling the TrueType driver module.</p>
195 </td></tr>
196 <tr><td class="link"><a href="ft2-pcf_driver.html">The PCF driver</a></td><td class="desc">
197 <p>Controlling the PCF driver module.</p>
198 </td></tr>
199 <tr><td class="link"><a href="ft2-properties.html">Driver properties</a></td><td class="desc">
200 <p>Controlling driver modules.</p>
201 </td></tr>
202 <tr><td class="link"><a href="ft2-parameter_tags.html">Parameter Tags</a></td><td class="desc">
203 <p>Macros for driver property and font loading parameter tags.</p>
204 </td></tr>
205 </table>
206 </div>
207 <div class="section">
208 <h2>Cache Sub-System</h2>
209 <table class="toc">
210 <tr><td class="link"><a href="ft2-cache_subsystem.html">Cache Sub-System</a></td><td class="desc">
211 <p>How to cache face, size, and glyph data with FreeType&nbsp;2.</p>
212 </td></tr>
213 </table>
214 </div>
215 <div class="section">
216 <h2>Support API</h2>
217 <table class="toc">
218 <tr><td class="link"><a href="ft2-computations.html">Computations</a></td><td class="desc">
219 <p>Crunching fixed numbers and vectors.</p>
220 </td></tr>
221 <tr><td class="link"><a href="ft2-list_processing.html">List Processing</a></td><td class="desc">
222 <p>Simple management of lists.</p>
223 </td></tr>
224 <tr><td class="link"><a href="ft2-outline_processing.html">Outline Processing</a></td><td class="desc">
225 <p>Functions to create, transform, and render vectorial glyph images.</p>
226 </td></tr>
227 <tr><td class="link"><a href="ft2-quick_advance.html">Quick retrieval of advance values</a></td><td class="desc">
228 <p>Retrieve horizontal and vertical advance values without processing glyph outlines, if possible.</p>
229 </td></tr>
230 <tr><td class="link"><a href="ft2-bitmap_handling.html">Bitmap Handling</a></td><td class="desc">
231 <p>Handling FT_Bitmap objects.</p>
232 </td></tr>
233 <tr><td class="link"><a href="ft2-raster.html">Scanline Converter</a></td><td class="desc">
234 <p>How vectorial outlines are converted into bitmaps and pixmaps.</p>
235 </td></tr>
236 <tr><td class="link"><a href="ft2-glyph_stroker.html">Glyph Stroker</a></td><td class="desc">
237 <p>Generating bordered and stroked glyphs.</p>
238 </td></tr>
239 <tr><td class="link"><a href="ft2-system_interface.html">System Interface</a></td><td class="desc">
240 <p>How FreeType manages memory and i/o.</p>
241 </td></tr>
242 <tr><td class="link"><a href="ft2-module_management.html">Module Management</a></td><td class="desc">
243 <p>How to add, upgrade, remove, and control modules from FreeType.</p>
244 </td></tr>
245 <tr><td class="link"><a href="ft2-gzip.html">GZIP Streams</a></td><td class="desc">
246 <p>Using gzip-compressed font files.</p>
247 </td></tr>
248 <tr><td class="link"><a href="ft2-lzw.html">LZW Streams</a></td><td class="desc">
249 <p>Using LZW-compressed font files.</p>
250 </td></tr>
251 <tr><td class="link"><a href="ft2-bzip2.html">BZIP2 Streams</a></td><td class="desc">
252 <p>Using bzip2-compressed font files.</p>
253 </td></tr>
254 <tr><td class="link"><a href="ft2-lcd_filtering.html">LCD Filtering</a></td><td class="desc">
255 <p>Reduce color fringes of subpixel-rendered bitmaps.</p>
256 </td></tr>
257 </table>
258 </div>
259 <div class="section">
260 <h2>Error Codes</h2>
261 <table class="toc">
262 <tr><td class="link"><a href="ft2-error_enumerations.html">Error Enumerations</a></td><td class="desc">
263 <p>How to handle errors and error strings.</p>
264 </td></tr>
265 <tr><td class="link"><a href="ft2-error_code_values.html">Error Code Values</a></td><td class="desc">
266 <p>All possible error codes returned by FreeType functions.</p>
267 </td></tr>
268 </table>
269 </div>
270 <div class="section">
271 <h2>Miscellaneous</h2>
272 <table class="toc">
273 <tr><td class="link"><a href="ft2-ot_validation.html">OpenType Validation</a></td><td class="desc">
274 <p>An API to validate OpenType tables.</p>
275 </td></tr>
276 <tr><td class="link"><a href="ft2-incremental.html">Incremental Loading</a></td><td class="desc">
277 <p>Custom Glyph Loading.</p>
278 </td></tr>
279 <tr><td class="link"><a href="ft2-truetype_engine.html">The TrueType Engine</a></td><td class="desc">
280 <p>TrueType bytecode support.</p>
281 </td></tr>
282 <tr><td class="link"><a href="ft2-gx_validation.html">TrueTypeGX/AAT Validation</a></td><td class="desc">
283 <p>An API to validate TrueTypeGX/AAT tables.</p>
284 </td></tr>
285 </table>
286 </div>
287 <div class="section">
288 <h2><a href="ft2-index.html">Global Index</a></h2></div>
289 <hr>
290 <table class="index-toc-link"><tr><td class="left">[<a href="ft2-index.html">Index</a>]</td></tr></table>
291
292 <div class="timestamp">generated on Mon Jan  8 12:30:20 2018</div></body>
293 </html>