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>
41 Mac Specific Interface
44 <table align=center cellspacing=5 cellpadding=0 border=0>
45 <tr><td></td><td><a href="#FT_New_Face_From_FOND">FT_New_Face_From_FOND</a></td><td></td><td><a href="#FT_GetFilePath_From_Mac_ATS_Name">FT_GetFilePath_From_Mac_ATS_Name</a></td></tr>
46 <tr><td></td><td><a href="#FT_GetFile_From_Mac_Name">FT_GetFile_From_Mac_Name</a></td><td></td><td><a href="#FT_New_Face_From_FSSpec">FT_New_Face_From_FSSpec</a></td></tr>
47 <tr><td></td><td><a href="#FT_GetFile_From_Mac_ATS_Name">FT_GetFile_From_Mac_ATS_Name</a></td><td></td><td><a href="#FT_New_Face_From_FSRef">FT_New_Face_From_FSRef</a></td></tr>
50 <table align=center width="87%"><tr><td>
51 <p>The following definitions are only available if FreeType is compiled on a Macintosh.</p>
52 </td></tr></table><br>
53 <table align=center width="75%"><tr><td>
54 <h4><a name="FT_New_Face_From_FOND">FT_New_Face_From_FOND</a></h4>
55 <table align=center width="87%"><tr><td>
56 Defined in FT_MAC_H (freetype/ftmac.h).
57 </td></tr></table><br>
58 <table align=center width="87%"><tr bgcolor="#D6E8FF"><td><pre>
60 FT_EXPORT( <a href="ft2-basic_types.html#FT_Error">FT_Error</a> )
61 <b>FT_New_Face_From_FOND</b>( <a href="ft2-base_interface.html#FT_Library">FT_Library</a> library,
63 <a href="ft2-basic_types.html#FT_Long">FT_Long</a> face_index,
64 <a href="ft2-base_interface.html#FT_Face">FT_Face</a> *aface )
65 FT_DEPRECATED_ATTRIBUTE;
68 <table align=center width="87%"><tr><td>
69 <p>Create a new face object from a FOND resource.</p>
70 </td></tr></table><br>
71 <table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>inout</b></em></td></tr><tr><td>
73 <table cellpadding=3 border=0>
74 <tr valign=top><td><b>library</b></td><td>
75 <p>A handle to the library resource.</p>
79 <table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>input</b></em></td></tr><tr><td>
81 <table cellpadding=3 border=0>
82 <tr valign=top><td><b>fond</b></td><td>
83 <p>A FOND resource.</p>
85 <tr valign=top><td><b>face_index</b></td><td>
86 <p>Only supported for the -1 ‘sanity check’ special case.</p>
90 <table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>output</b></em></td></tr><tr><td>
92 <table cellpadding=3 border=0>
93 <tr valign=top><td><b>aface</b></td><td>
94 <p>A handle to a new face object.</p>
98 <table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>return</b></em></td></tr><tr><td>
99 <p>FreeType error code. 0 means success.</p>
101 <table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>notes</b></em></td></tr><tr><td>
102 <p>This function can be used to create <a href="ft2-base_interface.html#FT_Face">FT_Face</a> objects from fonts that are installed in the system as follows.</p>
103 <pre class="colored">
104 fond = GetResource( 'FOND', fontName );
105 error = FT_New_Face_From_FOND( library, fond, 0, &face );
110 <table align=center width="75%"><tr><td><font size=-2>[<a href="ft2-index.html">Index</a>]</font></td>
111 <td width="100%"></td>
112 <td><font size=-2>[<a href="ft2-toc.html">TOC</a>]</font></td></tr></table>
114 <table align=center width="75%"><tr><td>
115 <h4><a name="FT_GetFile_From_Mac_Name">FT_GetFile_From_Mac_Name</a></h4>
116 <table align=center width="87%"><tr><td>
117 Defined in FT_MAC_H (freetype/ftmac.h).
118 </td></tr></table><br>
119 <table align=center width="87%"><tr bgcolor="#D6E8FF"><td><pre>
121 FT_EXPORT( <a href="ft2-basic_types.html#FT_Error">FT_Error</a> )
122 <b>FT_GetFile_From_Mac_Name</b>( <span class="keyword">const</span> <span class="keyword">char</span>* fontName,
124 <a href="ft2-basic_types.html#FT_Long">FT_Long</a>* face_index )
125 FT_DEPRECATED_ATTRIBUTE;
128 <table align=center width="87%"><tr><td>
129 <p>Return an FSSpec for the disk file containing the named font.</p>
130 </td></tr></table><br>
131 <table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>input</b></em></td></tr><tr><td>
133 <table cellpadding=3 border=0>
134 <tr valign=top><td><b>fontName</b></td><td>
135 <p>Mac OS name of the font (e.g., Times New Roman Bold).</p>
139 <table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>output</b></em></td></tr><tr><td>
141 <table cellpadding=3 border=0>
142 <tr valign=top><td><b>pathSpec</b></td><td>
143 <p>FSSpec to the file. For passing to <a href="ft2-mac_specific.html#FT_New_Face_From_FSSpec">FT_New_Face_From_FSSpec</a>.</p>
145 <tr valign=top><td><b>face_index</b></td><td>
146 <p>Index of the face. For passing to <a href="ft2-mac_specific.html#FT_New_Face_From_FSSpec">FT_New_Face_From_FSSpec</a>.</p>
150 <table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>return</b></em></td></tr><tr><td>
151 <p>FreeType error code. 0 means success.</p>
155 <table align=center width="75%"><tr><td><font size=-2>[<a href="ft2-index.html">Index</a>]</font></td>
156 <td width="100%"></td>
157 <td><font size=-2>[<a href="ft2-toc.html">TOC</a>]</font></td></tr></table>
159 <table align=center width="75%"><tr><td>
160 <h4><a name="FT_GetFile_From_Mac_ATS_Name">FT_GetFile_From_Mac_ATS_Name</a></h4>
161 <table align=center width="87%"><tr><td>
162 Defined in FT_MAC_H (freetype/ftmac.h).
163 </td></tr></table><br>
164 <table align=center width="87%"><tr bgcolor="#D6E8FF"><td><pre>
166 FT_EXPORT( <a href="ft2-basic_types.html#FT_Error">FT_Error</a> )
167 <b>FT_GetFile_From_Mac_ATS_Name</b>( <span class="keyword">const</span> <span class="keyword">char</span>* fontName,
169 <a href="ft2-basic_types.html#FT_Long">FT_Long</a>* face_index )
170 FT_DEPRECATED_ATTRIBUTE;
173 <table align=center width="87%"><tr><td>
174 <p>Return an FSSpec for the disk file containing the named font.</p>
175 </td></tr></table><br>
176 <table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>input</b></em></td></tr><tr><td>
178 <table cellpadding=3 border=0>
179 <tr valign=top><td><b>fontName</b></td><td>
180 <p>Mac OS name of the font in ATS framework.</p>
184 <table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>output</b></em></td></tr><tr><td>
186 <table cellpadding=3 border=0>
187 <tr valign=top><td><b>pathSpec</b></td><td>
188 <p>FSSpec to the file. For passing to <a href="ft2-mac_specific.html#FT_New_Face_From_FSSpec">FT_New_Face_From_FSSpec</a>.</p>
190 <tr valign=top><td><b>face_index</b></td><td>
191 <p>Index of the face. For passing to <a href="ft2-mac_specific.html#FT_New_Face_From_FSSpec">FT_New_Face_From_FSSpec</a>.</p>
195 <table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>return</b></em></td></tr><tr><td>
196 <p>FreeType error code. 0 means success.</p>
200 <table align=center width="75%"><tr><td><font size=-2>[<a href="ft2-index.html">Index</a>]</font></td>
201 <td width="100%"></td>
202 <td><font size=-2>[<a href="ft2-toc.html">TOC</a>]</font></td></tr></table>
204 <table align=center width="75%"><tr><td>
205 <h4><a name="FT_GetFilePath_From_Mac_ATS_Name">FT_GetFilePath_From_Mac_ATS_Name</a></h4>
206 <table align=center width="87%"><tr><td>
207 Defined in FT_MAC_H (freetype/ftmac.h).
208 </td></tr></table><br>
209 <table align=center width="87%"><tr bgcolor="#D6E8FF"><td><pre>
211 FT_EXPORT( <a href="ft2-basic_types.html#FT_Error">FT_Error</a> )
212 <b>FT_GetFilePath_From_Mac_ATS_Name</b>( <span class="keyword">const</span> <span class="keyword">char</span>* fontName,
215 <a href="ft2-basic_types.html#FT_Long">FT_Long</a>* face_index )
216 FT_DEPRECATED_ATTRIBUTE;
219 <table align=center width="87%"><tr><td>
220 <p>Return a pathname of the disk file and face index for given font name which is handled by ATS framework.</p>
221 </td></tr></table><br>
222 <table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>input</b></em></td></tr><tr><td>
224 <table cellpadding=3 border=0>
225 <tr valign=top><td><b>fontName</b></td><td>
226 <p>Mac OS name of the font in ATS framework.</p>
230 <table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>output</b></em></td></tr><tr><td>
232 <table cellpadding=3 border=0>
233 <tr valign=top><td><b>path</b></td><td>
234 <p>Buffer to store pathname of the file. For passing to <a href="ft2-base_interface.html#FT_New_Face">FT_New_Face</a>. The client must allocate this buffer before calling this function.</p>
236 <tr valign=top><td><b>maxPathSize</b></td><td>
237 <p>Lengths of the buffer ‘path’ that client allocated.</p>
239 <tr valign=top><td><b>face_index</b></td><td>
240 <p>Index of the face. For passing to <a href="ft2-base_interface.html#FT_New_Face">FT_New_Face</a>.</p>
244 <table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>return</b></em></td></tr><tr><td>
245 <p>FreeType error code. 0 means success.</p>
249 <table align=center width="75%"><tr><td><font size=-2>[<a href="ft2-index.html">Index</a>]</font></td>
250 <td width="100%"></td>
251 <td><font size=-2>[<a href="ft2-toc.html">TOC</a>]</font></td></tr></table>
253 <table align=center width="75%"><tr><td>
254 <h4><a name="FT_New_Face_From_FSSpec">FT_New_Face_From_FSSpec</a></h4>
255 <table align=center width="87%"><tr><td>
256 Defined in FT_MAC_H (freetype/ftmac.h).
257 </td></tr></table><br>
258 <table align=center width="87%"><tr bgcolor="#D6E8FF"><td><pre>
260 FT_EXPORT( <a href="ft2-basic_types.html#FT_Error">FT_Error</a> )
261 <b>FT_New_Face_From_FSSpec</b>( <a href="ft2-base_interface.html#FT_Library">FT_Library</a> library,
262 <span class="keyword">const</span> FSSpec *spec,
263 <a href="ft2-basic_types.html#FT_Long">FT_Long</a> face_index,
264 <a href="ft2-base_interface.html#FT_Face">FT_Face</a> *aface )
265 FT_DEPRECATED_ATTRIBUTE;
268 <table align=center width="87%"><tr><td>
269 <p>Create a new face object from a given resource and typeface index using an FSSpec to the font file.</p>
270 </td></tr></table><br>
271 <table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>inout</b></em></td></tr><tr><td>
273 <table cellpadding=3 border=0>
274 <tr valign=top><td><b>library</b></td><td>
275 <p>A handle to the library resource.</p>
279 <table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>input</b></em></td></tr><tr><td>
281 <table cellpadding=3 border=0>
282 <tr valign=top><td><b>spec</b></td><td>
283 <p>FSSpec to the font file.</p>
285 <tr valign=top><td><b>face_index</b></td><td>
286 <p>The index of the face within the resource. The first face has index 0.</p>
290 <table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>output</b></em></td></tr><tr><td>
292 <table cellpadding=3 border=0>
293 <tr valign=top><td><b>aface</b></td><td>
294 <p>A handle to a new face object.</p>
298 <table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>return</b></em></td></tr><tr><td>
299 <p>FreeType error code. 0 means success.</p>
301 <table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>note</b></em></td></tr><tr><td>
302 <p><a href="ft2-mac_specific.html#FT_New_Face_From_FSSpec">FT_New_Face_From_FSSpec</a> is identical to <a href="ft2-base_interface.html#FT_New_Face">FT_New_Face</a> except it accepts an FSSpec instead of a path.</p>
306 <table align=center width="75%"><tr><td><font size=-2>[<a href="ft2-index.html">Index</a>]</font></td>
307 <td width="100%"></td>
308 <td><font size=-2>[<a href="ft2-toc.html">TOC</a>]</font></td></tr></table>
310 <table align=center width="75%"><tr><td>
311 <h4><a name="FT_New_Face_From_FSRef">FT_New_Face_From_FSRef</a></h4>
312 <table align=center width="87%"><tr><td>
313 Defined in FT_MAC_H (freetype/ftmac.h).
314 </td></tr></table><br>
315 <table align=center width="87%"><tr bgcolor="#D6E8FF"><td><pre>
317 FT_EXPORT( <a href="ft2-basic_types.html#FT_Error">FT_Error</a> )
318 <b>FT_New_Face_From_FSRef</b>( <a href="ft2-base_interface.html#FT_Library">FT_Library</a> library,
319 <span class="keyword">const</span> FSRef *ref,
320 <a href="ft2-basic_types.html#FT_Long">FT_Long</a> face_index,
321 <a href="ft2-base_interface.html#FT_Face">FT_Face</a> *aface )
322 FT_DEPRECATED_ATTRIBUTE;
325 <table align=center width="87%"><tr><td>
326 <p>Create a new face object from a given resource and typeface index using an FSRef to the font file.</p>
327 </td></tr></table><br>
328 <table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>inout</b></em></td></tr><tr><td>
330 <table cellpadding=3 border=0>
331 <tr valign=top><td><b>library</b></td><td>
332 <p>A handle to the library resource.</p>
336 <table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>input</b></em></td></tr><tr><td>
338 <table cellpadding=3 border=0>
339 <tr valign=top><td><b>spec</b></td><td>
340 <p>FSRef to the font file.</p>
342 <tr valign=top><td><b>face_index</b></td><td>
343 <p>The index of the face within the resource. The first face has index 0.</p>
347 <table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>output</b></em></td></tr><tr><td>
349 <table cellpadding=3 border=0>
350 <tr valign=top><td><b>aface</b></td><td>
351 <p>A handle to a new face object.</p>
355 <table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>return</b></em></td></tr><tr><td>
356 <p>FreeType error code. 0 means success.</p>
358 <table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>note</b></em></td></tr><tr><td>
359 <p><a href="ft2-mac_specific.html#FT_New_Face_From_FSRef">FT_New_Face_From_FSRef</a> is identical to <a href="ft2-base_interface.html#FT_New_Face">FT_New_Face</a> except it accepts an FSRef instead of a path.</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>