Mercurial > hg > Game > Cerium

comparison freetype2/freetype/freetype.h @ 1206:a8ab91f49cac draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
add freetype2,ft2build.h
author Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
date Thu, 21 Jul 2011 19:38:12 +0900
parents
children
comparison
equal deleted inserted replaced
1205:b8adf4e95e96 1206:a8ab91f49cac
1 /***************************************************************************/
2 /* */
3 /* freetype.h */
4 /* */
5 /* FreeType high-level API and common types (specification only). */
6 /* */
7 /* Copyright 1996-2011 by */
8 /* David Turner, Robert Wilhelm, and Werner Lemberg. */
9 /* */
10 /* This file is part of the FreeType project, and may only be used, */
11 /* modified, and distributed under the terms of the FreeType project */
12 /* license, LICENSE.TXT. By continuing to use, modify, or distribute */
13 /* this file you indicate that you have read the license and */
14 /* understand and accept it fully. */
15 /* */
16 /***************************************************************************/
17
18
19 #ifndef FT_FREETYPE_H
20 #error "`ft2build.h' hasn't been included yet!"
21 #error "Please always use macros to include FreeType header files."
22 #error "Example:"
23 #error " #include <ft2build.h>"
24 #error " #include FT_FREETYPE_H"
25 #endif
26
27
28 #ifndef __FREETYPE_H__
29 #define __FREETYPE_H__
30
31
32 #include <ft2build.h>
33 #include FT_CONFIG_CONFIG_H
34 #include FT_ERRORS_H
35 #include FT_TYPES_H
36
37
38 FT_BEGIN_HEADER
39
40
41
42 /*************************************************************************/
43 /* */
44 /* <Section> */
45 /* user_allocation */
46 /* */
47 /* <Title> */
48 /* User allocation */
49 /* */
50 /* <Abstract> */
51 /* How client applications should allocate FreeType data structures. */
52 /* */
53 /* <Description> */
54 /* FreeType assumes that structures allocated by the user and passed */
55 /* as arguments are zeroed out except for the actual data. In other */
56 /* words, it is recommended to use `calloc' (or variants of it) */
57 /* instead of `malloc' for allocation. */
58 /* */
59 /*************************************************************************/
60
61
62
63 /*************************************************************************/
64 /*************************************************************************/
65 /* */
66 /* B A S I C T Y P E S */
67 /* */
68 /*************************************************************************/
69 /*************************************************************************/
70
71
72 /*************************************************************************/
73 /* */
74 /* <Section> */
75 /* base_interface */
76 /* */
77 /* <Title> */
78 /* Base Interface */
79 /* */
80 /* <Abstract> */
81 /* The FreeType~2 base font interface. */
82 /* */
83 /* <Description> */
84 /* This section describes the public high-level API of FreeType~2. */
85 /* */
86 /* <Order> */
87 /* FT_Library */
88 /* FT_Face */
89 /* FT_Size */
90 /* FT_GlyphSlot */
91 /* FT_CharMap */
92 /* FT_Encoding */
93 /* */
94 /* FT_FaceRec */
95 /* */
96 /* FT_FACE_FLAG_SCALABLE */
97 /* FT_FACE_FLAG_FIXED_SIZES */
98 /* FT_FACE_FLAG_FIXED_WIDTH */
99 /* FT_FACE_FLAG_HORIZONTAL */
100 /* FT_FACE_FLAG_VERTICAL */
101 /* FT_FACE_FLAG_SFNT */
102 /* FT_FACE_FLAG_KERNING */
103 /* FT_FACE_FLAG_MULTIPLE_MASTERS */
104 /* FT_FACE_FLAG_GLYPH_NAMES */
105 /* FT_FACE_FLAG_EXTERNAL_STREAM */
106 /* FT_FACE_FLAG_FAST_GLYPHS */
107 /* FT_FACE_FLAG_HINTER */
108 /* */
109 /* FT_STYLE_FLAG_BOLD */
110 /* FT_STYLE_FLAG_ITALIC */
111 /* */
112 /* FT_SizeRec */
113 /* FT_Size_Metrics */
114 /* */
115 /* FT_GlyphSlotRec */
116 /* FT_Glyph_Metrics */
117 /* FT_SubGlyph */
118 /* */
119 /* FT_Bitmap_Size */
120 /* */
121 /* FT_Init_FreeType */
122 /* FT_Done_FreeType */
123 /* */
124 /* FT_New_Face */
125 /* FT_Done_Face */
126 /* FT_New_Memory_Face */
127 /* FT_Open_Face */
128 /* FT_Open_Args */
129 /* FT_Parameter */
130 /* FT_Attach_File */
131 /* FT_Attach_Stream */
132 /* */
133 /* FT_Set_Char_Size */
134 /* FT_Set_Pixel_Sizes */
135 /* FT_Request_Size */
136 /* FT_Select_Size */
137 /* FT_Size_Request_Type */
138 /* FT_Size_Request */
139 /* FT_Set_Transform */
140 /* FT_Load_Glyph */
141 /* FT_Get_Char_Index */
142 /* FT_Get_Name_Index */
143 /* FT_Load_Char */
144 /* */
145 /* FT_OPEN_MEMORY */
146 /* FT_OPEN_STREAM */
147 /* FT_OPEN_PATHNAME */
148 /* FT_OPEN_DRIVER */
149 /* FT_OPEN_PARAMS */
150 /* */
151 /* FT_LOAD_DEFAULT */
152 /* FT_LOAD_RENDER */
153 /* FT_LOAD_MONOCHROME */
154 /* FT_LOAD_LINEAR_DESIGN */
155 /* FT_LOAD_NO_SCALE */
156 /* FT_LOAD_NO_HINTING */
157 /* FT_LOAD_NO_BITMAP */
158 /* FT_LOAD_CROP_BITMAP */
159 /* */
160 /* FT_LOAD_VERTICAL_LAYOUT */
161 /* FT_LOAD_IGNORE_TRANSFORM */
162 /* FT_LOAD_IGNORE_GLOBAL_ADVANCE_WIDTH */
163 /* FT_LOAD_FORCE_AUTOHINT */
164 /* FT_LOAD_NO_RECURSE */
165 /* FT_LOAD_PEDANTIC */
166 /* */
167 /* FT_LOAD_TARGET_NORMAL */
168 /* FT_LOAD_TARGET_LIGHT */
169 /* FT_LOAD_TARGET_MONO */
170 /* FT_LOAD_TARGET_LCD */
171 /* FT_LOAD_TARGET_LCD_V */
172 /* */
173 /* FT_Render_Glyph */
174 /* FT_Render_Mode */
175 /* FT_Get_Kerning */
176 /* FT_Kerning_Mode */
177 /* FT_Get_Track_Kerning */
178 /* FT_Get_Glyph_Name */
179 /* FT_Get_Postscript_Name */
180 /* */
181 /* FT_CharMapRec */
182 /* FT_Select_Charmap */
183 /* FT_Set_Charmap */
184 /* FT_Get_Charmap_Index */
185 /* */
186 /* FT_FSTYPE_INSTALLABLE_EMBEDDING */
187 /* FT_FSTYPE_RESTRICTED_LICENSE_EMBEDDING */
188 /* FT_FSTYPE_PREVIEW_AND_PRINT_EMBEDDING */
189 /* FT_FSTYPE_EDITABLE_EMBEDDING */
190 /* FT_FSTYPE_NO_SUBSETTING */
191 /* FT_FSTYPE_BITMAP_EMBEDDING_ONLY */
192 /* */
193 /* FT_Get_FSType_Flags */
194 /* */
195 /*************************************************************************/
196
197
198 /*************************************************************************/
199 /* */
200 /* <Struct> */
201 /* FT_Glyph_Metrics */
202 /* */
203 /* <Description> */
204 /* A structure used to model the metrics of a single glyph. The */
205 /* values are expressed in 26.6 fractional pixel format; if the flag */
206 /* @FT_LOAD_NO_SCALE has been used while loading the glyph, values */
207 /* are expressed in font units instead. */
208 /* */
209 /* <Fields> */
210 /* width :: */
211 /* The glyph's width. */
212 /* */
213 /* height :: */
214 /* The glyph's height. */
215 /* */
216 /* horiBearingX :: */
217 /* Left side bearing for horizontal layout. */
218 /* */
219 /* horiBearingY :: */
220 /* Top side bearing for horizontal layout. */
221 /* */
222 /* horiAdvance :: */
223 /* Advance width for horizontal layout. */
224 /* */
225 /* vertBearingX :: */
226 /* Left side bearing for vertical layout. */
227 /* */
228 /* vertBearingY :: */
229 /* Top side bearing for vertical layout. Larger positive values */
230 /* mean further below the vertical glyph origin. */
231 /* */
232 /* vertAdvance :: */
233 /* Advance height for vertical layout. Positive values mean the */
234 /* glyph has a positive advance downward. */
235 /* */
236 /* <Note> */
237 /* If not disabled with @FT_LOAD_NO_HINTING, the values represent */
238 /* dimensions of the hinted glyph (in case hinting is applicable). */
239 /* */
240 typedef struct FT_Glyph_Metrics_
241 {
242 FT_Pos width;
243 FT_Pos height;
244
245 FT_Pos horiBearingX;
246 FT_Pos horiBearingY;
247 FT_Pos horiAdvance;
248
249 FT_Pos vertBearingX;
250 FT_Pos vertBearingY;
251 FT_Pos vertAdvance;
252
253 } FT_Glyph_Metrics;
254
255
256 /*************************************************************************/
257 /* */
258 /* <Struct> */
259 /* FT_Bitmap_Size */
260 /* */
261 /* <Description> */
262 /* This structure models the metrics of a bitmap strike (i.e., a set */
263 /* of glyphs for a given point size and resolution) in a bitmap font. */
264 /* It is used for the `available_sizes' field of @FT_Face. */
265 /* */
266 /* <Fields> */
267 /* height :: The vertical distance, in pixels, between two */
268 /* consecutive baselines. It is always positive. */
269 /* */
270 /* width :: The average width, in pixels, of all glyphs in the */
271 /* strike. */
272 /* */
273 /* size :: The nominal size of the strike in 26.6 fractional */
274 /* points. This field is not very useful. */
275 /* */
276 /* x_ppem :: The horizontal ppem (nominal width) in 26.6 fractional */
277 /* pixels. */
278 /* */
279 /* y_ppem :: The vertical ppem (nominal height) in 26.6 fractional */
280 /* pixels. */
281 /* */
282 /* <Note> */
283 /* Windows FNT: */
284 /* The nominal size given in a FNT font is not reliable. Thus when */
285 /* the driver finds it incorrect, it sets `size' to some calculated */
286 /* values and sets `x_ppem' and `y_ppem' to the pixel width and */
287 /* height given in the font, respectively. */
288 /* */
289 /* TrueType embedded bitmaps: */
290 /* `size', `width', and `height' values are not contained in the */
291 /* bitmap strike itself. They are computed from the global font */
292 /* parameters. */
293 /* */
294 typedef struct FT_Bitmap_Size_
295 {
296 FT_Short height;
297 FT_Short width;
298
299 FT_Pos size;
300
301 FT_Pos x_ppem;
302 FT_Pos y_ppem;
303
304 } FT_Bitmap_Size;
305
306
307 /*************************************************************************/
308 /*************************************************************************/
309 /* */
310 /* O B J E C T C L A S S E S */
311 /* */
312 /*************************************************************************/
313 /*************************************************************************/
314
315 /*************************************************************************/
316 /* */
317 /* <Type> */
318 /* FT_Library */
319 /* */
320 /* <Description> */
321 /* A handle to a FreeType library instance. Each `library' is */
322 /* completely independent from the others; it is the `root' of a set */
323 /* of objects like fonts, faces, sizes, etc. */
324 /* */
325 /* It also embeds a memory manager (see @FT_Memory), as well as a */
326 /* scan-line converter object (see @FT_Raster). */
327 /* */
328 /* For multi-threading applications each thread should have its own */
329 /* FT_Library object. */
330 /* */
331 /* <Note> */
332 /* Library objects are normally created by @FT_Init_FreeType, and */
333 /* destroyed with @FT_Done_FreeType. */
334 /* */
335 typedef struct FT_LibraryRec_ *FT_Library;
336
337
338 /*************************************************************************/
339 /* */
340 /* <Type> */
341 /* FT_Module */
342 /* */
343 /* <Description> */
344 /* A handle to a given FreeType module object. Each module can be a */
345 /* font driver, a renderer, or anything else that provides services */
346 /* to the formers. */
347 /* */
348 typedef struct FT_ModuleRec_* FT_Module;
349
350
351 /*************************************************************************/
352 /* */
353 /* <Type> */
354 /* FT_Driver */
355 /* */
356 /* <Description> */
357 /* A handle to a given FreeType font driver object. Each font driver */
358 /* is a special module capable of creating faces from font files. */
359 /* */
360 typedef struct FT_DriverRec_* FT_Driver;
361
362
363 /*************************************************************************/
364 /* */
365 /* <Type> */
366 /* FT_Renderer */
367 /* */
368 /* <Description> */
369 /* A handle to a given FreeType renderer. A renderer is a special */
370 /* module in charge of converting a glyph image to a bitmap, when */
371 /* necessary. Each renderer supports a given glyph image format, and */
372 /* one or more target surface depths. */
373 /* */
374 typedef struct FT_RendererRec_* FT_Renderer;
375
376
377 /*************************************************************************/
378 /* */
379 /* <Type> */
380 /* FT_Face */
381 /* */
382 /* <Description> */
383 /* A handle to a given typographic face object. A face object models */
384 /* a given typeface, in a given style. */
385 /* */
386 /* <Note> */
387 /* Each face object also owns a single @FT_GlyphSlot object, as well */
388 /* as one or more @FT_Size objects. */
389 /* */
390 /* Use @FT_New_Face or @FT_Open_Face to create a new face object from */
391 /* a given filepathname or a custom input stream. */
392 /* */
393 /* Use @FT_Done_Face to destroy it (along with its slot and sizes). */
394 /* */
395 /* <Also> */
396 /* See @FT_FaceRec for the publicly accessible fields of a given face */
397 /* object. */
398 /* */
399 typedef struct FT_FaceRec_* FT_Face;
400
401
402 /*************************************************************************/
403 /* */
404 /* <Type> */
405 /* FT_Size */
406 /* */
407 /* <Description> */
408 /* A handle to an object used to model a face scaled to a given */
409 /* character size. */
410 /* */
411 /* <Note> */
412 /* Each @FT_Face has an _active_ @FT_Size object that is used by */
413 /* functions like @FT_Load_Glyph to determine the scaling */
414 /* transformation which is used to load and hint glyphs and metrics. */
415 /* */
416 /* You can use @FT_Set_Char_Size, @FT_Set_Pixel_Sizes, */
417 /* @FT_Request_Size or even @FT_Select_Size to change the content */
418 /* (i.e., the scaling values) of the active @FT_Size. */
419 /* */
420 /* You can use @FT_New_Size to create additional size objects for a */
421 /* given @FT_Face, but they won't be used by other functions until */
422 /* you activate it through @FT_Activate_Size. Only one size can be */
423 /* activated at any given time per face. */
424 /* */
425 /* <Also> */
426 /* See @FT_SizeRec for the publicly accessible fields of a given size */
427 /* object. */
428 /* */
429 typedef struct FT_SizeRec_* FT_Size;
430
431
432 /*************************************************************************/
433 /* */
434 /* <Type> */
435 /* FT_GlyphSlot */
436 /* */
437 /* <Description> */
438 /* A handle to a given `glyph slot'. A slot is a container where it */
439 /* is possible to load any of the glyphs contained in its parent */
440 /* face. */
441 /* */
442 /* In other words, each time you call @FT_Load_Glyph or */
443 /* @FT_Load_Char, the slot's content is erased by the new glyph data, */
444 /* i.e., the glyph's metrics, its image (bitmap or outline), and */
445 /* other control information. */
446 /* */
447 /* <Also> */
448 /* See @FT_GlyphSlotRec for the publicly accessible glyph fields. */
449 /* */
450 typedef struct FT_GlyphSlotRec_* FT_GlyphSlot;
451
452
453 /*************************************************************************/
454 /* */
455 /* <Type> */
456 /* FT_CharMap */
457 /* */
458 /* <Description> */
459 /* A handle to a given character map. A charmap is used to translate */
460 /* character codes in a given encoding into glyph indexes for its */
461 /* parent's face. Some font formats may provide several charmaps per */
462 /* font. */
463 /* */
464 /* Each face object owns zero or more charmaps, but only one of them */
465 /* can be `active' and used by @FT_Get_Char_Index or @FT_Load_Char. */
466 /* */
467 /* The list of available charmaps in a face is available through the */
468 /* `face->num_charmaps' and `face->charmaps' fields of @FT_FaceRec. */
469 /* */
470 /* The currently active charmap is available as `face->charmap'. */
471 /* You should call @FT_Set_Charmap to change it. */
472 /* */
473 /* <Note> */
474 /* When a new face is created (either through @FT_New_Face or */
475 /* @FT_Open_Face), the library looks for a Unicode charmap within */
476 /* the list and automatically activates it. */
477 /* */
478 /* <Also> */
479 /* See @FT_CharMapRec for the publicly accessible fields of a given */
480 /* character map. */
481 /* */
482 typedef struct FT_CharMapRec_* FT_CharMap;
483
484
485 /*************************************************************************/
486 /* */
487 /* <Macro> */
488 /* FT_ENC_TAG */
489 /* */
490 /* <Description> */
491 /* This macro converts four-letter tags into an unsigned long. It is */
492 /* used to define `encoding' identifiers (see @FT_Encoding). */
493 /* */
494 /* <Note> */
495 /* Since many 16-bit compilers don't like 32-bit enumerations, you */
496 /* should redefine this macro in case of problems to something like */
497 /* this: */
498 /* */
499 /* { */
500 /* #define FT_ENC_TAG( value, a, b, c, d ) value */
501 /* } */
502 /* */
503 /* to get a simple enumeration without assigning special numbers. */
504 /* */
505
506 #ifndef FT_ENC_TAG
507 #define FT_ENC_TAG( value, a, b, c, d ) \
508 value = ( ( (FT_UInt32)(a) << 24 ) | \
509 ( (FT_UInt32)(b) << 16 ) | \
510 ( (FT_UInt32)(c) << 8 ) | \
511 (FT_UInt32)(d) )
512
513 #endif /* FT_ENC_TAG */
514
515
516 /*************************************************************************/
517 /* */
518 /* <Enum> */
519 /* FT_Encoding */
520 /* */
521 /* <Description> */
522 /* An enumeration used to specify character sets supported by */
523 /* charmaps. Used in the @FT_Select_Charmap API function. */
524 /* */
525 /* <Note> */
526 /* Despite the name, this enumeration lists specific character */
527 /* repertories (i.e., charsets), and not text encoding methods (e.g., */
528 /* UTF-8, UTF-16, etc.). */
529 /* */
530 /* Other encodings might be defined in the future. */
531 /* */
532 /* <Values> */
533 /* FT_ENCODING_NONE :: */
534 /* The encoding value~0 is reserved. */
535 /* */
536 /* FT_ENCODING_UNICODE :: */
537 /* Corresponds to the Unicode character set. This value covers */
538 /* all versions of the Unicode repertoire, including ASCII and */
539 /* Latin-1. Most fonts include a Unicode charmap, but not all */
540 /* of them. */
541 /* */
542 /* For example, if you want to access Unicode value U+1F028 (and */
543 /* the font contains it), use value 0x1F028 as the input value for */
544 /* @FT_Get_Char_Index. */
545 /* */
546 /* FT_ENCODING_MS_SYMBOL :: */
547 /* Corresponds to the Microsoft Symbol encoding, used to encode */
548 /* mathematical symbols in the 32..255 character code range. For */
549 /* more information, see `http://www.ceviz.net/symbol.htm'. */
550 /* */
551 /* FT_ENCODING_SJIS :: */
552 /* Corresponds to Japanese SJIS encoding. More info at */
553 /* at `http://langsupport.japanreference.com/encoding.shtml'. */
554 /* See note on multi-byte encodings below. */
555 /* */
556 /* FT_ENCODING_GB2312 :: */
557 /* Corresponds to an encoding system for Simplified Chinese as used */
558 /* used in mainland China. */
559 /* */
560 /* FT_ENCODING_BIG5 :: */
561 /* Corresponds to an encoding system for Traditional Chinese as */
562 /* used in Taiwan and Hong Kong. */
563 /* */
564 /* FT_ENCODING_WANSUNG :: */
565 /* Corresponds to the Korean encoding system known as Wansung. */
566 /* For more information see */
567 /* `http://www.microsoft.com/typography/unicode/949.txt'. */
568 /* */
569 /* FT_ENCODING_JOHAB :: */
570 /* The Korean standard character set (KS~C 5601-1992), which */
571 /* corresponds to MS Windows code page 1361. This character set */
572 /* includes all possible Hangeul character combinations. */
573 /* */
574 /* FT_ENCODING_ADOBE_LATIN_1 :: */
575 /* Corresponds to a Latin-1 encoding as defined in a Type~1 */
576 /* PostScript font. It is limited to 256 character codes. */
577 /* */
578 /* FT_ENCODING_ADOBE_STANDARD :: */
579 /* Corresponds to the Adobe Standard encoding, as found in Type~1, */
580 /* CFF, and OpenType/CFF fonts. It is limited to 256 character */
581 /* codes. */
582 /* */
583 /* FT_ENCODING_ADOBE_EXPERT :: */
584 /* Corresponds to the Adobe Expert encoding, as found in Type~1, */
585 /* CFF, and OpenType/CFF fonts. It is limited to 256 character */
586 /* codes. */
587 /* */
588 /* FT_ENCODING_ADOBE_CUSTOM :: */
589 /* Corresponds to a custom encoding, as found in Type~1, CFF, and */
590 /* OpenType/CFF fonts. It is limited to 256 character codes. */
591 /* */
592 /* FT_ENCODING_APPLE_ROMAN :: */
593 /* Corresponds to the 8-bit Apple roman encoding. Many TrueType */
594 /* and OpenType fonts contain a charmap for this encoding, since */
595 /* older versions of Mac OS are able to use it. */
596 /* */
597 /* FT_ENCODING_OLD_LATIN_2 :: */
598 /* This value is deprecated and was never used nor reported by */
599 /* FreeType. Don't use or test for it. */
600 /* */
601 /* FT_ENCODING_MS_SJIS :: */
602 /* Same as FT_ENCODING_SJIS. Deprecated. */
603 /* */
604 /* FT_ENCODING_MS_GB2312 :: */
605 /* Same as FT_ENCODING_GB2312. Deprecated. */
606 /* */
607 /* FT_ENCODING_MS_BIG5 :: */
608 /* Same as FT_ENCODING_BIG5. Deprecated. */
609 /* */
610 /* FT_ENCODING_MS_WANSUNG :: */
611 /* Same as FT_ENCODING_WANSUNG. Deprecated. */
612 /* */
613 /* FT_ENCODING_MS_JOHAB :: */
614 /* Same as FT_ENCODING_JOHAB. Deprecated. */
615 /* */
616 /* <Note> */
617 /* By default, FreeType automatically synthesizes a Unicode charmap */
618 /* for PostScript fonts, using their glyph names dictionaries. */
619 /* However, it also reports the encodings defined explicitly in the */
620 /* font file, for the cases when they are needed, with the Adobe */
621 /* values as well. */
622 /* */
623 /* FT_ENCODING_NONE is set by the BDF and PCF drivers if the charmap */
624 /* is neither Unicode nor ISO-8859-1 (otherwise it is set to */
625 /* FT_ENCODING_UNICODE). Use @FT_Get_BDF_Charset_ID to find out */
626 /* which encoding is really present. If, for example, the */
627 /* `cs_registry' field is `KOI8' and the `cs_encoding' field is `R', */
628 /* the font is encoded in KOI8-R. */
629 /* */
630 /* FT_ENCODING_NONE is always set (with a single exception) by the */
631 /* winfonts driver. Use @FT_Get_WinFNT_Header and examine the */
632 /* `charset' field of the @FT_WinFNT_HeaderRec structure to find out */
633 /* which encoding is really present. For example, */
634 /* @FT_WinFNT_ID_CP1251 (204) means Windows code page 1251 (for */
635 /* Russian). */
636 /* */
637 /* FT_ENCODING_NONE is set if `platform_id' is @TT_PLATFORM_MACINTOSH */
638 /* and `encoding_id' is not @TT_MAC_ID_ROMAN (otherwise it is set to */
639 /* FT_ENCODING_APPLE_ROMAN). */
640 /* */
641 /* If `platform_id' is @TT_PLATFORM_MACINTOSH, use the function */
642 /* @FT_Get_CMap_Language_ID to query the Mac language ID which may */
643 /* be needed to be able to distinguish Apple encoding variants. See */
644 /* */
645 /* http://www.unicode.org/Public/MAPPINGS/VENDORS/APPLE/README.TXT */
646 /* */
647 /* to get an idea how to do that. Basically, if the language ID */
648 /* is~0, don't use it, otherwise subtract 1 from the language ID. */
649 /* Then examine `encoding_id'. If, for example, `encoding_id' is */
650 /* @TT_MAC_ID_ROMAN and the language ID (minus~1) is */
651 /* `TT_MAC_LANGID_GREEK', it is the Greek encoding, not Roman. */
652 /* @TT_MAC_ID_ARABIC with `TT_MAC_LANGID_FARSI' means the Farsi */
653 /* variant the Arabic encoding. */
654 /* */
655 typedef enum FT_Encoding_
656 {
657 FT_ENC_TAG( FT_ENCODING_NONE, 0, 0, 0, 0 ),
658
659 FT_ENC_TAG( FT_ENCODING_MS_SYMBOL, 's', 'y', 'm', 'b' ),
660 FT_ENC_TAG( FT_ENCODING_UNICODE, 'u', 'n', 'i', 'c' ),
661
662 FT_ENC_TAG( FT_ENCODING_SJIS, 's', 'j', 'i', 's' ),
663 FT_ENC_TAG( FT_ENCODING_GB2312, 'g', 'b', ' ', ' ' ),
664 FT_ENC_TAG( FT_ENCODING_BIG5, 'b', 'i', 'g', '5' ),
665 FT_ENC_TAG( FT_ENCODING_WANSUNG, 'w', 'a', 'n', 's' ),
666 FT_ENC_TAG( FT_ENCODING_JOHAB, 'j', 'o', 'h', 'a' ),
667
668 /* for backwards compatibility */
669 FT_ENCODING_MS_SJIS = FT_ENCODING_SJIS,
670 FT_ENCODING_MS_GB2312 = FT_ENCODING_GB2312,
671 FT_ENCODING_MS_BIG5 = FT_ENCODING_BIG5,
672 FT_ENCODING_MS_WANSUNG = FT_ENCODING_WANSUNG,
673 FT_ENCODING_MS_JOHAB = FT_ENCODING_JOHAB,
674
675 FT_ENC_TAG( FT_ENCODING_ADOBE_STANDARD, 'A', 'D', 'O', 'B' ),
676 FT_ENC_TAG( FT_ENCODING_ADOBE_EXPERT, 'A', 'D', 'B', 'E' ),
677 FT_ENC_TAG( FT_ENCODING_ADOBE_CUSTOM, 'A', 'D', 'B', 'C' ),
678 FT_ENC_TAG( FT_ENCODING_ADOBE_LATIN_1, 'l', 'a', 't', '1' ),
679
680 FT_ENC_TAG( FT_ENCODING_OLD_LATIN_2, 'l', 'a', 't', '2' ),
681
682 FT_ENC_TAG( FT_ENCODING_APPLE_ROMAN, 'a', 'r', 'm', 'n' )
683
684 } FT_Encoding;
685
686
687 /*************************************************************************/
688 /* */
689 /* <Enum> */
690 /* ft_encoding_xxx */
691 /* */
692 /* <Description> */
693 /* These constants are deprecated; use the corresponding @FT_Encoding */
694 /* values instead. */
695 /* */
696 #define ft_encoding_none FT_ENCODING_NONE
697 #define ft_encoding_unicode FT_ENCODING_UNICODE
698 #define ft_encoding_symbol FT_ENCODING_MS_SYMBOL
699 #define ft_encoding_latin_1 FT_ENCODING_ADOBE_LATIN_1
700 #define ft_encoding_latin_2 FT_ENCODING_OLD_LATIN_2
701 #define ft_encoding_sjis FT_ENCODING_SJIS
702 #define ft_encoding_gb2312 FT_ENCODING_GB2312
703 #define ft_encoding_big5 FT_ENCODING_BIG5
704 #define ft_encoding_wansung FT_ENCODING_WANSUNG
705 #define ft_encoding_johab FT_ENCODING_JOHAB
706
707 #define ft_encoding_adobe_standard FT_ENCODING_ADOBE_STANDARD
708 #define ft_encoding_adobe_expert FT_ENCODING_ADOBE_EXPERT
709 #define ft_encoding_adobe_custom FT_ENCODING_ADOBE_CUSTOM
710 #define ft_encoding_apple_roman FT_ENCODING_APPLE_ROMAN
711
712
713 /*************************************************************************/
714 /* */
715 /* <Struct> */
716 /* FT_CharMapRec */
717 /* */
718 /* <Description> */
719 /* The base charmap structure. */
720 /* */
721 /* <Fields> */
722 /* face :: A handle to the parent face object. */
723 /* */
724 /* encoding :: An @FT_Encoding tag identifying the charmap. Use */
725 /* this with @FT_Select_Charmap. */
726 /* */
727 /* platform_id :: An ID number describing the platform for the */
728 /* following encoding ID. This comes directly from */
729 /* the TrueType specification and should be emulated */
730 /* for other formats. */
731 /* */
732 /* encoding_id :: A platform specific encoding number. This also */
733 /* comes from the TrueType specification and should be */
734 /* emulated similarly. */
735 /* */
736 typedef struct FT_CharMapRec_
737 {
738 FT_Face face;
739 FT_Encoding encoding;
740 FT_UShort platform_id;
741 FT_UShort encoding_id;
742
743 } FT_CharMapRec;
744
745
746 /*************************************************************************/
747 /*************************************************************************/
748 /* */
749 /* B A S E O B J E C T C L A S S E S */
750 /* */
751 /*************************************************************************/
752 /*************************************************************************/
753
754
755 /*************************************************************************/
756 /* */
757 /* <Type> */
758 /* FT_Face_Internal */
759 /* */
760 /* <Description> */
761 /* An opaque handle to an `FT_Face_InternalRec' structure, used to */
762 /* model private data of a given @FT_Face object. */
763 /* */
764 /* This structure might change between releases of FreeType~2 and is */
765 /* not generally available to client applications. */
766 /* */
767 typedef struct FT_Face_InternalRec_* FT_Face_Internal;
768
769
770 /*************************************************************************/
771 /* */
772 /* <Struct> */
773 /* FT_FaceRec */
774 /* */
775 /* <Description> */
776 /* FreeType root face class structure. A face object models a */
777 /* typeface in a font file. */
778 /* */
779 /* <Fields> */
780 /* num_faces :: The number of faces in the font file. Some */
781 /* font formats can have multiple faces in */
782 /* a font file. */
783 /* */
784 /* face_index :: The index of the face in the font file. It */
785 /* is set to~0 if there is only one face in */
786 /* the font file. */
787 /* */
788 /* face_flags :: A set of bit flags that give important */
789 /* information about the face; see */
790 /* @FT_FACE_FLAG_XXX for the details. */
791 /* */
792 /* style_flags :: A set of bit flags indicating the style of */
793 /* the face; see @FT_STYLE_FLAG_XXX for the */
794 /* details. */
795 /* */
796 /* num_glyphs :: The number of glyphs in the face. If the */
797 /* face is scalable and has sbits (see */
798 /* `num_fixed_sizes'), it is set to the number */
799 /* of outline glyphs. */
800 /* */
801 /* For CID-keyed fonts, this value gives the */
802 /* highest CID used in the font. */
803 /* */
804 /* family_name :: The face's family name. This is an ASCII */
805 /* string, usually in English, which describes */
806 /* the typeface's family (like `Times New */
807 /* Roman', `Bodoni', `Garamond', etc). This */
808 /* is a least common denominator used to list */
809 /* fonts. Some formats (TrueType & OpenType) */
810 /* provide localized and Unicode versions of */
811 /* this string. Applications should use the */
812 /* format specific interface to access them. */
813 /* Can be NULL (e.g., in fonts embedded in a */
814 /* PDF file). */
815 /* */
816 /* style_name :: The face's style name. This is an ASCII */
817 /* string, usually in English, which describes */
818 /* the typeface's style (like `Italic', */
819 /* `Bold', `Condensed', etc). Not all font */
820 /* formats provide a style name, so this field */
821 /* is optional, and can be set to NULL. As */
822 /* for `family_name', some formats provide */
823 /* localized and Unicode versions of this */
824 /* string. Applications should use the format */
825 /* specific interface to access them. */
826 /* */
827 /* num_fixed_sizes :: The number of bitmap strikes in the face. */
828 /* Even if the face is scalable, there might */
829 /* still be bitmap strikes, which are called */
830 /* `sbits' in that case. */
831 /* */
832 /* available_sizes :: An array of @FT_Bitmap_Size for all bitmap */
833 /* strikes in the face. It is set to NULL if */
834 /* there is no bitmap strike. */
835 /* */
836 /* num_charmaps :: The number of charmaps in the face. */
837 /* */
838 /* charmaps :: An array of the charmaps of the face. */
839 /* */
840 /* generic :: A field reserved for client uses. See the */
841 /* @FT_Generic type description. */
842 /* */
843 /* bbox :: The font bounding box. Coordinates are */
844 /* expressed in font units (see */
845 /* `units_per_EM'). The box is large enough */
846 /* to contain any glyph from the font. Thus, */
847 /* `bbox.yMax' can be seen as the `maximal */
848 /* ascender', and `bbox.yMin' as the `minimal */
849 /* descender'. Only relevant for scalable */
850 /* formats. */
851 /* */
852 /* Note that the bounding box might be off by */
853 /* (at least) one pixel for hinted fonts. See */
854 /* @FT_Size_Metrics for further discussion. */
855 /* */
856 /* units_per_EM :: The number of font units per EM square for */
857 /* this face. This is typically 2048 for */
858 /* TrueType fonts, and 1000 for Type~1 fonts. */
859 /* Only relevant for scalable formats. */
860 /* */
861 /* ascender :: The typographic ascender of the face, */
862 /* expressed in font units. For font formats */
863 /* not having this information, it is set to */
864 /* `bbox.yMax'. Only relevant for scalable */
865 /* formats. */
866 /* */
867 /* descender :: The typographic descender of the face, */
868 /* expressed in font units. For font formats */
869 /* not having this information, it is set to */
870 /* `bbox.yMin'. Note that this field is */
871 /* usually negative. Only relevant for */
872 /* scalable formats. */
873 /* */
874 /* height :: The height is the vertical distance */
875 /* between two consecutive baselines, */
876 /* expressed in font units. It is always */
877 /* positive. Only relevant for scalable */
878 /* formats. */
879 /* */
880 /* max_advance_width :: The maximal advance width, in font units, */
881 /* for all glyphs in this face. This can be */
882 /* used to make word wrapping computations */
883 /* faster. Only relevant for scalable */
884 /* formats. */
885 /* */
886 /* max_advance_height :: The maximal advance height, in font units, */
887 /* for all glyphs in this face. This is only */
888 /* relevant for vertical layouts, and is set */
889 /* to `height' for fonts that do not provide */
890 /* vertical metrics. Only relevant for */
891 /* scalable formats. */
892 /* */
893 /* underline_position :: The position, in font units, of the */
894 /* underline line for this face. It is the */
895 /* center of the underlining stem. Only */
896 /* relevant for scalable formats. */
897 /* */
898 /* underline_thickness :: The thickness, in font units, of the */
899 /* underline for this face. Only relevant for */
900 /* scalable formats. */
901 /* */
902 /* glyph :: The face's associated glyph slot(s). */
903 /* */
904 /* size :: The current active size for this face. */
905 /* */
906 /* charmap :: The current active charmap for this face. */
907 /* */
908 /* <Note> */
909 /* Fields may be changed after a call to @FT_Attach_File or */
910 /* @FT_Attach_Stream. */
911 /* */
912 typedef struct FT_FaceRec_
913 {
914 FT_Long num_faces;
915 FT_Long face_index;
916
917 FT_Long face_flags;
918 FT_Long style_flags;
919
920 FT_Long num_glyphs;
921
922 FT_String* family_name;
923 FT_String* style_name;
924
925 FT_Int num_fixed_sizes;
926 FT_Bitmap_Size* available_sizes;
927
928 FT_Int num_charmaps;
929 FT_CharMap* charmaps;
930
931 FT_Generic generic;
932
933 /*# The following member variables (down to `underline_thickness') */
934 /*# are only relevant to scalable outlines; cf. @FT_Bitmap_Size */
935 /*# for bitmap fonts. */
936 FT_BBox bbox;
937
938 FT_UShort units_per_EM;
939 FT_Short ascender;
940 FT_Short descender;
941 FT_Short height;
942
943 FT_Short max_advance_width;
944 FT_Short max_advance_height;
945
946 FT_Short underline_position;
947 FT_Short underline_thickness;
948
949 FT_GlyphSlot glyph;
950 FT_Size size;
951 FT_CharMap charmap;
952
953 /*@private begin */
954
955 FT_Driver driver;
956 FT_Memory memory;
957 FT_Stream stream;
958
959 FT_ListRec sizes_list;
960
961 FT_Generic autohint;
962 void* extensions;
963
964 FT_Face_Internal internal;
965
966 /*@private end */
967
968 } FT_FaceRec;
969
970
971 /*************************************************************************/
972 /* */
973 /* <Enum> */
974 /* FT_FACE_FLAG_XXX */
975 /* */
976 /* <Description> */
977 /* A list of bit flags used in the `face_flags' field of the */
978 /* @FT_FaceRec structure. They inform client applications of */
979 /* properties of the corresponding face. */
980 /* */
981 /* <Values> */
982 /* FT_FACE_FLAG_SCALABLE :: */
983 /* Indicates that the face contains outline glyphs. This doesn't */
984 /* prevent bitmap strikes, i.e., a face can have both this and */
985 /* and @FT_FACE_FLAG_FIXED_SIZES set. */
986 /* */
987 /* FT_FACE_FLAG_FIXED_SIZES :: */
988 /* Indicates that the face contains bitmap strikes. See also the */
989 /* `num_fixed_sizes' and `available_sizes' fields of @FT_FaceRec. */
990 /* */
991 /* FT_FACE_FLAG_FIXED_WIDTH :: */
992 /* Indicates that the face contains fixed-width characters (like */
993 /* Courier, Lucido, MonoType, etc.). */
994 /* */
995 /* FT_FACE_FLAG_SFNT :: */
996 /* Indicates that the face uses the `sfnt' storage scheme. For */
997 /* now, this means TrueType and OpenType. */
998 /* */
999 /* FT_FACE_FLAG_HORIZONTAL :: */
1000 /* Indicates that the face contains horizontal glyph metrics. This */
1001 /* should be set for all common formats. */
1002 /* */
1003 /* FT_FACE_FLAG_VERTICAL :: */
1004 /* Indicates that the face contains vertical glyph metrics. This */
1005 /* is only available in some formats, not all of them. */
1006 /* */
1007 /* FT_FACE_FLAG_KERNING :: */
1008 /* Indicates that the face contains kerning information. If set, */
1009 /* the kerning distance can be retrieved through the function */
1010 /* @FT_Get_Kerning. Otherwise the function always return the */
1011 /* vector (0,0). Note that FreeType doesn't handle kerning data */
1012 /* from the `GPOS' table (as present in some OpenType fonts). */
1013 /* */
1014 /* FT_FACE_FLAG_FAST_GLYPHS :: */
1015 /* THIS FLAG IS DEPRECATED. DO NOT USE OR TEST IT. */
1016 /* */
1017 /* FT_FACE_FLAG_MULTIPLE_MASTERS :: */
1018 /* Indicates that the font contains multiple masters and is capable */
1019 /* of interpolating between them. See the multiple-masters */
1020 /* specific API for details. */
1021 /* */
1022 /* FT_FACE_FLAG_GLYPH_NAMES :: */
1023 /* Indicates that the font contains glyph names that can be */
1024 /* retrieved through @FT_Get_Glyph_Name. Note that some TrueType */
1025 /* fonts contain broken glyph name tables. Use the function */
1026 /* @FT_Has_PS_Glyph_Names when needed. */
1027 /* */
1028 /* FT_FACE_FLAG_EXTERNAL_STREAM :: */
1029 /* Used internally by FreeType to indicate that a face's stream was */
1030 /* provided by the client application and should not be destroyed */
1031 /* when @FT_Done_Face is called. Don't read or test this flag. */
1032 /* */
1033 /* FT_FACE_FLAG_HINTER :: */
1034 /* Set if the font driver has a hinting machine of its own. For */
1035 /* example, with TrueType fonts, it makes sense to use data from */
1036 /* the SFNT `gasp' table only if the native TrueType hinting engine */
1037 /* (with the bytecode interpreter) is available and active. */
1038 /* */
1039 /* FT_FACE_FLAG_CID_KEYED :: */
1040 /* Set if the font is CID-keyed. In that case, the font is not */
1041 /* accessed by glyph indices but by CID values. For subsetted */
1042 /* CID-keyed fonts this has the consequence that not all index */
1043 /* values are a valid argument to FT_Load_Glyph. Only the CID */
1044 /* values for which corresponding glyphs in the subsetted font */
1045 /* exist make FT_Load_Glyph return successfully; in all other cases */
1046 /* you get an `FT_Err_Invalid_Argument' error. */
1047 /* */
1048 /* Note that CID-keyed fonts which are in an SFNT wrapper don't */
1049 /* have this flag set since the glyphs are accessed in the normal */
1050 /* way (using contiguous indices); the `CID-ness' isn't visible to */
1051 /* the application. */
1052 /* */
1053 /* FT_FACE_FLAG_TRICKY :: */
1054 /* Set if the font is `tricky', this is, it always needs the */
1055 /* font format's native hinting engine to get a reasonable result. */
1056 /* A typical example is the Chinese font `mingli.ttf' which uses */
1057 /* TrueType bytecode instructions to move and scale all of its */
1058 /* subglyphs. */
1059 /* */
1060 /* It is not possible to autohint such fonts using */
1061 /* @FT_LOAD_FORCE_AUTOHINT; it will also ignore */
1062 /* @FT_LOAD_NO_HINTING. You have to set both @FT_LOAD_NO_HINTING */
1063 /* and @FT_LOAD_NO_AUTOHINT to really disable hinting; however, you */
1064 /* probably never want this except for demonstration purposes. */
1065 /* */
1066 /* Currently, there are six TrueType fonts in the list of tricky */
1067 /* fonts; they are hard-coded in file `ttobjs.c'. */
1068 /* */
1069 #define FT_FACE_FLAG_SCALABLE ( 1L << 0 )
1070 #define FT_FACE_FLAG_FIXED_SIZES ( 1L << 1 )
1071 #define FT_FACE_FLAG_FIXED_WIDTH ( 1L << 2 )
1072 #define FT_FACE_FLAG_SFNT ( 1L << 3 )
1073 #define FT_FACE_FLAG_HORIZONTAL ( 1L << 4 )
1074 #define FT_FACE_FLAG_VERTICAL ( 1L << 5 )
1075 #define FT_FACE_FLAG_KERNING ( 1L << 6 )
1076 #define FT_FACE_FLAG_FAST_GLYPHS ( 1L << 7 )
1077 #define FT_FACE_FLAG_MULTIPLE_MASTERS ( 1L << 8 )
1078 #define FT_FACE_FLAG_GLYPH_NAMES ( 1L << 9 )
1079 #define FT_FACE_FLAG_EXTERNAL_STREAM ( 1L << 10 )
1080 #define FT_FACE_FLAG_HINTER ( 1L << 11 )
1081 #define FT_FACE_FLAG_CID_KEYED ( 1L << 12 )
1082 #define FT_FACE_FLAG_TRICKY ( 1L << 13 )
1083
1084
1085 /*************************************************************************
1086 *
1087 * @macro:
1088 * FT_HAS_HORIZONTAL( face )
1089 *
1090 * @description:
1091 * A macro that returns true whenever a face object contains
1092 * horizontal metrics (this is true for all font formats though).
1093 *
1094 * @also:
1095 * @FT_HAS_VERTICAL can be used to check for vertical metrics.
1096 *
1097 */
1098 #define FT_HAS_HORIZONTAL( face ) \
1099 ( face->face_flags & FT_FACE_FLAG_HORIZONTAL )
1100
1101
1102 /*************************************************************************
1103 *
1104 * @macro:
1105 * FT_HAS_VERTICAL( face )
1106 *
1107 * @description:
1108 * A macro that returns true whenever a face object contains vertical
1109 * metrics.
1110 *
1111 */
1112 #define FT_HAS_VERTICAL( face ) \
1113 ( face->face_flags & FT_FACE_FLAG_VERTICAL )
1114
1115
1116 /*************************************************************************
1117 *
1118 * @macro:
1119 * FT_HAS_KERNING( face )
1120 *
1121 * @description:
1122 * A macro that returns true whenever a face object contains kerning
1123 * data that can be accessed with @FT_Get_Kerning.
1124 *
1125 */
1126 #define FT_HAS_KERNING( face ) \
1127 ( face->face_flags & FT_FACE_FLAG_KERNING )
1128
1129
1130 /*************************************************************************
1131 *
1132 * @macro:
1133 * FT_IS_SCALABLE( face )
1134 *
1135 * @description:
1136 * A macro that returns true whenever a face object contains a scalable
1137 * font face (true for TrueType, Type~1, Type~42, CID, OpenType/CFF,
1138 * and PFR font formats.
1139 *
1140 */
1141 #define FT_IS_SCALABLE( face ) \
1142 ( face->face_flags & FT_FACE_FLAG_SCALABLE )
1143
1144
1145 /*************************************************************************
1146 *
1147 * @macro:
1148 * FT_IS_SFNT( face )
1149 *
1150 * @description:
1151 * A macro that returns true whenever a face object contains a font
1152 * whose format is based on the SFNT storage scheme. This usually
1153 * means: TrueType fonts, OpenType fonts, as well as SFNT-based embedded
1154 * bitmap fonts.
1155 *
1156 * If this macro is true, all functions defined in @FT_SFNT_NAMES_H and
1157 * @FT_TRUETYPE_TABLES_H are available.
1158 *
1159 */
1160 #define FT_IS_SFNT( face ) \
1161 ( face->face_flags & FT_FACE_FLAG_SFNT )
1162
1163
1164 /*************************************************************************
1165 *
1166 * @macro:
1167 * FT_IS_FIXED_WIDTH( face )
1168 *
1169 * @description:
1170 * A macro that returns true whenever a face object contains a font face
1171 * that contains fixed-width (or `monospace', `fixed-pitch', etc.)
1172 * glyphs.
1173 *
1174 */
1175 #define FT_IS_FIXED_WIDTH( face ) \
1176 ( face->face_flags & FT_FACE_FLAG_FIXED_WIDTH )
1177
1178
1179 /*************************************************************************
1180 *
1181 * @macro:
1182 * FT_HAS_FIXED_SIZES( face )
1183 *
1184 * @description:
1185 * A macro that returns true whenever a face object contains some
1186 * embedded bitmaps. See the `available_sizes' field of the
1187 * @FT_FaceRec structure.
1188 *
1189 */
1190 #define FT_HAS_FIXED_SIZES( face ) \
1191 ( face->face_flags & FT_FACE_FLAG_FIXED_SIZES )
1192
1193
1194 /*************************************************************************
1195 *
1196 * @macro:
1197 * FT_HAS_FAST_GLYPHS( face )
1198 *
1199 * @description:
1200 * Deprecated.
1201 *
1202 */
1203 #define FT_HAS_FAST_GLYPHS( face ) 0
1204
1205
1206 /*************************************************************************
1207 *
1208 * @macro:
1209 * FT_HAS_GLYPH_NAMES( face )
1210 *
1211 * @description:
1212 * A macro that returns true whenever a face object contains some glyph
1213 * names that can be accessed through @FT_Get_Glyph_Name.
1214 *
1215 */
1216 #define FT_HAS_GLYPH_NAMES( face ) \
1217 ( face->face_flags & FT_FACE_FLAG_GLYPH_NAMES )
1218
1219
1220 /*************************************************************************
1221 *
1222 * @macro:
1223 * FT_HAS_MULTIPLE_MASTERS( face )
1224 *
1225 * @description:
1226 * A macro that returns true whenever a face object contains some
1227 * multiple masters. The functions provided by @FT_MULTIPLE_MASTERS_H
1228 * are then available to choose the exact design you want.
1229 *
1230 */
1231 #define FT_HAS_MULTIPLE_MASTERS( face ) \
1232 ( face->face_flags & FT_FACE_FLAG_MULTIPLE_MASTERS )
1233
1234
1235 /*************************************************************************
1236 *
1237 * @macro:
1238 * FT_IS_CID_KEYED( face )
1239 *
1240 * @description:
1241 * A macro that returns true whenever a face object contains a CID-keyed
1242 * font. See the discussion of @FT_FACE_FLAG_CID_KEYED for more
1243 * details.
1244 *
1245 * If this macro is true, all functions defined in @FT_CID_H are
1246 * available.
1247 *
1248 */
1249 #define FT_IS_CID_KEYED( face ) \
1250 ( face->face_flags & FT_FACE_FLAG_CID_KEYED )
1251
1252
1253 /*************************************************************************
1254 *
1255 * @macro:
1256 * FT_IS_TRICKY( face )
1257 *
1258 * @description:
1259 * A macro that returns true whenever a face represents a `tricky' font.
1260 * See the discussion of @FT_FACE_FLAG_TRICKY for more details.
1261 *
1262 */
1263 #define FT_IS_TRICKY( face ) \
1264 ( face->face_flags & FT_FACE_FLAG_TRICKY )
1265
1266
1267 /*************************************************************************/
1268 /* */
1269 /* <Const> */
1270 /* FT_STYLE_FLAG_XXX */
1271 /* */
1272 /* <Description> */
1273 /* A list of bit-flags used to indicate the style of a given face. */
1274 /* These are used in the `style_flags' field of @FT_FaceRec. */
1275 /* */
1276 /* <Values> */
1277 /* FT_STYLE_FLAG_ITALIC :: */
1278 /* Indicates that a given face style is italic or oblique. */
1279 /* */
1280 /* FT_STYLE_FLAG_BOLD :: */
1281 /* Indicates that a given face is bold. */
1282 /* */
1283 /* <Note> */
1284 /* The style information as provided by FreeType is very basic. More */
1285 /* details are beyond the scope and should be done on a higher level */
1286 /* (for example, by analyzing various fields of the `OS/2' table in */
1287 /* SFNT based fonts). */
1288 /* */
1289 #define FT_STYLE_FLAG_ITALIC ( 1 << 0 )
1290 #define FT_STYLE_FLAG_BOLD ( 1 << 1 )
1291
1292
1293 /*************************************************************************/
1294 /* */
1295 /* <Type> */
1296 /* FT_Size_Internal */
1297 /* */
1298 /* <Description> */
1299 /* An opaque handle to an `FT_Size_InternalRec' structure, used to */
1300 /* model private data of a given @FT_Size object. */
1301 /* */
1302 typedef struct FT_Size_InternalRec_* FT_Size_Internal;
1303
1304
1305 /*************************************************************************/
1306 /* */
1307 /* <Struct> */
1308 /* FT_Size_Metrics */
1309 /* */
1310 /* <Description> */
1311 /* The size metrics structure gives the metrics of a size object. */
1312 /* */
1313 /* <Fields> */
1314 /* x_ppem :: The width of the scaled EM square in pixels, hence */
1315 /* the term `ppem' (pixels per EM). It is also */
1316 /* referred to as `nominal width'. */
1317 /* */
1318 /* y_ppem :: The height of the scaled EM square in pixels, */
1319 /* hence the term `ppem' (pixels per EM). It is also */
1320 /* referred to as `nominal height'. */
1321 /* */
1322 /* x_scale :: A 16.16 fractional scaling value used to convert */
1323 /* horizontal metrics from font units to 26.6 */
1324 /* fractional pixels. Only relevant for scalable */
1325 /* font formats. */
1326 /* */
1327 /* y_scale :: A 16.16 fractional scaling value used to convert */
1328 /* vertical metrics from font units to 26.6 */
1329 /* fractional pixels. Only relevant for scalable */
1330 /* font formats. */
1331 /* */
1332 /* ascender :: The ascender in 26.6 fractional pixels. See */
1333 /* @FT_FaceRec for the details. */
1334 /* */
1335 /* descender :: The descender in 26.6 fractional pixels. See */
1336 /* @FT_FaceRec for the details. */
1337 /* */
1338 /* height :: The height in 26.6 fractional pixels. See */
1339 /* @FT_FaceRec for the details. */
1340 /* */
1341 /* max_advance :: The maximal advance width in 26.6 fractional */
1342 /* pixels. See @FT_FaceRec for the details. */
1343 /* */
1344 /* <Note> */
1345 /* The scaling values, if relevant, are determined first during a */
1346 /* size changing operation. The remaining fields are then set by the */
1347 /* driver. For scalable formats, they are usually set to scaled */
1348 /* values of the corresponding fields in @FT_FaceRec. */
1349 /* */
1350 /* Note that due to glyph hinting, these values might not be exact */
1351 /* for certain fonts. Thus they must be treated as unreliable */
1352 /* with an error margin of at least one pixel! */
1353 /* */
1354 /* Indeed, the only way to get the exact metrics is to render _all_ */
1355 /* glyphs. As this would be a definite performance hit, it is up to */
1356 /* client applications to perform such computations. */
1357 /* */
1358 /* The FT_Size_Metrics structure is valid for bitmap fonts also. */
1359 /* */
1360 typedef struct FT_Size_Metrics_
1361 {
1362 FT_UShort x_ppem; /* horizontal pixels per EM */
1363 FT_UShort y_ppem; /* vertical pixels per EM */
1364
1365 FT_Fixed x_scale; /* scaling values used to convert font */
1366 FT_Fixed y_scale; /* units to 26.6 fractional pixels */
1367
1368 FT_Pos ascender; /* ascender in 26.6 frac. pixels */
1369 FT_Pos descender; /* descender in 26.6 frac. pixels */
1370 FT_Pos height; /* text height in 26.6 frac. pixels */
1371 FT_Pos max_advance; /* max horizontal advance, in 26.6 pixels */
1372
1373 } FT_Size_Metrics;
1374
1375
1376 /*************************************************************************/
1377 /* */
1378 /* <Struct> */
1379 /* FT_SizeRec */
1380 /* */
1381 /* <Description> */
1382 /* FreeType root size class structure. A size object models a face */
1383 /* object at a given size. */
1384 /* */
1385 /* <Fields> */
1386 /* face :: Handle to the parent face object. */
1387 /* */
1388 /* generic :: A typeless pointer, which is unused by the FreeType */
1389 /* library or any of its drivers. It can be used by */
1390 /* client applications to link their own data to each size */
1391 /* object. */
1392 /* */
1393 /* metrics :: Metrics for this size object. This field is read-only. */
1394 /* */
1395 typedef struct FT_SizeRec_
1396 {
1397 FT_Face face; /* parent face object */
1398 FT_Generic generic; /* generic pointer for client uses */
1399 FT_Size_Metrics metrics; /* size metrics */
1400 FT_Size_Internal internal;
1401
1402 } FT_SizeRec;
1403
1404
1405 /*************************************************************************/
1406 /* */
1407 /* <Struct> */
1408 /* FT_SubGlyph */
1409 /* */
1410 /* <Description> */
1411 /* The subglyph structure is an internal object used to describe */
1412 /* subglyphs (for example, in the case of composites). */
1413 /* */
1414 /* <Note> */
1415 /* The subglyph implementation is not part of the high-level API, */
1416 /* hence the forward structure declaration. */
1417 /* */
1418 /* You can however retrieve subglyph information with */
1419 /* @FT_Get_SubGlyph_Info. */
1420 /* */
1421 typedef struct FT_SubGlyphRec_* FT_SubGlyph;
1422
1423
1424 /*************************************************************************/
1425 /* */
1426 /* <Type> */
1427 /* FT_Slot_Internal */
1428 /* */
1429 /* <Description> */
1430 /* An opaque handle to an `FT_Slot_InternalRec' structure, used to */
1431 /* model private data of a given @FT_GlyphSlot object. */
1432 /* */
1433 typedef struct FT_Slot_InternalRec_* FT_Slot_Internal;
1434
1435
1436 /*************************************************************************/
1437 /* */
1438 /* <Struct> */
1439 /* FT_GlyphSlotRec */
1440 /* */
1441 /* <Description> */
1442 /* FreeType root glyph slot class structure. A glyph slot is a */
1443 /* container where individual glyphs can be loaded, be they in */
1444 /* outline or bitmap format. */
1445 /* */
1446 /* <Fields> */
1447 /* library :: A handle to the FreeType library instance */
1448 /* this slot belongs to. */
1449 /* */
1450 /* face :: A handle to the parent face object. */
1451 /* */
1452 /* next :: In some cases (like some font tools), several */
1453 /* glyph slots per face object can be a good */
1454 /* thing. As this is rare, the glyph slots are */
1455 /* listed through a direct, single-linked list */
1456 /* using its `next' field. */
1457 /* */
1458 /* generic :: A typeless pointer which is unused by the */
1459 /* FreeType library or any of its drivers. It */
1460 /* can be used by client applications to link */
1461 /* their own data to each glyph slot object. */
1462 /* */
1463 /* metrics :: The metrics of the last loaded glyph in the */
1464 /* slot. The returned values depend on the last */
1465 /* load flags (see the @FT_Load_Glyph API */
1466 /* function) and can be expressed either in 26.6 */
1467 /* fractional pixels or font units. */
1468 /* */
1469 /* Note that even when the glyph image is */
1470 /* transformed, the metrics are not. */
1471 /* */
1472 /* linearHoriAdvance :: The advance width of the unhinted glyph. */
1473 /* Its value is expressed in 16.16 fractional */
1474 /* pixels, unless @FT_LOAD_LINEAR_DESIGN is set */
1475 /* when loading the glyph. This field can be */
1476 /* important to perform correct WYSIWYG layout. */
1477 /* Only relevant for outline glyphs. */
1478 /* */
1479 /* linearVertAdvance :: The advance height of the unhinted glyph. */
1480 /* Its value is expressed in 16.16 fractional */
1481 /* pixels, unless @FT_LOAD_LINEAR_DESIGN is set */
1482 /* when loading the glyph. This field can be */
1483 /* important to perform correct WYSIWYG layout. */
1484 /* Only relevant for outline glyphs. */
1485 /* */
1486 /* advance :: This shorthand is, depending on */
1487 /* @FT_LOAD_IGNORE_TRANSFORM, the transformed */
1488 /* advance width for the glyph (in 26.6 */
1489 /* fractional pixel format). As specified with */
1490 /* @FT_LOAD_VERTICAL_LAYOUT, it uses either the */
1491 /* `horiAdvance' or the `vertAdvance' value of */
1492 /* `metrics' field. */
1493 /* */
1494 /* format :: This field indicates the format of the image */
1495 /* contained in the glyph slot. Typically */
1496 /* @FT_GLYPH_FORMAT_BITMAP, */
1497 /* @FT_GLYPH_FORMAT_OUTLINE, or */
1498 /* @FT_GLYPH_FORMAT_COMPOSITE, but others are */
1499 /* possible. */
1500 /* */
1501 /* bitmap :: This field is used as a bitmap descriptor */
1502 /* when the slot format is */
1503 /* @FT_GLYPH_FORMAT_BITMAP. Note that the */
1504 /* address and content of the bitmap buffer can */
1505 /* change between calls of @FT_Load_Glyph and a */
1506 /* few other functions. */
1507 /* */
1508 /* bitmap_left :: This is the bitmap's left bearing expressed */
1509 /* in integer pixels. Of course, this is only */
1510 /* valid if the format is */
1511 /* @FT_GLYPH_FORMAT_BITMAP. */
1512 /* */
1513 /* bitmap_top :: This is the bitmap's top bearing expressed in */
1514 /* integer pixels. Remember that this is the */
1515 /* distance from the baseline to the top-most */
1516 /* glyph scanline, upwards y~coordinates being */
1517 /* *positive*. */
1518 /* */
1519 /* outline :: The outline descriptor for the current glyph */
1520 /* image if its format is */
1521 /* @FT_GLYPH_FORMAT_OUTLINE. Once a glyph is */
1522 /* loaded, `outline' can be transformed, */
1523 /* distorted, embolded, etc. However, it must */
1524 /* not be freed. */
1525 /* */
1526 /* num_subglyphs :: The number of subglyphs in a composite glyph. */
1527 /* This field is only valid for the composite */
1528 /* glyph format that should normally only be */
1529 /* loaded with the @FT_LOAD_NO_RECURSE flag. */
1530 /* For now this is internal to FreeType. */
1531 /* */
1532 /* subglyphs :: An array of subglyph descriptors for */
1533 /* composite glyphs. There are `num_subglyphs' */
1534 /* elements in there. Currently internal to */
1535 /* FreeType. */
1536 /* */
1537 /* control_data :: Certain font drivers can also return the */
1538 /* control data for a given glyph image (e.g. */
1539 /* TrueType bytecode, Type~1 charstrings, etc.). */
1540 /* This field is a pointer to such data. */
1541 /* */
1542 /* control_len :: This is the length in bytes of the control */
1543 /* data. */
1544 /* */
1545 /* other :: Really wicked formats can use this pointer to */
1546 /* present their own glyph image to client */
1547 /* applications. Note that the application */
1548 /* needs to know about the image format. */
1549 /* */
1550 /* lsb_delta :: The difference between hinted and unhinted */
1551 /* left side bearing while autohinting is */
1552 /* active. Zero otherwise. */
1553 /* */
1554 /* rsb_delta :: The difference between hinted and unhinted */
1555 /* right side bearing while autohinting is */
1556 /* active. Zero otherwise. */
1557 /* */
1558 /* <Note> */
1559 /* If @FT_Load_Glyph is called with default flags (see */
1560 /* @FT_LOAD_DEFAULT) the glyph image is loaded in the glyph slot in */
1561 /* its native format (e.g., an outline glyph for TrueType and Type~1 */
1562 /* formats). */
1563 /* */
1564 /* This image can later be converted into a bitmap by calling */
1565 /* @FT_Render_Glyph. This function finds the current renderer for */
1566 /* the native image's format, then invokes it. */
1567 /* */
1568 /* The renderer is in charge of transforming the native image through */
1569 /* the slot's face transformation fields, then converting it into a */
1570 /* bitmap that is returned in `slot->bitmap'. */
1571 /* */
1572 /* Note that `slot->bitmap_left' and `slot->bitmap_top' are also used */
1573 /* to specify the position of the bitmap relative to the current pen */
1574 /* position (e.g., coordinates (0,0) on the baseline). Of course, */
1575 /* `slot->format' is also changed to @FT_GLYPH_FORMAT_BITMAP. */
1576 /* */
1577 /* <Note> */
1578 /* Here a small pseudo code fragment which shows how to use */
1579 /* `lsb_delta' and `rsb_delta': */
1580 /* */
1581 /* { */
1582 /* FT_Pos origin_x = 0; */
1583 /* FT_Pos prev_rsb_delta = 0; */
1584 /* */
1585 /* */
1586 /* for all glyphs do */
1587 /* <compute kern between current and previous glyph and add it to */
1588 /* `origin_x'> */
1589 /* */
1590 /* <load glyph with `FT_Load_Glyph'> */
1591 /* */
1592 /* if ( prev_rsb_delta - face->glyph->lsb_delta >= 32 ) */
1593 /* origin_x -= 64; */
1594 /* else if ( prev_rsb_delta - face->glyph->lsb_delta < -32 ) */
1595 /* origin_x += 64; */
1596 /* */
1597 /* prev_rsb_delta = face->glyph->rsb_delta; */
1598 /* */
1599 /* <save glyph image, or render glyph, or ...> */
1600 /* */
1601 /* origin_x += face->glyph->advance.x; */
1602 /* endfor */
1603 /* } */
1604 /* */
1605 typedef struct FT_GlyphSlotRec_
1606 {
1607 FT_Library library;
1608 FT_Face face;
1609 FT_GlyphSlot next;
1610 FT_UInt reserved; /* retained for binary compatibility */
1611 FT_Generic generic;
1612
1613 FT_Glyph_Metrics metrics;
1614 FT_Fixed linearHoriAdvance;
1615 FT_Fixed linearVertAdvance;
1616 FT_Vector advance;
1617
1618 FT_Glyph_Format format;
1619
1620 FT_Bitmap bitmap;
1621 FT_Int bitmap_left;
1622 FT_Int bitmap_top;
1623
1624 FT_Outline outline;
1625
1626 FT_UInt num_subglyphs;
1627 FT_SubGlyph subglyphs;
1628
1629 void* control_data;
1630 long control_len;
1631
1632 FT_Pos lsb_delta;
1633 FT_Pos rsb_delta;
1634
1635 void* other;
1636
1637 FT_Slot_Internal internal;
1638
1639 } FT_GlyphSlotRec;
1640
1641
1642 /*************************************************************************/
1643 /*************************************************************************/
1644 /* */
1645 /* F U N C T I O N S */
1646 /* */
1647 /*************************************************************************/
1648 /*************************************************************************/
1649
1650
1651 /*************************************************************************/
1652 /* */
1653 /* <Function> */
1654 /* FT_Init_FreeType */
1655 /* */
1656 /* <Description> */
1657 /* Initialize a new FreeType library object. The set of modules */
1658 /* that are registered by this function is determined at build time. */
1659 /* */
1660 /* <Output> */
1661 /* alibrary :: A handle to a new library object. */
1662 /* */
1663 /* <Return> */
1664 /* FreeType error code. 0~means success. */
1665 /* */
1666 /* <Note> */
1667 /* In case you want to provide your own memory allocating routines, */
1668 /* use @FT_New_Library instead, followed by a call to */
1669 /* @FT_Add_Default_Modules (or a series of calls to @FT_Add_Module). */
1670 /* */
1671 FT_EXPORT( FT_Error )
1672 FT_Init_FreeType( FT_Library *alibrary );
1673
1674
1675 /*************************************************************************/
1676 /* */
1677 /* <Function> */
1678 /* FT_Done_FreeType */
1679 /* */
1680 /* <Description> */
1681 /* Destroy a given FreeType library object and all of its children, */
1682 /* including resources, drivers, faces, sizes, etc. */
1683 /* */
1684 /* <Input> */
1685 /* library :: A handle to the target library object. */
1686 /* */
1687 /* <Return> */
1688 /* FreeType error code. 0~means success. */
1689 /* */
1690 FT_EXPORT( FT_Error )
1691 FT_Done_FreeType( FT_Library library );
1692
1693
1694 /*************************************************************************/
1695 /* */
1696 /* <Enum> */
1697 /* FT_OPEN_XXX */
1698 /* */
1699 /* <Description> */
1700 /* A list of bit-field constants used within the `flags' field of the */
1701 /* @FT_Open_Args structure. */
1702 /* */
1703 /* <Values> */
1704 /* FT_OPEN_MEMORY :: This is a memory-based stream. */
1705 /* */
1706 /* FT_OPEN_STREAM :: Copy the stream from the `stream' field. */
1707 /* */
1708 /* FT_OPEN_PATHNAME :: Create a new input stream from a C~path */
1709 /* name. */
1710 /* */
1711 /* FT_OPEN_DRIVER :: Use the `driver' field. */
1712 /* */
1713 /* FT_OPEN_PARAMS :: Use the `num_params' and `params' fields. */
1714 /* */
1715 /* ft_open_memory :: Deprecated; use @FT_OPEN_MEMORY instead. */
1716 /* */
1717 /* ft_open_stream :: Deprecated; use @FT_OPEN_STREAM instead. */
1718 /* */
1719 /* ft_open_pathname :: Deprecated; use @FT_OPEN_PATHNAME instead. */
1720 /* */
1721 /* ft_open_driver :: Deprecated; use @FT_OPEN_DRIVER instead. */
1722 /* */
1723 /* ft_open_params :: Deprecated; use @FT_OPEN_PARAMS instead. */
1724 /* */
1725 /* <Note> */
1726 /* The `FT_OPEN_MEMORY', `FT_OPEN_STREAM', and `FT_OPEN_PATHNAME' */
1727 /* flags are mutually exclusive. */
1728 /* */
1729 #define FT_OPEN_MEMORY 0x1
1730 #define FT_OPEN_STREAM 0x2
1731 #define FT_OPEN_PATHNAME 0x4
1732 #define FT_OPEN_DRIVER 0x8
1733 #define FT_OPEN_PARAMS 0x10
1734
1735 #define ft_open_memory FT_OPEN_MEMORY /* deprecated */
1736 #define ft_open_stream FT_OPEN_STREAM /* deprecated */
1737 #define ft_open_pathname FT_OPEN_PATHNAME /* deprecated */
1738 #define ft_open_driver FT_OPEN_DRIVER /* deprecated */
1739 #define ft_open_params FT_OPEN_PARAMS /* deprecated */
1740
1741
1742 /*************************************************************************/
1743 /* */
1744 /* <Struct> */
1745 /* FT_Parameter */
1746 /* */
1747 /* <Description> */
1748 /* A simple structure used to pass more or less generic parameters to */
1749 /* @FT_Open_Face. */
1750 /* */
1751 /* <Fields> */
1752 /* tag :: A four-byte identification tag. */
1753 /* */
1754 /* data :: A pointer to the parameter data. */
1755 /* */
1756 /* <Note> */
1757 /* The ID and function of parameters are driver-specific. See the */
1758 /* various FT_PARAM_TAG_XXX flags for more information. */
1759 /* */
1760 typedef struct FT_Parameter_
1761 {
1762 FT_ULong tag;
1763 FT_Pointer data;
1764
1765 } FT_Parameter;
1766
1767
1768 /*************************************************************************/
1769 /* */
1770 /* <Struct> */
1771 /* FT_Open_Args */
1772 /* */
1773 /* <Description> */
1774 /* A structure used to indicate how to open a new font file or */
1775 /* stream. A pointer to such a structure can be used as a parameter */
1776 /* for the functions @FT_Open_Face and @FT_Attach_Stream. */
1777 /* */
1778 /* <Fields> */
1779 /* flags :: A set of bit flags indicating how to use the */
1780 /* structure. */
1781 /* */
1782 /* memory_base :: The first byte of the file in memory. */
1783 /* */
1784 /* memory_size :: The size in bytes of the file in memory. */
1785 /* */
1786 /* pathname :: A pointer to an 8-bit file pathname. */
1787 /* */
1788 /* stream :: A handle to a source stream object. */
1789 /* */
1790 /* driver :: This field is exclusively used by @FT_Open_Face; */
1791 /* it simply specifies the font driver to use to open */
1792 /* the face. If set to~0, FreeType tries to load the */
1793 /* face with each one of the drivers in its list. */
1794 /* */
1795 /* num_params :: The number of extra parameters. */
1796 /* */
1797 /* params :: Extra parameters passed to the font driver when */
1798 /* opening a new face. */
1799 /* */
1800 /* <Note> */
1801 /* The stream type is determined by the contents of `flags' which */
1802 /* are tested in the following order by @FT_Open_Face: */
1803 /* */
1804 /* If the `FT_OPEN_MEMORY' bit is set, assume that this is a */
1805 /* memory file of `memory_size' bytes, located at `memory_address'. */
1806 /* The data are are not copied, and the client is responsible for */
1807 /* releasing and destroying them _after_ the corresponding call to */
1808 /* @FT_Done_Face. */
1809 /* */
1810 /* Otherwise, if the `FT_OPEN_STREAM' bit is set, assume that a */
1811 /* custom input stream `stream' is used. */
1812 /* */
1813 /* Otherwise, if the `FT_OPEN_PATHNAME' bit is set, assume that this */
1814 /* is a normal file and use `pathname' to open it. */
1815 /* */
1816 /* If the `FT_OPEN_DRIVER' bit is set, @FT_Open_Face only tries to */
1817 /* open the file with the driver whose handler is in `driver'. */
1818 /* */
1819 /* If the `FT_OPEN_PARAMS' bit is set, the parameters given by */
1820 /* `num_params' and `params' is used. They are ignored otherwise. */
1821 /* */
1822 /* Ideally, both the `pathname' and `params' fields should be tagged */
1823 /* as `const'; this is missing for API backwards compatibility. In */
1824 /* other words, applications should treat them as read-only. */
1825 /* */
1826 typedef struct FT_Open_Args_
1827 {
1828 FT_UInt flags;
1829 const FT_Byte* memory_base;
1830 FT_Long memory_size;
1831 FT_String* pathname;
1832 FT_Stream stream;
1833 FT_Module driver;
1834 FT_Int num_params;
1835 FT_Parameter* params;
1836
1837 } FT_Open_Args;
1838
1839
1840 /*************************************************************************/
1841 /* */
1842 /* <Function> */
1843 /* FT_New_Face */
1844 /* */
1845 /* <Description> */
1846 /* This function calls @FT_Open_Face to open a font by its pathname. */
1847 /* */
1848 /* <InOut> */
1849 /* library :: A handle to the library resource. */
1850 /* */
1851 /* <Input> */
1852 /* pathname :: A path to the font file. */
1853 /* */
1854 /* face_index :: The index of the face within the font. The first */
1855 /* face has index~0. */
1856 /* */
1857 /* <Output> */
1858 /* aface :: A handle to a new face object. If `face_index' is */
1859 /* greater than or equal to zero, it must be non-NULL. */
1860 /* See @FT_Open_Face for more details. */
1861 /* */
1862 /* <Return> */
1863 /* FreeType error code. 0~means success. */
1864 /* */
1865 FT_EXPORT( FT_Error )
1866 FT_New_Face( FT_Library library,
1867 const char* filepathname,
1868 FT_Long face_index,
1869 FT_Face *aface );
1870
1871
1872 /*************************************************************************/
1873 /* */
1874 /* <Function> */
1875 /* FT_New_Memory_Face */
1876 /* */
1877 /* <Description> */
1878 /* This function calls @FT_Open_Face to open a font which has been */
1879 /* loaded into memory. */
1880 /* */
1881 /* <InOut> */
1882 /* library :: A handle to the library resource. */
1883 /* */
1884 /* <Input> */
1885 /* file_base :: A pointer to the beginning of the font data. */
1886 /* */
1887 /* file_size :: The size of the memory chunk used by the font data. */
1888 /* */
1889 /* face_index :: The index of the face within the font. The first */
1890 /* face has index~0. */
1891 /* */
1892 /* <Output> */
1893 /* aface :: A handle to a new face object. If `face_index' is */
1894 /* greater than or equal to zero, it must be non-NULL. */
1895 /* See @FT_Open_Face for more details. */
1896 /* */
1897 /* <Return> */
1898 /* FreeType error code. 0~means success. */
1899 /* */
1900 /* <Note> */
1901 /* You must not deallocate the memory before calling @FT_Done_Face. */
1902 /* */
1903 FT_EXPORT( FT_Error )
1904 FT_New_Memory_Face( FT_Library library,
1905 const FT_Byte* file_base,
1906 FT_Long file_size,
1907 FT_Long face_index,
1908 FT_Face *aface );
1909
1910
1911 /*************************************************************************/
1912 /* */
1913 /* <Function> */
1914 /* FT_Open_Face */
1915 /* */
1916 /* <Description> */
1917 /* Create a face object from a given resource described by */
1918 /* @FT_Open_Args. */
1919 /* */
1920 /* <InOut> */
1921 /* library :: A handle to the library resource. */
1922 /* */
1923 /* <Input> */
1924 /* args :: A pointer to an `FT_Open_Args' structure which must */
1925 /* be filled by the caller. */
1926 /* */
1927 /* face_index :: The index of the face within the font. The first */
1928 /* face has index~0. */
1929 /* */
1930 /* <Output> */
1931 /* aface :: A handle to a new face object. If `face_index' is */
1932 /* greater than or equal to zero, it must be non-NULL. */
1933 /* See note below. */
1934 /* */
1935 /* <Return> */
1936 /* FreeType error code. 0~means success. */
1937 /* */
1938 /* <Note> */
1939 /* Unlike FreeType 1.x, this function automatically creates a glyph */
1940 /* slot for the face object which can be accessed directly through */
1941 /* `face->glyph'. */
1942 /* */
1943 /* FT_Open_Face can be used to quickly check whether the font */
1944 /* format of a given font resource is supported by FreeType. If the */
1945 /* `face_index' field is negative, the function's return value is~0 */
1946 /* if the font format is recognized, or non-zero otherwise; */
1947 /* the function returns a more or less empty face handle in `*aface' */
1948 /* (if `aface' isn't NULL). The only useful field in this special */
1949 /* case is `face->num_faces' which gives the number of faces within */
1950 /* the font file. After examination, the returned @FT_Face structure */
1951 /* should be deallocated with a call to @FT_Done_Face. */
1952 /* */
1953 /* Each new face object created with this function also owns a */
1954 /* default @FT_Size object, accessible as `face->size'. */
1955 /* */
1956 /* See the discussion of reference counters in the description of */
1957 /* @FT_Reference_Face. */
1958 /* */
1959 FT_EXPORT( FT_Error )
1960 FT_Open_Face( FT_Library library,
1961 const FT_Open_Args* args,
1962 FT_Long face_index,
1963 FT_Face *aface );
1964
1965
1966 /*************************************************************************/
1967 /* */
1968 /* <Function> */
1969 /* FT_Attach_File */
1970 /* */
1971 /* <Description> */
1972 /* This function calls @FT_Attach_Stream to attach a file. */
1973 /* */
1974 /* <InOut> */
1975 /* face :: The target face object. */
1976 /* */
1977 /* <Input> */
1978 /* filepathname :: The pathname. */
1979 /* */
1980 /* <Return> */
1981 /* FreeType error code. 0~means success. */
1982 /* */
1983 FT_EXPORT( FT_Error )
1984 FT_Attach_File( FT_Face face,
1985 const char* filepathname );
1986
1987
1988 /*************************************************************************/
1989 /* */
1990 /* <Function> */
1991 /* FT_Attach_Stream */
1992 /* */
1993 /* <Description> */
1994 /* `Attach' data to a face object. Normally, this is used to read */
1995 /* additional information for the face object. For example, you can */
1996 /* attach an AFM file that comes with a Type~1 font to get the */
1997 /* kerning values and other metrics. */
1998 /* */
1999 /* <InOut> */
2000 /* face :: The target face object. */
2001 /* */
2002 /* <Input> */
2003 /* parameters :: A pointer to @FT_Open_Args which must be filled by */
2004 /* the caller. */
2005 /* */
2006 /* <Return> */
2007 /* FreeType error code. 0~means success. */
2008 /* */
2009 /* <Note> */
2010 /* The meaning of the `attach' (i.e., what really happens when the */
2011 /* new file is read) is not fixed by FreeType itself. It really */
2012 /* depends on the font format (and thus the font driver). */
2013 /* */
2014 /* Client applications are expected to know what they are doing */
2015 /* when invoking this function. Most drivers simply do not implement */
2016 /* file attachments. */
2017 /* */
2018 FT_EXPORT( FT_Error )
2019 FT_Attach_Stream( FT_Face face,
2020 FT_Open_Args* parameters );
2021
2022
2023 /*************************************************************************/
2024 /* */
2025 /* <Function> */
2026 /* FT_Reference_Face */
2027 /* */
2028 /* <Description> */
2029 /* A counter gets initialized to~1 at the time an @FT_Face structure */
2030 /* is created. This function increments the counter. @FT_Done_Face */
2031 /* then only destroys a face if the counter is~1, otherwise it simply */
2032 /* decrements the counter. */
2033 /* */
2034 /* This function helps in managing life-cycles of structures which */
2035 /* reference @FT_Face objects. */
2036 /* */
2037 /* <Input> */
2038 /* face :: A handle to a target face object. */
2039 /* */
2040 /* <Return> */
2041 /* FreeType error code. 0~means success. */
2042 /* */
2043 /* <Since> */
2044 /* 2.4.2 */
2045 /* */
2046 FT_EXPORT( FT_Error )
2047 FT_Reference_Face( FT_Face face );
2048
2049
2050 /*************************************************************************/
2051 /* */
2052 /* <Function> */
2053 /* FT_Done_Face */
2054 /* */
2055 /* <Description> */
2056 /* Discard a given face object, as well as all of its child slots and */
2057 /* sizes. */
2058 /* */
2059 /* <Input> */
2060 /* face :: A handle to a target face object. */
2061 /* */
2062 /* <Return> */
2063 /* FreeType error code. 0~means success. */
2064 /* */
2065 /* <Note> */
2066 /* See the discussion of reference counters in the description of */
2067 /* @FT_Reference_Face. */
2068 /* */
2069 FT_EXPORT( FT_Error )
2070 FT_Done_Face( FT_Face face );
2071
2072
2073 /*************************************************************************/
2074 /* */
2075 /* <Function> */
2076 /* FT_Select_Size */
2077 /* */
2078 /* <Description> */
2079 /* Select a bitmap strike. */
2080 /* */
2081 /* <InOut> */
2082 /* face :: A handle to a target face object. */
2083 /* */
2084 /* <Input> */
2085 /* strike_index :: The index of the bitmap strike in the */
2086 /* `available_sizes' field of @FT_FaceRec structure. */
2087 /* */
2088 /* <Return> */
2089 /* FreeType error code. 0~means success. */
2090 /* */
2091 FT_EXPORT( FT_Error )
2092 FT_Select_Size( FT_Face face,
2093 FT_Int strike_index );
2094
2095
2096 /*************************************************************************/
2097 /* */
2098 /* <Enum> */
2099 /* FT_Size_Request_Type */
2100 /* */
2101 /* <Description> */
2102 /* An enumeration type that lists the supported size request types. */
2103 /* */
2104 /* <Values> */
2105 /* FT_SIZE_REQUEST_TYPE_NOMINAL :: */
2106 /* The nominal size. The `units_per_EM' field of @FT_FaceRec is */
2107 /* used to determine both scaling values. */
2108 /* */
2109 /* FT_SIZE_REQUEST_TYPE_REAL_DIM :: */
2110 /* The real dimension. The sum of the the `Ascender' and (minus */
2111 /* of) the `Descender' fields of @FT_FaceRec are used to determine */
2112 /* both scaling values. */
2113 /* */
2114 /* FT_SIZE_REQUEST_TYPE_BBOX :: */
2115 /* The font bounding box. The width and height of the `bbox' field */
2116 /* of @FT_FaceRec are used to determine the horizontal and vertical */
2117 /* scaling value, respectively. */
2118 /* */
2119 /* FT_SIZE_REQUEST_TYPE_CELL :: */
2120 /* The `max_advance_width' field of @FT_FaceRec is used to */
2121 /* determine the horizontal scaling value; the vertical scaling */
2122 /* value is determined the same way as */
2123 /* @FT_SIZE_REQUEST_TYPE_REAL_DIM does. Finally, both scaling */
2124 /* values are set to the smaller one. This type is useful if you */
2125 /* want to specify the font size for, say, a window of a given */
2126 /* dimension and 80x24 cells. */
2127 /* */
2128 /* FT_SIZE_REQUEST_TYPE_SCALES :: */
2129 /* Specify the scaling values directly. */
2130 /* */
2131 /* <Note> */
2132 /* The above descriptions only apply to scalable formats. For bitmap */
2133 /* formats, the behaviour is up to the driver. */
2134 /* */
2135 /* See the note section of @FT_Size_Metrics if you wonder how size */
2136 /* requesting relates to scaling values. */
2137 /* */
2138 typedef enum FT_Size_Request_Type_
2139 {
2140 FT_SIZE_REQUEST_TYPE_NOMINAL,
2141 FT_SIZE_REQUEST_TYPE_REAL_DIM,
2142 FT_SIZE_REQUEST_TYPE_BBOX,
2143 FT_SIZE_REQUEST_TYPE_CELL,
2144 FT_SIZE_REQUEST_TYPE_SCALES,
2145
2146 FT_SIZE_REQUEST_TYPE_MAX
2147
2148 } FT_Size_Request_Type;
2149
2150
2151 /*************************************************************************/
2152 /* */
2153 /* <Struct> */
2154 /* FT_Size_RequestRec */
2155 /* */
2156 /* <Description> */
2157 /* A structure used to model a size request. */
2158 /* */
2159 /* <Fields> */
2160 /* type :: See @FT_Size_Request_Type. */
2161 /* */
2162 /* width :: The desired width. */
2163 /* */
2164 /* height :: The desired height. */
2165 /* */
2166 /* horiResolution :: The horizontal resolution. If set to zero, */
2167 /* `width' is treated as a 26.6 fractional pixel */
2168 /* value. */
2169 /* */
2170 /* vertResolution :: The vertical resolution. If set to zero, */
2171 /* `height' is treated as a 26.6 fractional pixel */
2172 /* value. */
2173 /* */
2174 /* <Note> */
2175 /* If `width' is zero, then the horizontal scaling value is set equal */
2176 /* to the vertical scaling value, and vice versa. */
2177 /* */
2178 typedef struct FT_Size_RequestRec_
2179 {
2180 FT_Size_Request_Type type;
2181 FT_Long width;
2182 FT_Long height;
2183 FT_UInt horiResolution;
2184 FT_UInt vertResolution;
2185
2186 } FT_Size_RequestRec;
2187
2188
2189 /*************************************************************************/
2190 /* */
2191 /* <Struct> */
2192 /* FT_Size_Request */
2193 /* */
2194 /* <Description> */
2195 /* A handle to a size request structure. */
2196 /* */
2197 typedef struct FT_Size_RequestRec_ *FT_Size_Request;
2198
2199
2200 /*************************************************************************/
2201 /* */
2202 /* <Function> */
2203 /* FT_Request_Size */
2204 /* */
2205 /* <Description> */
2206 /* Resize the scale of the active @FT_Size object in a face. */
2207 /* */
2208 /* <InOut> */
2209 /* face :: A handle to a target face object. */
2210 /* */
2211 /* <Input> */
2212 /* req :: A pointer to a @FT_Size_RequestRec. */
2213 /* */
2214 /* <Return> */
2215 /* FreeType error code. 0~means success. */
2216 /* */
2217 /* <Note> */
2218 /* Although drivers may select the bitmap strike matching the */
2219 /* request, you should not rely on this if you intend to select a */
2220 /* particular bitmap strike. Use @FT_Select_Size instead in that */
2221 /* case. */
2222 /* */
2223 FT_EXPORT( FT_Error )
2224 FT_Request_Size( FT_Face face,
2225 FT_Size_Request req );
2226
2227
2228 /*************************************************************************/
2229 /* */
2230 /* <Function> */
2231 /* FT_Set_Char_Size */
2232 /* */
2233 /* <Description> */
2234 /* This function calls @FT_Request_Size to request the nominal size */
2235 /* (in points). */
2236 /* */
2237 /* <InOut> */
2238 /* face :: A handle to a target face object. */
2239 /* */
2240 /* <Input> */
2241 /* char_width :: The nominal width, in 26.6 fractional points. */
2242 /* */
2243 /* char_height :: The nominal height, in 26.6 fractional points. */
2244 /* */
2245 /* horz_resolution :: The horizontal resolution in dpi. */
2246 /* */
2247 /* vert_resolution :: The vertical resolution in dpi. */
2248 /* */
2249 /* <Return> */
2250 /* FreeType error code. 0~means success. */
2251 /* */
2252 /* <Note> */
2253 /* If either the character width or height is zero, it is set equal */
2254 /* to the other value. */
2255 /* */
2256 /* If either the horizontal or vertical resolution is zero, it is set */
2257 /* equal to the other value. */
2258 /* */
2259 /* A character width or height smaller than 1pt is set to 1pt; if */
2260 /* both resolution values are zero, they are set to 72dpi. */
2261 /* */
2262 /* Don't use this function if you are using the FreeType cache API. */
2263 /* */
2264 FT_EXPORT( FT_Error )
2265 FT_Set_Char_Size( FT_Face face,
2266 FT_F26Dot6 char_width,
2267 FT_F26Dot6 char_height,
2268 FT_UInt horz_resolution,
2269 FT_UInt vert_resolution );
2270
2271
2272 /*************************************************************************/
2273 /* */
2274 /* <Function> */
2275 /* FT_Set_Pixel_Sizes */
2276 /* */
2277 /* <Description> */
2278 /* This function calls @FT_Request_Size to request the nominal size */
2279 /* (in pixels). */
2280 /* */
2281 /* <InOut> */
2282 /* face :: A handle to the target face object. */
2283 /* */
2284 /* <Input> */
2285 /* pixel_width :: The nominal width, in pixels. */
2286 /* */
2287 /* pixel_height :: The nominal height, in pixels. */
2288 /* */
2289 /* <Return> */
2290 /* FreeType error code. 0~means success. */
2291 /* */
2292 FT_EXPORT( FT_Error )
2293 FT_Set_Pixel_Sizes( FT_Face face,
2294 FT_UInt pixel_width,
2295 FT_UInt pixel_height );
2296
2297
2298 /*************************************************************************/
2299 /* */
2300 /* <Function> */
2301 /* FT_Load_Glyph */
2302 /* */
2303 /* <Description> */
2304 /* A function used to load a single glyph into the glyph slot of a */
2305 /* face object. */
2306 /* */
2307 /* <InOut> */
2308 /* face :: A handle to the target face object where the glyph */
2309 /* is loaded. */
2310 /* */
2311 /* <Input> */
2312 /* glyph_index :: The index of the glyph in the font file. For */
2313 /* CID-keyed fonts (either in PS or in CFF format) */
2314 /* this argument specifies the CID value. */
2315 /* */
2316 /* load_flags :: A flag indicating what to load for this glyph. The */
2317 /* @FT_LOAD_XXX constants can be used to control the */
2318 /* glyph loading process (e.g., whether the outline */
2319 /* should be scaled, whether to load bitmaps or not, */
2320 /* whether to hint the outline, etc). */
2321 /* */
2322 /* <Return> */
2323 /* FreeType error code. 0~means success. */
2324 /* */
2325 /* <Note> */
2326 /* The loaded glyph may be transformed. See @FT_Set_Transform for */
2327 /* the details. */
2328 /* */
2329 /* For subsetted CID-keyed fonts, `FT_Err_Invalid_Argument' is */
2330 /* returned for invalid CID values (this is, for CID values which */
2331 /* don't have a corresponding glyph in the font). See the discussion */
2332 /* of the @FT_FACE_FLAG_CID_KEYED flag for more details. */
2333 /* */
2334 FT_EXPORT( FT_Error )
2335 FT_Load_Glyph( FT_Face face,
2336 FT_UInt glyph_index,
2337 FT_Int32 load_flags );
2338
2339
2340 /*************************************************************************/
2341 /* */
2342 /* <Function> */
2343 /* FT_Load_Char */
2344 /* */
2345 /* <Description> */
2346 /* A function used to load a single glyph into the glyph slot of a */
2347 /* face object, according to its character code. */
2348 /* */
2349 /* <InOut> */
2350 /* face :: A handle to a target face object where the glyph */
2351 /* is loaded. */
2352 /* */
2353 /* <Input> */
2354 /* char_code :: The glyph's character code, according to the */
2355 /* current charmap used in the face. */
2356 /* */
2357 /* load_flags :: A flag indicating what to load for this glyph. The */
2358 /* @FT_LOAD_XXX constants can be used to control the */
2359 /* glyph loading process (e.g., whether the outline */
2360 /* should be scaled, whether to load bitmaps or not, */
2361 /* whether to hint the outline, etc). */
2362 /* */
2363 /* <Return> */
2364 /* FreeType error code. 0~means success. */
2365 /* */
2366 /* <Note> */
2367 /* This function simply calls @FT_Get_Char_Index and @FT_Load_Glyph. */
2368 /* */
2369 FT_EXPORT( FT_Error )
2370 FT_Load_Char( FT_Face face,
2371 FT_ULong char_code,
2372 FT_Int32 load_flags );
2373
2374
2375 /*************************************************************************
2376 *
2377 * @enum:
2378 * FT_LOAD_XXX
2379 *
2380 * @description:
2381 * A list of bit-field constants used with @FT_Load_Glyph to indicate
2382 * what kind of operations to perform during glyph loading.
2383 *
2384 * @values:
2385 * FT_LOAD_DEFAULT ::
2386 * Corresponding to~0, this value is used as the default glyph load
2387 * operation. In this case, the following happens:
2388 *
2389 * 1. FreeType looks for a bitmap for the glyph corresponding to the
2390 * face's current size. If one is found, the function returns.
2391 * The bitmap data can be accessed from the glyph slot (see note
2392 * below).
2393 *
2394 * 2. If no embedded bitmap is searched or found, FreeType looks for a
2395 * scalable outline. If one is found, it is loaded from the font
2396 * file, scaled to device pixels, then `hinted' to the pixel grid
2397 * in order to optimize it. The outline data can be accessed from
2398 * the glyph slot (see note below).
2399 *
2400 * Note that by default, the glyph loader doesn't render outlines into
2401 * bitmaps. The following flags are used to modify this default
2402 * behaviour to more specific and useful cases.
2403 *
2404 * FT_LOAD_NO_SCALE ::
2405 * Don't scale the outline glyph loaded, but keep it in font units.
2406 *
2407 * This flag implies @FT_LOAD_NO_HINTING and @FT_LOAD_NO_BITMAP, and
2408 * unsets @FT_LOAD_RENDER.
2409 *
2410 * FT_LOAD_NO_HINTING ::
2411 * Disable hinting. This generally generates `blurrier' bitmap glyph
2412 * when the glyph is rendered in any of the anti-aliased modes. See
2413 * also the note below.
2414 *
2415 * This flag is implied by @FT_LOAD_NO_SCALE.
2416 *
2417 * FT_LOAD_RENDER ::
2418 * Call @FT_Render_Glyph after the glyph is loaded. By default, the
2419 * glyph is rendered in @FT_RENDER_MODE_NORMAL mode. This can be
2420 * overridden by @FT_LOAD_TARGET_XXX or @FT_LOAD_MONOCHROME.
2421 *
2422 * This flag is unset by @FT_LOAD_NO_SCALE.
2423 *
2424 * FT_LOAD_NO_BITMAP ::
2425 * Ignore bitmap strikes when loading. Bitmap-only fonts ignore this
2426 * flag.
2427 *
2428 * @FT_LOAD_NO_SCALE always sets this flag.
2429 *
2430 * FT_LOAD_VERTICAL_LAYOUT ::
2431 * Load the glyph for vertical text layout. _Don't_ use it as it is
2432 * problematic currently.
2433 *
2434 * FT_LOAD_FORCE_AUTOHINT ::
2435 * Indicates that the auto-hinter is preferred over the font's native
2436 * hinter. See also the note below.
2437 *
2438 * FT_LOAD_CROP_BITMAP ::
2439 * Indicates that the font driver should crop the loaded bitmap glyph
2440 * (i.e., remove all space around its black bits). Not all drivers
2441 * implement this.
2442 *
2443 * FT_LOAD_PEDANTIC ::
2444 * Indicates that the font driver should perform pedantic verifications
2445 * during glyph loading. This is mostly used to detect broken glyphs
2446 * in fonts. By default, FreeType tries to handle broken fonts also.
2447 *
2448 * FT_LOAD_IGNORE_GLOBAL_ADVANCE_WIDTH ::
2449 * Ignored. Deprecated.
2450 *
2451 * FT_LOAD_NO_RECURSE ::
2452 * This flag is only used internally. It merely indicates that the
2453 * font driver should not load composite glyphs recursively. Instead,
2454 * it should set the `num_subglyph' and `subglyphs' values of the
2455 * glyph slot accordingly, and set `glyph->format' to
2456 * @FT_GLYPH_FORMAT_COMPOSITE.
2457 *
2458 * The description of sub-glyphs is not available to client
2459 * applications for now.
2460 *
2461 * This flag implies @FT_LOAD_NO_SCALE and @FT_LOAD_IGNORE_TRANSFORM.
2462 *
2463 * FT_LOAD_IGNORE_TRANSFORM ::
2464 * Indicates that the transform matrix set by @FT_Set_Transform should
2465 * be ignored.
2466 *
2467 * FT_LOAD_MONOCHROME ::
2468 * This flag is used with @FT_LOAD_RENDER to indicate that you want to
2469 * render an outline glyph to a 1-bit monochrome bitmap glyph, with
2470 * 8~pixels packed into each byte of the bitmap data.
2471 *
2472 * Note that this has no effect on the hinting algorithm used. You
2473 * should rather use @FT_LOAD_TARGET_MONO so that the
2474 * monochrome-optimized hinting algorithm is used.
2475 *
2476 * FT_LOAD_LINEAR_DESIGN ::
2477 * Indicates that the `linearHoriAdvance' and `linearVertAdvance'
2478 * fields of @FT_GlyphSlotRec should be kept in font units. See
2479 * @FT_GlyphSlotRec for details.
2480 *
2481 * FT_LOAD_NO_AUTOHINT ::
2482 * Disable auto-hinter. See also the note below.
2483 *
2484 * @note:
2485 * By default, hinting is enabled and the font's native hinter (see
2486 * @FT_FACE_FLAG_HINTER) is preferred over the auto-hinter. You can
2487 * disable hinting by setting @FT_LOAD_NO_HINTING or change the
2488 * precedence by setting @FT_LOAD_FORCE_AUTOHINT. You can also set
2489 * @FT_LOAD_NO_AUTOHINT in case you don't want the auto-hinter to be
2490 * used at all.
2491 *
2492 * See the description of @FT_FACE_FLAG_TRICKY for a special exception
2493 * (affecting only a handful of Asian fonts).
2494 *
2495 * Besides deciding which hinter to use, you can also decide which
2496 * hinting algorithm to use. See @FT_LOAD_TARGET_XXX for details.
2497 *
2498 */
2499 #define FT_LOAD_DEFAULT 0x0
2500 #define FT_LOAD_NO_SCALE 0x1
2501 #define FT_LOAD_NO_HINTING 0x2
2502 #define FT_LOAD_RENDER 0x4
2503 #define FT_LOAD_NO_BITMAP 0x8
2504 #define FT_LOAD_VERTICAL_LAYOUT 0x10
2505 #define FT_LOAD_FORCE_AUTOHINT 0x20
2506 #define FT_LOAD_CROP_BITMAP 0x40
2507 #define FT_LOAD_PEDANTIC 0x80
2508 #define FT_LOAD_IGNORE_GLOBAL_ADVANCE_WIDTH 0x200
2509 #define FT_LOAD_NO_RECURSE 0x400
2510 #define FT_LOAD_IGNORE_TRANSFORM 0x800
2511 #define FT_LOAD_MONOCHROME 0x1000
2512 #define FT_LOAD_LINEAR_DESIGN 0x2000
2513 #define FT_LOAD_NO_AUTOHINT 0x8000U
2514
2515 /* */
2516
2517 /* used internally only by certain font drivers! */
2518 #define FT_LOAD_ADVANCE_ONLY 0x100
2519 #define FT_LOAD_SBITS_ONLY 0x4000
2520
2521
2522 /**************************************************************************
2523 *
2524 * @enum:
2525 * FT_LOAD_TARGET_XXX
2526 *
2527 * @description:
2528 * A list of values that are used to select a specific hinting algorithm
2529 * to use by the hinter. You should OR one of these values to your
2530 * `load_flags' when calling @FT_Load_Glyph.
2531 *
2532 * Note that font's native hinters may ignore the hinting algorithm you
2533 * have specified (e.g., the TrueType bytecode interpreter). You can set
2534 * @FT_LOAD_FORCE_AUTOHINT to ensure that the auto-hinter is used.
2535 *
2536 * Also note that @FT_LOAD_TARGET_LIGHT is an exception, in that it
2537 * always implies @FT_LOAD_FORCE_AUTOHINT.
2538 *
2539 * @values:
2540 * FT_LOAD_TARGET_NORMAL ::
2541 * This corresponds to the default hinting algorithm, optimized for
2542 * standard gray-level rendering. For monochrome output, use
2543 * @FT_LOAD_TARGET_MONO instead.
2544 *
2545 * FT_LOAD_TARGET_LIGHT ::
2546 * A lighter hinting algorithm for non-monochrome modes. Many
2547 * generated glyphs are more fuzzy but better resemble its original
2548 * shape. A bit like rendering on Mac OS~X.
2549 *
2550 * As a special exception, this target implies @FT_LOAD_FORCE_AUTOHINT.
2551 *
2552 * FT_LOAD_TARGET_MONO ::
2553 * Strong hinting algorithm that should only be used for monochrome
2554 * output. The result is probably unpleasant if the glyph is rendered
2555 * in non-monochrome modes.
2556 *
2557 * FT_LOAD_TARGET_LCD ::
2558 * A variant of @FT_LOAD_TARGET_NORMAL optimized for horizontally
2559 * decimated LCD displays.
2560 *
2561 * FT_LOAD_TARGET_LCD_V ::
2562 * A variant of @FT_LOAD_TARGET_NORMAL optimized for vertically
2563 * decimated LCD displays.
2564 *
2565 * @note:
2566 * You should use only _one_ of the FT_LOAD_TARGET_XXX values in your
2567 * `load_flags'. They can't be ORed.
2568 *
2569 * If @FT_LOAD_RENDER is also set, the glyph is rendered in the
2570 * corresponding mode (i.e., the mode which matches the used algorithm
2571 * best) unless @FT_LOAD_MONOCHROME is set.
2572 *
2573 * You can use a hinting algorithm that doesn't correspond to the same
2574 * rendering mode. As an example, it is possible to use the `light'
2575 * hinting algorithm and have the results rendered in horizontal LCD
2576 * pixel mode, with code like
2577 *
2578 * {
2579 * FT_Load_Glyph( face, glyph_index,
2580 * load_flags | FT_LOAD_TARGET_LIGHT );
2581 *
2582 * FT_Render_Glyph( face->glyph, FT_RENDER_MODE_LCD );
2583 * }
2584 *
2585 */
2586 #define FT_LOAD_TARGET_( x ) ( (FT_Int32)( (x) & 15 ) << 16 )
2587
2588 #define FT_LOAD_TARGET_NORMAL FT_LOAD_TARGET_( FT_RENDER_MODE_NORMAL )
2589 #define FT_LOAD_TARGET_LIGHT FT_LOAD_TARGET_( FT_RENDER_MODE_LIGHT )
2590 #define FT_LOAD_TARGET_MONO FT_LOAD_TARGET_( FT_RENDER_MODE_MONO )
2591 #define FT_LOAD_TARGET_LCD FT_LOAD_TARGET_( FT_RENDER_MODE_LCD )
2592 #define FT_LOAD_TARGET_LCD_V FT_LOAD_TARGET_( FT_RENDER_MODE_LCD_V )
2593
2594
2595 /**************************************************************************
2596 *
2597 * @macro:
2598 * FT_LOAD_TARGET_MODE
2599 *
2600 * @description:
2601 * Return the @FT_Render_Mode corresponding to a given
2602 * @FT_LOAD_TARGET_XXX value.
2603 *
2604 */
2605 #define FT_LOAD_TARGET_MODE( x ) ( (FT_Render_Mode)( ( (x) >> 16 ) & 15 ) )
2606
2607
2608 /*************************************************************************/
2609 /* */
2610 /* <Function> */
2611 /* FT_Set_Transform */
2612 /* */
2613 /* <Description> */
2614 /* A function used to set the transformation that is applied to glyph */
2615 /* images when they are loaded into a glyph slot through */
2616 /* @FT_Load_Glyph. */
2617 /* */
2618 /* <InOut> */
2619 /* face :: A handle to the source face object. */
2620 /* */
2621 /* <Input> */
2622 /* matrix :: A pointer to the transformation's 2x2 matrix. Use~0 for */
2623 /* the identity matrix. */
2624 /* delta :: A pointer to the translation vector. Use~0 for the null */
2625 /* vector. */
2626 /* */
2627 /* <Note> */
2628 /* The transformation is only applied to scalable image formats after */
2629 /* the glyph has been loaded. It means that hinting is unaltered by */
2630 /* the transformation and is performed on the character size given in */
2631 /* the last call to @FT_Set_Char_Size or @FT_Set_Pixel_Sizes. */
2632 /* */
2633 /* Note that this also transforms the `face.glyph.advance' field, but */
2634 /* *not* the values in `face.glyph.metrics'. */
2635 /* */
2636 FT_EXPORT( void )
2637 FT_Set_Transform( FT_Face face,
2638 FT_Matrix* matrix,
2639 FT_Vector* delta );
2640
2641
2642 /*************************************************************************/
2643 /* */
2644 /* <Enum> */
2645 /* FT_Render_Mode */
2646 /* */
2647 /* <Description> */
2648 /* An enumeration type that lists the render modes supported by */
2649 /* FreeType~2. Each mode corresponds to a specific type of scanline */
2650 /* conversion performed on the outline. */
2651 /* */
2652 /* For bitmap fonts and embedded bitmaps the `bitmap->pixel_mode' */
2653 /* field in the @FT_GlyphSlotRec structure gives the format of the */
2654 /* returned bitmap. */
2655 /* */
2656 /* All modes except @FT_RENDER_MODE_MONO use 256 levels of opacity. */
2657 /* */
2658 /* <Values> */
2659 /* FT_RENDER_MODE_NORMAL :: */
2660 /* This is the default render mode; it corresponds to 8-bit */
2661 /* anti-aliased bitmaps. */
2662 /* */
2663 /* FT_RENDER_MODE_LIGHT :: */
2664 /* This is equivalent to @FT_RENDER_MODE_NORMAL. It is only */
2665 /* defined as a separate value because render modes are also used */
2666 /* indirectly to define hinting algorithm selectors. See */
2667 /* @FT_LOAD_TARGET_XXX for details. */
2668 /* */
2669 /* FT_RENDER_MODE_MONO :: */
2670 /* This mode corresponds to 1-bit bitmaps (with 2~levels of */
2671 /* opacity). */
2672 /* */
2673 /* FT_RENDER_MODE_LCD :: */
2674 /* This mode corresponds to horizontal RGB and BGR sub-pixel */
2675 /* displays like LCD screens. It produces 8-bit bitmaps that are */
2676 /* 3~times the width of the original glyph outline in pixels, and */
2677 /* which use the @FT_PIXEL_MODE_LCD mode. */
2678 /* */
2679 /* FT_RENDER_MODE_LCD_V :: */
2680 /* This mode corresponds to vertical RGB and BGR sub-pixel displays */
2681 /* (like PDA screens, rotated LCD displays, etc.). It produces */
2682 /* 8-bit bitmaps that are 3~times the height of the original */
2683 /* glyph outline in pixels and use the @FT_PIXEL_MODE_LCD_V mode. */
2684 /* */
2685 /* <Note> */
2686 /* The LCD-optimized glyph bitmaps produced by FT_Render_Glyph can be */
2687 /* filtered to reduce color-fringes by using @FT_Library_SetLcdFilter */
2688 /* (not active in the default builds). It is up to the caller to */
2689 /* either call @FT_Library_SetLcdFilter (if available) or do the */
2690 /* filtering itself. */
2691 /* */
2692 /* The selected render mode only affects vector glyphs of a font. */
2693 /* Embedded bitmaps often have a different pixel mode like */
2694 /* @FT_PIXEL_MODE_MONO. You can use @FT_Bitmap_Convert to transform */
2695 /* them into 8-bit pixmaps. */
2696 /* */
2697 typedef enum FT_Render_Mode_
2698 {
2699 FT_RENDER_MODE_NORMAL = 0,
2700 FT_RENDER_MODE_LIGHT,
2701 FT_RENDER_MODE_MONO,
2702 FT_RENDER_MODE_LCD,
2703 FT_RENDER_MODE_LCD_V,
2704
2705 FT_RENDER_MODE_MAX
2706
2707 } FT_Render_Mode;
2708
2709
2710 /*************************************************************************/
2711 /* */
2712 /* <Enum> */
2713 /* ft_render_mode_xxx */
2714 /* */
2715 /* <Description> */
2716 /* These constants are deprecated. Use the corresponding */
2717 /* @FT_Render_Mode values instead. */
2718 /* */
2719 /* <Values> */
2720 /* ft_render_mode_normal :: see @FT_RENDER_MODE_NORMAL */
2721 /* ft_render_mode_mono :: see @FT_RENDER_MODE_MONO */
2722 /* */
2723 #define ft_render_mode_normal FT_RENDER_MODE_NORMAL
2724 #define ft_render_mode_mono FT_RENDER_MODE_MONO
2725
2726
2727 /*************************************************************************/
2728 /* */
2729 /* <Function> */
2730 /* FT_Render_Glyph */
2731 /* */
2732 /* <Description> */
2733 /* Convert a given glyph image to a bitmap. It does so by inspecting */
2734 /* the glyph image format, finding the relevant renderer, and */
2735 /* invoking it. */
2736 /* */
2737 /* <InOut> */
2738 /* slot :: A handle to the glyph slot containing the image to */
2739 /* convert. */
2740 /* */
2741 /* <Input> */
2742 /* render_mode :: This is the render mode used to render the glyph */
2743 /* image into a bitmap. See @FT_Render_Mode for a */
2744 /* list of possible values. */
2745 /* */
2746 /* <Return> */
2747 /* FreeType error code. 0~means success. */
2748 /* */
2749 FT_EXPORT( FT_Error )
2750 FT_Render_Glyph( FT_GlyphSlot slot,
2751 FT_Render_Mode render_mode );
2752
2753
2754 /*************************************************************************/
2755 /* */
2756 /* <Enum> */
2757 /* FT_Kerning_Mode */
2758 /* */
2759 /* <Description> */
2760 /* An enumeration used to specify which kerning values to return in */
2761 /* @FT_Get_Kerning. */
2762 /* */
2763 /* <Values> */
2764 /* FT_KERNING_DEFAULT :: Return scaled and grid-fitted kerning */
2765 /* distances (value is~0). */
2766 /* */
2767 /* FT_KERNING_UNFITTED :: Return scaled but un-grid-fitted kerning */
2768 /* distances. */
2769 /* */
2770 /* FT_KERNING_UNSCALED :: Return the kerning vector in original font */
2771 /* units. */
2772 /* */
2773 typedef enum FT_Kerning_Mode_
2774 {
2775 FT_KERNING_DEFAULT = 0,
2776 FT_KERNING_UNFITTED,
2777 FT_KERNING_UNSCALED
2778
2779 } FT_Kerning_Mode;
2780
2781
2782 /*************************************************************************/
2783 /* */
2784 /* <Const> */
2785 /* ft_kerning_default */
2786 /* */
2787 /* <Description> */
2788 /* This constant is deprecated. Please use @FT_KERNING_DEFAULT */
2789 /* instead. */
2790 /* */
2791 #define ft_kerning_default FT_KERNING_DEFAULT
2792
2793
2794 /*************************************************************************/
2795 /* */
2796 /* <Const> */
2797 /* ft_kerning_unfitted */
2798 /* */
2799 /* <Description> */
2800 /* This constant is deprecated. Please use @FT_KERNING_UNFITTED */
2801 /* instead. */
2802 /* */
2803 #define ft_kerning_unfitted FT_KERNING_UNFITTED
2804
2805
2806 /*************************************************************************/
2807 /* */
2808 /* <Const> */
2809 /* ft_kerning_unscaled */
2810 /* */
2811 /* <Description> */
2812 /* This constant is deprecated. Please use @FT_KERNING_UNSCALED */
2813 /* instead. */
2814 /* */
2815 #define ft_kerning_unscaled FT_KERNING_UNSCALED
2816
2817
2818 /*************************************************************************/
2819 /* */
2820 /* <Function> */
2821 /* FT_Get_Kerning */
2822 /* */
2823 /* <Description> */
2824 /* Return the kerning vector between two glyphs of a same face. */
2825 /* */
2826 /* <Input> */
2827 /* face :: A handle to a source face object. */
2828 /* */
2829 /* left_glyph :: The index of the left glyph in the kern pair. */
2830 /* */
2831 /* right_glyph :: The index of the right glyph in the kern pair. */
2832 /* */
2833 /* kern_mode :: See @FT_Kerning_Mode for more information. */
2834 /* Determines the scale and dimension of the returned */
2835 /* kerning vector. */
2836 /* */
2837 /* <Output> */
2838 /* akerning :: The kerning vector. This is either in font units */
2839 /* or in pixels (26.6 format) for scalable formats, */
2840 /* and in pixels for fixed-sizes formats. */
2841 /* */
2842 /* <Return> */
2843 /* FreeType error code. 0~means success. */
2844 /* */
2845 /* <Note> */
2846 /* Only horizontal layouts (left-to-right & right-to-left) are */
2847 /* supported by this method. Other layouts, or more sophisticated */
2848 /* kernings, are out of the scope of this API function -- they can be */
2849 /* implemented through format-specific interfaces. */
2850 /* */
2851 FT_EXPORT( FT_Error )
2852 FT_Get_Kerning( FT_Face face,
2853 FT_UInt left_glyph,
2854 FT_UInt right_glyph,
2855 FT_UInt kern_mode,
2856 FT_Vector *akerning );
2857
2858
2859 /*************************************************************************/
2860 /* */
2861 /* <Function> */
2862 /* FT_Get_Track_Kerning */
2863 /* */
2864 /* <Description> */
2865 /* Return the track kerning for a given face object at a given size. */
2866 /* */
2867 /* <Input> */
2868 /* face :: A handle to a source face object. */
2869 /* */
2870 /* point_size :: The point size in 16.16 fractional points. */
2871 /* */
2872 /* degree :: The degree of tightness. */
2873 /* */
2874 /* <Output> */
2875 /* akerning :: The kerning in 16.16 fractional points. */
2876 /* */
2877 /* <Return> */
2878 /* FreeType error code. 0~means success. */
2879 /* */
2880 FT_EXPORT( FT_Error )
2881 FT_Get_Track_Kerning( FT_Face face,
2882 FT_Fixed point_size,
2883 FT_Int degree,
2884 FT_Fixed* akerning );
2885
2886
2887 /*************************************************************************/
2888 /* */
2889 /* <Function> */
2890 /* FT_Get_Glyph_Name */
2891 /* */
2892 /* <Description> */
2893 /* Retrieve the ASCII name of a given glyph in a face. This only */
2894 /* works for those faces where @FT_HAS_GLYPH_NAMES(face) returns~1. */
2895 /* */
2896 /* <Input> */
2897 /* face :: A handle to a source face object. */
2898 /* */
2899 /* glyph_index :: The glyph index. */
2900 /* */
2901 /* buffer_max :: The maximal number of bytes available in the */
2902 /* buffer. */
2903 /* */
2904 /* <Output> */
2905 /* buffer :: A pointer to a target buffer where the name is */
2906 /* copied to. */
2907 /* */
2908 /* <Return> */
2909 /* FreeType error code. 0~means success. */
2910 /* */
2911 /* <Note> */
2912 /* An error is returned if the face doesn't provide glyph names or if */
2913 /* the glyph index is invalid. In all cases of failure, the first */
2914 /* byte of `buffer' is set to~0 to indicate an empty name. */
2915 /* */
2916 /* The glyph name is truncated to fit within the buffer if it is too */
2917 /* long. The returned string is always zero-terminated. */
2918 /* */
2919 /* This function is not compiled within the library if the config */
2920 /* macro `FT_CONFIG_OPTION_NO_GLYPH_NAMES' is defined in */
2921 /* `include/freetype/config/ftoptions.h'. */
2922 /* */
2923 FT_EXPORT( FT_Error )
2924 FT_Get_Glyph_Name( FT_Face face,
2925 FT_UInt glyph_index,
2926 FT_Pointer buffer,
2927 FT_UInt buffer_max );
2928
2929
2930 /*************************************************************************/
2931 /* */
2932 /* <Function> */
2933 /* FT_Get_Postscript_Name */
2934 /* */
2935 /* <Description> */
2936 /* Retrieve the ASCII PostScript name of a given face, if available. */
2937 /* This only works with PostScript and TrueType fonts. */
2938 /* */
2939 /* <Input> */
2940 /* face :: A handle to the source face object. */
2941 /* */
2942 /* <Return> */
2943 /* A pointer to the face's PostScript name. NULL if unavailable. */
2944 /* */
2945 /* <Note> */
2946 /* The returned pointer is owned by the face and is destroyed with */
2947 /* it. */
2948 /* */
2949 FT_EXPORT( const char* )
2950 FT_Get_Postscript_Name( FT_Face face );
2951
2952
2953 /*************************************************************************/
2954 /* */
2955 /* <Function> */
2956 /* FT_Select_Charmap */
2957 /* */
2958 /* <Description> */
2959 /* Select a given charmap by its encoding tag (as listed in */
2960 /* `freetype.h'). */
2961 /* */
2962 /* <InOut> */
2963 /* face :: A handle to the source face object. */
2964 /* */
2965 /* <Input> */
2966 /* encoding :: A handle to the selected encoding. */
2967 /* */
2968 /* <Return> */
2969 /* FreeType error code. 0~means success. */
2970 /* */
2971 /* <Note> */
2972 /* This function returns an error if no charmap in the face */
2973 /* corresponds to the encoding queried here. */
2974 /* */
2975 /* Because many fonts contain more than a single cmap for Unicode */
2976 /* encoding, this function has some special code to select the one */
2977 /* which covers Unicode best (`best' in the sense that a UCS-4 cmap */
2978 /* is preferred to a UCS-2 cmap). It is thus preferable to */
2979 /* @FT_Set_Charmap in this case. */
2980 /* */
2981 FT_EXPORT( FT_Error )
2982 FT_Select_Charmap( FT_Face face,
2983 FT_Encoding encoding );
2984
2985
2986 /*************************************************************************/
2987 /* */
2988 /* <Function> */
2989 /* FT_Set_Charmap */
2990 /* */
2991 /* <Description> */
2992 /* Select a given charmap for character code to glyph index mapping. */
2993 /* */
2994 /* <InOut> */
2995 /* face :: A handle to the source face object. */
2996 /* */
2997 /* <Input> */
2998 /* charmap :: A handle to the selected charmap. */
2999 /* */
3000 /* <Return> */
3001 /* FreeType error code. 0~means success. */
3002 /* */
3003 /* <Note> */
3004 /* This function returns an error if the charmap is not part of */
3005 /* the face (i.e., if it is not listed in the `face->charmaps' */
3006 /* table). */
3007 /* */
3008 /* It also fails if a type~14 charmap is selected. */
3009 /* */
3010 FT_EXPORT( FT_Error )
3011 FT_Set_Charmap( FT_Face face,
3012 FT_CharMap charmap );
3013
3014
3015 /*************************************************************************
3016 *
3017 * @function:
3018 * FT_Get_Charmap_Index
3019 *
3020 * @description:
3021 * Retrieve index of a given charmap.
3022 *
3023 * @input:
3024 * charmap ::
3025 * A handle to a charmap.
3026 *
3027 * @return:
3028 * The index into the array of character maps within the face to which
3029 * `charmap' belongs. If an error occurs, -1 is returned.
3030 *
3031 */
3032 FT_EXPORT( FT_Int )
3033 FT_Get_Charmap_Index( FT_CharMap charmap );
3034
3035
3036 /*************************************************************************/
3037 /* */
3038 /* <Function> */
3039 /* FT_Get_Char_Index */
3040 /* */
3041 /* <Description> */
3042 /* Return the glyph index of a given character code. This function */
3043 /* uses a charmap object to do the mapping. */
3044 /* */
3045 /* <Input> */
3046 /* face :: A handle to the source face object. */
3047 /* */
3048 /* charcode :: The character code. */
3049 /* */
3050 /* <Return> */
3051 /* The glyph index. 0~means `undefined character code'. */
3052 /* */
3053 /* <Note> */
3054 /* If you use FreeType to manipulate the contents of font files */
3055 /* directly, be aware that the glyph index returned by this function */
3056 /* doesn't always correspond to the internal indices used within */
3057 /* the file. This is done to ensure that value~0 always corresponds */
3058 /* to the `missing glyph'. */
3059 /* */
3060 FT_EXPORT( FT_UInt )
3061 FT_Get_Char_Index( FT_Face face,
3062 FT_ULong charcode );
3063
3064
3065 /*************************************************************************/
3066 /* */
3067 /* <Function> */
3068 /* FT_Get_First_Char */
3069 /* */
3070 /* <Description> */
3071 /* This function is used to return the first character code in the */
3072 /* current charmap of a given face. It also returns the */
3073 /* corresponding glyph index. */
3074 /* */
3075 /* <Input> */
3076 /* face :: A handle to the source face object. */
3077 /* */
3078 /* <Output> */
3079 /* agindex :: Glyph index of first character code. 0~if charmap is */
3080 /* empty. */
3081 /* */
3082 /* <Return> */
3083 /* The charmap's first character code. */
3084 /* */
3085 /* <Note> */
3086 /* You should use this function with @FT_Get_Next_Char to be able to */
3087 /* parse all character codes available in a given charmap. The code */
3088 /* should look like this: */
3089 /* */
3090 /* { */
3091 /* FT_ULong charcode; */
3092 /* FT_UInt gindex; */
3093 /* */
3094 /* */
3095 /* charcode = FT_Get_First_Char( face, &gindex ); */
3096 /* while ( gindex != 0 ) */
3097 /* { */
3098 /* ... do something with (charcode,gindex) pair ... */
3099 /* */
3100 /* charcode = FT_Get_Next_Char( face, charcode, &gindex ); */
3101 /* } */
3102 /* } */
3103 /* */
3104 /* Note that `*agindex' is set to~0 if the charmap is empty. The */
3105 /* result itself can be~0 in two cases: if the charmap is empty or */
3106 /* if the value~0 is the first valid character code. */
3107 /* */
3108 FT_EXPORT( FT_ULong )
3109 FT_Get_First_Char( FT_Face face,
3110 FT_UInt *agindex );
3111
3112
3113 /*************************************************************************/
3114 /* */
3115 /* <Function> */
3116 /* FT_Get_Next_Char */
3117 /* */
3118 /* <Description> */
3119 /* This function is used to return the next character code in the */
3120 /* current charmap of a given face following the value `char_code', */
3121 /* as well as the corresponding glyph index. */
3122 /* */
3123 /* <Input> */
3124 /* face :: A handle to the source face object. */
3125 /* char_code :: The starting character code. */
3126 /* */
3127 /* <Output> */
3128 /* agindex :: Glyph index of next character code. 0~if charmap */
3129 /* is empty. */
3130 /* */
3131 /* <Return> */
3132 /* The charmap's next character code. */
3133 /* */
3134 /* <Note> */
3135 /* You should use this function with @FT_Get_First_Char to walk */
3136 /* over all character codes available in a given charmap. See the */
3137 /* note for this function for a simple code example. */
3138 /* */
3139 /* Note that `*agindex' is set to~0 when there are no more codes in */
3140 /* the charmap. */
3141 /* */
3142 FT_EXPORT( FT_ULong )
3143 FT_Get_Next_Char( FT_Face face,
3144 FT_ULong char_code,
3145 FT_UInt *agindex );
3146
3147
3148 /*************************************************************************/
3149 /* */
3150 /* <Function> */
3151 /* FT_Get_Name_Index */
3152 /* */
3153 /* <Description> */
3154 /* Return the glyph index of a given glyph name. This function uses */
3155 /* driver specific objects to do the translation. */
3156 /* */
3157 /* <Input> */
3158 /* face :: A handle to the source face object. */
3159 /* */
3160 /* glyph_name :: The glyph name. */
3161 /* */
3162 /* <Return> */
3163 /* The glyph index. 0~means `undefined character code'. */
3164 /* */
3165 FT_EXPORT( FT_UInt )
3166 FT_Get_Name_Index( FT_Face face,
3167 FT_String* glyph_name );
3168
3169
3170 /*************************************************************************
3171 *
3172 * @macro:
3173 * FT_SUBGLYPH_FLAG_XXX
3174 *
3175 * @description:
3176 * A list of constants used to describe subglyphs. Please refer to the
3177 * TrueType specification for the meaning of the various flags.
3178 *
3179 * @values:
3180 * FT_SUBGLYPH_FLAG_ARGS_ARE_WORDS ::
3181 * FT_SUBGLYPH_FLAG_ARGS_ARE_XY_VALUES ::
3182 * FT_SUBGLYPH_FLAG_ROUND_XY_TO_GRID ::
3183 * FT_SUBGLYPH_FLAG_SCALE ::
3184 * FT_SUBGLYPH_FLAG_XY_SCALE ::
3185 * FT_SUBGLYPH_FLAG_2X2 ::
3186 * FT_SUBGLYPH_FLAG_USE_MY_METRICS ::
3187 *
3188 */
3189 #define FT_SUBGLYPH_FLAG_ARGS_ARE_WORDS 1
3190 #define FT_SUBGLYPH_FLAG_ARGS_ARE_XY_VALUES 2
3191 #define FT_SUBGLYPH_FLAG_ROUND_XY_TO_GRID 4
3192 #define FT_SUBGLYPH_FLAG_SCALE 8
3193 #define FT_SUBGLYPH_FLAG_XY_SCALE 0x40
3194 #define FT_SUBGLYPH_FLAG_2X2 0x80
3195 #define FT_SUBGLYPH_FLAG_USE_MY_METRICS 0x200
3196
3197
3198 /*************************************************************************
3199 *
3200 * @func:
3201 * FT_Get_SubGlyph_Info
3202 *
3203 * @description:
3204 * Retrieve a description of a given subglyph. Only use it if
3205 * `glyph->format' is @FT_GLYPH_FORMAT_COMPOSITE; an error is
3206 * returned otherwise.
3207 *
3208 * @input:
3209 * glyph ::
3210 * The source glyph slot.
3211 *
3212 * sub_index ::
3213 * The index of the subglyph. Must be less than
3214 * `glyph->num_subglyphs'.
3215 *
3216 * @output:
3217 * p_index ::
3218 * The glyph index of the subglyph.
3219 *
3220 * p_flags ::
3221 * The subglyph flags, see @FT_SUBGLYPH_FLAG_XXX.
3222 *
3223 * p_arg1 ::
3224 * The subglyph's first argument (if any).
3225 *
3226 * p_arg2 ::
3227 * The subglyph's second argument (if any).
3228 *
3229 * p_transform ::
3230 * The subglyph transformation (if any).
3231 *
3232 * @return:
3233 * FreeType error code. 0~means success.
3234 *
3235 * @note:
3236 * The values of `*p_arg1', `*p_arg2', and `*p_transform' must be
3237 * interpreted depending on the flags returned in `*p_flags'. See the
3238 * TrueType specification for details.
3239 *
3240 */
3241 FT_EXPORT( FT_Error )
3242 FT_Get_SubGlyph_Info( FT_GlyphSlot glyph,
3243 FT_UInt sub_index,
3244 FT_Int *p_index,
3245 FT_UInt *p_flags,
3246 FT_Int *p_arg1,
3247 FT_Int *p_arg2,
3248 FT_Matrix *p_transform );
3249
3250
3251 /*************************************************************************/
3252 /* */
3253 /* <Enum> */
3254 /* FT_FSTYPE_XXX */
3255 /* */
3256 /* <Description> */
3257 /* A list of bit flags used in the `fsType' field of the OS/2 table */
3258 /* in a TrueType or OpenType font and the `FSType' entry in a */
3259 /* PostScript font. These bit flags are returned by */
3260 /* @FT_Get_FSType_Flags; they inform client applications of embedding */
3261 /* and subsetting restrictions associated with a font. */
3262 /* */
3263 /* See http://www.adobe.com/devnet/acrobat/pdfs/FontPolicies.pdf for */
3264 /* more details. */
3265 /* */
3266 /* <Values> */
3267 /* FT_FSTYPE_INSTALLABLE_EMBEDDING :: */
3268 /* Fonts with no fsType bit set may be embedded and permanently */
3269 /* installed on the remote system by an application. */
3270 /* */
3271 /* FT_FSTYPE_RESTRICTED_LICENSE_EMBEDDING :: */
3272 /* Fonts that have only this bit set must not be modified, embedded */
3273 /* or exchanged in any manner without first obtaining permission of */
3274 /* the font software copyright owner. */
3275 /* */
3276 /* FT_FSTYPE_PREVIEW_AND_PRINT_EMBEDDING :: */
3277 /* If this bit is set, the font may be embedded and temporarily */
3278 /* loaded on the remote system. Documents containing Preview & */
3279 /* Print fonts must be opened `read-only'; no edits can be applied */
3280 /* to the document. */
3281 /* */
3282 /* FT_FSTYPE_EDITABLE_EMBEDDING :: */
3283 /* If this bit is set, the font may be embedded but must only be */
3284 /* installed temporarily on other systems. In contrast to Preview */
3285 /* & Print fonts, documents containing editable fonts may be opened */
3286 /* for reading, editing is permitted, and changes may be saved. */
3287 /* */
3288 /* FT_FSTYPE_NO_SUBSETTING :: */
3289 /* If this bit is set, the font may not be subsetted prior to */
3290 /* embedding. */
3291 /* */
3292 /* FT_FSTYPE_BITMAP_EMBEDDING_ONLY :: */
3293 /* If this bit is set, only bitmaps contained in the font may be */
3294 /* embedded; no outline data may be embedded. If there are no */
3295 /* bitmaps available in the font, then the font is unembeddable. */
3296 /* */
3297 /* <Note> */
3298 /* While the fsType flags can indicate that a font may be embedded, a */
3299 /* license with the font vendor may be separately required to use the */
3300 /* font in this way. */
3301 /* */
3302 #define FT_FSTYPE_INSTALLABLE_EMBEDDING 0x0000
3303 #define FT_FSTYPE_RESTRICTED_LICENSE_EMBEDDING 0x0002
3304 #define FT_FSTYPE_PREVIEW_AND_PRINT_EMBEDDING 0x0004
3305 #define FT_FSTYPE_EDITABLE_EMBEDDING 0x0008
3306 #define FT_FSTYPE_NO_SUBSETTING 0x0100
3307 #define FT_FSTYPE_BITMAP_EMBEDDING_ONLY 0x0200
3308
3309
3310 /*************************************************************************/
3311 /* */
3312 /* <Function> */
3313 /* FT_Get_FSType_Flags */
3314 /* */
3315 /* <Description> */
3316 /* Return the fsType flags for a font. */
3317 /* */
3318 /* <Input> */
3319 /* face :: A handle to the source face object. */
3320 /* */
3321 /* <Return> */
3322 /* The fsType flags, @FT_FSTYPE_XXX. */
3323 /* */
3324 /* <Note> */
3325 /* Use this function rather than directly reading the `fs_type' field */
3326 /* in the @PS_FontInfoRec structure which is only guaranteed to */
3327 /* return the correct results for Type~1 fonts. */
3328 /* */
3329 FT_EXPORT( FT_UShort )
3330 FT_Get_FSType_Flags( FT_Face face );
3331
3332
3333 /*************************************************************************/
3334 /* */
3335 /* <Section> */
3336 /* glyph_variants */
3337 /* */
3338 /* <Title> */
3339 /* Glyph Variants */
3340 /* */
3341 /* <Abstract> */
3342 /* The FreeType~2 interface to Unicode Ideographic Variation */
3343 /* Sequences (IVS), using the SFNT cmap format~14. */
3344 /* */
3345 /* <Description> */
3346 /* Many CJK characters have variant forms. They are a sort of grey */
3347 /* area somewhere between being totally irrelevant and semantically */
3348 /* distinct; for this reason, the Unicode consortium decided to */
3349 /* introduce Ideographic Variation Sequences (IVS), consisting of a */
3350 /* Unicode base character and one of 240 variant selectors */
3351 /* (U+E0100-U+E01EF), instead of further extending the already huge */
3352 /* code range for CJK characters. */
3353 /* */
3354 /* An IVS is registered and unique; for further details please refer */
3355 /* to Unicode Technical Report #37, the Ideographic Variation */
3356 /* Database. To date (October 2007), the character with the most */
3357 /* variants is U+908A, having 8~such IVS. */
3358 /* */
3359 /* Adobe and MS decided to support IVS with a new cmap subtable */
3360 /* (format~14). It is an odd subtable because it is not a mapping of */
3361 /* input code points to glyphs, but contains lists of all variants */
3362 /* supported by the font. */
3363 /* */
3364 /* A variant may be either `default' or `non-default'. A default */
3365 /* variant is the one you will get for that code point if you look it */
3366 /* up in the standard Unicode cmap. A non-default variant is a */
3367 /* different glyph. */
3368 /* */
3369 /*************************************************************************/
3370
3371
3372 /*************************************************************************/
3373 /* */
3374 /* <Function> */
3375 /* FT_Face_GetCharVariantIndex */
3376 /* */
3377 /* <Description> */
3378 /* Return the glyph index of a given character code as modified by */
3379 /* the variation selector. */
3380 /* */
3381 /* <Input> */
3382 /* face :: */
3383 /* A handle to the source face object. */
3384 /* */
3385 /* charcode :: */
3386 /* The character code point in Unicode. */
3387 /* */
3388 /* variantSelector :: */
3389 /* The Unicode code point of the variation selector. */
3390 /* */
3391 /* <Return> */
3392 /* The glyph index. 0~means either `undefined character code', or */
3393 /* `undefined selector code', or `no variation selector cmap */
3394 /* subtable', or `current CharMap is not Unicode'. */
3395 /* */
3396 /* <Note> */
3397 /* If you use FreeType to manipulate the contents of font files */
3398 /* directly, be aware that the glyph index returned by this function */
3399 /* doesn't always correspond to the internal indices used within */
3400 /* the file. This is done to ensure that value~0 always corresponds */
3401 /* to the `missing glyph'. */
3402 /* */
3403 /* This function is only meaningful if */
3404 /* a) the font has a variation selector cmap sub table, */
3405 /* and */
3406 /* b) the current charmap has a Unicode encoding. */
3407 /* */
3408 /* <Since> */
3409 /* 2.3.6 */
3410 /* */
3411 FT_EXPORT( FT_UInt )
3412 FT_Face_GetCharVariantIndex( FT_Face face,
3413 FT_ULong charcode,
3414 FT_ULong variantSelector );
3415
3416
3417 /*************************************************************************/
3418 /* */
3419 /* <Function> */
3420 /* FT_Face_GetCharVariantIsDefault */
3421 /* */
3422 /* <Description> */
3423 /* Check whether this variant of this Unicode character is the one to */
3424 /* be found in the `cmap'. */
3425 /* */
3426 /* <Input> */
3427 /* face :: */
3428 /* A handle to the source face object. */
3429 /* */
3430 /* charcode :: */
3431 /* The character codepoint in Unicode. */
3432 /* */
3433 /* variantSelector :: */
3434 /* The Unicode codepoint of the variation selector. */
3435 /* */
3436 /* <Return> */
3437 /* 1~if found in the standard (Unicode) cmap, 0~if found in the */
3438 /* variation selector cmap, or -1 if it is not a variant. */
3439 /* */
3440 /* <Note> */
3441 /* This function is only meaningful if the font has a variation */
3442 /* selector cmap subtable. */
3443 /* */
3444 /* <Since> */
3445 /* 2.3.6 */
3446 /* */
3447 FT_EXPORT( FT_Int )
3448 FT_Face_GetCharVariantIsDefault( FT_Face face,
3449 FT_ULong charcode,
3450 FT_ULong variantSelector );
3451
3452
3453 /*************************************************************************/
3454 /* */
3455 /* <Function> */
3456 /* FT_Face_GetVariantSelectors */
3457 /* */
3458 /* <Description> */
3459 /* Return a zero-terminated list of Unicode variant selectors found */
3460 /* in the font. */
3461 /* */
3462 /* <Input> */
3463 /* face :: */
3464 /* A handle to the source face object. */
3465 /* */
3466 /* <Return> */
3467 /* A pointer to an array of selector code points, or NULL if there is */
3468 /* no valid variant selector cmap subtable. */
3469 /* */
3470 /* <Note> */
3471 /* The last item in the array is~0; the array is owned by the */
3472 /* @FT_Face object but can be overwritten or released on the next */
3473 /* call to a FreeType function. */
3474 /* */
3475 /* <Since> */
3476 /* 2.3.6 */
3477 /* */
3478 FT_EXPORT( FT_UInt32* )
3479 FT_Face_GetVariantSelectors( FT_Face face );
3480
3481
3482 /*************************************************************************/
3483 /* */
3484 /* <Function> */
3485 /* FT_Face_GetVariantsOfChar */
3486 /* */
3487 /* <Description> */
3488 /* Return a zero-terminated list of Unicode variant selectors found */
3489 /* for the specified character code. */
3490 /* */
3491 /* <Input> */
3492 /* face :: */
3493 /* A handle to the source face object. */
3494 /* */
3495 /* charcode :: */
3496 /* The character codepoint in Unicode. */
3497 /* */
3498 /* <Return> */
3499 /* A pointer to an array of variant selector code points which are */
3500 /* active for the given character, or NULL if the corresponding list */
3501 /* is empty. */
3502 /* */
3503 /* <Note> */
3504 /* The last item in the array is~0; the array is owned by the */
3505 /* @FT_Face object but can be overwritten or released on the next */
3506 /* call to a FreeType function. */
3507 /* */
3508 /* <Since> */
3509 /* 2.3.6 */
3510 /* */
3511 FT_EXPORT( FT_UInt32* )
3512 FT_Face_GetVariantsOfChar( FT_Face face,
3513 FT_ULong charcode );
3514
3515
3516 /*************************************************************************/
3517 /* */
3518 /* <Function> */
3519 /* FT_Face_GetCharsOfVariant */
3520 /* */
3521 /* <Description> */
3522 /* Return a zero-terminated list of Unicode character codes found for */
3523 /* the specified variant selector. */
3524 /* */
3525 /* <Input> */
3526 /* face :: */
3527 /* A handle to the source face object. */
3528 /* */
3529 /* variantSelector :: */
3530 /* The variant selector code point in Unicode. */
3531 /* */
3532 /* <Return> */
3533 /* A list of all the code points which are specified by this selector */
3534 /* (both default and non-default codes are returned) or NULL if there */
3535 /* is no valid cmap or the variant selector is invalid. */
3536 /* */
3537 /* <Note> */
3538 /* The last item in the array is~0; the array is owned by the */
3539 /* @FT_Face object but can be overwritten or released on the next */
3540 /* call to a FreeType function. */
3541 /* */
3542 /* <Since> */
3543 /* 2.3.6 */
3544 /* */
3545 FT_EXPORT( FT_UInt32* )
3546 FT_Face_GetCharsOfVariant( FT_Face face,
3547 FT_ULong variantSelector );
3548
3549
3550 /*************************************************************************/
3551 /* */
3552 /* <Section> */
3553 /* computations */
3554 /* */
3555 /* <Title> */
3556 /* Computations */
3557 /* */
3558 /* <Abstract> */
3559 /* Crunching fixed numbers and vectors. */
3560 /* */
3561 /* <Description> */
3562 /* This section contains various functions used to perform */
3563 /* computations on 16.16 fixed-float numbers or 2d vectors. */
3564 /* */
3565 /* <Order> */
3566 /* FT_MulDiv */
3567 /* FT_MulFix */
3568 /* FT_DivFix */
3569 /* FT_RoundFix */
3570 /* FT_CeilFix */
3571 /* FT_FloorFix */
3572 /* FT_Vector_Transform */
3573 /* FT_Matrix_Multiply */
3574 /* FT_Matrix_Invert */
3575 /* */
3576 /*************************************************************************/
3577
3578
3579 /*************************************************************************/
3580 /* */
3581 /* <Function> */
3582 /* FT_MulDiv */
3583 /* */
3584 /* <Description> */
3585 /* A very simple function used to perform the computation `(a*b)/c' */
3586 /* with maximal accuracy (it uses a 64-bit intermediate integer */
3587 /* whenever necessary). */
3588 /* */
3589 /* This function isn't necessarily as fast as some processor specific */
3590 /* operations, but is at least completely portable. */
3591 /* */
3592 /* <Input> */
3593 /* a :: The first multiplier. */
3594 /* b :: The second multiplier. */
3595 /* c :: The divisor. */
3596 /* */
3597 /* <Return> */
3598 /* The result of `(a*b)/c'. This function never traps when trying to */
3599 /* divide by zero; it simply returns `MaxInt' or `MinInt' depending */
3600 /* on the signs of `a' and `b'. */
3601 /* */
3602 FT_EXPORT( FT_Long )
3603 FT_MulDiv( FT_Long a,
3604 FT_Long b,
3605 FT_Long c );
3606
3607
3608 /* */
3609
3610 /* The following #if 0 ... #endif is for the documentation formatter, */
3611 /* hiding the internal `FT_MULFIX_INLINED' macro. */
3612
3613 #if 0
3614 /*************************************************************************/
3615 /* */
3616 /* <Function> */
3617 /* FT_MulFix */
3618 /* */
3619 /* <Description> */
3620 /* A very simple function used to perform the computation */
3621 /* `(a*b)/0x10000' with maximal accuracy. Most of the time this is */
3622 /* used to multiply a given value by a 16.16 fixed float factor. */
3623 /* */
3624 /* <Input> */
3625 /* a :: The first multiplier. */
3626 /* b :: The second multiplier. Use a 16.16 factor here whenever */
3627 /* possible (see note below). */
3628 /* */
3629 /* <Return> */
3630 /* The result of `(a*b)/0x10000'. */
3631 /* */
3632 /* <Note> */
3633 /* This function has been optimized for the case where the absolute */
3634 /* value of `a' is less than 2048, and `b' is a 16.16 scaling factor. */
3635 /* As this happens mainly when scaling from notional units to */
3636 /* fractional pixels in FreeType, it resulted in noticeable speed */
3637 /* improvements between versions 2.x and 1.x. */
3638 /* */
3639 /* As a conclusion, always try to place a 16.16 factor as the */
3640 /* _second_ argument of this function; this can make a great */
3641 /* difference. */
3642 /* */
3643 FT_EXPORT( FT_Long )
3644 FT_MulFix( FT_Long a,
3645 FT_Long b );
3646
3647 /* */
3648 #endif
3649
3650 #ifdef FT_MULFIX_INLINED
3651 #define FT_MulFix( a, b ) FT_MULFIX_INLINED( a, b )
3652 #else
3653 FT_EXPORT( FT_Long )
3654 FT_MulFix( FT_Long a,
3655 FT_Long b );
3656 #endif
3657
3658
3659 /*************************************************************************/
3660 /* */
3661 /* <Function> */
3662 /* FT_DivFix */
3663 /* */
3664 /* <Description> */
3665 /* A very simple function used to perform the computation */
3666 /* `(a*0x10000)/b' with maximal accuracy. Most of the time, this is */
3667 /* used to divide a given value by a 16.16 fixed float factor. */
3668 /* */
3669 /* <Input> */
3670 /* a :: The first multiplier. */
3671 /* b :: The second multiplier. Use a 16.16 factor here whenever */
3672 /* possible (see note below). */
3673 /* */
3674 /* <Return> */
3675 /* The result of `(a*0x10000)/b'. */
3676 /* */
3677 /* <Note> */
3678 /* The optimization for FT_DivFix() is simple: If (a~<<~16) fits in */
3679 /* 32~bits, then the division is computed directly. Otherwise, we */
3680 /* use a specialized version of @FT_MulDiv. */
3681 /* */
3682 FT_EXPORT( FT_Long )
3683 FT_DivFix( FT_Long a,
3684 FT_Long b );
3685
3686
3687 /*************************************************************************/
3688 /* */
3689 /* <Function> */
3690 /* FT_RoundFix */
3691 /* */
3692 /* <Description> */
3693 /* A very simple function used to round a 16.16 fixed number. */
3694 /* */
3695 /* <Input> */
3696 /* a :: The number to be rounded. */
3697 /* */
3698 /* <Return> */
3699 /* The result of `(a + 0x8000) & -0x10000'. */
3700 /* */
3701 FT_EXPORT( FT_Fixed )
3702 FT_RoundFix( FT_Fixed a );
3703
3704
3705 /*************************************************************************/
3706 /* */
3707 /* <Function> */
3708 /* FT_CeilFix */
3709 /* */
3710 /* <Description> */
3711 /* A very simple function used to compute the ceiling function of a */
3712 /* 16.16 fixed number. */
3713 /* */
3714 /* <Input> */
3715 /* a :: The number for which the ceiling function is to be computed. */
3716 /* */
3717 /* <Return> */
3718 /* The result of `(a + 0x10000 - 1) & -0x10000'. */
3719 /* */
3720 FT_EXPORT( FT_Fixed )
3721 FT_CeilFix( FT_Fixed a );
3722
3723
3724 /*************************************************************************/
3725 /* */
3726 /* <Function> */
3727 /* FT_FloorFix */
3728 /* */
3729 /* <Description> */
3730 /* A very simple function used to compute the floor function of a */
3731 /* 16.16 fixed number. */
3732 /* */
3733 /* <Input> */
3734 /* a :: The number for which the floor function is to be computed. */
3735 /* */
3736 /* <Return> */
3737 /* The result of `a & -0x10000'. */
3738 /* */
3739 FT_EXPORT( FT_Fixed )
3740 FT_FloorFix( FT_Fixed a );
3741
3742
3743 /*************************************************************************/
3744 /* */
3745 /* <Function> */
3746 /* FT_Vector_Transform */
3747 /* */
3748 /* <Description> */
3749 /* Transform a single vector through a 2x2 matrix. */
3750 /* */
3751 /* <InOut> */
3752 /* vector :: The target vector to transform. */
3753 /* */
3754 /* <Input> */
3755 /* matrix :: A pointer to the source 2x2 matrix. */
3756 /* */
3757 /* <Note> */
3758 /* The result is undefined if either `vector' or `matrix' is invalid. */
3759 /* */
3760 FT_EXPORT( void )
3761 FT_Vector_Transform( FT_Vector* vec,
3762 const FT_Matrix* matrix );
3763
3764
3765 /*************************************************************************/
3766 /* */
3767 /* <Section> */
3768 /* version */
3769 /* */
3770 /* <Title> */
3771 /* FreeType Version */
3772 /* */
3773 /* <Abstract> */
3774 /* Functions and macros related to FreeType versions. */
3775 /* */
3776 /* <Description> */
3777 /* Note that those functions and macros are of limited use because */
3778 /* even a new release of FreeType with only documentation changes */
3779 /* increases the version number. */
3780 /* */
3781 /*************************************************************************/
3782
3783
3784 /*************************************************************************
3785 *
3786 * @enum:
3787 * FREETYPE_XXX
3788 *
3789 * @description:
3790 * These three macros identify the FreeType source code version.
3791 * Use @FT_Library_Version to access them at runtime.
3792 *
3793 * @values:
3794 * FREETYPE_MAJOR :: The major version number.
3795 * FREETYPE_MINOR :: The minor version number.
3796 * FREETYPE_PATCH :: The patch level.
3797 *
3798 * @note:
3799 * The version number of FreeType if built as a dynamic link library
3800 * with the `libtool' package is _not_ controlled by these three
3801 * macros.
3802 *
3803 */
3804 #define FREETYPE_MAJOR 2
3805 #define FREETYPE_MINOR 4
3806 #define FREETYPE_PATCH 5
3807
3808
3809 /*************************************************************************/
3810 /* */
3811 /* <Function> */
3812 /* FT_Library_Version */
3813 /* */
3814 /* <Description> */
3815 /* Return the version of the FreeType library being used. This is */
3816 /* useful when dynamically linking to the library, since one cannot */
3817 /* use the macros @FREETYPE_MAJOR, @FREETYPE_MINOR, and */
3818 /* @FREETYPE_PATCH. */
3819 /* */
3820 /* <Input> */
3821 /* library :: A source library handle. */
3822 /* */
3823 /* <Output> */
3824 /* amajor :: The major version number. */
3825 /* */
3826 /* aminor :: The minor version number. */
3827 /* */
3828 /* apatch :: The patch version number. */
3829 /* */
3830 /* <Note> */
3831 /* The reason why this function takes a `library' argument is because */
3832 /* certain programs implement library initialization in a custom way */
3833 /* that doesn't use @FT_Init_FreeType. */
3834 /* */
3835 /* In such cases, the library version might not be available before */
3836 /* the library object has been created. */
3837 /* */
3838 FT_EXPORT( void )
3839 FT_Library_Version( FT_Library library,
3840 FT_Int *amajor,
3841 FT_Int *aminor,
3842 FT_Int *apatch );
3843
3844
3845 /*************************************************************************/
3846 /* */
3847 /* <Function> */
3848 /* FT_Face_CheckTrueTypePatents */
3849 /* */
3850 /* <Description> */
3851 /* Parse all bytecode instructions of a TrueType font file to check */
3852 /* whether any of the patented opcodes are used. This is only useful */
3853 /* if you want to be able to use the unpatented hinter with */
3854 /* fonts that do *not* use these opcodes. */
3855 /* */
3856 /* Note that this function parses *all* glyph instructions in the */
3857 /* font file, which may be slow. */
3858 /* */
3859 /* <Input> */
3860 /* face :: A face handle. */
3861 /* */
3862 /* <Return> */
3863 /* 1~if this is a TrueType font that uses one of the patented */
3864 /* opcodes, 0~otherwise. */
3865 /* */
3866 /* <Note> */
3867 /* Since May 2010, TrueType hinting is no longer patented. */
3868 /* */
3869 /* <Since> */
3870 /* 2.3.5 */
3871 /* */
3872 FT_EXPORT( FT_Bool )
3873 FT_Face_CheckTrueTypePatents( FT_Face face );
3874
3875
3876 /*************************************************************************/
3877 /* */
3878 /* <Function> */
3879 /* FT_Face_SetUnpatentedHinting */
3880 /* */
3881 /* <Description> */
3882 /* Enable or disable the unpatented hinter for a given face. */
3883 /* Only enable it if you have determined that the face doesn't */
3884 /* use any patented opcodes (see @FT_Face_CheckTrueTypePatents). */
3885 /* */
3886 /* <Input> */
3887 /* face :: A face handle. */
3888 /* */
3889 /* value :: New boolean setting. */
3890 /* */
3891 /* <Return> */
3892 /* The old setting value. This will always be false if this is not */
3893 /* an SFNT font, or if the unpatented hinter is not compiled in this */
3894 /* instance of the library. */
3895 /* */
3896 /* <Note> */
3897 /* Since May 2010, TrueType hinting is no longer patented. */
3898 /* */
3899 /* <Since> */
3900 /* 2.3.5 */
3901 /* */
3902 FT_EXPORT( FT_Bool )
3903 FT_Face_SetUnpatentedHinting( FT_Face face,
3904 FT_Bool value );
3905
3906 /* */
3907
3908
3909 FT_END_HEADER
3910
3911 #endif /* __FREETYPE_H__ */
3912
3913
3914 /* END */