1 /***************************************************************************/
5 /* FreeType high-level API and common types (specification only). */
7 /* Copyright 1996-2012 by */
8 /* David Turner, Robert Wilhelm, and Werner Lemberg. */
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. */
16 /***************************************************************************/
19 #ifndef __FREETYPE_H__
20 #define __FREETYPE_H__
24 #error "`ft2build.h' hasn't been included yet!"
25 #error "Please always use macros to include FreeType header files."
27 #error " #include <ft2build.h>"
28 #error " #include FT_FREETYPE_H"
33 #include FT_CONFIG_CONFIG_H
42 /*************************************************************************/
51 /* How client applications should allocate FreeType data structures. */
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. */
59 /*************************************************************************/
63 /*************************************************************************/
64 /*************************************************************************/
66 /* B A S I C T Y P E S */
68 /*************************************************************************/
69 /*************************************************************************/
72 /*************************************************************************/
81 /* The FreeType~2 base font interface. */
84 /* This section describes the public high-level API of FreeType~2. */
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 */
109 /* FT_STYLE_FLAG_BOLD */
110 /* FT_STYLE_FLAG_ITALIC */
113 /* FT_Size_Metrics */
115 /* FT_GlyphSlotRec */
116 /* FT_Glyph_Metrics */
121 /* FT_Init_FreeType */
122 /* FT_Done_FreeType */
126 /* FT_New_Memory_Face */
131 /* FT_Attach_Stream */
133 /* FT_Set_Char_Size */
134 /* FT_Set_Pixel_Sizes */
135 /* FT_Request_Size */
137 /* FT_Size_Request_Type */
138 /* FT_Size_Request */
139 /* FT_Set_Transform */
141 /* FT_Get_Char_Index */
142 /* FT_Get_Name_Index */
147 /* FT_OPEN_PATHNAME */
151 /* FT_LOAD_DEFAULT */
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 */
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 */
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 */
173 /* FT_Render_Glyph */
176 /* FT_Kerning_Mode */
177 /* FT_Get_Track_Kerning */
178 /* FT_Get_Glyph_Name */
179 /* FT_Get_Postscript_Name */
182 /* FT_Select_Charmap */
184 /* FT_Get_Charmap_Index */
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 */
193 /* FT_Get_FSType_Flags */
195 /*************************************************************************/
198 /*************************************************************************/
201 /* FT_Glyph_Metrics */
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. */
211 /* The glyph's width. */
214 /* The glyph's height. */
216 /* horiBearingX :: */
217 /* Left side bearing for horizontal layout. */
219 /* horiBearingY :: */
220 /* Top side bearing for horizontal layout. */
223 /* Advance width for horizontal layout. */
225 /* vertBearingX :: */
226 /* Left side bearing for vertical layout. */
228 /* vertBearingY :: */
229 /* Top side bearing for vertical layout. Larger positive values */
230 /* mean further below the vertical glyph origin. */
233 /* Advance height for vertical layout. Positive values mean the */
234 /* glyph has a positive advance downward. */
237 /* If not disabled with @FT_LOAD_NO_HINTING, the values represent */
238 /* dimensions of the hinted glyph (in case hinting is applicable). */
240 /* Stroking a glyph with an outside border does not increase */
241 /* `horiAdvance' or `vertAdvance'; you have to manually adjust these */
242 /* values to account for the added width and height. */
244 typedef struct FT_Glyph_Metrics_
260 /*************************************************************************/
266 /* This structure models the metrics of a bitmap strike (i.e., a set */
267 /* of glyphs for a given point size and resolution) in a bitmap font. */
268 /* It is used for the `available_sizes' field of @FT_Face. */
271 /* height :: The vertical distance, in pixels, between two */
272 /* consecutive baselines. It is always positive. */
274 /* width :: The average width, in pixels, of all glyphs in the */
277 /* size :: The nominal size of the strike in 26.6 fractional */
278 /* points. This field is not very useful. */
280 /* x_ppem :: The horizontal ppem (nominal width) in 26.6 fractional */
283 /* y_ppem :: The vertical ppem (nominal height) in 26.6 fractional */
288 /* The nominal size given in a FNT font is not reliable. Thus when */
289 /* the driver finds it incorrect, it sets `size' to some calculated */
290 /* values and sets `x_ppem' and `y_ppem' to the pixel width and */
291 /* height given in the font, respectively. */
293 /* TrueType embedded bitmaps: */
294 /* `size', `width', and `height' values are not contained in the */
295 /* bitmap strike itself. They are computed from the global font */
298 typedef struct FT_Bitmap_Size_
311 /*************************************************************************/
312 /*************************************************************************/
314 /* O B J E C T C L A S S E S */
316 /*************************************************************************/
317 /*************************************************************************/
319 /*************************************************************************/
325 /* A handle to a FreeType library instance. Each `library' is */
326 /* completely independent from the others; it is the `root' of a set */
327 /* of objects like fonts, faces, sizes, etc. */
329 /* It also embeds a memory manager (see @FT_Memory), as well as a */
330 /* scan-line converter object (see @FT_Raster). */
332 /* For multi-threading applications each thread should have its own */
333 /* FT_Library object. */
336 /* Library objects are normally created by @FT_Init_FreeType, and */
337 /* destroyed with @FT_Done_FreeType. */
339 typedef struct FT_LibraryRec_ *FT_Library;
342 /*************************************************************************/
348 /* A handle to a given FreeType module object. Each module can be a */
349 /* font driver, a renderer, or anything else that provides services */
350 /* to the formers. */
352 typedef struct FT_ModuleRec_* FT_Module;
355 /*************************************************************************/
361 /* A handle to a given FreeType font driver object. Each font driver */
362 /* is a special module capable of creating faces from font files. */
364 typedef struct FT_DriverRec_* FT_Driver;
367 /*************************************************************************/
373 /* A handle to a given FreeType renderer. A renderer is a special */
374 /* module in charge of converting a glyph image to a bitmap, when */
375 /* necessary. Each renderer supports a given glyph image format, and */
376 /* one or more target surface depths. */
378 typedef struct FT_RendererRec_* FT_Renderer;
381 /*************************************************************************/
387 /* A handle to a given typographic face object. A face object models */
388 /* a given typeface, in a given style. */
391 /* Each face object also owns a single @FT_GlyphSlot object, as well */
392 /* as one or more @FT_Size objects. */
394 /* Use @FT_New_Face or @FT_Open_Face to create a new face object from */
395 /* a given filepathname or a custom input stream. */
397 /* Use @FT_Done_Face to destroy it (along with its slot and sizes). */
400 /* See @FT_FaceRec for the publicly accessible fields of a given face */
403 typedef struct FT_FaceRec_* FT_Face;
406 /*************************************************************************/
412 /* A handle to an object used to model a face scaled to a given */
413 /* character size. */
416 /* Each @FT_Face has an _active_ @FT_Size object that is used by */
417 /* functions like @FT_Load_Glyph to determine the scaling */
418 /* transformation which is used to load and hint glyphs and metrics. */
420 /* You can use @FT_Set_Char_Size, @FT_Set_Pixel_Sizes, */
421 /* @FT_Request_Size or even @FT_Select_Size to change the content */
422 /* (i.e., the scaling values) of the active @FT_Size. */
424 /* You can use @FT_New_Size to create additional size objects for a */
425 /* given @FT_Face, but they won't be used by other functions until */
426 /* you activate it through @FT_Activate_Size. Only one size can be */
427 /* activated at any given time per face. */
430 /* See @FT_SizeRec for the publicly accessible fields of a given size */
433 typedef struct FT_SizeRec_* FT_Size;
436 /*************************************************************************/
442 /* A handle to a given `glyph slot'. A slot is a container where it */
443 /* is possible to load any of the glyphs contained in its parent */
446 /* In other words, each time you call @FT_Load_Glyph or */
447 /* @FT_Load_Char, the slot's content is erased by the new glyph data, */
448 /* i.e., the glyph's metrics, its image (bitmap or outline), and */
449 /* other control information. */
452 /* See @FT_GlyphSlotRec for the publicly accessible glyph fields. */
454 typedef struct FT_GlyphSlotRec_* FT_GlyphSlot;
457 /*************************************************************************/
463 /* A handle to a given character map. A charmap is used to translate */
464 /* character codes in a given encoding into glyph indexes for its */
465 /* parent's face. Some font formats may provide several charmaps per */
468 /* Each face object owns zero or more charmaps, but only one of them */
469 /* can be `active' and used by @FT_Get_Char_Index or @FT_Load_Char. */
471 /* The list of available charmaps in a face is available through the */
472 /* `face->num_charmaps' and `face->charmaps' fields of @FT_FaceRec. */
474 /* The currently active charmap is available as `face->charmap'. */
475 /* You should call @FT_Set_Charmap to change it. */
478 /* When a new face is created (either through @FT_New_Face or */
479 /* @FT_Open_Face), the library looks for a Unicode charmap within */
480 /* the list and automatically activates it. */
483 /* See @FT_CharMapRec for the publicly accessible fields of a given */
486 typedef struct FT_CharMapRec_* FT_CharMap;
489 /*************************************************************************/
495 /* This macro converts four-letter tags into an unsigned long. It is */
496 /* used to define `encoding' identifiers (see @FT_Encoding). */
499 /* Since many 16-bit compilers don't like 32-bit enumerations, you */
500 /* should redefine this macro in case of problems to something like */
504 /* #define FT_ENC_TAG( value, a, b, c, d ) value */
507 /* to get a simple enumeration without assigning special numbers. */
511 #define FT_ENC_TAG( value, a, b, c, d ) \
512 value = ( ( (FT_UInt32)(a) << 24 ) | \
513 ( (FT_UInt32)(b) << 16 ) | \
514 ( (FT_UInt32)(c) << 8 ) | \
517 #endif /* FT_ENC_TAG */
520 /*************************************************************************/
526 /* An enumeration used to specify character sets supported by */
527 /* charmaps. Used in the @FT_Select_Charmap API function. */
530 /* Despite the name, this enumeration lists specific character */
531 /* repertories (i.e., charsets), and not text encoding methods (e.g., */
532 /* UTF-8, UTF-16, etc.). */
534 /* Other encodings might be defined in the future. */
537 /* FT_ENCODING_NONE :: */
538 /* The encoding value~0 is reserved. */
540 /* FT_ENCODING_UNICODE :: */
541 /* Corresponds to the Unicode character set. This value covers */
542 /* all versions of the Unicode repertoire, including ASCII and */
543 /* Latin-1. Most fonts include a Unicode charmap, but not all */
546 /* For example, if you want to access Unicode value U+1F028 (and */
547 /* the font contains it), use value 0x1F028 as the input value for */
548 /* @FT_Get_Char_Index. */
550 /* FT_ENCODING_MS_SYMBOL :: */
551 /* Corresponds to the Microsoft Symbol encoding, used to encode */
552 /* mathematical symbols in the 32..255 character code range. For */
553 /* more information, see `http://www.ceviz.net/symbol.htm'. */
555 /* FT_ENCODING_SJIS :: */
556 /* Corresponds to Japanese SJIS encoding. More info at */
557 /* at `http://langsupport.japanreference.com/encoding.shtml'. */
558 /* See note on multi-byte encodings below. */
560 /* FT_ENCODING_GB2312 :: */
561 /* Corresponds to an encoding system for Simplified Chinese as used */
562 /* used in mainland China. */
564 /* FT_ENCODING_BIG5 :: */
565 /* Corresponds to an encoding system for Traditional Chinese as */
566 /* used in Taiwan and Hong Kong. */
568 /* FT_ENCODING_WANSUNG :: */
569 /* Corresponds to the Korean encoding system known as Wansung. */
570 /* For more information see */
571 /* `http://www.microsoft.com/typography/unicode/949.txt'. */
573 /* FT_ENCODING_JOHAB :: */
574 /* The Korean standard character set (KS~C 5601-1992), which */
575 /* corresponds to MS Windows code page 1361. This character set */
576 /* includes all possible Hangeul character combinations. */
578 /* FT_ENCODING_ADOBE_LATIN_1 :: */
579 /* Corresponds to a Latin-1 encoding as defined in a Type~1 */
580 /* PostScript font. It is limited to 256 character codes. */
582 /* FT_ENCODING_ADOBE_STANDARD :: */
583 /* Corresponds to the Adobe Standard encoding, as found in Type~1, */
584 /* CFF, and OpenType/CFF fonts. It is limited to 256 character */
587 /* FT_ENCODING_ADOBE_EXPERT :: */
588 /* Corresponds to the Adobe Expert encoding, as found in Type~1, */
589 /* CFF, and OpenType/CFF fonts. It is limited to 256 character */
592 /* FT_ENCODING_ADOBE_CUSTOM :: */
593 /* Corresponds to a custom encoding, as found in Type~1, CFF, and */
594 /* OpenType/CFF fonts. It is limited to 256 character codes. */
596 /* FT_ENCODING_APPLE_ROMAN :: */
597 /* Corresponds to the 8-bit Apple roman encoding. Many TrueType */
598 /* and OpenType fonts contain a charmap for this encoding, since */
599 /* older versions of Mac OS are able to use it. */
601 /* FT_ENCODING_OLD_LATIN_2 :: */
602 /* This value is deprecated and was never used nor reported by */
603 /* FreeType. Don't use or test for it. */
605 /* FT_ENCODING_MS_SJIS :: */
606 /* Same as FT_ENCODING_SJIS. Deprecated. */
608 /* FT_ENCODING_MS_GB2312 :: */
609 /* Same as FT_ENCODING_GB2312. Deprecated. */
611 /* FT_ENCODING_MS_BIG5 :: */
612 /* Same as FT_ENCODING_BIG5. Deprecated. */
614 /* FT_ENCODING_MS_WANSUNG :: */
615 /* Same as FT_ENCODING_WANSUNG. Deprecated. */
617 /* FT_ENCODING_MS_JOHAB :: */
618 /* Same as FT_ENCODING_JOHAB. Deprecated. */
621 /* By default, FreeType automatically synthesizes a Unicode charmap */
622 /* for PostScript fonts, using their glyph names dictionaries. */
623 /* However, it also reports the encodings defined explicitly in the */
624 /* font file, for the cases when they are needed, with the Adobe */
625 /* values as well. */
627 /* FT_ENCODING_NONE is set by the BDF and PCF drivers if the charmap */
628 /* is neither Unicode nor ISO-8859-1 (otherwise it is set to */
629 /* FT_ENCODING_UNICODE). Use @FT_Get_BDF_Charset_ID to find out */
630 /* which encoding is really present. If, for example, the */
631 /* `cs_registry' field is `KOI8' and the `cs_encoding' field is `R', */
632 /* the font is encoded in KOI8-R. */
634 /* FT_ENCODING_NONE is always set (with a single exception) by the */
635 /* winfonts driver. Use @FT_Get_WinFNT_Header and examine the */
636 /* `charset' field of the @FT_WinFNT_HeaderRec structure to find out */
637 /* which encoding is really present. For example, */
638 /* @FT_WinFNT_ID_CP1251 (204) means Windows code page 1251 (for */
641 /* FT_ENCODING_NONE is set if `platform_id' is @TT_PLATFORM_MACINTOSH */
642 /* and `encoding_id' is not @TT_MAC_ID_ROMAN (otherwise it is set to */
643 /* FT_ENCODING_APPLE_ROMAN). */
645 /* If `platform_id' is @TT_PLATFORM_MACINTOSH, use the function */
646 /* @FT_Get_CMap_Language_ID to query the Mac language ID which may */
647 /* be needed to be able to distinguish Apple encoding variants. See */
649 /* http://www.unicode.org/Public/MAPPINGS/VENDORS/APPLE/README.TXT */
651 /* to get an idea how to do that. Basically, if the language ID */
652 /* is~0, don't use it, otherwise subtract 1 from the language ID. */
653 /* Then examine `encoding_id'. If, for example, `encoding_id' is */
654 /* @TT_MAC_ID_ROMAN and the language ID (minus~1) is */
655 /* `TT_MAC_LANGID_GREEK', it is the Greek encoding, not Roman. */
656 /* @TT_MAC_ID_ARABIC with `TT_MAC_LANGID_FARSI' means the Farsi */
657 /* variant the Arabic encoding. */
659 typedef enum FT_Encoding_
661 FT_ENC_TAG( FT_ENCODING_NONE, 0, 0, 0, 0 ),
663 FT_ENC_TAG( FT_ENCODING_MS_SYMBOL, 's', 'y', 'm', 'b' ),
664 FT_ENC_TAG( FT_ENCODING_UNICODE, 'u', 'n', 'i', 'c' ),
666 FT_ENC_TAG( FT_ENCODING_SJIS, 's', 'j', 'i', 's' ),
667 FT_ENC_TAG( FT_ENCODING_GB2312, 'g', 'b', ' ', ' ' ),
668 FT_ENC_TAG( FT_ENCODING_BIG5, 'b', 'i', 'g', '5' ),
669 FT_ENC_TAG( FT_ENCODING_WANSUNG, 'w', 'a', 'n', 's' ),
670 FT_ENC_TAG( FT_ENCODING_JOHAB, 'j', 'o', 'h', 'a' ),
672 /* for backwards compatibility */
673 FT_ENCODING_MS_SJIS = FT_ENCODING_SJIS,
674 FT_ENCODING_MS_GB2312 = FT_ENCODING_GB2312,
675 FT_ENCODING_MS_BIG5 = FT_ENCODING_BIG5,
676 FT_ENCODING_MS_WANSUNG = FT_ENCODING_WANSUNG,
677 FT_ENCODING_MS_JOHAB = FT_ENCODING_JOHAB,
679 FT_ENC_TAG( FT_ENCODING_ADOBE_STANDARD, 'A', 'D', 'O', 'B' ),
680 FT_ENC_TAG( FT_ENCODING_ADOBE_EXPERT, 'A', 'D', 'B', 'E' ),
681 FT_ENC_TAG( FT_ENCODING_ADOBE_CUSTOM, 'A', 'D', 'B', 'C' ),
682 FT_ENC_TAG( FT_ENCODING_ADOBE_LATIN_1, 'l', 'a', 't', '1' ),
684 FT_ENC_TAG( FT_ENCODING_OLD_LATIN_2, 'l', 'a', 't', '2' ),
686 FT_ENC_TAG( FT_ENCODING_APPLE_ROMAN, 'a', 'r', 'm', 'n' )
691 /*************************************************************************/
694 /* ft_encoding_xxx */
697 /* These constants are deprecated; use the corresponding @FT_Encoding */
698 /* values instead. */
700 #define ft_encoding_none FT_ENCODING_NONE
701 #define ft_encoding_unicode FT_ENCODING_UNICODE
702 #define ft_encoding_symbol FT_ENCODING_MS_SYMBOL
703 #define ft_encoding_latin_1 FT_ENCODING_ADOBE_LATIN_1
704 #define ft_encoding_latin_2 FT_ENCODING_OLD_LATIN_2
705 #define ft_encoding_sjis FT_ENCODING_SJIS
706 #define ft_encoding_gb2312 FT_ENCODING_GB2312
707 #define ft_encoding_big5 FT_ENCODING_BIG5
708 #define ft_encoding_wansung FT_ENCODING_WANSUNG
709 #define ft_encoding_johab FT_ENCODING_JOHAB
711 #define ft_encoding_adobe_standard FT_ENCODING_ADOBE_STANDARD
712 #define ft_encoding_adobe_expert FT_ENCODING_ADOBE_EXPERT
713 #define ft_encoding_adobe_custom FT_ENCODING_ADOBE_CUSTOM
714 #define ft_encoding_apple_roman FT_ENCODING_APPLE_ROMAN
717 /*************************************************************************/
723 /* The base charmap structure. */
726 /* face :: A handle to the parent face object. */
728 /* encoding :: An @FT_Encoding tag identifying the charmap. Use */
729 /* this with @FT_Select_Charmap. */
731 /* platform_id :: An ID number describing the platform for the */
732 /* following encoding ID. This comes directly from */
733 /* the TrueType specification and should be emulated */
734 /* for other formats. */
736 /* encoding_id :: A platform specific encoding number. This also */
737 /* comes from the TrueType specification and should be */
738 /* emulated similarly. */
740 typedef struct FT_CharMapRec_
743 FT_Encoding encoding;
744 FT_UShort platform_id;
745 FT_UShort encoding_id;
750 /*************************************************************************/
751 /*************************************************************************/
753 /* B A S E O B J E C T C L A S S E S */
755 /*************************************************************************/
756 /*************************************************************************/
759 /*************************************************************************/
762 /* FT_Face_Internal */
765 /* An opaque handle to an `FT_Face_InternalRec' structure, used to */
766 /* model private data of a given @FT_Face object. */
768 /* This structure might change between releases of FreeType~2 and is */
769 /* not generally available to client applications. */
771 typedef struct FT_Face_InternalRec_* FT_Face_Internal;
774 /*************************************************************************/
780 /* FreeType root face class structure. A face object models a */
781 /* typeface in a font file. */
784 /* num_faces :: The number of faces in the font file. Some */
785 /* font formats can have multiple faces in */
788 /* face_index :: The index of the face in the font file. It */
789 /* is set to~0 if there is only one face in */
792 /* face_flags :: A set of bit flags that give important */
793 /* information about the face; see */
794 /* @FT_FACE_FLAG_XXX for the details. */
796 /* style_flags :: A set of bit flags indicating the style of */
797 /* the face; see @FT_STYLE_FLAG_XXX for the */
800 /* num_glyphs :: The number of glyphs in the face. If the */
801 /* face is scalable and has sbits (see */
802 /* `num_fixed_sizes'), it is set to the number */
803 /* of outline glyphs. */
805 /* For CID-keyed fonts, this value gives the */
806 /* highest CID used in the font. */
808 /* family_name :: The face's family name. This is an ASCII */
809 /* string, usually in English, which describes */
810 /* the typeface's family (like `Times New */
811 /* Roman', `Bodoni', `Garamond', etc). This */
812 /* is a least common denominator used to list */
813 /* fonts. Some formats (TrueType & OpenType) */
814 /* provide localized and Unicode versions of */
815 /* this string. Applications should use the */
816 /* format specific interface to access them. */
817 /* Can be NULL (e.g., in fonts embedded in a */
820 /* style_name :: The face's style name. This is an ASCII */
821 /* string, usually in English, which describes */
822 /* the typeface's style (like `Italic', */
823 /* `Bold', `Condensed', etc). Not all font */
824 /* formats provide a style name, so this field */
825 /* is optional, and can be set to NULL. As */
826 /* for `family_name', some formats provide */
827 /* localized and Unicode versions of this */
828 /* string. Applications should use the format */
829 /* specific interface to access them. */
831 /* num_fixed_sizes :: The number of bitmap strikes in the face. */
832 /* Even if the face is scalable, there might */
833 /* still be bitmap strikes, which are called */
834 /* `sbits' in that case. */
836 /* available_sizes :: An array of @FT_Bitmap_Size for all bitmap */
837 /* strikes in the face. It is set to NULL if */
838 /* there is no bitmap strike. */
840 /* num_charmaps :: The number of charmaps in the face. */
842 /* charmaps :: An array of the charmaps of the face. */
844 /* generic :: A field reserved for client uses. See the */
845 /* @FT_Generic type description. */
847 /* bbox :: The font bounding box. Coordinates are */
848 /* expressed in font units (see */
849 /* `units_per_EM'). The box is large enough */
850 /* to contain any glyph from the font. Thus, */
851 /* `bbox.yMax' can be seen as the `maximum */
852 /* ascender', and `bbox.yMin' as the `minimum */
853 /* descender'. Only relevant for scalable */
856 /* Note that the bounding box might be off by */
857 /* (at least) one pixel for hinted fonts. See */
858 /* @FT_Size_Metrics for further discussion. */
860 /* units_per_EM :: The number of font units per EM square for */
861 /* this face. This is typically 2048 for */
862 /* TrueType fonts, and 1000 for Type~1 fonts. */
863 /* Only relevant for scalable formats. */
865 /* ascender :: The typographic ascender of the face, */
866 /* expressed in font units. For font formats */
867 /* not having this information, it is set to */
868 /* `bbox.yMax'. Only relevant for scalable */
871 /* descender :: The typographic descender of the face, */
872 /* expressed in font units. For font formats */
873 /* not having this information, it is set to */
874 /* `bbox.yMin'. Note that this field is */
875 /* usually negative. Only relevant for */
876 /* scalable formats. */
878 /* height :: The height is the vertical distance */
879 /* between two consecutive baselines, */
880 /* expressed in font units. It is always */
881 /* positive. Only relevant for scalable */
884 /* max_advance_width :: The maximum advance width, in font units, */
885 /* for all glyphs in this face. This can be */
886 /* used to make word wrapping computations */
887 /* faster. Only relevant for scalable */
890 /* max_advance_height :: The maximum advance height, in font units, */
891 /* for all glyphs in this face. This is only */
892 /* relevant for vertical layouts, and is set */
893 /* to `height' for fonts that do not provide */
894 /* vertical metrics. Only relevant for */
895 /* scalable formats. */
897 /* underline_position :: The position, in font units, of the */
898 /* underline line for this face. It is the */
899 /* center of the underlining stem. Only */
900 /* relevant for scalable formats. */
902 /* underline_thickness :: The thickness, in font units, of the */
903 /* underline for this face. Only relevant for */
904 /* scalable formats. */
906 /* glyph :: The face's associated glyph slot(s). */
908 /* size :: The current active size for this face. */
910 /* charmap :: The current active charmap for this face. */
913 /* Fields may be changed after a call to @FT_Attach_File or */
914 /* @FT_Attach_Stream. */
916 typedef struct FT_FaceRec_
926 FT_String* family_name;
927 FT_String* style_name;
929 FT_Int num_fixed_sizes;
930 FT_Bitmap_Size* available_sizes;
933 FT_CharMap* charmaps;
937 /*# The following member variables (down to `underline_thickness') */
938 /*# are only relevant to scalable outlines; cf. @FT_Bitmap_Size */
939 /*# for bitmap fonts. */
942 FT_UShort units_per_EM;
947 FT_Short max_advance_width;
948 FT_Short max_advance_height;
950 FT_Short underline_position;
951 FT_Short underline_thickness;
963 FT_ListRec sizes_list;
965 FT_Generic autohint; /* face-specific auto-hinter data */
966 void* extensions; /* unused */
968 FT_Face_Internal internal;
975 /*************************************************************************/
978 /* FT_FACE_FLAG_XXX */
981 /* A list of bit flags used in the `face_flags' field of the */
982 /* @FT_FaceRec structure. They inform client applications of */
983 /* properties of the corresponding face. */
986 /* FT_FACE_FLAG_SCALABLE :: */
987 /* Indicates that the face contains outline glyphs. This doesn't */
988 /* prevent bitmap strikes, i.e., a face can have both this and */
989 /* and @FT_FACE_FLAG_FIXED_SIZES set. */
991 /* FT_FACE_FLAG_FIXED_SIZES :: */
992 /* Indicates that the face contains bitmap strikes. See also the */
993 /* `num_fixed_sizes' and `available_sizes' fields of @FT_FaceRec. */
995 /* FT_FACE_FLAG_FIXED_WIDTH :: */
996 /* Indicates that the face contains fixed-width characters (like */
997 /* Courier, Lucido, MonoType, etc.). */
999 /* FT_FACE_FLAG_SFNT :: */
1000 /* Indicates that the face uses the `sfnt' storage scheme. For */
1001 /* now, this means TrueType and OpenType. */
1003 /* FT_FACE_FLAG_HORIZONTAL :: */
1004 /* Indicates that the face contains horizontal glyph metrics. This */
1005 /* should be set for all common formats. */
1007 /* FT_FACE_FLAG_VERTICAL :: */
1008 /* Indicates that the face contains vertical glyph metrics. This */
1009 /* is only available in some formats, not all of them. */
1011 /* FT_FACE_FLAG_KERNING :: */
1012 /* Indicates that the face contains kerning information. If set, */
1013 /* the kerning distance can be retrieved through the function */
1014 /* @FT_Get_Kerning. Otherwise the function always return the */
1015 /* vector (0,0). Note that FreeType doesn't handle kerning data */
1016 /* from the `GPOS' table (as present in some OpenType fonts). */
1018 /* FT_FACE_FLAG_FAST_GLYPHS :: */
1019 /* THIS FLAG IS DEPRECATED. DO NOT USE OR TEST IT. */
1021 /* FT_FACE_FLAG_MULTIPLE_MASTERS :: */
1022 /* Indicates that the font contains multiple masters and is capable */
1023 /* of interpolating between them. See the multiple-masters */
1024 /* specific API for details. */
1026 /* FT_FACE_FLAG_GLYPH_NAMES :: */
1027 /* Indicates that the font contains glyph names that can be */
1028 /* retrieved through @FT_Get_Glyph_Name. Note that some TrueType */
1029 /* fonts contain broken glyph name tables. Use the function */
1030 /* @FT_Has_PS_Glyph_Names when needed. */
1032 /* FT_FACE_FLAG_EXTERNAL_STREAM :: */
1033 /* Used internally by FreeType to indicate that a face's stream was */
1034 /* provided by the client application and should not be destroyed */
1035 /* when @FT_Done_Face is called. Don't read or test this flag. */
1037 /* FT_FACE_FLAG_HINTER :: */
1038 /* Set if the font driver has a hinting machine of its own. For */
1039 /* example, with TrueType fonts, it makes sense to use data from */
1040 /* the SFNT `gasp' table only if the native TrueType hinting engine */
1041 /* (with the bytecode interpreter) is available and active. */
1043 /* FT_FACE_FLAG_CID_KEYED :: */
1044 /* Set if the font is CID-keyed. In that case, the font is not */
1045 /* accessed by glyph indices but by CID values. For subsetted */
1046 /* CID-keyed fonts this has the consequence that not all index */
1047 /* values are a valid argument to FT_Load_Glyph. Only the CID */
1048 /* values for which corresponding glyphs in the subsetted font */
1049 /* exist make FT_Load_Glyph return successfully; in all other cases */
1050 /* you get an `FT_Err_Invalid_Argument' error. */
1052 /* Note that CID-keyed fonts which are in an SFNT wrapper don't */
1053 /* have this flag set since the glyphs are accessed in the normal */
1054 /* way (using contiguous indices); the `CID-ness' isn't visible to */
1055 /* the application. */
1057 /* FT_FACE_FLAG_TRICKY :: */
1058 /* Set if the font is `tricky', this is, it always needs the */
1059 /* font format's native hinting engine to get a reasonable result. */
1060 /* A typical example is the Chinese font `mingli.ttf' which uses */
1061 /* TrueType bytecode instructions to move and scale all of its */
1064 /* It is not possible to autohint such fonts using */
1065 /* @FT_LOAD_FORCE_AUTOHINT; it will also ignore */
1066 /* @FT_LOAD_NO_HINTING. You have to set both @FT_LOAD_NO_HINTING */
1067 /* and @FT_LOAD_NO_AUTOHINT to really disable hinting; however, you */
1068 /* probably never want this except for demonstration purposes. */
1070 /* Currently, there are about a dozen TrueType fonts in the list of */
1071 /* tricky fonts; they are hard-coded in file `ttobjs.c'. */
1073 #define FT_FACE_FLAG_SCALABLE ( 1L << 0 )
1074 #define FT_FACE_FLAG_FIXED_SIZES ( 1L << 1 )
1075 #define FT_FACE_FLAG_FIXED_WIDTH ( 1L << 2 )
1076 #define FT_FACE_FLAG_SFNT ( 1L << 3 )
1077 #define FT_FACE_FLAG_HORIZONTAL ( 1L << 4 )
1078 #define FT_FACE_FLAG_VERTICAL ( 1L << 5 )
1079 #define FT_FACE_FLAG_KERNING ( 1L << 6 )
1080 #define FT_FACE_FLAG_FAST_GLYPHS ( 1L << 7 )
1081 #define FT_FACE_FLAG_MULTIPLE_MASTERS ( 1L << 8 )
1082 #define FT_FACE_FLAG_GLYPH_NAMES ( 1L << 9 )
1083 #define FT_FACE_FLAG_EXTERNAL_STREAM ( 1L << 10 )
1084 #define FT_FACE_FLAG_HINTER ( 1L << 11 )
1085 #define FT_FACE_FLAG_CID_KEYED ( 1L << 12 )
1086 #define FT_FACE_FLAG_TRICKY ( 1L << 13 )
1089 /*************************************************************************
1092 * FT_HAS_HORIZONTAL( face )
1095 * A macro that returns true whenever a face object contains
1096 * horizontal metrics (this is true for all font formats though).
1099 * @FT_HAS_VERTICAL can be used to check for vertical metrics.
1102 #define FT_HAS_HORIZONTAL( face ) \
1103 ( face->face_flags & FT_FACE_FLAG_HORIZONTAL )
1106 /*************************************************************************
1109 * FT_HAS_VERTICAL( face )
1112 * A macro that returns true whenever a face object contains real
1113 * vertical metrics (and not only synthesized ones).
1116 #define FT_HAS_VERTICAL( face ) \
1117 ( face->face_flags & FT_FACE_FLAG_VERTICAL )
1120 /*************************************************************************
1123 * FT_HAS_KERNING( face )
1126 * A macro that returns true whenever a face object contains kerning
1127 * data that can be accessed with @FT_Get_Kerning.
1130 #define FT_HAS_KERNING( face ) \
1131 ( face->face_flags & FT_FACE_FLAG_KERNING )
1134 /*************************************************************************
1137 * FT_IS_SCALABLE( face )
1140 * A macro that returns true whenever a face object contains a scalable
1141 * font face (true for TrueType, Type~1, Type~42, CID, OpenType/CFF,
1142 * and PFR font formats.
1145 #define FT_IS_SCALABLE( face ) \
1146 ( face->face_flags & FT_FACE_FLAG_SCALABLE )
1149 /*************************************************************************
1152 * FT_IS_SFNT( face )
1155 * A macro that returns true whenever a face object contains a font
1156 * whose format is based on the SFNT storage scheme. This usually
1157 * means: TrueType fonts, OpenType fonts, as well as SFNT-based embedded
1160 * If this macro is true, all functions defined in @FT_SFNT_NAMES_H and
1161 * @FT_TRUETYPE_TABLES_H are available.
1164 #define FT_IS_SFNT( face ) \
1165 ( face->face_flags & FT_FACE_FLAG_SFNT )
1168 /*************************************************************************
1171 * FT_IS_FIXED_WIDTH( face )
1174 * A macro that returns true whenever a face object contains a font face
1175 * that contains fixed-width (or `monospace', `fixed-pitch', etc.)
1179 #define FT_IS_FIXED_WIDTH( face ) \
1180 ( face->face_flags & FT_FACE_FLAG_FIXED_WIDTH )
1183 /*************************************************************************
1186 * FT_HAS_FIXED_SIZES( face )
1189 * A macro that returns true whenever a face object contains some
1190 * embedded bitmaps. See the `available_sizes' field of the
1191 * @FT_FaceRec structure.
1194 #define FT_HAS_FIXED_SIZES( face ) \
1195 ( face->face_flags & FT_FACE_FLAG_FIXED_SIZES )
1198 /*************************************************************************
1201 * FT_HAS_FAST_GLYPHS( face )
1207 #define FT_HAS_FAST_GLYPHS( face ) 0
1210 /*************************************************************************
1213 * FT_HAS_GLYPH_NAMES( face )
1216 * A macro that returns true whenever a face object contains some glyph
1217 * names that can be accessed through @FT_Get_Glyph_Name.
1220 #define FT_HAS_GLYPH_NAMES( face ) \
1221 ( face->face_flags & FT_FACE_FLAG_GLYPH_NAMES )
1224 /*************************************************************************
1227 * FT_HAS_MULTIPLE_MASTERS( face )
1230 * A macro that returns true whenever a face object contains some
1231 * multiple masters. The functions provided by @FT_MULTIPLE_MASTERS_H
1232 * are then available to choose the exact design you want.
1235 #define FT_HAS_MULTIPLE_MASTERS( face ) \
1236 ( face->face_flags & FT_FACE_FLAG_MULTIPLE_MASTERS )
1239 /*************************************************************************
1242 * FT_IS_CID_KEYED( face )
1245 * A macro that returns true whenever a face object contains a CID-keyed
1246 * font. See the discussion of @FT_FACE_FLAG_CID_KEYED for more
1249 * If this macro is true, all functions defined in @FT_CID_H are
1253 #define FT_IS_CID_KEYED( face ) \
1254 ( face->face_flags & FT_FACE_FLAG_CID_KEYED )
1257 /*************************************************************************
1260 * FT_IS_TRICKY( face )
1263 * A macro that returns true whenever a face represents a `tricky' font.
1264 * See the discussion of @FT_FACE_FLAG_TRICKY for more details.
1267 #define FT_IS_TRICKY( face ) \
1268 ( face->face_flags & FT_FACE_FLAG_TRICKY )
1271 /*************************************************************************/
1274 /* FT_STYLE_FLAG_XXX */
1277 /* A list of bit-flags used to indicate the style of a given face. */
1278 /* These are used in the `style_flags' field of @FT_FaceRec. */
1281 /* FT_STYLE_FLAG_ITALIC :: */
1282 /* Indicates that a given face style is italic or oblique. */
1284 /* FT_STYLE_FLAG_BOLD :: */
1285 /* Indicates that a given face is bold. */
1288 /* The style information as provided by FreeType is very basic. More */
1289 /* details are beyond the scope and should be done on a higher level */
1290 /* (for example, by analyzing various fields of the `OS/2' table in */
1291 /* SFNT based fonts). */
1293 #define FT_STYLE_FLAG_ITALIC ( 1 << 0 )
1294 #define FT_STYLE_FLAG_BOLD ( 1 << 1 )
1297 /*************************************************************************/
1300 /* FT_Size_Internal */
1303 /* An opaque handle to an `FT_Size_InternalRec' structure, used to */
1304 /* model private data of a given @FT_Size object. */
1306 typedef struct FT_Size_InternalRec_* FT_Size_Internal;
1309 /*************************************************************************/
1312 /* FT_Size_Metrics */
1315 /* The size metrics structure gives the metrics of a size object. */
1318 /* x_ppem :: The width of the scaled EM square in pixels, hence */
1319 /* the term `ppem' (pixels per EM). It is also */
1320 /* referred to as `nominal width'. */
1322 /* y_ppem :: The height of the scaled EM square in pixels, */
1323 /* hence the term `ppem' (pixels per EM). It is also */
1324 /* referred to as `nominal height'. */
1326 /* x_scale :: A 16.16 fractional scaling value used to convert */
1327 /* horizontal metrics from font units to 26.6 */
1328 /* fractional pixels. Only relevant for scalable */
1331 /* y_scale :: A 16.16 fractional scaling value used to convert */
1332 /* vertical metrics from font units to 26.6 */
1333 /* fractional pixels. Only relevant for scalable */
1336 /* ascender :: The ascender in 26.6 fractional pixels. See */
1337 /* @FT_FaceRec for the details. */
1339 /* descender :: The descender in 26.6 fractional pixels. See */
1340 /* @FT_FaceRec for the details. */
1342 /* height :: The height in 26.6 fractional pixels. See */
1343 /* @FT_FaceRec for the details. */
1345 /* max_advance :: The maximum advance width in 26.6 fractional */
1346 /* pixels. See @FT_FaceRec for the details. */
1349 /* The scaling values, if relevant, are determined first during a */
1350 /* size changing operation. The remaining fields are then set by the */
1351 /* driver. For scalable formats, they are usually set to scaled */
1352 /* values of the corresponding fields in @FT_FaceRec. */
1354 /* Note that due to glyph hinting, these values might not be exact */
1355 /* for certain fonts. Thus they must be treated as unreliable */
1356 /* with an error margin of at least one pixel! */
1358 /* Indeed, the only way to get the exact metrics is to render _all_ */
1359 /* glyphs. As this would be a definite performance hit, it is up to */
1360 /* client applications to perform such computations. */
1362 /* The FT_Size_Metrics structure is valid for bitmap fonts also. */
1364 typedef struct FT_Size_Metrics_
1366 FT_UShort x_ppem; /* horizontal pixels per EM */
1367 FT_UShort y_ppem; /* vertical pixels per EM */
1369 FT_Fixed x_scale; /* scaling values used to convert font */
1370 FT_Fixed y_scale; /* units to 26.6 fractional pixels */
1372 FT_Pos ascender; /* ascender in 26.6 frac. pixels */
1373 FT_Pos descender; /* descender in 26.6 frac. pixels */
1374 FT_Pos height; /* text height in 26.6 frac. pixels */
1375 FT_Pos max_advance; /* max horizontal advance, in 26.6 pixels */
1380 /*************************************************************************/
1386 /* FreeType root size class structure. A size object models a face */
1387 /* object at a given size. */
1390 /* face :: Handle to the parent face object. */
1392 /* generic :: A typeless pointer, which is unused by the FreeType */
1393 /* library or any of its drivers. It can be used by */
1394 /* client applications to link their own data to each size */
1397 /* metrics :: Metrics for this size object. This field is read-only. */
1399 typedef struct FT_SizeRec_
1401 FT_Face face; /* parent face object */
1402 FT_Generic generic; /* generic pointer for client uses */
1403 FT_Size_Metrics metrics; /* size metrics */
1404 FT_Size_Internal internal;
1409 /*************************************************************************/
1415 /* The subglyph structure is an internal object used to describe */
1416 /* subglyphs (for example, in the case of composites). */
1419 /* The subglyph implementation is not part of the high-level API, */
1420 /* hence the forward structure declaration. */
1422 /* You can however retrieve subglyph information with */
1423 /* @FT_Get_SubGlyph_Info. */
1425 typedef struct FT_SubGlyphRec_* FT_SubGlyph;
1428 /*************************************************************************/
1431 /* FT_Slot_Internal */
1434 /* An opaque handle to an `FT_Slot_InternalRec' structure, used to */
1435 /* model private data of a given @FT_GlyphSlot object. */
1437 typedef struct FT_Slot_InternalRec_* FT_Slot_Internal;
1440 /*************************************************************************/
1443 /* FT_GlyphSlotRec */
1446 /* FreeType root glyph slot class structure. A glyph slot is a */
1447 /* container where individual glyphs can be loaded, be they in */
1448 /* outline or bitmap format. */
1451 /* library :: A handle to the FreeType library instance */
1452 /* this slot belongs to. */
1454 /* face :: A handle to the parent face object. */
1456 /* next :: In some cases (like some font tools), several */
1457 /* glyph slots per face object can be a good */
1458 /* thing. As this is rare, the glyph slots are */
1459 /* listed through a direct, single-linked list */
1460 /* using its `next' field. */
1462 /* generic :: A typeless pointer which is unused by the */
1463 /* FreeType library or any of its drivers. It */
1464 /* can be used by client applications to link */
1465 /* their own data to each glyph slot object. */
1467 /* metrics :: The metrics of the last loaded glyph in the */
1468 /* slot. The returned values depend on the last */
1469 /* load flags (see the @FT_Load_Glyph API */
1470 /* function) and can be expressed either in 26.6 */
1471 /* fractional pixels or font units. */
1473 /* Note that even when the glyph image is */
1474 /* transformed, the metrics are not. */
1476 /* linearHoriAdvance :: The advance width of the unhinted glyph. */
1477 /* Its value is expressed in 16.16 fractional */
1478 /* pixels, unless @FT_LOAD_LINEAR_DESIGN is set */
1479 /* when loading the glyph. This field can be */
1480 /* important to perform correct WYSIWYG layout. */
1481 /* Only relevant for outline glyphs. */
1483 /* linearVertAdvance :: The advance height of the unhinted glyph. */
1484 /* Its value is expressed in 16.16 fractional */
1485 /* pixels, unless @FT_LOAD_LINEAR_DESIGN is set */
1486 /* when loading the glyph. This field can be */
1487 /* important to perform correct WYSIWYG layout. */
1488 /* Only relevant for outline glyphs. */
1490 /* advance :: This shorthand is, depending on */
1491 /* @FT_LOAD_IGNORE_TRANSFORM, the transformed */
1492 /* advance width for the glyph (in 26.6 */
1493 /* fractional pixel format). As specified with */
1494 /* @FT_LOAD_VERTICAL_LAYOUT, it uses either the */
1495 /* `horiAdvance' or the `vertAdvance' value of */
1496 /* `metrics' field. */
1498 /* format :: This field indicates the format of the image */
1499 /* contained in the glyph slot. Typically */
1500 /* @FT_GLYPH_FORMAT_BITMAP, */
1501 /* @FT_GLYPH_FORMAT_OUTLINE, or */
1502 /* @FT_GLYPH_FORMAT_COMPOSITE, but others are */
1505 /* bitmap :: This field is used as a bitmap descriptor */
1506 /* when the slot format is */
1507 /* @FT_GLYPH_FORMAT_BITMAP. Note that the */
1508 /* address and content of the bitmap buffer can */
1509 /* change between calls of @FT_Load_Glyph and a */
1510 /* few other functions. */
1512 /* bitmap_left :: This is the bitmap's left bearing expressed */
1513 /* in integer pixels. Of course, this is only */
1514 /* valid if the format is */
1515 /* @FT_GLYPH_FORMAT_BITMAP. */
1517 /* bitmap_top :: This is the bitmap's top bearing expressed in */
1518 /* integer pixels. Remember that this is the */
1519 /* distance from the baseline to the top-most */
1520 /* glyph scanline, upwards y~coordinates being */
1523 /* outline :: The outline descriptor for the current glyph */
1524 /* image if its format is */
1525 /* @FT_GLYPH_FORMAT_OUTLINE. Once a glyph is */
1526 /* loaded, `outline' can be transformed, */
1527 /* distorted, embolded, etc. However, it must */
1530 /* num_subglyphs :: The number of subglyphs in a composite glyph. */
1531 /* This field is only valid for the composite */
1532 /* glyph format that should normally only be */
1533 /* loaded with the @FT_LOAD_NO_RECURSE flag. */
1534 /* For now this is internal to FreeType. */
1536 /* subglyphs :: An array of subglyph descriptors for */
1537 /* composite glyphs. There are `num_subglyphs' */
1538 /* elements in there. Currently internal to */
1541 /* control_data :: Certain font drivers can also return the */
1542 /* control data for a given glyph image (e.g. */
1543 /* TrueType bytecode, Type~1 charstrings, etc.). */
1544 /* This field is a pointer to such data. */
1546 /* control_len :: This is the length in bytes of the control */
1549 /* other :: Really wicked formats can use this pointer to */
1550 /* present their own glyph image to client */
1551 /* applications. Note that the application */
1552 /* needs to know about the image format. */
1554 /* lsb_delta :: The difference between hinted and unhinted */
1555 /* left side bearing while autohinting is */
1556 /* active. Zero otherwise. */
1558 /* rsb_delta :: The difference between hinted and unhinted */
1559 /* right side bearing while autohinting is */
1560 /* active. Zero otherwise. */
1563 /* If @FT_Load_Glyph is called with default flags (see */
1564 /* @FT_LOAD_DEFAULT) the glyph image is loaded in the glyph slot in */
1565 /* its native format (e.g., an outline glyph for TrueType and Type~1 */
1568 /* This image can later be converted into a bitmap by calling */
1569 /* @FT_Render_Glyph. This function finds the current renderer for */
1570 /* the native image's format, then invokes it. */
1572 /* The renderer is in charge of transforming the native image through */
1573 /* the slot's face transformation fields, then converting it into a */
1574 /* bitmap that is returned in `slot->bitmap'. */
1576 /* Note that `slot->bitmap_left' and `slot->bitmap_top' are also used */
1577 /* to specify the position of the bitmap relative to the current pen */
1578 /* position (e.g., coordinates (0,0) on the baseline). Of course, */
1579 /* `slot->format' is also changed to @FT_GLYPH_FORMAT_BITMAP. */
1582 /* Here a small pseudo code fragment which shows how to use */
1583 /* `lsb_delta' and `rsb_delta': */
1586 /* FT_Pos origin_x = 0; */
1587 /* FT_Pos prev_rsb_delta = 0; */
1590 /* for all glyphs do */
1591 /* <compute kern between current and previous glyph and add it to */
1594 /* <load glyph with `FT_Load_Glyph'> */
1596 /* if ( prev_rsb_delta - face->glyph->lsb_delta >= 32 ) */
1597 /* origin_x -= 64; */
1598 /* else if ( prev_rsb_delta - face->glyph->lsb_delta < -32 ) */
1599 /* origin_x += 64; */
1601 /* prev_rsb_delta = face->glyph->rsb_delta; */
1603 /* <save glyph image, or render glyph, or ...> */
1605 /* origin_x += face->glyph->advance.x; */
1609 typedef struct FT_GlyphSlotRec_
1614 FT_UInt reserved; /* retained for binary compatibility */
1617 FT_Glyph_Metrics metrics;
1618 FT_Fixed linearHoriAdvance;
1619 FT_Fixed linearVertAdvance;
1622 FT_Glyph_Format format;
1630 FT_UInt num_subglyphs;
1631 FT_SubGlyph subglyphs;
1641 FT_Slot_Internal internal;
1646 /*************************************************************************/
1647 /*************************************************************************/
1649 /* F U N C T I O N S */
1651 /*************************************************************************/
1652 /*************************************************************************/
1655 /*************************************************************************/
1658 /* FT_Init_FreeType */
1661 /* Initialize a new FreeType library object. The set of modules */
1662 /* that are registered by this function is determined at build time. */
1665 /* alibrary :: A handle to a new library object. */
1668 /* FreeType error code. 0~means success. */
1671 /* In case you want to provide your own memory allocating routines, */
1672 /* use @FT_New_Library instead, followed by a call to */
1673 /* @FT_Add_Default_Modules (or a series of calls to @FT_Add_Module). */
1675 /* For multi-threading applications each thread should have its own */
1676 /* FT_Library object. */
1678 FT_EXPORT( FT_Error )
1679 FT_Init_FreeType( FT_Library *alibrary );
1682 /*************************************************************************/
1685 /* FT_Done_FreeType */
1688 /* Destroy a given FreeType library object and all of its children, */
1689 /* including resources, drivers, faces, sizes, etc. */
1692 /* library :: A handle to the target library object. */
1695 /* FreeType error code. 0~means success. */
1697 FT_EXPORT( FT_Error )
1698 FT_Done_FreeType( FT_Library library );
1701 /*************************************************************************/
1707 /* A list of bit-field constants used within the `flags' field of the */
1708 /* @FT_Open_Args structure. */
1711 /* FT_OPEN_MEMORY :: This is a memory-based stream. */
1713 /* FT_OPEN_STREAM :: Copy the stream from the `stream' field. */
1715 /* FT_OPEN_PATHNAME :: Create a new input stream from a C~path */
1718 /* FT_OPEN_DRIVER :: Use the `driver' field. */
1720 /* FT_OPEN_PARAMS :: Use the `num_params' and `params' fields. */
1722 /* ft_open_memory :: Deprecated; use @FT_OPEN_MEMORY instead. */
1724 /* ft_open_stream :: Deprecated; use @FT_OPEN_STREAM instead. */
1726 /* ft_open_pathname :: Deprecated; use @FT_OPEN_PATHNAME instead. */
1728 /* ft_open_driver :: Deprecated; use @FT_OPEN_DRIVER instead. */
1730 /* ft_open_params :: Deprecated; use @FT_OPEN_PARAMS instead. */
1733 /* The `FT_OPEN_MEMORY', `FT_OPEN_STREAM', and `FT_OPEN_PATHNAME' */
1734 /* flags are mutually exclusive. */
1736 #define FT_OPEN_MEMORY 0x1
1737 #define FT_OPEN_STREAM 0x2
1738 #define FT_OPEN_PATHNAME 0x4
1739 #define FT_OPEN_DRIVER 0x8
1740 #define FT_OPEN_PARAMS 0x10
1742 #define ft_open_memory FT_OPEN_MEMORY /* deprecated */
1743 #define ft_open_stream FT_OPEN_STREAM /* deprecated */
1744 #define ft_open_pathname FT_OPEN_PATHNAME /* deprecated */
1745 #define ft_open_driver FT_OPEN_DRIVER /* deprecated */
1746 #define ft_open_params FT_OPEN_PARAMS /* deprecated */
1749 /*************************************************************************/
1755 /* A simple structure used to pass more or less generic parameters to */
1756 /* @FT_Open_Face. */
1759 /* tag :: A four-byte identification tag. */
1761 /* data :: A pointer to the parameter data. */
1764 /* The ID and function of parameters are driver-specific. See the */
1765 /* various FT_PARAM_TAG_XXX flags for more information. */
1767 typedef struct FT_Parameter_
1775 /*************************************************************************/
1781 /* A structure used to indicate how to open a new font file or */
1782 /* stream. A pointer to such a structure can be used as a parameter */
1783 /* for the functions @FT_Open_Face and @FT_Attach_Stream. */
1786 /* flags :: A set of bit flags indicating how to use the */
1789 /* memory_base :: The first byte of the file in memory. */
1791 /* memory_size :: The size in bytes of the file in memory. */
1793 /* pathname :: A pointer to an 8-bit file pathname. */
1795 /* stream :: A handle to a source stream object. */
1797 /* driver :: This field is exclusively used by @FT_Open_Face; */
1798 /* it simply specifies the font driver to use to open */
1799 /* the face. If set to~0, FreeType tries to load the */
1800 /* face with each one of the drivers in its list. */
1802 /* num_params :: The number of extra parameters. */
1804 /* params :: Extra parameters passed to the font driver when */
1805 /* opening a new face. */
1808 /* The stream type is determined by the contents of `flags' which */
1809 /* are tested in the following order by @FT_Open_Face: */
1811 /* If the `FT_OPEN_MEMORY' bit is set, assume that this is a */
1812 /* memory file of `memory_size' bytes, located at `memory_address'. */
1813 /* The data are are not copied, and the client is responsible for */
1814 /* releasing and destroying them _after_ the corresponding call to */
1815 /* @FT_Done_Face. */
1817 /* Otherwise, if the `FT_OPEN_STREAM' bit is set, assume that a */
1818 /* custom input stream `stream' is used. */
1820 /* Otherwise, if the `FT_OPEN_PATHNAME' bit is set, assume that this */
1821 /* is a normal file and use `pathname' to open it. */
1823 /* If the `FT_OPEN_DRIVER' bit is set, @FT_Open_Face only tries to */
1824 /* open the file with the driver whose handler is in `driver'. */
1826 /* If the `FT_OPEN_PARAMS' bit is set, the parameters given by */
1827 /* `num_params' and `params' is used. They are ignored otherwise. */
1829 /* Ideally, both the `pathname' and `params' fields should be tagged */
1830 /* as `const'; this is missing for API backwards compatibility. In */
1831 /* other words, applications should treat them as read-only. */
1833 typedef struct FT_Open_Args_
1836 const FT_Byte* memory_base;
1837 FT_Long memory_size;
1838 FT_String* pathname;
1842 FT_Parameter* params;
1847 /*************************************************************************/
1853 /* This function calls @FT_Open_Face to open a font by its pathname. */
1856 /* library :: A handle to the library resource. */
1859 /* pathname :: A path to the font file. */
1861 /* face_index :: The index of the face within the font. The first */
1862 /* face has index~0. */
1865 /* aface :: A handle to a new face object. If `face_index' is */
1866 /* greater than or equal to zero, it must be non-NULL. */
1867 /* See @FT_Open_Face for more details. */
1870 /* FreeType error code. 0~means success. */
1872 FT_EXPORT( FT_Error )
1873 FT_New_Face( FT_Library library,
1874 const char* filepathname,
1879 /*************************************************************************/
1882 /* FT_New_Memory_Face */
1885 /* This function calls @FT_Open_Face to open a font which has been */
1886 /* loaded into memory. */
1889 /* library :: A handle to the library resource. */
1892 /* file_base :: A pointer to the beginning of the font data. */
1894 /* file_size :: The size of the memory chunk used by the font data. */
1896 /* face_index :: The index of the face within the font. The first */
1897 /* face has index~0. */
1900 /* aface :: A handle to a new face object. If `face_index' is */
1901 /* greater than or equal to zero, it must be non-NULL. */
1902 /* See @FT_Open_Face for more details. */
1905 /* FreeType error code. 0~means success. */
1908 /* You must not deallocate the memory before calling @FT_Done_Face. */
1910 FT_EXPORT( FT_Error )
1911 FT_New_Memory_Face( FT_Library library,
1912 const FT_Byte* file_base,
1918 /*************************************************************************/
1924 /* Create a face object from a given resource described by */
1925 /* @FT_Open_Args. */
1928 /* library :: A handle to the library resource. */
1931 /* args :: A pointer to an `FT_Open_Args' structure which must */
1932 /* be filled by the caller. */
1934 /* face_index :: The index of the face within the font. The first */
1935 /* face has index~0. */
1938 /* aface :: A handle to a new face object. If `face_index' is */
1939 /* greater than or equal to zero, it must be non-NULL. */
1940 /* See note below. */
1943 /* FreeType error code. 0~means success. */
1946 /* Unlike FreeType 1.x, this function automatically creates a glyph */
1947 /* slot for the face object which can be accessed directly through */
1948 /* `face->glyph'. */
1950 /* FT_Open_Face can be used to quickly check whether the font */
1951 /* format of a given font resource is supported by FreeType. If the */
1952 /* `face_index' field is negative, the function's return value is~0 */
1953 /* if the font format is recognized, or non-zero otherwise; */
1954 /* the function returns a more or less empty face handle in `*aface' */
1955 /* (if `aface' isn't NULL). The only useful field in this special */
1956 /* case is `face->num_faces' which gives the number of faces within */
1957 /* the font file. After examination, the returned @FT_Face structure */
1958 /* should be deallocated with a call to @FT_Done_Face. */
1960 /* Each new face object created with this function also owns a */
1961 /* default @FT_Size object, accessible as `face->size'. */
1963 /* One @FT_Library instance can have multiple face objects, this is, */
1964 /* @FT_Open_Face and its siblings can be called multiple times using */
1965 /* the same `library' argument. */
1967 /* See the discussion of reference counters in the description of */
1968 /* @FT_Reference_Face. */
1970 FT_EXPORT( FT_Error )
1971 FT_Open_Face( FT_Library library,
1972 const FT_Open_Args* args,
1977 /*************************************************************************/
1980 /* FT_Attach_File */
1983 /* This function calls @FT_Attach_Stream to attach a file. */
1986 /* face :: The target face object. */
1989 /* filepathname :: The pathname. */
1992 /* FreeType error code. 0~means success. */
1994 FT_EXPORT( FT_Error )
1995 FT_Attach_File( FT_Face face,
1996 const char* filepathname );
1999 /*************************************************************************/
2002 /* FT_Attach_Stream */
2005 /* `Attach' data to a face object. Normally, this is used to read */
2006 /* additional information for the face object. For example, you can */
2007 /* attach an AFM file that comes with a Type~1 font to get the */
2008 /* kerning values and other metrics. */
2011 /* face :: The target face object. */
2014 /* parameters :: A pointer to @FT_Open_Args which must be filled by */
2018 /* FreeType error code. 0~means success. */
2021 /* The meaning of the `attach' (i.e., what really happens when the */
2022 /* new file is read) is not fixed by FreeType itself. It really */
2023 /* depends on the font format (and thus the font driver). */
2025 /* Client applications are expected to know what they are doing */
2026 /* when invoking this function. Most drivers simply do not implement */
2027 /* file attachments. */
2029 FT_EXPORT( FT_Error )
2030 FT_Attach_Stream( FT_Face face,
2031 FT_Open_Args* parameters );
2034 /*************************************************************************/
2037 /* FT_Reference_Face */
2040 /* A counter gets initialized to~1 at the time an @FT_Face structure */
2041 /* is created. This function increments the counter. @FT_Done_Face */
2042 /* then only destroys a face if the counter is~1, otherwise it simply */
2043 /* decrements the counter. */
2045 /* This function helps in managing life-cycles of structures which */
2046 /* reference @FT_Face objects. */
2049 /* face :: A handle to a target face object. */
2052 /* FreeType error code. 0~means success. */
2057 FT_EXPORT( FT_Error )
2058 FT_Reference_Face( FT_Face face );
2061 /*************************************************************************/
2067 /* Discard a given face object, as well as all of its child slots and */
2071 /* face :: A handle to a target face object. */
2074 /* FreeType error code. 0~means success. */
2077 /* See the discussion of reference counters in the description of */
2078 /* @FT_Reference_Face. */
2080 FT_EXPORT( FT_Error )
2081 FT_Done_Face( FT_Face face );
2084 /*************************************************************************/
2087 /* FT_Select_Size */
2090 /* Select a bitmap strike. */
2093 /* face :: A handle to a target face object. */
2096 /* strike_index :: The index of the bitmap strike in the */
2097 /* `available_sizes' field of @FT_FaceRec structure. */
2100 /* FreeType error code. 0~means success. */
2102 FT_EXPORT( FT_Error )
2103 FT_Select_Size( FT_Face face,
2104 FT_Int strike_index );
2107 /*************************************************************************/
2110 /* FT_Size_Request_Type */
2113 /* An enumeration type that lists the supported size request types. */
2116 /* FT_SIZE_REQUEST_TYPE_NOMINAL :: */
2117 /* The nominal size. The `units_per_EM' field of @FT_FaceRec is */
2118 /* used to determine both scaling values. */
2120 /* FT_SIZE_REQUEST_TYPE_REAL_DIM :: */
2121 /* The real dimension. The sum of the the `ascender' and (minus */
2122 /* of) the `descender' fields of @FT_FaceRec are used to determine */
2123 /* both scaling values. */
2125 /* FT_SIZE_REQUEST_TYPE_BBOX :: */
2126 /* The font bounding box. The width and height of the `bbox' field */
2127 /* of @FT_FaceRec are used to determine the horizontal and vertical */
2128 /* scaling value, respectively. */
2130 /* FT_SIZE_REQUEST_TYPE_CELL :: */
2131 /* The `max_advance_width' field of @FT_FaceRec is used to */
2132 /* determine the horizontal scaling value; the vertical scaling */
2133 /* value is determined the same way as */
2134 /* @FT_SIZE_REQUEST_TYPE_REAL_DIM does. Finally, both scaling */
2135 /* values are set to the smaller one. This type is useful if you */
2136 /* want to specify the font size for, say, a window of a given */
2137 /* dimension and 80x24 cells. */
2139 /* FT_SIZE_REQUEST_TYPE_SCALES :: */
2140 /* Specify the scaling values directly. */
2143 /* The above descriptions only apply to scalable formats. For bitmap */
2144 /* formats, the behaviour is up to the driver. */
2146 /* See the note section of @FT_Size_Metrics if you wonder how size */
2147 /* requesting relates to scaling values. */
2149 typedef enum FT_Size_Request_Type_
2151 FT_SIZE_REQUEST_TYPE_NOMINAL,
2152 FT_SIZE_REQUEST_TYPE_REAL_DIM,
2153 FT_SIZE_REQUEST_TYPE_BBOX,
2154 FT_SIZE_REQUEST_TYPE_CELL,
2155 FT_SIZE_REQUEST_TYPE_SCALES,
2157 FT_SIZE_REQUEST_TYPE_MAX
2159 } FT_Size_Request_Type;
2162 /*************************************************************************/
2165 /* FT_Size_RequestRec */
2168 /* A structure used to model a size request. */
2171 /* type :: See @FT_Size_Request_Type. */
2173 /* width :: The desired width. */
2175 /* height :: The desired height. */
2177 /* horiResolution :: The horizontal resolution. If set to zero, */
2178 /* `width' is treated as a 26.6 fractional pixel */
2181 /* vertResolution :: The vertical resolution. If set to zero, */
2182 /* `height' is treated as a 26.6 fractional pixel */
2186 /* If `width' is zero, then the horizontal scaling value is set equal */
2187 /* to the vertical scaling value, and vice versa. */
2189 typedef struct FT_Size_RequestRec_
2191 FT_Size_Request_Type type;
2194 FT_UInt horiResolution;
2195 FT_UInt vertResolution;
2197 } FT_Size_RequestRec;
2200 /*************************************************************************/
2203 /* FT_Size_Request */
2206 /* A handle to a size request structure. */
2208 typedef struct FT_Size_RequestRec_ *FT_Size_Request;
2211 /*************************************************************************/
2214 /* FT_Request_Size */
2217 /* Resize the scale of the active @FT_Size object in a face. */
2220 /* face :: A handle to a target face object. */
2223 /* req :: A pointer to a @FT_Size_RequestRec. */
2226 /* FreeType error code. 0~means success. */
2229 /* Although drivers may select the bitmap strike matching the */
2230 /* request, you should not rely on this if you intend to select a */
2231 /* particular bitmap strike. Use @FT_Select_Size instead in that */
2234 /* The relation between the requested size and the resulting glyph */
2235 /* size is dependent entirely on how the size is defined in the */
2236 /* source face. The font designer chooses the final size of each */
2237 /* glyph relative to this size. For more information refer to */
2238 /* `http://www.freetype.org/freetype2/docs/glyphs/glyphs-2.html' */
2240 FT_EXPORT( FT_Error )
2241 FT_Request_Size( FT_Face face,
2242 FT_Size_Request req );
2245 /*************************************************************************/
2248 /* FT_Set_Char_Size */
2251 /* This function calls @FT_Request_Size to request the nominal size */
2255 /* face :: A handle to a target face object. */
2258 /* char_width :: The nominal width, in 26.6 fractional points. */
2260 /* char_height :: The nominal height, in 26.6 fractional points. */
2262 /* horz_resolution :: The horizontal resolution in dpi. */
2264 /* vert_resolution :: The vertical resolution in dpi. */
2267 /* FreeType error code. 0~means success. */
2270 /* If either the character width or height is zero, it is set equal */
2271 /* to the other value. */
2273 /* If either the horizontal or vertical resolution is zero, it is set */
2274 /* equal to the other value. */
2276 /* A character width or height smaller than 1pt is set to 1pt; if */
2277 /* both resolution values are zero, they are set to 72dpi. */
2279 /* Don't use this function if you are using the FreeType cache API. */
2281 FT_EXPORT( FT_Error )
2282 FT_Set_Char_Size( FT_Face face,
2283 FT_F26Dot6 char_width,
2284 FT_F26Dot6 char_height,
2285 FT_UInt horz_resolution,
2286 FT_UInt vert_resolution );
2289 /*************************************************************************/
2292 /* FT_Set_Pixel_Sizes */
2295 /* This function calls @FT_Request_Size to request the nominal size */
2299 /* face :: A handle to the target face object. */
2302 /* pixel_width :: The nominal width, in pixels. */
2304 /* pixel_height :: The nominal height, in pixels. */
2307 /* FreeType error code. 0~means success. */
2310 /* You should not rely on the resulting glyphs matching, or being */
2311 /* constrained, to this pixel size. Refer to @FT_Request_Size to */
2312 /* understand how requested sizes relate to actual sizes. */
2314 FT_EXPORT( FT_Error )
2315 FT_Set_Pixel_Sizes( FT_Face face,
2316 FT_UInt pixel_width,
2317 FT_UInt pixel_height );
2320 /*************************************************************************/
2326 /* A function used to load a single glyph into the glyph slot of a */
2330 /* face :: A handle to the target face object where the glyph */
2334 /* glyph_index :: The index of the glyph in the font file. For */
2335 /* CID-keyed fonts (either in PS or in CFF format) */
2336 /* this argument specifies the CID value. */
2338 /* load_flags :: A flag indicating what to load for this glyph. The */
2339 /* @FT_LOAD_XXX constants can be used to control the */
2340 /* glyph loading process (e.g., whether the outline */
2341 /* should be scaled, whether to load bitmaps or not, */
2342 /* whether to hint the outline, etc). */
2345 /* FreeType error code. 0~means success. */
2348 /* The loaded glyph may be transformed. See @FT_Set_Transform for */
2351 /* For subsetted CID-keyed fonts, `FT_Err_Invalid_Argument' is */
2352 /* returned for invalid CID values (this is, for CID values which */
2353 /* don't have a corresponding glyph in the font). See the discussion */
2354 /* of the @FT_FACE_FLAG_CID_KEYED flag for more details. */
2356 FT_EXPORT( FT_Error )
2357 FT_Load_Glyph( FT_Face face,
2358 FT_UInt glyph_index,
2359 FT_Int32 load_flags );
2362 /*************************************************************************/
2368 /* A function used to load a single glyph into the glyph slot of a */
2369 /* face object, according to its character code. */
2372 /* face :: A handle to a target face object where the glyph */
2376 /* char_code :: The glyph's character code, according to the */
2377 /* current charmap used in the face. */
2379 /* load_flags :: A flag indicating what to load for this glyph. The */
2380 /* @FT_LOAD_XXX constants can be used to control the */
2381 /* glyph loading process (e.g., whether the outline */
2382 /* should be scaled, whether to load bitmaps or not, */
2383 /* whether to hint the outline, etc). */
2386 /* FreeType error code. 0~means success. */
2389 /* This function simply calls @FT_Get_Char_Index and @FT_Load_Glyph. */
2391 FT_EXPORT( FT_Error )
2392 FT_Load_Char( FT_Face face,
2394 FT_Int32 load_flags );
2397 /*************************************************************************
2403 * A list of bit-field constants used with @FT_Load_Glyph to indicate
2404 * what kind of operations to perform during glyph loading.
2407 * FT_LOAD_DEFAULT ::
2408 * Corresponding to~0, this value is used as the default glyph load
2409 * operation. In this case, the following happens:
2411 * 1. FreeType looks for a bitmap for the glyph corresponding to the
2412 * face's current size. If one is found, the function returns.
2413 * The bitmap data can be accessed from the glyph slot (see note
2416 * 2. If no embedded bitmap is searched or found, FreeType looks for a
2417 * scalable outline. If one is found, it is loaded from the font
2418 * file, scaled to device pixels, then `hinted' to the pixel grid
2419 * in order to optimize it. The outline data can be accessed from
2420 * the glyph slot (see note below).
2422 * Note that by default, the glyph loader doesn't render outlines into
2423 * bitmaps. The following flags are used to modify this default
2424 * behaviour to more specific and useful cases.
2426 * FT_LOAD_NO_SCALE ::
2427 * Don't scale the loaded outline glyph but keep it in font units.
2429 * This flag implies @FT_LOAD_NO_HINTING and @FT_LOAD_NO_BITMAP, and
2430 * unsets @FT_LOAD_RENDER.
2432 * If the font is `tricky' (see @FT_FACE_FLAG_TRICKY for more), using
2433 * FT_LOAD_NO_SCALE usually yields meaningless outlines because the
2434 * subglyphs must be scaled and positioned with hinting instructions.
2435 * This can be solved by loading the font without FT_LOAD_NO_SCALE and
2436 * setting the character size to `font->units_per_EM'.
2438 * FT_LOAD_NO_HINTING ::
2439 * Disable hinting. This generally generates `blurrier' bitmap glyphs
2440 * when the glyph are rendered in any of the anti-aliased modes. See
2441 * also the note below.
2443 * This flag is implied by @FT_LOAD_NO_SCALE.
2446 * Call @FT_Render_Glyph after the glyph is loaded. By default, the
2447 * glyph is rendered in @FT_RENDER_MODE_NORMAL mode. This can be
2448 * overridden by @FT_LOAD_TARGET_XXX or @FT_LOAD_MONOCHROME.
2450 * This flag is unset by @FT_LOAD_NO_SCALE.
2452 * FT_LOAD_NO_BITMAP ::
2453 * Ignore bitmap strikes when loading. Bitmap-only fonts ignore this
2456 * @FT_LOAD_NO_SCALE always sets this flag.
2458 * FT_LOAD_VERTICAL_LAYOUT ::
2459 * Load the glyph for vertical text layout. In particular, the
2460 * `advance' value in the @FT_GlyphSlotRec structure is set to the
2461 * `vertAdvance' value of the `metrics' field.
2463 * In case @FT_HAS_VERTICAL doesn't return true, you shouldn't use
2464 * this flag currently. Reason is that in this case vertical metrics
2465 * get synthesized, and those values are not always consistent across
2466 * various font formats.
2468 * FT_LOAD_FORCE_AUTOHINT ::
2469 * Indicates that the auto-hinter is preferred over the font's native
2470 * hinter. See also the note below.
2472 * FT_LOAD_CROP_BITMAP ::
2473 * Indicates that the font driver should crop the loaded bitmap glyph
2474 * (i.e., remove all space around its black bits). Not all drivers
2477 * FT_LOAD_PEDANTIC ::
2478 * Indicates that the font driver should perform pedantic verifications
2479 * during glyph loading. This is mostly used to detect broken glyphs
2480 * in fonts. By default, FreeType tries to handle broken fonts also.
2482 * In particular, errors from the TrueType bytecode engine are not
2483 * passed to the application if this flag is not set; this might
2484 * result in partially hinted or distorted glyphs in case a glyph's
2485 * bytecode is buggy.
2487 * FT_LOAD_IGNORE_GLOBAL_ADVANCE_WIDTH ::
2488 * Ignored. Deprecated.
2490 * FT_LOAD_NO_RECURSE ::
2491 * This flag is only used internally. It merely indicates that the
2492 * font driver should not load composite glyphs recursively. Instead,
2493 * it should set the `num_subglyph' and `subglyphs' values of the
2494 * glyph slot accordingly, and set `glyph->format' to
2495 * @FT_GLYPH_FORMAT_COMPOSITE.
2497 * The description of sub-glyphs is not available to client
2498 * applications for now.
2500 * This flag implies @FT_LOAD_NO_SCALE and @FT_LOAD_IGNORE_TRANSFORM.
2502 * FT_LOAD_IGNORE_TRANSFORM ::
2503 * Indicates that the transform matrix set by @FT_Set_Transform should
2506 * FT_LOAD_MONOCHROME ::
2507 * This flag is used with @FT_LOAD_RENDER to indicate that you want to
2508 * render an outline glyph to a 1-bit monochrome bitmap glyph, with
2509 * 8~pixels packed into each byte of the bitmap data.
2511 * Note that this has no effect on the hinting algorithm used. You
2512 * should rather use @FT_LOAD_TARGET_MONO so that the
2513 * monochrome-optimized hinting algorithm is used.
2515 * FT_LOAD_LINEAR_DESIGN ::
2516 * Indicates that the `linearHoriAdvance' and `linearVertAdvance'
2517 * fields of @FT_GlyphSlotRec should be kept in font units. See
2518 * @FT_GlyphSlotRec for details.
2520 * FT_LOAD_NO_AUTOHINT ::
2521 * Disable auto-hinter. See also the note below.
2524 * By default, hinting is enabled and the font's native hinter (see
2525 * @FT_FACE_FLAG_HINTER) is preferred over the auto-hinter. You can
2526 * disable hinting by setting @FT_LOAD_NO_HINTING or change the
2527 * precedence by setting @FT_LOAD_FORCE_AUTOHINT. You can also set
2528 * @FT_LOAD_NO_AUTOHINT in case you don't want the auto-hinter to be
2531 * See the description of @FT_FACE_FLAG_TRICKY for a special exception
2532 * (affecting only a handful of Asian fonts).
2534 * Besides deciding which hinter to use, you can also decide which
2535 * hinting algorithm to use. See @FT_LOAD_TARGET_XXX for details.
2537 * Note that the auto-hinter needs a valid Unicode cmap (either a native
2538 * one or synthesized by FreeType) for producing correct results. If a
2539 * font provides an incorrect mapping (for example, assigning the
2540 * character code U+005A, LATIN CAPITAL LETTER Z, to a glyph depicting a
2541 * mathematical integral sign), the auto-hinter might produce useless
2545 #define FT_LOAD_DEFAULT 0x0
2546 #define FT_LOAD_NO_SCALE ( 1L << 0 )
2547 #define FT_LOAD_NO_HINTING ( 1L << 1 )
2548 #define FT_LOAD_RENDER ( 1L << 2 )
2549 #define FT_LOAD_NO_BITMAP ( 1L << 3 )
2550 #define FT_LOAD_VERTICAL_LAYOUT ( 1L << 4 )
2551 #define FT_LOAD_FORCE_AUTOHINT ( 1L << 5 )
2552 #define FT_LOAD_CROP_BITMAP ( 1L << 6 )
2553 #define FT_LOAD_PEDANTIC ( 1L << 7 )
2554 #define FT_LOAD_IGNORE_GLOBAL_ADVANCE_WIDTH ( 1L << 9 )
2555 #define FT_LOAD_NO_RECURSE ( 1L << 10 )
2556 #define FT_LOAD_IGNORE_TRANSFORM ( 1L << 11 )
2557 #define FT_LOAD_MONOCHROME ( 1L << 12 )
2558 #define FT_LOAD_LINEAR_DESIGN ( 1L << 13 )
2559 #define FT_LOAD_NO_AUTOHINT ( 1L << 15 )
2563 /* used internally only by certain font drivers! */
2564 #define FT_LOAD_ADVANCE_ONLY ( 1L << 8 )
2565 #define FT_LOAD_SBITS_ONLY ( 1L << 14 )
2568 /**************************************************************************
2571 * FT_LOAD_TARGET_XXX
2574 * A list of values that are used to select a specific hinting algorithm
2575 * to use by the hinter. You should OR one of these values to your
2576 * `load_flags' when calling @FT_Load_Glyph.
2578 * Note that font's native hinters may ignore the hinting algorithm you
2579 * have specified (e.g., the TrueType bytecode interpreter). You can set
2580 * @FT_LOAD_FORCE_AUTOHINT to ensure that the auto-hinter is used.
2582 * Also note that @FT_LOAD_TARGET_LIGHT is an exception, in that it
2583 * always implies @FT_LOAD_FORCE_AUTOHINT.
2586 * FT_LOAD_TARGET_NORMAL ::
2587 * This corresponds to the default hinting algorithm, optimized for
2588 * standard gray-level rendering. For monochrome output, use
2589 * @FT_LOAD_TARGET_MONO instead.
2591 * FT_LOAD_TARGET_LIGHT ::
2592 * A lighter hinting algorithm for non-monochrome modes. Many
2593 * generated glyphs are more fuzzy but better resemble its original
2594 * shape. A bit like rendering on Mac OS~X.
2596 * As a special exception, this target implies @FT_LOAD_FORCE_AUTOHINT.
2598 * FT_LOAD_TARGET_MONO ::
2599 * Strong hinting algorithm that should only be used for monochrome
2600 * output. The result is probably unpleasant if the glyph is rendered
2601 * in non-monochrome modes.
2603 * FT_LOAD_TARGET_LCD ::
2604 * A variant of @FT_LOAD_TARGET_NORMAL optimized for horizontally
2605 * decimated LCD displays.
2607 * FT_LOAD_TARGET_LCD_V ::
2608 * A variant of @FT_LOAD_TARGET_NORMAL optimized for vertically
2609 * decimated LCD displays.
2612 * You should use only _one_ of the FT_LOAD_TARGET_XXX values in your
2613 * `load_flags'. They can't be ORed.
2615 * If @FT_LOAD_RENDER is also set, the glyph is rendered in the
2616 * corresponding mode (i.e., the mode which matches the used algorithm
2617 * best). An exeption is FT_LOAD_TARGET_MONO since it implies
2618 * @FT_LOAD_MONOCHROME.
2620 * You can use a hinting algorithm that doesn't correspond to the same
2621 * rendering mode. As an example, it is possible to use the `light'
2622 * hinting algorithm and have the results rendered in horizontal LCD
2623 * pixel mode, with code like
2626 * FT_Load_Glyph( face, glyph_index,
2627 * load_flags | FT_LOAD_TARGET_LIGHT );
2629 * FT_Render_Glyph( face->glyph, FT_RENDER_MODE_LCD );
2633 #define FT_LOAD_TARGET_( x ) ( (FT_Int32)( (x) & 15 ) << 16 )
2635 #define FT_LOAD_TARGET_NORMAL FT_LOAD_TARGET_( FT_RENDER_MODE_NORMAL )
2636 #define FT_LOAD_TARGET_LIGHT FT_LOAD_TARGET_( FT_RENDER_MODE_LIGHT )
2637 #define FT_LOAD_TARGET_MONO FT_LOAD_TARGET_( FT_RENDER_MODE_MONO )
2638 #define FT_LOAD_TARGET_LCD FT_LOAD_TARGET_( FT_RENDER_MODE_LCD )
2639 #define FT_LOAD_TARGET_LCD_V FT_LOAD_TARGET_( FT_RENDER_MODE_LCD_V )
2642 /**************************************************************************
2645 * FT_LOAD_TARGET_MODE
2648 * Return the @FT_Render_Mode corresponding to a given
2649 * @FT_LOAD_TARGET_XXX value.
2652 #define FT_LOAD_TARGET_MODE( x ) ( (FT_Render_Mode)( ( (x) >> 16 ) & 15 ) )
2655 /*************************************************************************/
2658 /* FT_Set_Transform */
2661 /* A function used to set the transformation that is applied to glyph */
2662 /* images when they are loaded into a glyph slot through */
2663 /* @FT_Load_Glyph. */
2666 /* face :: A handle to the source face object. */
2669 /* matrix :: A pointer to the transformation's 2x2 matrix. Use~0 for */
2670 /* the identity matrix. */
2671 /* delta :: A pointer to the translation vector. Use~0 for the null */
2675 /* The transformation is only applied to scalable image formats after */
2676 /* the glyph has been loaded. It means that hinting is unaltered by */
2677 /* the transformation and is performed on the character size given in */
2678 /* the last call to @FT_Set_Char_Size or @FT_Set_Pixel_Sizes. */
2680 /* Note that this also transforms the `face.glyph.advance' field, but */
2681 /* *not* the values in `face.glyph.metrics'. */
2684 FT_Set_Transform( FT_Face face,
2689 /*************************************************************************/
2692 /* FT_Render_Mode */
2695 /* An enumeration type that lists the render modes supported by */
2696 /* FreeType~2. Each mode corresponds to a specific type of scanline */
2697 /* conversion performed on the outline. */
2699 /* For bitmap fonts and embedded bitmaps the `bitmap->pixel_mode' */
2700 /* field in the @FT_GlyphSlotRec structure gives the format of the */
2701 /* returned bitmap. */
2703 /* All modes except @FT_RENDER_MODE_MONO use 256 levels of opacity. */
2706 /* FT_RENDER_MODE_NORMAL :: */
2707 /* This is the default render mode; it corresponds to 8-bit */
2708 /* anti-aliased bitmaps. */
2710 /* FT_RENDER_MODE_LIGHT :: */
2711 /* This is equivalent to @FT_RENDER_MODE_NORMAL. It is only */
2712 /* defined as a separate value because render modes are also used */
2713 /* indirectly to define hinting algorithm selectors. See */
2714 /* @FT_LOAD_TARGET_XXX for details. */
2716 /* FT_RENDER_MODE_MONO :: */
2717 /* This mode corresponds to 1-bit bitmaps (with 2~levels of */
2720 /* FT_RENDER_MODE_LCD :: */
2721 /* This mode corresponds to horizontal RGB and BGR sub-pixel */
2722 /* displays like LCD screens. It produces 8-bit bitmaps that are */
2723 /* 3~times the width of the original glyph outline in pixels, and */
2724 /* which use the @FT_PIXEL_MODE_LCD mode. */
2726 /* FT_RENDER_MODE_LCD_V :: */
2727 /* This mode corresponds to vertical RGB and BGR sub-pixel displays */
2728 /* (like PDA screens, rotated LCD displays, etc.). It produces */
2729 /* 8-bit bitmaps that are 3~times the height of the original */
2730 /* glyph outline in pixels and use the @FT_PIXEL_MODE_LCD_V mode. */
2733 /* The LCD-optimized glyph bitmaps produced by FT_Render_Glyph can be */
2734 /* filtered to reduce color-fringes by using @FT_Library_SetLcdFilter */
2735 /* (not active in the default builds). It is up to the caller to */
2736 /* either call @FT_Library_SetLcdFilter (if available) or do the */
2737 /* filtering itself. */
2739 /* The selected render mode only affects vector glyphs of a font. */
2740 /* Embedded bitmaps often have a different pixel mode like */
2741 /* @FT_PIXEL_MODE_MONO. You can use @FT_Bitmap_Convert to transform */
2742 /* them into 8-bit pixmaps. */
2744 typedef enum FT_Render_Mode_
2746 FT_RENDER_MODE_NORMAL = 0,
2747 FT_RENDER_MODE_LIGHT,
2748 FT_RENDER_MODE_MONO,
2750 FT_RENDER_MODE_LCD_V,
2757 /*************************************************************************/
2760 /* ft_render_mode_xxx */
2763 /* These constants are deprecated. Use the corresponding */
2764 /* @FT_Render_Mode values instead. */
2767 /* ft_render_mode_normal :: see @FT_RENDER_MODE_NORMAL */
2768 /* ft_render_mode_mono :: see @FT_RENDER_MODE_MONO */
2770 #define ft_render_mode_normal FT_RENDER_MODE_NORMAL
2771 #define ft_render_mode_mono FT_RENDER_MODE_MONO
2774 /*************************************************************************/
2777 /* FT_Render_Glyph */
2780 /* Convert a given glyph image to a bitmap. It does so by inspecting */
2781 /* the glyph image format, finding the relevant renderer, and */
2785 /* slot :: A handle to the glyph slot containing the image to */
2789 /* render_mode :: This is the render mode used to render the glyph */
2790 /* image into a bitmap. See @FT_Render_Mode for a */
2791 /* list of possible values. */
2794 /* FreeType error code. 0~means success. */
2796 FT_EXPORT( FT_Error )
2797 FT_Render_Glyph( FT_GlyphSlot slot,
2798 FT_Render_Mode render_mode );
2801 /*************************************************************************/
2804 /* FT_Kerning_Mode */
2807 /* An enumeration used to specify which kerning values to return in */
2808 /* @FT_Get_Kerning. */
2811 /* FT_KERNING_DEFAULT :: Return scaled and grid-fitted kerning */
2812 /* distances (value is~0). */
2814 /* FT_KERNING_UNFITTED :: Return scaled but un-grid-fitted kerning */
2817 /* FT_KERNING_UNSCALED :: Return the kerning vector in original font */
2820 typedef enum FT_Kerning_Mode_
2822 FT_KERNING_DEFAULT = 0,
2823 FT_KERNING_UNFITTED,
2829 /*************************************************************************/
2832 /* ft_kerning_default */
2835 /* This constant is deprecated. Please use @FT_KERNING_DEFAULT */
2838 #define ft_kerning_default FT_KERNING_DEFAULT
2841 /*************************************************************************/
2844 /* ft_kerning_unfitted */
2847 /* This constant is deprecated. Please use @FT_KERNING_UNFITTED */
2850 #define ft_kerning_unfitted FT_KERNING_UNFITTED
2853 /*************************************************************************/
2856 /* ft_kerning_unscaled */
2859 /* This constant is deprecated. Please use @FT_KERNING_UNSCALED */
2862 #define ft_kerning_unscaled FT_KERNING_UNSCALED
2865 /*************************************************************************/
2868 /* FT_Get_Kerning */
2871 /* Return the kerning vector between two glyphs of a same face. */
2874 /* face :: A handle to a source face object. */
2876 /* left_glyph :: The index of the left glyph in the kern pair. */
2878 /* right_glyph :: The index of the right glyph in the kern pair. */
2880 /* kern_mode :: See @FT_Kerning_Mode for more information. */
2881 /* Determines the scale and dimension of the returned */
2882 /* kerning vector. */
2885 /* akerning :: The kerning vector. This is either in font units */
2886 /* or in pixels (26.6 format) for scalable formats, */
2887 /* and in pixels for fixed-sizes formats. */
2890 /* FreeType error code. 0~means success. */
2893 /* Only horizontal layouts (left-to-right & right-to-left) are */
2894 /* supported by this method. Other layouts, or more sophisticated */
2895 /* kernings, are out of the scope of this API function -- they can be */
2896 /* implemented through format-specific interfaces. */
2898 FT_EXPORT( FT_Error )
2899 FT_Get_Kerning( FT_Face face,
2901 FT_UInt right_glyph,
2903 FT_Vector *akerning );
2906 /*************************************************************************/
2909 /* FT_Get_Track_Kerning */
2912 /* Return the track kerning for a given face object at a given size. */
2915 /* face :: A handle to a source face object. */
2917 /* point_size :: The point size in 16.16 fractional points. */
2919 /* degree :: The degree of tightness. Increasingly negative */
2920 /* values represent tighter track kerning, while */
2921 /* increasingly positive values represent looser track */
2922 /* kerning. Value zero means no track kerning. */
2925 /* akerning :: The kerning in 16.16 fractional points, to be */
2926 /* uniformly applied between all glyphs. */
2929 /* FreeType error code. 0~means success. */
2932 /* Currently, only the Type~1 font driver supports track kerning, */
2933 /* using data from AFM files (if attached with @FT_Attach_File or */
2934 /* @FT_Attach_Stream). */
2936 /* Only very few AFM files come with track kerning data; please refer */
2937 /* to the Adobe's AFM specification for more details. */
2939 FT_EXPORT( FT_Error )
2940 FT_Get_Track_Kerning( FT_Face face,
2941 FT_Fixed point_size,
2943 FT_Fixed* akerning );
2946 /*************************************************************************/
2949 /* FT_Get_Glyph_Name */
2952 /* Retrieve the ASCII name of a given glyph in a face. This only */
2953 /* works for those faces where @FT_HAS_GLYPH_NAMES(face) returns~1. */
2956 /* face :: A handle to a source face object. */
2958 /* glyph_index :: The glyph index. */
2960 /* buffer_max :: The maximum number of bytes available in the */
2964 /* buffer :: A pointer to a target buffer where the name is */
2968 /* FreeType error code. 0~means success. */
2971 /* An error is returned if the face doesn't provide glyph names or if */
2972 /* the glyph index is invalid. In all cases of failure, the first */
2973 /* byte of `buffer' is set to~0 to indicate an empty name. */
2975 /* The glyph name is truncated to fit within the buffer if it is too */
2976 /* long. The returned string is always zero-terminated. */
2978 /* Be aware that FreeType reorders glyph indices internally so that */
2979 /* glyph index~0 always corresponds to the `missing glyph' (called */
2982 /* This function is not compiled within the library if the config */
2983 /* macro `FT_CONFIG_OPTION_NO_GLYPH_NAMES' is defined in */
2984 /* `include/freetype/config/ftoptions.h'. */
2986 FT_EXPORT( FT_Error )
2987 FT_Get_Glyph_Name( FT_Face face,
2988 FT_UInt glyph_index,
2990 FT_UInt buffer_max );
2993 /*************************************************************************/
2996 /* FT_Get_Postscript_Name */
2999 /* Retrieve the ASCII PostScript name of a given face, if available. */
3000 /* This only works with PostScript and TrueType fonts. */
3003 /* face :: A handle to the source face object. */
3006 /* A pointer to the face's PostScript name. NULL if unavailable. */
3009 /* The returned pointer is owned by the face and is destroyed with */
3012 FT_EXPORT( const char* )
3013 FT_Get_Postscript_Name( FT_Face face );
3016 /*************************************************************************/
3019 /* FT_Select_Charmap */
3022 /* Select a given charmap by its encoding tag (as listed in */
3023 /* `freetype.h'). */
3026 /* face :: A handle to the source face object. */
3029 /* encoding :: A handle to the selected encoding. */
3032 /* FreeType error code. 0~means success. */
3035 /* This function returns an error if no charmap in the face */
3036 /* corresponds to the encoding queried here. */
3038 /* Because many fonts contain more than a single cmap for Unicode */
3039 /* encoding, this function has some special code to select the one */
3040 /* which covers Unicode best (`best' in the sense that a UCS-4 cmap */
3041 /* is preferred to a UCS-2 cmap). It is thus preferable to */
3042 /* @FT_Set_Charmap in this case. */
3044 FT_EXPORT( FT_Error )
3045 FT_Select_Charmap( FT_Face face,
3046 FT_Encoding encoding );
3049 /*************************************************************************/
3052 /* FT_Set_Charmap */
3055 /* Select a given charmap for character code to glyph index mapping. */
3058 /* face :: A handle to the source face object. */
3061 /* charmap :: A handle to the selected charmap. */
3064 /* FreeType error code. 0~means success. */
3067 /* This function returns an error if the charmap is not part of */
3068 /* the face (i.e., if it is not listed in the `face->charmaps' */
3071 /* It also fails if a type~14 charmap is selected. */
3073 FT_EXPORT( FT_Error )
3074 FT_Set_Charmap( FT_Face face,
3075 FT_CharMap charmap );
3078 /*************************************************************************
3081 * FT_Get_Charmap_Index
3084 * Retrieve index of a given charmap.
3088 * A handle to a charmap.
3091 * The index into the array of character maps within the face to which
3092 * `charmap' belongs. If an error occurs, -1 is returned.
3096 FT_Get_Charmap_Index( FT_CharMap charmap );
3099 /*************************************************************************/
3102 /* FT_Get_Char_Index */
3105 /* Return the glyph index of a given character code. This function */
3106 /* uses a charmap object to do the mapping. */
3109 /* face :: A handle to the source face object. */
3111 /* charcode :: The character code. */
3114 /* The glyph index. 0~means `undefined character code'. */
3117 /* If you use FreeType to manipulate the contents of font files */
3118 /* directly, be aware that the glyph index returned by this function */
3119 /* doesn't always correspond to the internal indices used within the */
3120 /* file. This is done to ensure that value~0 always corresponds to */
3121 /* the `missing glyph'. If the first glyph is not named `.notdef', */
3122 /* then for Type~1 and Type~42 fonts, `.notdef' will be moved into */
3123 /* the glyph ID~0 position, and whatever was there will be moved to */
3124 /* the position `.notdef' had. For Type~1 fonts, if there is no */
3125 /* `.notdef' glyph at all, then one will be created at index~0 and */
3126 /* whatever was there will be moved to the last index -- Type~42 */
3127 /* fonts are considered invalid under this condition. */
3129 FT_EXPORT( FT_UInt )
3130 FT_Get_Char_Index( FT_Face face,
3131 FT_ULong charcode );
3134 /*************************************************************************/
3137 /* FT_Get_First_Char */
3140 /* This function is used to return the first character code in the */
3141 /* current charmap of a given face. It also returns the */
3142 /* corresponding glyph index. */
3145 /* face :: A handle to the source face object. */
3148 /* agindex :: Glyph index of first character code. 0~if charmap is */
3152 /* The charmap's first character code. */
3155 /* You should use this function with @FT_Get_Next_Char to be able to */
3156 /* parse all character codes available in a given charmap. The code */
3157 /* should look like this: */
3160 /* FT_ULong charcode; */
3161 /* FT_UInt gindex; */
3164 /* charcode = FT_Get_First_Char( face, &gindex ); */
3165 /* while ( gindex != 0 ) */
3167 /* ... do something with (charcode,gindex) pair ... */
3169 /* charcode = FT_Get_Next_Char( face, charcode, &gindex ); */
3173 /* Note that `*agindex' is set to~0 if the charmap is empty. The */
3174 /* result itself can be~0 in two cases: if the charmap is empty or */
3175 /* if the value~0 is the first valid character code. */
3177 FT_EXPORT( FT_ULong )
3178 FT_Get_First_Char( FT_Face face,
3182 /*************************************************************************/
3185 /* FT_Get_Next_Char */
3188 /* This function is used to return the next character code in the */
3189 /* current charmap of a given face following the value `char_code', */
3190 /* as well as the corresponding glyph index. */
3193 /* face :: A handle to the source face object. */
3194 /* char_code :: The starting character code. */
3197 /* agindex :: Glyph index of next character code. 0~if charmap */
3201 /* The charmap's next character code. */
3204 /* You should use this function with @FT_Get_First_Char to walk */
3205 /* over all character codes available in a given charmap. See the */
3206 /* note for this function for a simple code example. */
3208 /* Note that `*agindex' is set to~0 when there are no more codes in */
3211 FT_EXPORT( FT_ULong )
3212 FT_Get_Next_Char( FT_Face face,
3217 /*************************************************************************/
3220 /* FT_Get_Name_Index */
3223 /* Return the glyph index of a given glyph name. This function uses */
3224 /* driver specific objects to do the translation. */
3227 /* face :: A handle to the source face object. */
3229 /* glyph_name :: The glyph name. */
3232 /* The glyph index. 0~means `undefined character code'. */
3234 FT_EXPORT( FT_UInt )
3235 FT_Get_Name_Index( FT_Face face,
3236 FT_String* glyph_name );
3239 /*************************************************************************
3242 * FT_SUBGLYPH_FLAG_XXX
3245 * A list of constants used to describe subglyphs. Please refer to the
3246 * TrueType specification for the meaning of the various flags.
3249 * FT_SUBGLYPH_FLAG_ARGS_ARE_WORDS ::
3250 * FT_SUBGLYPH_FLAG_ARGS_ARE_XY_VALUES ::
3251 * FT_SUBGLYPH_FLAG_ROUND_XY_TO_GRID ::
3252 * FT_SUBGLYPH_FLAG_SCALE ::
3253 * FT_SUBGLYPH_FLAG_XY_SCALE ::
3254 * FT_SUBGLYPH_FLAG_2X2 ::
3255 * FT_SUBGLYPH_FLAG_USE_MY_METRICS ::
3258 #define FT_SUBGLYPH_FLAG_ARGS_ARE_WORDS 1
3259 #define FT_SUBGLYPH_FLAG_ARGS_ARE_XY_VALUES 2
3260 #define FT_SUBGLYPH_FLAG_ROUND_XY_TO_GRID 4
3261 #define FT_SUBGLYPH_FLAG_SCALE 8
3262 #define FT_SUBGLYPH_FLAG_XY_SCALE 0x40
3263 #define FT_SUBGLYPH_FLAG_2X2 0x80
3264 #define FT_SUBGLYPH_FLAG_USE_MY_METRICS 0x200
3267 /*************************************************************************
3270 * FT_Get_SubGlyph_Info
3273 * Retrieve a description of a given subglyph. Only use it if
3274 * `glyph->format' is @FT_GLYPH_FORMAT_COMPOSITE; an error is
3275 * returned otherwise.
3279 * The source glyph slot.
3282 * The index of the subglyph. Must be less than
3283 * `glyph->num_subglyphs'.
3287 * The glyph index of the subglyph.
3290 * The subglyph flags, see @FT_SUBGLYPH_FLAG_XXX.
3293 * The subglyph's first argument (if any).
3296 * The subglyph's second argument (if any).
3299 * The subglyph transformation (if any).
3302 * FreeType error code. 0~means success.
3305 * The values of `*p_arg1', `*p_arg2', and `*p_transform' must be
3306 * interpreted depending on the flags returned in `*p_flags'. See the
3307 * TrueType specification for details.
3310 FT_EXPORT( FT_Error )
3311 FT_Get_SubGlyph_Info( FT_GlyphSlot glyph,
3317 FT_Matrix *p_transform );
3320 /*************************************************************************/
3326 /* A list of bit flags used in the `fsType' field of the OS/2 table */
3327 /* in a TrueType or OpenType font and the `FSType' entry in a */
3328 /* PostScript font. These bit flags are returned by */
3329 /* @FT_Get_FSType_Flags; they inform client applications of embedding */
3330 /* and subsetting restrictions associated with a font. */
3332 /* See http://www.adobe.com/devnet/acrobat/pdfs/FontPolicies.pdf for */
3336 /* FT_FSTYPE_INSTALLABLE_EMBEDDING :: */
3337 /* Fonts with no fsType bit set may be embedded and permanently */
3338 /* installed on the remote system by an application. */
3340 /* FT_FSTYPE_RESTRICTED_LICENSE_EMBEDDING :: */
3341 /* Fonts that have only this bit set must not be modified, embedded */
3342 /* or exchanged in any manner without first obtaining permission of */
3343 /* the font software copyright owner. */
3345 /* FT_FSTYPE_PREVIEW_AND_PRINT_EMBEDDING :: */
3346 /* If this bit is set, the font may be embedded and temporarily */
3347 /* loaded on the remote system. Documents containing Preview & */
3348 /* Print fonts must be opened `read-only'; no edits can be applied */
3349 /* to the document. */
3351 /* FT_FSTYPE_EDITABLE_EMBEDDING :: */
3352 /* If this bit is set, the font may be embedded but must only be */
3353 /* installed temporarily on other systems. In contrast to Preview */
3354 /* & Print fonts, documents containing editable fonts may be opened */
3355 /* for reading, editing is permitted, and changes may be saved. */
3357 /* FT_FSTYPE_NO_SUBSETTING :: */
3358 /* If this bit is set, the font may not be subsetted prior to */
3361 /* FT_FSTYPE_BITMAP_EMBEDDING_ONLY :: */
3362 /* If this bit is set, only bitmaps contained in the font may be */
3363 /* embedded; no outline data may be embedded. If there are no */
3364 /* bitmaps available in the font, then the font is unembeddable. */
3367 /* While the fsType flags can indicate that a font may be embedded, a */
3368 /* license with the font vendor may be separately required to use the */
3369 /* font in this way. */
3371 #define FT_FSTYPE_INSTALLABLE_EMBEDDING 0x0000
3372 #define FT_FSTYPE_RESTRICTED_LICENSE_EMBEDDING 0x0002
3373 #define FT_FSTYPE_PREVIEW_AND_PRINT_EMBEDDING 0x0004
3374 #define FT_FSTYPE_EDITABLE_EMBEDDING 0x0008
3375 #define FT_FSTYPE_NO_SUBSETTING 0x0100
3376 #define FT_FSTYPE_BITMAP_EMBEDDING_ONLY 0x0200
3379 /*************************************************************************/
3382 /* FT_Get_FSType_Flags */
3385 /* Return the fsType flags for a font. */
3388 /* face :: A handle to the source face object. */
3391 /* The fsType flags, @FT_FSTYPE_XXX. */
3394 /* Use this function rather than directly reading the `fs_type' field */
3395 /* in the @PS_FontInfoRec structure which is only guaranteed to */
3396 /* return the correct results for Type~1 fonts. */
3401 FT_EXPORT( FT_UShort )
3402 FT_Get_FSType_Flags( FT_Face face );
3405 /*************************************************************************/
3408 /* glyph_variants */
3411 /* Glyph Variants */
3414 /* The FreeType~2 interface to Unicode Ideographic Variation */
3415 /* Sequences (IVS), using the SFNT cmap format~14. */
3418 /* Many CJK characters have variant forms. They are a sort of grey */
3419 /* area somewhere between being totally irrelevant and semantically */
3420 /* distinct; for this reason, the Unicode consortium decided to */
3421 /* introduce Ideographic Variation Sequences (IVS), consisting of a */
3422 /* Unicode base character and one of 240 variant selectors */
3423 /* (U+E0100-U+E01EF), instead of further extending the already huge */
3424 /* code range for CJK characters. */
3426 /* An IVS is registered and unique; for further details please refer */
3427 /* to Unicode Technical Standard #37, the Ideographic Variation */
3430 /* http://www.unicode.org/reports/tr37/ */
3432 /* To date (November 2012), the character with the most variants is */
3433 /* U+9089, having 31 such IVS. */
3435 /* Adobe and MS decided to support IVS with a new cmap subtable */
3436 /* (format~14). It is an odd subtable because it is not a mapping of */
3437 /* input code points to glyphs, but contains lists of all variants */
3438 /* supported by the font. */
3440 /* A variant may be either `default' or `non-default'. A default */
3441 /* variant is the one you will get for that code point if you look it */
3442 /* up in the standard Unicode cmap. A non-default variant is a */
3443 /* different glyph. */
3445 /*************************************************************************/
3448 /*************************************************************************/
3451 /* FT_Face_GetCharVariantIndex */
3454 /* Return the glyph index of a given character code as modified by */
3455 /* the variation selector. */
3459 /* A handle to the source face object. */
3462 /* The character code point in Unicode. */
3464 /* variantSelector :: */
3465 /* The Unicode code point of the variation selector. */
3468 /* The glyph index. 0~means either `undefined character code', or */
3469 /* `undefined selector code', or `no variation selector cmap */
3470 /* subtable', or `current CharMap is not Unicode'. */
3473 /* If you use FreeType to manipulate the contents of font files */
3474 /* directly, be aware that the glyph index returned by this function */
3475 /* doesn't always correspond to the internal indices used within */
3476 /* the file. This is done to ensure that value~0 always corresponds */
3477 /* to the `missing glyph'. */
3479 /* This function is only meaningful if */
3480 /* a) the font has a variation selector cmap sub table, */
3482 /* b) the current charmap has a Unicode encoding. */
3487 FT_EXPORT( FT_UInt )
3488 FT_Face_GetCharVariantIndex( FT_Face face,
3490 FT_ULong variantSelector );
3493 /*************************************************************************/
3496 /* FT_Face_GetCharVariantIsDefault */
3499 /* Check whether this variant of this Unicode character is the one to */
3500 /* be found in the `cmap'. */
3504 /* A handle to the source face object. */
3507 /* The character codepoint in Unicode. */
3509 /* variantSelector :: */
3510 /* The Unicode codepoint of the variation selector. */
3513 /* 1~if found in the standard (Unicode) cmap, 0~if found in the */
3514 /* variation selector cmap, or -1 if it is not a variant. */
3517 /* This function is only meaningful if the font has a variation */
3518 /* selector cmap subtable. */
3524 FT_Face_GetCharVariantIsDefault( FT_Face face,
3526 FT_ULong variantSelector );
3529 /*************************************************************************/
3532 /* FT_Face_GetVariantSelectors */
3535 /* Return a zero-terminated list of Unicode variant selectors found */
3540 /* A handle to the source face object. */
3543 /* A pointer to an array of selector code points, or NULL if there is */
3544 /* no valid variant selector cmap subtable. */
3547 /* The last item in the array is~0; the array is owned by the */
3548 /* @FT_Face object but can be overwritten or released on the next */
3549 /* call to a FreeType function. */
3554 FT_EXPORT( FT_UInt32* )
3555 FT_Face_GetVariantSelectors( FT_Face face );
3558 /*************************************************************************/
3561 /* FT_Face_GetVariantsOfChar */
3564 /* Return a zero-terminated list of Unicode variant selectors found */
3565 /* for the specified character code. */
3569 /* A handle to the source face object. */
3572 /* The character codepoint in Unicode. */
3575 /* A pointer to an array of variant selector code points which are */
3576 /* active for the given character, or NULL if the corresponding list */
3580 /* The last item in the array is~0; the array is owned by the */
3581 /* @FT_Face object but can be overwritten or released on the next */
3582 /* call to a FreeType function. */
3587 FT_EXPORT( FT_UInt32* )
3588 FT_Face_GetVariantsOfChar( FT_Face face,
3589 FT_ULong charcode );
3592 /*************************************************************************/
3595 /* FT_Face_GetCharsOfVariant */
3598 /* Return a zero-terminated list of Unicode character codes found for */
3599 /* the specified variant selector. */
3603 /* A handle to the source face object. */
3605 /* variantSelector :: */
3606 /* The variant selector code point in Unicode. */
3609 /* A list of all the code points which are specified by this selector */
3610 /* (both default and non-default codes are returned) or NULL if there */
3611 /* is no valid cmap or the variant selector is invalid. */
3614 /* The last item in the array is~0; the array is owned by the */
3615 /* @FT_Face object but can be overwritten or released on the next */
3616 /* call to a FreeType function. */
3621 FT_EXPORT( FT_UInt32* )
3622 FT_Face_GetCharsOfVariant( FT_Face face,
3623 FT_ULong variantSelector );
3626 /*************************************************************************/
3635 /* Crunching fixed numbers and vectors. */
3638 /* This section contains various functions used to perform */
3639 /* computations on 16.16 fixed-float numbers or 2d vectors. */
3648 /* FT_Vector_Transform */
3649 /* FT_Matrix_Multiply */
3650 /* FT_Matrix_Invert */
3652 /*************************************************************************/
3655 /*************************************************************************/
3661 /* A very simple function used to perform the computation `(a*b)/c' */
3662 /* with maximum accuracy (it uses a 64-bit intermediate integer */
3663 /* whenever necessary). */
3665 /* This function isn't necessarily as fast as some processor specific */
3666 /* operations, but is at least completely portable. */
3669 /* a :: The first multiplier. */
3670 /* b :: The second multiplier. */
3671 /* c :: The divisor. */
3674 /* The result of `(a*b)/c'. This function never traps when trying to */
3675 /* divide by zero; it simply returns `MaxInt' or `MinInt' depending */
3676 /* on the signs of `a' and `b'. */
3678 FT_EXPORT( FT_Long )
3679 FT_MulDiv( FT_Long a,
3686 /* The following #if 0 ... #endif is for the documentation formatter, */
3687 /* hiding the internal `FT_MULFIX_INLINED' macro. */
3690 /*************************************************************************/
3696 /* A very simple function used to perform the computation */
3697 /* `(a*b)/0x10000' with maximum accuracy. Most of the time this is */
3698 /* used to multiply a given value by a 16.16 fixed float factor. */
3701 /* a :: The first multiplier. */
3702 /* b :: The second multiplier. Use a 16.16 factor here whenever */
3703 /* possible (see note below). */
3706 /* The result of `(a*b)/0x10000'. */
3709 /* This function has been optimized for the case where the absolute */
3710 /* value of `a' is less than 2048, and `b' is a 16.16 scaling factor. */
3711 /* As this happens mainly when scaling from notional units to */
3712 /* fractional pixels in FreeType, it resulted in noticeable speed */
3713 /* improvements between versions 2.x and 1.x. */
3715 /* As a conclusion, always try to place a 16.16 factor as the */
3716 /* _second_ argument of this function; this can make a great */
3719 FT_EXPORT( FT_Long )
3720 FT_MulFix( FT_Long a,
3726 #ifdef FT_MULFIX_INLINED
3727 #define FT_MulFix( a, b ) FT_MULFIX_INLINED( a, b )
3729 FT_EXPORT( FT_Long )
3730 FT_MulFix( FT_Long a,
3735 /*************************************************************************/
3741 /* A very simple function used to perform the computation */
3742 /* `(a*0x10000)/b' with maximum accuracy. Most of the time, this is */
3743 /* used to divide a given value by a 16.16 fixed float factor. */
3746 /* a :: The first multiplier. */
3747 /* b :: The second multiplier. Use a 16.16 factor here whenever */
3748 /* possible (see note below). */
3751 /* The result of `(a*0x10000)/b'. */
3754 /* The optimization for FT_DivFix() is simple: If (a~<<~16) fits in */
3755 /* 32~bits, then the division is computed directly. Otherwise, we */
3756 /* use a specialized version of @FT_MulDiv. */
3758 FT_EXPORT( FT_Long )
3759 FT_DivFix( FT_Long a,
3763 /*************************************************************************/
3769 /* A very simple function used to round a 16.16 fixed number. */
3772 /* a :: The number to be rounded. */
3775 /* The result of `(a + 0x8000) & -0x10000'. */
3777 FT_EXPORT( FT_Fixed )
3778 FT_RoundFix( FT_Fixed a );
3781 /*************************************************************************/
3787 /* A very simple function used to compute the ceiling function of a */
3788 /* 16.16 fixed number. */
3791 /* a :: The number for which the ceiling function is to be computed. */
3794 /* The result of `(a + 0x10000 - 1) & -0x10000'. */
3796 FT_EXPORT( FT_Fixed )
3797 FT_CeilFix( FT_Fixed a );
3800 /*************************************************************************/
3806 /* A very simple function used to compute the floor function of a */
3807 /* 16.16 fixed number. */
3810 /* a :: The number for which the floor function is to be computed. */
3813 /* The result of `a & -0x10000'. */
3815 FT_EXPORT( FT_Fixed )
3816 FT_FloorFix( FT_Fixed a );
3819 /*************************************************************************/
3822 /* FT_Vector_Transform */
3825 /* Transform a single vector through a 2x2 matrix. */
3828 /* vector :: The target vector to transform. */
3831 /* matrix :: A pointer to the source 2x2 matrix. */
3834 /* The result is undefined if either `vector' or `matrix' is invalid. */
3837 FT_Vector_Transform( FT_Vector* vec,
3838 const FT_Matrix* matrix );
3841 /*************************************************************************/
3847 /* FreeType Version */
3850 /* Functions and macros related to FreeType versions. */
3853 /* Note that those functions and macros are of limited use because */
3854 /* even a new release of FreeType with only documentation changes */
3855 /* increases the version number. */
3857 /*************************************************************************/
3860 /*************************************************************************
3866 * These three macros identify the FreeType source code version.
3867 * Use @FT_Library_Version to access them at runtime.
3870 * FREETYPE_MAJOR :: The major version number.
3871 * FREETYPE_MINOR :: The minor version number.
3872 * FREETYPE_PATCH :: The patch level.
3875 * The version number of FreeType if built as a dynamic link library
3876 * with the `libtool' package is _not_ controlled by these three
3880 #define FREETYPE_MAJOR 2
3881 #define FREETYPE_MINOR 4
3882 #define FREETYPE_PATCH 11
3885 /*************************************************************************/
3888 /* FT_Library_Version */
3891 /* Return the version of the FreeType library being used. This is */
3892 /* useful when dynamically linking to the library, since one cannot */
3893 /* use the macros @FREETYPE_MAJOR, @FREETYPE_MINOR, and */
3894 /* @FREETYPE_PATCH. */
3897 /* library :: A source library handle. */
3900 /* amajor :: The major version number. */
3902 /* aminor :: The minor version number. */
3904 /* apatch :: The patch version number. */
3907 /* The reason why this function takes a `library' argument is because */
3908 /* certain programs implement library initialization in a custom way */
3909 /* that doesn't use @FT_Init_FreeType. */
3911 /* In such cases, the library version might not be available before */
3912 /* the library object has been created. */
3915 FT_Library_Version( FT_Library library,
3921 /*************************************************************************/
3924 /* FT_Face_CheckTrueTypePatents */
3927 /* Parse all bytecode instructions of a TrueType font file to check */
3928 /* whether any of the patented opcodes are used. This is only useful */
3929 /* if you want to be able to use the unpatented hinter with */
3930 /* fonts that do *not* use these opcodes. */
3932 /* Note that this function parses *all* glyph instructions in the */
3933 /* font file, which may be slow. */
3936 /* face :: A face handle. */
3939 /* 1~if this is a TrueType font that uses one of the patented */
3940 /* opcodes, 0~otherwise. */
3943 /* Since May 2010, TrueType hinting is no longer patented. */
3948 FT_EXPORT( FT_Bool )
3949 FT_Face_CheckTrueTypePatents( FT_Face face );
3952 /*************************************************************************/
3955 /* FT_Face_SetUnpatentedHinting */
3958 /* Enable or disable the unpatented hinter for a given face. */
3959 /* Only enable it if you have determined that the face doesn't */
3960 /* use any patented opcodes (see @FT_Face_CheckTrueTypePatents). */
3963 /* face :: A face handle. */
3965 /* value :: New boolean setting. */
3968 /* The old setting value. This will always be false if this is not */
3969 /* an SFNT font, or if the unpatented hinter is not compiled in this */
3970 /* instance of the library. */
3973 /* Since May 2010, TrueType hinting is no longer patented. */
3978 FT_EXPORT( FT_Bool )
3979 FT_Face_SetUnpatentedHinting( FT_Face face,
3987 #endif /* __FREETYPE_H__ */
projects / hornmich / skoda-qr-demo.git / blob