1 /***************************************************************************/
5 /* FreeType high-level API and common types (specification only). */
7 /* Copyright 1996-2014 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 /*************************************************************************/
45 /* header_inclusion */
48 /* FreeType's header inclusion scheme */
51 /* How client applications should include FreeType header files. */
54 /* To be as flexible as possible (and for historical reasons), */
55 /* FreeType uses a very special inclusion scheme to load header */
56 /* files, for example */
59 /* #include <ft2build.h> */
61 /* #include FT_FREETYPE_H */
62 /* #include FT_OUTLINE_H */
65 /* A compiler and its preprocessor only needs an include path to find */
66 /* the file `ft2build.h'; the exact locations and names of the other */
67 /* FreeType header files are hidden by preprocessor macro names, */
68 /* loaded by `ft2build.h'. The API documentation always gives the */
69 /* header macro name needed for a particular function. */
71 /*************************************************************************/
74 /*************************************************************************/
83 /* How client applications should allocate FreeType data structures. */
86 /* FreeType assumes that structures allocated by the user and passed */
87 /* as arguments are zeroed out except for the actual data. In other */
88 /* words, it is recommended to use `calloc' (or variants of it) */
89 /* instead of `malloc' for allocation. */
91 /*************************************************************************/
95 /*************************************************************************/
96 /*************************************************************************/
98 /* B A S I C T Y P E S */
100 /*************************************************************************/
101 /*************************************************************************/
104 /*************************************************************************/
113 /* The FreeType~2 base font interface. */
116 /* This section describes the most important public high-level API */
117 /* functions of FreeType~2. */
130 /* FT_FACE_FLAG_SCALABLE */
131 /* FT_FACE_FLAG_FIXED_SIZES */
132 /* FT_FACE_FLAG_FIXED_WIDTH */
133 /* FT_FACE_FLAG_HORIZONTAL */
134 /* FT_FACE_FLAG_VERTICAL */
135 /* FT_FACE_FLAG_COLOR */
136 /* FT_FACE_FLAG_SFNT */
137 /* FT_FACE_FLAG_CID_KEYED */
138 /* FT_FACE_FLAG_TRICKY */
139 /* FT_FACE_FLAG_KERNING */
140 /* FT_FACE_FLAG_MULTIPLE_MASTERS */
141 /* FT_FACE_FLAG_GLYPH_NAMES */
142 /* FT_FACE_FLAG_EXTERNAL_STREAM */
143 /* FT_FACE_FLAG_HINTER */
144 /* FT_FACE_FLAG_TRICKY */
146 /* FT_HAS_HORIZONTAL */
147 /* FT_HAS_VERTICAL */
149 /* FT_HAS_FIXED_SIZES */
150 /* FT_HAS_GLYPH_NAMES */
151 /* FT_HAS_MULTIPLE_MASTERS */
156 /* FT_IS_FIXED_WIDTH */
157 /* FT_IS_CID_KEYED */
160 /* FT_STYLE_FLAG_BOLD */
161 /* FT_STYLE_FLAG_ITALIC */
164 /* FT_Size_Metrics */
166 /* FT_GlyphSlotRec */
167 /* FT_Glyph_Metrics */
172 /* FT_Init_FreeType */
173 /* FT_Done_FreeType */
177 /* FT_Reference_Face */
178 /* FT_New_Memory_Face */
183 /* FT_Attach_Stream */
185 /* FT_Set_Char_Size */
186 /* FT_Set_Pixel_Sizes */
187 /* FT_Request_Size */
189 /* FT_Size_Request_Type */
190 /* FT_Size_RequestRec */
191 /* FT_Size_Request */
192 /* FT_Set_Transform */
194 /* FT_Get_Char_Index */
195 /* FT_Get_First_Char */
196 /* FT_Get_Next_Char */
197 /* FT_Get_Name_Index */
202 /* FT_OPEN_PATHNAME */
206 /* FT_LOAD_DEFAULT */
208 /* FT_LOAD_MONOCHROME */
209 /* FT_LOAD_LINEAR_DESIGN */
210 /* FT_LOAD_NO_SCALE */
211 /* FT_LOAD_NO_HINTING */
212 /* FT_LOAD_NO_BITMAP */
213 /* FT_LOAD_NO_AUTOHINT */
216 /* FT_LOAD_VERTICAL_LAYOUT */
217 /* FT_LOAD_IGNORE_TRANSFORM */
218 /* FT_LOAD_FORCE_AUTOHINT */
219 /* FT_LOAD_NO_RECURSE */
220 /* FT_LOAD_PEDANTIC */
222 /* FT_LOAD_TARGET_NORMAL */
223 /* FT_LOAD_TARGET_LIGHT */
224 /* FT_LOAD_TARGET_MONO */
225 /* FT_LOAD_TARGET_LCD */
226 /* FT_LOAD_TARGET_LCD_V */
228 /* FT_LOAD_TARGET_MODE */
230 /* FT_Render_Glyph */
233 /* FT_Kerning_Mode */
234 /* FT_Get_Track_Kerning */
235 /* FT_Get_Glyph_Name */
236 /* FT_Get_Postscript_Name */
239 /* FT_Select_Charmap */
241 /* FT_Get_Charmap_Index */
243 /* FT_Get_FSType_Flags */
244 /* FT_Get_SubGlyph_Info */
246 /* FT_Face_Internal */
247 /* FT_Size_Internal */
248 /* FT_Slot_Internal */
250 /* FT_FACE_FLAG_XXX */
251 /* FT_STYLE_FLAG_XXX */
254 /* FT_LOAD_TARGET_XXX */
255 /* FT_SUBGLYPH_FLAG_XXX */
258 /* FT_HAS_FAST_GLYPHS */
260 /*************************************************************************/
263 /*************************************************************************/
266 /* FT_Glyph_Metrics */
269 /* A structure used to model the metrics of a single glyph. The */
270 /* values are expressed in 26.6 fractional pixel format; if the flag */
271 /* @FT_LOAD_NO_SCALE has been used while loading the glyph, values */
272 /* are expressed in font units instead. */
276 /* The glyph's width. */
279 /* The glyph's height. */
281 /* horiBearingX :: */
282 /* Left side bearing for horizontal layout. */
284 /* horiBearingY :: */
285 /* Top side bearing for horizontal layout. */
288 /* Advance width for horizontal layout. */
290 /* vertBearingX :: */
291 /* Left side bearing for vertical layout. */
293 /* vertBearingY :: */
294 /* Top side bearing for vertical layout. Larger positive values */
295 /* mean further below the vertical glyph origin. */
298 /* Advance height for vertical layout. Positive values mean the */
299 /* glyph has a positive advance downward. */
302 /* If not disabled with @FT_LOAD_NO_HINTING, the values represent */
303 /* dimensions of the hinted glyph (in case hinting is applicable). */
305 /* Stroking a glyph with an outside border does not increase */
306 /* `horiAdvance' or `vertAdvance'; you have to manually adjust these */
307 /* values to account for the added width and height. */
309 typedef struct FT_Glyph_Metrics_
325 /*************************************************************************/
331 /* This structure models the metrics of a bitmap strike (i.e., a set */
332 /* of glyphs for a given point size and resolution) in a bitmap font. */
333 /* It is used for the `available_sizes' field of @FT_Face. */
336 /* height :: The vertical distance, in pixels, between two */
337 /* consecutive baselines. It is always positive. */
339 /* width :: The average width, in pixels, of all glyphs in the */
342 /* size :: The nominal size of the strike in 26.6 fractional */
343 /* points. This field is not very useful. */
345 /* x_ppem :: The horizontal ppem (nominal width) in 26.6 fractional */
348 /* y_ppem :: The vertical ppem (nominal height) in 26.6 fractional */
353 /* The nominal size given in a FNT font is not reliable. Thus when */
354 /* the driver finds it incorrect, it sets `size' to some calculated */
355 /* values and sets `x_ppem' and `y_ppem' to the pixel width and */
356 /* height given in the font, respectively. */
358 /* TrueType embedded bitmaps: */
359 /* `size', `width', and `height' values are not contained in the */
360 /* bitmap strike itself. They are computed from the global font */
363 typedef struct FT_Bitmap_Size_
376 /*************************************************************************/
377 /*************************************************************************/
379 /* O B J E C T C L A S S E S */
381 /*************************************************************************/
382 /*************************************************************************/
384 /*************************************************************************/
390 /* A handle to a FreeType library instance. Each `library' is */
391 /* completely independent from the others; it is the `root' of a set */
392 /* of objects like fonts, faces, sizes, etc. */
394 /* It also embeds a memory manager (see @FT_Memory), as well as a */
395 /* scan-line converter object (see @FT_Raster). */
397 /* In multi-threaded applications, make sure that the same FT_Library */
398 /* object or any of its children doesn't get accessed in parallel. */
401 /* Library objects are normally created by @FT_Init_FreeType, and */
402 /* destroyed with @FT_Done_FreeType. If you need reference-counting */
403 /* (cf. @FT_Reference_Library), use @FT_New_Library and */
404 /* @FT_Done_Library. */
406 typedef struct FT_LibraryRec_ *FT_Library;
409 /*************************************************************************/
412 /* module_management */
414 /*************************************************************************/
416 /*************************************************************************/
422 /* A handle to a given FreeType module object. Each module can be a */
423 /* font driver, a renderer, or anything else that provides services */
424 /* to the formers. */
426 typedef struct FT_ModuleRec_* FT_Module;
429 /*************************************************************************/
435 /* A handle to a given FreeType font driver object. Each font driver */
436 /* is a special module capable of creating faces from font files. */
438 typedef struct FT_DriverRec_* FT_Driver;
441 /*************************************************************************/
447 /* A handle to a given FreeType renderer. A renderer is a special */
448 /* module in charge of converting a glyph image to a bitmap, when */
449 /* necessary. Each renderer supports a given glyph image format, and */
450 /* one or more target surface depths. */
452 typedef struct FT_RendererRec_* FT_Renderer;
455 /*************************************************************************/
460 /*************************************************************************/
462 /*************************************************************************/
468 /* A handle to a given typographic face object. A face object models */
469 /* a given typeface, in a given style. */
472 /* Each face object also owns a single @FT_GlyphSlot object, as well */
473 /* as one or more @FT_Size objects. */
475 /* Use @FT_New_Face or @FT_Open_Face to create a new face object from */
476 /* a given filepathname or a custom input stream. */
478 /* Use @FT_Done_Face to destroy it (along with its slot and sizes). */
481 /* See @FT_FaceRec for the publicly accessible fields of a given face */
484 typedef struct FT_FaceRec_* FT_Face;
487 /*************************************************************************/
493 /* A handle to an object used to model a face scaled to a given */
494 /* character size. */
497 /* Each @FT_Face has an _active_ @FT_Size object that is used by */
498 /* functions like @FT_Load_Glyph to determine the scaling */
499 /* transformation that in turn is used to load and hint glyphs and */
502 /* You can use @FT_Set_Char_Size, @FT_Set_Pixel_Sizes, */
503 /* @FT_Request_Size or even @FT_Select_Size to change the content */
504 /* (i.e., the scaling values) of the active @FT_Size. */
506 /* You can use @FT_New_Size to create additional size objects for a */
507 /* given @FT_Face, but they won't be used by other functions until */
508 /* you activate it through @FT_Activate_Size. Only one size can be */
509 /* activated at any given time per face. */
512 /* See @FT_SizeRec for the publicly accessible fields of a given size */
515 typedef struct FT_SizeRec_* FT_Size;
518 /*************************************************************************/
524 /* A handle to a given `glyph slot'. A slot is a container where it */
525 /* is possible to load any of the glyphs contained in its parent */
528 /* In other words, each time you call @FT_Load_Glyph or */
529 /* @FT_Load_Char, the slot's content is erased by the new glyph data, */
530 /* i.e., the glyph's metrics, its image (bitmap or outline), and */
531 /* other control information. */
534 /* See @FT_GlyphSlotRec for the publicly accessible glyph fields. */
536 typedef struct FT_GlyphSlotRec_* FT_GlyphSlot;
539 /*************************************************************************/
545 /* A handle to a given character map. A charmap is used to translate */
546 /* character codes in a given encoding into glyph indexes for its */
547 /* parent's face. Some font formats may provide several charmaps per */
550 /* Each face object owns zero or more charmaps, but only one of them */
551 /* can be `active' and used by @FT_Get_Char_Index or @FT_Load_Char. */
553 /* The list of available charmaps in a face is available through the */
554 /* `face->num_charmaps' and `face->charmaps' fields of @FT_FaceRec. */
556 /* The currently active charmap is available as `face->charmap'. */
557 /* You should call @FT_Set_Charmap to change it. */
560 /* When a new face is created (either through @FT_New_Face or */
561 /* @FT_Open_Face), the library looks for a Unicode charmap within */
562 /* the list and automatically activates it. */
565 /* See @FT_CharMapRec for the publicly accessible fields of a given */
568 typedef struct FT_CharMapRec_* FT_CharMap;
571 /*************************************************************************/
577 /* This macro converts four-letter tags into an unsigned long. It is */
578 /* used to define `encoding' identifiers (see @FT_Encoding). */
581 /* Since many 16-bit compilers don't like 32-bit enumerations, you */
582 /* should redefine this macro in case of problems to something like */
586 /* #define FT_ENC_TAG( value, a, b, c, d ) value */
589 /* to get a simple enumeration without assigning special numbers. */
593 #define FT_ENC_TAG( value, a, b, c, d ) \
594 value = ( ( (FT_UInt32)(a) << 24 ) | \
595 ( (FT_UInt32)(b) << 16 ) | \
596 ( (FT_UInt32)(c) << 8 ) | \
599 #endif /* FT_ENC_TAG */
602 /*************************************************************************/
608 /* An enumeration used to specify character sets supported by */
609 /* charmaps. Used in the @FT_Select_Charmap API function. */
612 /* Despite the name, this enumeration lists specific character */
613 /* repertories (i.e., charsets), and not text encoding methods (e.g., */
614 /* UTF-8, UTF-16, etc.). */
616 /* Other encodings might be defined in the future. */
619 /* FT_ENCODING_NONE :: */
620 /* The encoding value~0 is reserved. */
622 /* FT_ENCODING_UNICODE :: */
623 /* Corresponds to the Unicode character set. This value covers */
624 /* all versions of the Unicode repertoire, including ASCII and */
625 /* Latin-1. Most fonts include a Unicode charmap, but not all */
628 /* For example, if you want to access Unicode value U+1F028 (and */
629 /* the font contains it), use value 0x1F028 as the input value for */
630 /* @FT_Get_Char_Index. */
632 /* FT_ENCODING_MS_SYMBOL :: */
633 /* Corresponds to the Microsoft Symbol encoding, used to encode */
634 /* mathematical symbols in the 32..255 character code range. For */
635 /* more information, see */
636 /* `http://www.kostis.net/charsets/symbol.htm'. */
638 /* FT_ENCODING_SJIS :: */
639 /* Corresponds to Japanese SJIS encoding. More info at */
640 /* at `http://en.wikipedia.org/wiki/Shift_JIS'. */
641 /* See note on multi-byte encodings below. */
643 /* FT_ENCODING_GB2312 :: */
644 /* Corresponds to an encoding system for Simplified Chinese as used */
645 /* used in mainland China. */
647 /* FT_ENCODING_BIG5 :: */
648 /* Corresponds to an encoding system for Traditional Chinese as */
649 /* used in Taiwan and Hong Kong. */
651 /* FT_ENCODING_WANSUNG :: */
652 /* Corresponds to the Korean encoding system known as Wansung. */
653 /* For more information see */
654 /* `http://msdn.microsoft.com/en-US/goglobal/cc305154'. */
656 /* FT_ENCODING_JOHAB :: */
657 /* The Korean standard character set (KS~C 5601-1992), which */
658 /* corresponds to MS Windows code page 1361. This character set */
659 /* includes all possible Hangeul character combinations. */
661 /* FT_ENCODING_ADOBE_LATIN_1 :: */
662 /* Corresponds to a Latin-1 encoding as defined in a Type~1 */
663 /* PostScript font. It is limited to 256 character codes. */
665 /* FT_ENCODING_ADOBE_STANDARD :: */
666 /* Corresponds to the Adobe Standard encoding, as found in Type~1, */
667 /* CFF, and OpenType/CFF fonts. It is limited to 256 character */
670 /* FT_ENCODING_ADOBE_EXPERT :: */
671 /* Corresponds to the Adobe Expert encoding, as found in Type~1, */
672 /* CFF, and OpenType/CFF fonts. It is limited to 256 character */
675 /* FT_ENCODING_ADOBE_CUSTOM :: */
676 /* Corresponds to a custom encoding, as found in Type~1, CFF, and */
677 /* OpenType/CFF fonts. It is limited to 256 character codes. */
679 /* FT_ENCODING_APPLE_ROMAN :: */
680 /* Corresponds to the 8-bit Apple roman encoding. Many TrueType */
681 /* and OpenType fonts contain a charmap for this encoding, since */
682 /* older versions of Mac OS are able to use it. */
684 /* FT_ENCODING_OLD_LATIN_2 :: */
685 /* This value is deprecated and was never used nor reported by */
686 /* FreeType. Don't use or test for it. */
688 /* FT_ENCODING_MS_SJIS :: */
689 /* Same as FT_ENCODING_SJIS. Deprecated. */
691 /* FT_ENCODING_MS_GB2312 :: */
692 /* Same as FT_ENCODING_GB2312. Deprecated. */
694 /* FT_ENCODING_MS_BIG5 :: */
695 /* Same as FT_ENCODING_BIG5. Deprecated. */
697 /* FT_ENCODING_MS_WANSUNG :: */
698 /* Same as FT_ENCODING_WANSUNG. Deprecated. */
700 /* FT_ENCODING_MS_JOHAB :: */
701 /* Same as FT_ENCODING_JOHAB. Deprecated. */
704 /* By default, FreeType automatically synthesizes a Unicode charmap */
705 /* for PostScript fonts, using their glyph names dictionaries. */
706 /* However, it also reports the encodings defined explicitly in the */
707 /* font file, for the cases when they are needed, with the Adobe */
708 /* values as well. */
710 /* FT_ENCODING_NONE is set by the BDF and PCF drivers if the charmap */
711 /* is neither Unicode nor ISO-8859-1 (otherwise it is set to */
712 /* FT_ENCODING_UNICODE). Use @FT_Get_BDF_Charset_ID to find out */
713 /* which encoding is really present. If, for example, the */
714 /* `cs_registry' field is `KOI8' and the `cs_encoding' field is `R', */
715 /* the font is encoded in KOI8-R. */
717 /* FT_ENCODING_NONE is always set (with a single exception) by the */
718 /* winfonts driver. Use @FT_Get_WinFNT_Header and examine the */
719 /* `charset' field of the @FT_WinFNT_HeaderRec structure to find out */
720 /* which encoding is really present. For example, */
721 /* @FT_WinFNT_ID_CP1251 (204) means Windows code page 1251 (for */
724 /* FT_ENCODING_NONE is set if `platform_id' is @TT_PLATFORM_MACINTOSH */
725 /* and `encoding_id' is not @TT_MAC_ID_ROMAN (otherwise it is set to */
726 /* FT_ENCODING_APPLE_ROMAN). */
728 /* If `platform_id' is @TT_PLATFORM_MACINTOSH, use the function */
729 /* @FT_Get_CMap_Language_ID to query the Mac language ID that may */
730 /* be needed to be able to distinguish Apple encoding variants. See */
732 /* http://www.unicode.org/Public/MAPPINGS/VENDORS/APPLE/Readme.txt */
734 /* to get an idea how to do that. Basically, if the language ID */
735 /* is~0, don't use it, otherwise subtract 1 from the language ID. */
736 /* Then examine `encoding_id'. If, for example, `encoding_id' is */
737 /* @TT_MAC_ID_ROMAN and the language ID (minus~1) is */
738 /* `TT_MAC_LANGID_GREEK', it is the Greek encoding, not Roman. */
739 /* @TT_MAC_ID_ARABIC with `TT_MAC_LANGID_FARSI' means the Farsi */
740 /* variant the Arabic encoding. */
742 typedef enum FT_Encoding_
744 FT_ENC_TAG( FT_ENCODING_NONE, 0, 0, 0, 0 ),
746 FT_ENC_TAG( FT_ENCODING_MS_SYMBOL, 's', 'y', 'm', 'b' ),
747 FT_ENC_TAG( FT_ENCODING_UNICODE, 'u', 'n', 'i', 'c' ),
749 FT_ENC_TAG( FT_ENCODING_SJIS, 's', 'j', 'i', 's' ),
750 FT_ENC_TAG( FT_ENCODING_GB2312, 'g', 'b', ' ', ' ' ),
751 FT_ENC_TAG( FT_ENCODING_BIG5, 'b', 'i', 'g', '5' ),
752 FT_ENC_TAG( FT_ENCODING_WANSUNG, 'w', 'a', 'n', 's' ),
753 FT_ENC_TAG( FT_ENCODING_JOHAB, 'j', 'o', 'h', 'a' ),
755 /* for backwards compatibility */
756 FT_ENCODING_MS_SJIS = FT_ENCODING_SJIS,
757 FT_ENCODING_MS_GB2312 = FT_ENCODING_GB2312,
758 FT_ENCODING_MS_BIG5 = FT_ENCODING_BIG5,
759 FT_ENCODING_MS_WANSUNG = FT_ENCODING_WANSUNG,
760 FT_ENCODING_MS_JOHAB = FT_ENCODING_JOHAB,
762 FT_ENC_TAG( FT_ENCODING_ADOBE_STANDARD, 'A', 'D', 'O', 'B' ),
763 FT_ENC_TAG( FT_ENCODING_ADOBE_EXPERT, 'A', 'D', 'B', 'E' ),
764 FT_ENC_TAG( FT_ENCODING_ADOBE_CUSTOM, 'A', 'D', 'B', 'C' ),
765 FT_ENC_TAG( FT_ENCODING_ADOBE_LATIN_1, 'l', 'a', 't', '1' ),
767 FT_ENC_TAG( FT_ENCODING_OLD_LATIN_2, 'l', 'a', 't', '2' ),
769 FT_ENC_TAG( FT_ENCODING_APPLE_ROMAN, 'a', 'r', 'm', 'n' )
774 /* these constants are deprecated; use the corresponding `FT_Encoding' */
776 #define ft_encoding_none FT_ENCODING_NONE
777 #define ft_encoding_unicode FT_ENCODING_UNICODE
778 #define ft_encoding_symbol FT_ENCODING_MS_SYMBOL
779 #define ft_encoding_latin_1 FT_ENCODING_ADOBE_LATIN_1
780 #define ft_encoding_latin_2 FT_ENCODING_OLD_LATIN_2
781 #define ft_encoding_sjis FT_ENCODING_SJIS
782 #define ft_encoding_gb2312 FT_ENCODING_GB2312
783 #define ft_encoding_big5 FT_ENCODING_BIG5
784 #define ft_encoding_wansung FT_ENCODING_WANSUNG
785 #define ft_encoding_johab FT_ENCODING_JOHAB
787 #define ft_encoding_adobe_standard FT_ENCODING_ADOBE_STANDARD
788 #define ft_encoding_adobe_expert FT_ENCODING_ADOBE_EXPERT
789 #define ft_encoding_adobe_custom FT_ENCODING_ADOBE_CUSTOM
790 #define ft_encoding_apple_roman FT_ENCODING_APPLE_ROMAN
793 /*************************************************************************/
799 /* The base charmap structure. */
802 /* face :: A handle to the parent face object. */
804 /* encoding :: An @FT_Encoding tag identifying the charmap. Use */
805 /* this with @FT_Select_Charmap. */
807 /* platform_id :: An ID number describing the platform for the */
808 /* following encoding ID. This comes directly from */
809 /* the TrueType specification and should be emulated */
810 /* for other formats. */
812 /* encoding_id :: A platform specific encoding number. This also */
813 /* comes from the TrueType specification and should be */
814 /* emulated similarly. */
816 typedef struct FT_CharMapRec_
819 FT_Encoding encoding;
820 FT_UShort platform_id;
821 FT_UShort encoding_id;
826 /*************************************************************************/
827 /*************************************************************************/
829 /* B A S E O B J E C T C L A S S E S */
831 /*************************************************************************/
832 /*************************************************************************/
835 /*************************************************************************/
838 /* FT_Face_Internal */
841 /* An opaque handle to an `FT_Face_InternalRec' structure, used to */
842 /* model private data of a given @FT_Face object. */
844 /* This structure might change between releases of FreeType~2 and is */
845 /* not generally available to client applications. */
847 typedef struct FT_Face_InternalRec_* FT_Face_Internal;
850 /*************************************************************************/
856 /* FreeType root face class structure. A face object models a */
857 /* typeface in a font file. */
860 /* num_faces :: The number of faces in the font file. Some */
861 /* font formats can have multiple faces in */
864 /* face_index :: The index of the face in the font file. It */
865 /* is set to~0 if there is only one face in */
868 /* face_flags :: A set of bit flags that give important */
869 /* information about the face; see */
870 /* @FT_FACE_FLAG_XXX for the details. */
872 /* style_flags :: A set of bit flags indicating the style of */
873 /* the face; see @FT_STYLE_FLAG_XXX for the */
876 /* num_glyphs :: The number of glyphs in the face. If the */
877 /* face is scalable and has sbits (see */
878 /* `num_fixed_sizes'), it is set to the number */
879 /* of outline glyphs. */
881 /* For CID-keyed fonts, this value gives the */
882 /* highest CID used in the font. */
884 /* family_name :: The face's family name. This is an ASCII */
885 /* string, usually in English, that describes */
886 /* the typeface's family (like `Times New */
887 /* Roman', `Bodoni', `Garamond', etc). This */
888 /* is a least common denominator used to list */
889 /* fonts. Some formats (TrueType & OpenType) */
890 /* provide localized and Unicode versions of */
891 /* this string. Applications should use the */
892 /* format specific interface to access them. */
893 /* Can be NULL (e.g., in fonts embedded in a */
896 /* style_name :: The face's style name. This is an ASCII */
897 /* string, usually in English, that describes */
898 /* the typeface's style (like `Italic', */
899 /* `Bold', `Condensed', etc). Not all font */
900 /* formats provide a style name, so this field */
901 /* is optional, and can be set to NULL. As */
902 /* for `family_name', some formats provide */
903 /* localized and Unicode versions of this */
904 /* string. Applications should use the format */
905 /* specific interface to access them. */
907 /* num_fixed_sizes :: The number of bitmap strikes in the face. */
908 /* Even if the face is scalable, there might */
909 /* still be bitmap strikes, which are called */
910 /* `sbits' in that case. */
912 /* available_sizes :: An array of @FT_Bitmap_Size for all bitmap */
913 /* strikes in the face. It is set to NULL if */
914 /* there is no bitmap strike. */
916 /* num_charmaps :: The number of charmaps in the face. */
918 /* charmaps :: An array of the charmaps of the face. */
920 /* generic :: A field reserved for client uses. See the */
921 /* @FT_Generic type description. */
923 /* bbox :: The font bounding box. Coordinates are */
924 /* expressed in font units (see */
925 /* `units_per_EM'). The box is large enough */
926 /* to contain any glyph from the font. Thus, */
927 /* `bbox.yMax' can be seen as the `maximum */
928 /* ascender', and `bbox.yMin' as the `minimum */
929 /* descender'. Only relevant for scalable */
932 /* Note that the bounding box might be off by */
933 /* (at least) one pixel for hinted fonts. See */
934 /* @FT_Size_Metrics for further discussion. */
936 /* units_per_EM :: The number of font units per EM square for */
937 /* this face. This is typically 2048 for */
938 /* TrueType fonts, and 1000 for Type~1 fonts. */
939 /* Only relevant for scalable formats. */
941 /* ascender :: The typographic ascender of the face, */
942 /* expressed in font units. For font formats */
943 /* not having this information, it is set to */
944 /* `bbox.yMax'. Only relevant for scalable */
947 /* descender :: The typographic descender of the face, */
948 /* expressed in font units. For font formats */
949 /* not having this information, it is set to */
950 /* `bbox.yMin'. Note that this field is */
951 /* usually negative. Only relevant for */
952 /* scalable formats. */
954 /* height :: This value is the vertical distance */
955 /* between two consecutive baselines, */
956 /* expressed in font units. It is always */
957 /* positive. Only relevant for scalable */
960 /* If you want the global glyph height, use */
961 /* `ascender - descender'. */
963 /* max_advance_width :: The maximum advance width, in font units, */
964 /* for all glyphs in this face. This can be */
965 /* used to make word wrapping computations */
966 /* faster. Only relevant for scalable */
969 /* max_advance_height :: The maximum advance height, in font units, */
970 /* for all glyphs in this face. This is only */
971 /* relevant for vertical layouts, and is set */
972 /* to `height' for fonts that do not provide */
973 /* vertical metrics. Only relevant for */
974 /* scalable formats. */
976 /* underline_position :: The position, in font units, of the */
977 /* underline line for this face. It is the */
978 /* center of the underlining stem. Only */
979 /* relevant for scalable formats. */
981 /* underline_thickness :: The thickness, in font units, of the */
982 /* underline for this face. Only relevant for */
983 /* scalable formats. */
985 /* glyph :: The face's associated glyph slot(s). */
987 /* size :: The current active size for this face. */
989 /* charmap :: The current active charmap for this face. */
992 /* Fields may be changed after a call to @FT_Attach_File or */
993 /* @FT_Attach_Stream. */
995 typedef struct FT_FaceRec_
1001 FT_Long style_flags;
1005 FT_String* family_name;
1006 FT_String* style_name;
1008 FT_Int num_fixed_sizes;
1009 FT_Bitmap_Size* available_sizes;
1011 FT_Int num_charmaps;
1012 FT_CharMap* charmaps;
1016 /*# The following member variables (down to `underline_thickness') */
1017 /*# are only relevant to scalable outlines; cf. @FT_Bitmap_Size */
1018 /*# for bitmap fonts. */
1021 FT_UShort units_per_EM;
1026 FT_Short max_advance_width;
1027 FT_Short max_advance_height;
1029 FT_Short underline_position;
1030 FT_Short underline_thickness;
1042 FT_ListRec sizes_list;
1044 FT_Generic autohint; /* face-specific auto-hinter data */
1045 void* extensions; /* unused */
1047 FT_Face_Internal internal;
1054 /*************************************************************************/
1057 /* FT_FACE_FLAG_XXX */
1060 /* A list of bit flags used in the `face_flags' field of the */
1061 /* @FT_FaceRec structure. They inform client applications of */
1062 /* properties of the corresponding face. */
1065 /* FT_FACE_FLAG_SCALABLE :: */
1066 /* Indicates that the face contains outline glyphs. This doesn't */
1067 /* prevent bitmap strikes, i.e., a face can have both this and */
1068 /* and @FT_FACE_FLAG_FIXED_SIZES set. */
1070 /* FT_FACE_FLAG_FIXED_SIZES :: */
1071 /* Indicates that the face contains bitmap strikes. See also the */
1072 /* `num_fixed_sizes' and `available_sizes' fields of @FT_FaceRec. */
1074 /* FT_FACE_FLAG_FIXED_WIDTH :: */
1075 /* Indicates that the face contains fixed-width characters (like */
1076 /* Courier, Lucido, MonoType, etc.). */
1078 /* FT_FACE_FLAG_SFNT :: */
1079 /* Indicates that the face uses the `sfnt' storage scheme. For */
1080 /* now, this means TrueType and OpenType. */
1082 /* FT_FACE_FLAG_HORIZONTAL :: */
1083 /* Indicates that the face contains horizontal glyph metrics. This */
1084 /* should be set for all common formats. */
1086 /* FT_FACE_FLAG_VERTICAL :: */
1087 /* Indicates that the face contains vertical glyph metrics. This */
1088 /* is only available in some formats, not all of them. */
1090 /* FT_FACE_FLAG_KERNING :: */
1091 /* Indicates that the face contains kerning information. If set, */
1092 /* the kerning distance can be retrieved through the function */
1093 /* @FT_Get_Kerning. Otherwise the function always return the */
1094 /* vector (0,0). Note that FreeType doesn't handle kerning data */
1095 /* from the `GPOS' table (as present in some OpenType fonts). */
1097 /* FT_FACE_FLAG_FAST_GLYPHS :: */
1098 /* THIS FLAG IS DEPRECATED. DO NOT USE OR TEST IT. */
1100 /* FT_FACE_FLAG_MULTIPLE_MASTERS :: */
1101 /* Indicates that the font contains multiple masters and is capable */
1102 /* of interpolating between them. See the multiple-masters */
1103 /* specific API for details. */
1105 /* FT_FACE_FLAG_GLYPH_NAMES :: */
1106 /* Indicates that the font contains glyph names that can be */
1107 /* retrieved through @FT_Get_Glyph_Name. Note that some TrueType */
1108 /* fonts contain broken glyph name tables. Use the function */
1109 /* @FT_Has_PS_Glyph_Names when needed. */
1111 /* FT_FACE_FLAG_EXTERNAL_STREAM :: */
1112 /* Used internally by FreeType to indicate that a face's stream was */
1113 /* provided by the client application and should not be destroyed */
1114 /* when @FT_Done_Face is called. Don't read or test this flag. */
1116 /* FT_FACE_FLAG_HINTER :: */
1117 /* Set if the font driver has a hinting machine of its own. For */
1118 /* example, with TrueType fonts, it makes sense to use data from */
1119 /* the SFNT `gasp' table only if the native TrueType hinting engine */
1120 /* (with the bytecode interpreter) is available and active. */
1122 /* FT_FACE_FLAG_CID_KEYED :: */
1123 /* Set if the font is CID-keyed. In that case, the font is not */
1124 /* accessed by glyph indices but by CID values. For subsetted */
1125 /* CID-keyed fonts this has the consequence that not all index */
1126 /* values are a valid argument to FT_Load_Glyph. Only the CID */
1127 /* values for which corresponding glyphs in the subsetted font */
1128 /* exist make FT_Load_Glyph return successfully; in all other cases */
1129 /* you get an `FT_Err_Invalid_Argument' error. */
1131 /* Note that CID-keyed fonts that are in an SFNT wrapper don't */
1132 /* have this flag set since the glyphs are accessed in the normal */
1133 /* way (using contiguous indices); the `CID-ness' isn't visible to */
1134 /* the application. */
1136 /* FT_FACE_FLAG_TRICKY :: */
1137 /* Set if the font is `tricky', this is, it always needs the */
1138 /* font format's native hinting engine to get a reasonable result. */
1139 /* A typical example is the Chinese font `mingli.ttf' that uses */
1140 /* TrueType bytecode instructions to move and scale all of its */
1143 /* It is not possible to autohint such fonts using */
1144 /* @FT_LOAD_FORCE_AUTOHINT; it will also ignore */
1145 /* @FT_LOAD_NO_HINTING. You have to set both @FT_LOAD_NO_HINTING */
1146 /* and @FT_LOAD_NO_AUTOHINT to really disable hinting; however, you */
1147 /* probably never want this except for demonstration purposes. */
1149 /* Currently, there are about a dozen TrueType fonts in the list of */
1150 /* tricky fonts; they are hard-coded in file `ttobjs.c'. */
1152 /* FT_FACE_FLAG_COLOR :: */
1153 /* Set if the font has color glyph tables. To access color glyphs */
1154 /* use @FT_LOAD_COLOR. */
1156 #define FT_FACE_FLAG_SCALABLE ( 1L << 0 )
1157 #define FT_FACE_FLAG_FIXED_SIZES ( 1L << 1 )
1158 #define FT_FACE_FLAG_FIXED_WIDTH ( 1L << 2 )
1159 #define FT_FACE_FLAG_SFNT ( 1L << 3 )
1160 #define FT_FACE_FLAG_HORIZONTAL ( 1L << 4 )
1161 #define FT_FACE_FLAG_VERTICAL ( 1L << 5 )
1162 #define FT_FACE_FLAG_KERNING ( 1L << 6 )
1163 #define FT_FACE_FLAG_FAST_GLYPHS ( 1L << 7 )
1164 #define FT_FACE_FLAG_MULTIPLE_MASTERS ( 1L << 8 )
1165 #define FT_FACE_FLAG_GLYPH_NAMES ( 1L << 9 )
1166 #define FT_FACE_FLAG_EXTERNAL_STREAM ( 1L << 10 )
1167 #define FT_FACE_FLAG_HINTER ( 1L << 11 )
1168 #define FT_FACE_FLAG_CID_KEYED ( 1L << 12 )
1169 #define FT_FACE_FLAG_TRICKY ( 1L << 13 )
1170 #define FT_FACE_FLAG_COLOR ( 1L << 14 )
1173 /*************************************************************************
1176 * FT_HAS_HORIZONTAL( face )
1179 * A macro that returns true whenever a face object contains
1180 * horizontal metrics (this is true for all font formats though).
1183 * @FT_HAS_VERTICAL can be used to check for vertical metrics.
1186 #define FT_HAS_HORIZONTAL( face ) \
1187 ( face->face_flags & FT_FACE_FLAG_HORIZONTAL )
1190 /*************************************************************************
1193 * FT_HAS_VERTICAL( face )
1196 * A macro that returns true whenever a face object contains real
1197 * vertical metrics (and not only synthesized ones).
1200 #define FT_HAS_VERTICAL( face ) \
1201 ( face->face_flags & FT_FACE_FLAG_VERTICAL )
1204 /*************************************************************************
1207 * FT_HAS_KERNING( face )
1210 * A macro that returns true whenever a face object contains kerning
1211 * data that can be accessed with @FT_Get_Kerning.
1214 #define FT_HAS_KERNING( face ) \
1215 ( face->face_flags & FT_FACE_FLAG_KERNING )
1218 /*************************************************************************
1221 * FT_IS_SCALABLE( face )
1224 * A macro that returns true whenever a face object contains a scalable
1225 * font face (true for TrueType, Type~1, Type~42, CID, OpenType/CFF,
1226 * and PFR font formats.
1229 #define FT_IS_SCALABLE( face ) \
1230 ( face->face_flags & FT_FACE_FLAG_SCALABLE )
1233 /*************************************************************************
1236 * FT_IS_SFNT( face )
1239 * A macro that returns true whenever a face object contains a font
1240 * whose format is based on the SFNT storage scheme. This usually
1241 * means: TrueType fonts, OpenType fonts, as well as SFNT-based embedded
1244 * If this macro is true, all functions defined in @FT_SFNT_NAMES_H and
1245 * @FT_TRUETYPE_TABLES_H are available.
1248 #define FT_IS_SFNT( face ) \
1249 ( face->face_flags & FT_FACE_FLAG_SFNT )
1252 /*************************************************************************
1255 * FT_IS_FIXED_WIDTH( face )
1258 * A macro that returns true whenever a face object contains a font face
1259 * that contains fixed-width (or `monospace', `fixed-pitch', etc.)
1263 #define FT_IS_FIXED_WIDTH( face ) \
1264 ( face->face_flags & FT_FACE_FLAG_FIXED_WIDTH )
1267 /*************************************************************************
1270 * FT_HAS_FIXED_SIZES( face )
1273 * A macro that returns true whenever a face object contains some
1274 * embedded bitmaps. See the `available_sizes' field of the
1275 * @FT_FaceRec structure.
1278 #define FT_HAS_FIXED_SIZES( face ) \
1279 ( face->face_flags & FT_FACE_FLAG_FIXED_SIZES )
1282 /*************************************************************************
1285 * FT_HAS_FAST_GLYPHS( face )
1291 #define FT_HAS_FAST_GLYPHS( face ) 0
1294 /*************************************************************************
1297 * FT_HAS_GLYPH_NAMES( face )
1300 * A macro that returns true whenever a face object contains some glyph
1301 * names that can be accessed through @FT_Get_Glyph_Name.
1304 #define FT_HAS_GLYPH_NAMES( face ) \
1305 ( face->face_flags & FT_FACE_FLAG_GLYPH_NAMES )
1308 /*************************************************************************
1311 * FT_HAS_MULTIPLE_MASTERS( face )
1314 * A macro that returns true whenever a face object contains some
1315 * multiple masters. The functions provided by @FT_MULTIPLE_MASTERS_H
1316 * are then available to choose the exact design you want.
1319 #define FT_HAS_MULTIPLE_MASTERS( face ) \
1320 ( face->face_flags & FT_FACE_FLAG_MULTIPLE_MASTERS )
1323 /*************************************************************************
1326 * FT_IS_CID_KEYED( face )
1329 * A macro that returns true whenever a face object contains a CID-keyed
1330 * font. See the discussion of @FT_FACE_FLAG_CID_KEYED for more
1333 * If this macro is true, all functions defined in @FT_CID_H are
1337 #define FT_IS_CID_KEYED( face ) \
1338 ( face->face_flags & FT_FACE_FLAG_CID_KEYED )
1341 /*************************************************************************
1344 * FT_IS_TRICKY( face )
1347 * A macro that returns true whenever a face represents a `tricky' font.
1348 * See the discussion of @FT_FACE_FLAG_TRICKY for more details.
1351 #define FT_IS_TRICKY( face ) \
1352 ( face->face_flags & FT_FACE_FLAG_TRICKY )
1355 /*************************************************************************
1358 * FT_HAS_COLOR( face )
1361 * A macro that returns true whenever a face object contains
1362 * tables for color glyphs.
1365 #define FT_HAS_COLOR( face ) \
1366 ( face->face_flags & FT_FACE_FLAG_COLOR )
1369 /*************************************************************************/
1372 /* FT_STYLE_FLAG_XXX */
1375 /* A list of bit-flags used to indicate the style of a given face. */
1376 /* These are used in the `style_flags' field of @FT_FaceRec. */
1379 /* FT_STYLE_FLAG_ITALIC :: */
1380 /* Indicates that a given face style is italic or oblique. */
1382 /* FT_STYLE_FLAG_BOLD :: */
1383 /* Indicates that a given face is bold. */
1386 /* The style information as provided by FreeType is very basic. More */
1387 /* details are beyond the scope and should be done on a higher level */
1388 /* (for example, by analyzing various fields of the `OS/2' table in */
1389 /* SFNT based fonts). */
1391 #define FT_STYLE_FLAG_ITALIC ( 1 << 0 )
1392 #define FT_STYLE_FLAG_BOLD ( 1 << 1 )
1395 /*************************************************************************/
1398 /* FT_Size_Internal */
1401 /* An opaque handle to an `FT_Size_InternalRec' structure, used to */
1402 /* model private data of a given @FT_Size object. */
1404 typedef struct FT_Size_InternalRec_* FT_Size_Internal;
1407 /*************************************************************************/
1410 /* FT_Size_Metrics */
1413 /* The size metrics structure gives the metrics of a size object. */
1416 /* x_ppem :: The width of the scaled EM square in pixels, hence */
1417 /* the term `ppem' (pixels per EM). It is also */
1418 /* referred to as `nominal width'. */
1420 /* y_ppem :: The height of the scaled EM square in pixels, */
1421 /* hence the term `ppem' (pixels per EM). It is also */
1422 /* referred to as `nominal height'. */
1424 /* x_scale :: A 16.16 fractional scaling value used to convert */
1425 /* horizontal metrics from font units to 26.6 */
1426 /* fractional pixels. Only relevant for scalable */
1429 /* y_scale :: A 16.16 fractional scaling value used to convert */
1430 /* vertical metrics from font units to 26.6 */
1431 /* fractional pixels. Only relevant for scalable */
1434 /* ascender :: The ascender in 26.6 fractional pixels. See */
1435 /* @FT_FaceRec for the details. */
1437 /* descender :: The descender in 26.6 fractional pixels. See */
1438 /* @FT_FaceRec for the details. */
1440 /* height :: The height in 26.6 fractional pixels. See */
1441 /* @FT_FaceRec for the details. */
1443 /* max_advance :: The maximum advance width in 26.6 fractional */
1444 /* pixels. See @FT_FaceRec for the details. */
1447 /* The scaling values, if relevant, are determined first during a */
1448 /* size changing operation. The remaining fields are then set by the */
1449 /* driver. For scalable formats, they are usually set to scaled */
1450 /* values of the corresponding fields in @FT_FaceRec. */
1452 /* Note that due to glyph hinting, these values might not be exact */
1453 /* for certain fonts. Thus they must be treated as unreliable */
1454 /* with an error margin of at least one pixel! */
1456 /* Indeed, the only way to get the exact metrics is to render _all_ */
1457 /* glyphs. As this would be a definite performance hit, it is up to */
1458 /* client applications to perform such computations. */
1460 /* The FT_Size_Metrics structure is valid for bitmap fonts also. */
1462 typedef struct FT_Size_Metrics_
1464 FT_UShort x_ppem; /* horizontal pixels per EM */
1465 FT_UShort y_ppem; /* vertical pixels per EM */
1467 FT_Fixed x_scale; /* scaling values used to convert font */
1468 FT_Fixed y_scale; /* units to 26.6 fractional pixels */
1470 FT_Pos ascender; /* ascender in 26.6 frac. pixels */
1471 FT_Pos descender; /* descender in 26.6 frac. pixels */
1472 FT_Pos height; /* text height in 26.6 frac. pixels */
1473 FT_Pos max_advance; /* max horizontal advance, in 26.6 pixels */
1478 /*************************************************************************/
1484 /* FreeType root size class structure. A size object models a face */
1485 /* object at a given size. */
1488 /* face :: Handle to the parent face object. */
1490 /* generic :: A typeless pointer, unused by the FreeType library or */
1491 /* any of its drivers. It can be used by client */
1492 /* applications to link their own data to each size */
1495 /* metrics :: Metrics for this size object. This field is read-only. */
1497 typedef struct FT_SizeRec_
1499 FT_Face face; /* parent face object */
1500 FT_Generic generic; /* generic pointer for client uses */
1501 FT_Size_Metrics metrics; /* size metrics */
1502 FT_Size_Internal internal;
1507 /*************************************************************************/
1513 /* The subglyph structure is an internal object used to describe */
1514 /* subglyphs (for example, in the case of composites). */
1517 /* The subglyph implementation is not part of the high-level API, */
1518 /* hence the forward structure declaration. */
1520 /* You can however retrieve subglyph information with */
1521 /* @FT_Get_SubGlyph_Info. */
1523 typedef struct FT_SubGlyphRec_* FT_SubGlyph;
1526 /*************************************************************************/
1529 /* FT_Slot_Internal */
1532 /* An opaque handle to an `FT_Slot_InternalRec' structure, used to */
1533 /* model private data of a given @FT_GlyphSlot object. */
1535 typedef struct FT_Slot_InternalRec_* FT_Slot_Internal;
1538 /*************************************************************************/
1541 /* FT_GlyphSlotRec */
1544 /* FreeType root glyph slot class structure. A glyph slot is a */
1545 /* container where individual glyphs can be loaded, be they in */
1546 /* outline or bitmap format. */
1549 /* library :: A handle to the FreeType library instance */
1550 /* this slot belongs to. */
1552 /* face :: A handle to the parent face object. */
1554 /* next :: In some cases (like some font tools), several */
1555 /* glyph slots per face object can be a good */
1556 /* thing. As this is rare, the glyph slots are */
1557 /* listed through a direct, single-linked list */
1558 /* using its `next' field. */
1560 /* generic :: A typeless pointer unused by the FreeType */
1561 /* library or any of its drivers. It can be */
1562 /* used by client applications to link their own */
1563 /* data to each glyph slot object. */
1565 /* metrics :: The metrics of the last loaded glyph in the */
1566 /* slot. The returned values depend on the last */
1567 /* load flags (see the @FT_Load_Glyph API */
1568 /* function) and can be expressed either in 26.6 */
1569 /* fractional pixels or font units. */
1571 /* Note that even when the glyph image is */
1572 /* transformed, the metrics are not. */
1574 /* linearHoriAdvance :: The advance width of the unhinted glyph. */
1575 /* Its value is expressed in 16.16 fractional */
1576 /* pixels, unless @FT_LOAD_LINEAR_DESIGN is set */
1577 /* when loading the glyph. This field can be */
1578 /* important to perform correct WYSIWYG layout. */
1579 /* Only relevant for outline glyphs. */
1581 /* linearVertAdvance :: The advance height of the unhinted glyph. */
1582 /* Its value is expressed in 16.16 fractional */
1583 /* pixels, unless @FT_LOAD_LINEAR_DESIGN is set */
1584 /* when loading the glyph. This field can be */
1585 /* important to perform correct WYSIWYG layout. */
1586 /* Only relevant for outline glyphs. */
1588 /* advance :: This shorthand is, depending on */
1589 /* @FT_LOAD_IGNORE_TRANSFORM, the transformed */
1590 /* (hinted) advance width for the glyph, in 26.6 */
1591 /* fractional pixel format. As specified with */
1592 /* @FT_LOAD_VERTICAL_LAYOUT, it uses either the */
1593 /* `horiAdvance' or the `vertAdvance' value of */
1594 /* `metrics' field. */
1596 /* format :: This field indicates the format of the image */
1597 /* contained in the glyph slot. Typically */
1598 /* @FT_GLYPH_FORMAT_BITMAP, */
1599 /* @FT_GLYPH_FORMAT_OUTLINE, or */
1600 /* @FT_GLYPH_FORMAT_COMPOSITE, but others are */
1603 /* bitmap :: This field is used as a bitmap descriptor */
1604 /* when the slot format is */
1605 /* @FT_GLYPH_FORMAT_BITMAP. Note that the */
1606 /* address and content of the bitmap buffer can */
1607 /* change between calls of @FT_Load_Glyph and a */
1608 /* few other functions. */
1610 /* bitmap_left :: The bitmap's left bearing expressed in */
1611 /* integer pixels. Only valid if the format is */
1612 /* @FT_GLYPH_FORMAT_BITMAP, this is, if the */
1613 /* glyph slot contains a bitmap. */
1615 /* bitmap_top :: The bitmap's top bearing expressed in integer */
1616 /* pixels. Remember that this is the distance */
1617 /* from the baseline to the top-most glyph */
1618 /* scanline, upwards y~coordinates being */
1621 /* outline :: The outline descriptor for the current glyph */
1622 /* image if its format is */
1623 /* @FT_GLYPH_FORMAT_OUTLINE. Once a glyph is */
1624 /* loaded, `outline' can be transformed, */
1625 /* distorted, embolded, etc. However, it must */
1628 /* num_subglyphs :: The number of subglyphs in a composite glyph. */
1629 /* This field is only valid for the composite */
1630 /* glyph format that should normally only be */
1631 /* loaded with the @FT_LOAD_NO_RECURSE flag. */
1633 /* subglyphs :: An array of subglyph descriptors for */
1634 /* composite glyphs. There are `num_subglyphs' */
1635 /* elements in there. Currently internal to */
1638 /* control_data :: Certain font drivers can also return the */
1639 /* control data for a given glyph image (e.g. */
1640 /* TrueType bytecode, Type~1 charstrings, etc.). */
1641 /* This field is a pointer to such data. */
1643 /* control_len :: This is the length in bytes of the control */
1646 /* other :: Really wicked formats can use this pointer to */
1647 /* present their own glyph image to client */
1648 /* applications. Note that the application */
1649 /* needs to know about the image format. */
1651 /* lsb_delta :: The difference between hinted and unhinted */
1652 /* left side bearing while autohinting is */
1653 /* active. Zero otherwise. */
1655 /* rsb_delta :: The difference between hinted and unhinted */
1656 /* right side bearing while autohinting is */
1657 /* active. Zero otherwise. */
1660 /* If @FT_Load_Glyph is called with default flags (see */
1661 /* @FT_LOAD_DEFAULT) the glyph image is loaded in the glyph slot in */
1662 /* its native format (e.g., an outline glyph for TrueType and Type~1 */
1665 /* This image can later be converted into a bitmap by calling */
1666 /* @FT_Render_Glyph. This function finds the current renderer for */
1667 /* the native image's format, then invokes it. */
1669 /* The renderer is in charge of transforming the native image through */
1670 /* the slot's face transformation fields, then converting it into a */
1671 /* bitmap that is returned in `slot->bitmap'. */
1673 /* Note that `slot->bitmap_left' and `slot->bitmap_top' are also used */
1674 /* to specify the position of the bitmap relative to the current pen */
1675 /* position (e.g., coordinates (0,0) on the baseline). Of course, */
1676 /* `slot->format' is also changed to @FT_GLYPH_FORMAT_BITMAP. */
1679 /* Here a small pseudo code fragment that shows how to use */
1680 /* `lsb_delta' and `rsb_delta': */
1683 /* FT_Pos origin_x = 0; */
1684 /* FT_Pos prev_rsb_delta = 0; */
1687 /* for all glyphs do */
1688 /* <compute kern between current and previous glyph and add it to */
1691 /* <load glyph with `FT_Load_Glyph'> */
1693 /* if ( prev_rsb_delta - face->glyph->lsb_delta >= 32 ) */
1694 /* origin_x -= 64; */
1695 /* else if ( prev_rsb_delta - face->glyph->lsb_delta < -32 ) */
1696 /* origin_x += 64; */
1698 /* prev_rsb_delta = face->glyph->rsb_delta; */
1700 /* <save glyph image, or render glyph, or ...> */
1702 /* origin_x += face->glyph->advance.x; */
1706 typedef struct FT_GlyphSlotRec_
1711 FT_UInt reserved; /* retained for binary compatibility */
1714 FT_Glyph_Metrics metrics;
1715 FT_Fixed linearHoriAdvance;
1716 FT_Fixed linearVertAdvance;
1719 FT_Glyph_Format format;
1727 FT_UInt num_subglyphs;
1728 FT_SubGlyph subglyphs;
1738 FT_Slot_Internal internal;
1743 /*************************************************************************/
1744 /*************************************************************************/
1746 /* F U N C T I O N S */
1748 /*************************************************************************/
1749 /*************************************************************************/
1752 /*************************************************************************/
1755 /* FT_Init_FreeType */
1758 /* Initialize a new FreeType library object. The set of modules */
1759 /* that are registered by this function is determined at build time. */
1762 /* alibrary :: A handle to a new library object. */
1765 /* FreeType error code. 0~means success. */
1768 /* In case you want to provide your own memory allocating routines, */
1769 /* use @FT_New_Library instead, followed by a call to */
1770 /* @FT_Add_Default_Modules (or a series of calls to @FT_Add_Module). */
1772 /* For multi-threading applications each thread should have its own */
1773 /* FT_Library object. */
1775 /* If you need reference-counting (cf. @FT_Reference_Library), use */
1776 /* @FT_New_Library and @FT_Done_Library. */
1778 FT_EXPORT( FT_Error )
1779 FT_Init_FreeType( FT_Library *alibrary );
1782 /*************************************************************************/
1785 /* FT_Done_FreeType */
1788 /* Destroy a given FreeType library object and all of its children, */
1789 /* including resources, drivers, faces, sizes, etc. */
1792 /* library :: A handle to the target library object. */
1795 /* FreeType error code. 0~means success. */
1797 FT_EXPORT( FT_Error )
1798 FT_Done_FreeType( FT_Library library );
1801 /*************************************************************************/
1807 /* A list of bit-field constants used within the `flags' field of the */
1808 /* @FT_Open_Args structure. */
1811 /* FT_OPEN_MEMORY :: This is a memory-based stream. */
1813 /* FT_OPEN_STREAM :: Copy the stream from the `stream' field. */
1815 /* FT_OPEN_PATHNAME :: Create a new input stream from a C~path */
1818 /* FT_OPEN_DRIVER :: Use the `driver' field. */
1820 /* FT_OPEN_PARAMS :: Use the `num_params' and `params' fields. */
1823 /* The `FT_OPEN_MEMORY', `FT_OPEN_STREAM', and `FT_OPEN_PATHNAME' */
1824 /* flags are mutually exclusive. */
1826 #define FT_OPEN_MEMORY 0x1
1827 #define FT_OPEN_STREAM 0x2
1828 #define FT_OPEN_PATHNAME 0x4
1829 #define FT_OPEN_DRIVER 0x8
1830 #define FT_OPEN_PARAMS 0x10
1833 /* these constants are deprecated; use the corresponding `FT_OPEN_XXX' */
1834 /* values instead */
1835 #define ft_open_memory FT_OPEN_MEMORY
1836 #define ft_open_stream FT_OPEN_STREAM
1837 #define ft_open_pathname FT_OPEN_PATHNAME
1838 #define ft_open_driver FT_OPEN_DRIVER
1839 #define ft_open_params FT_OPEN_PARAMS
1842 /*************************************************************************/
1848 /* A simple structure used to pass more or less generic parameters to */
1849 /* @FT_Open_Face. */
1852 /* tag :: A four-byte identification tag. */
1854 /* data :: A pointer to the parameter data. */
1857 /* The ID and function of parameters are driver-specific. See the */
1858 /* various FT_PARAM_TAG_XXX flags for more information. */
1860 typedef struct FT_Parameter_
1868 /*************************************************************************/
1874 /* A structure used to indicate how to open a new font file or */
1875 /* stream. A pointer to such a structure can be used as a parameter */
1876 /* for the functions @FT_Open_Face and @FT_Attach_Stream. */
1879 /* flags :: A set of bit flags indicating how to use the */
1882 /* memory_base :: The first byte of the file in memory. */
1884 /* memory_size :: The size in bytes of the file in memory. */
1886 /* pathname :: A pointer to an 8-bit file pathname. */
1888 /* stream :: A handle to a source stream object. */
1890 /* driver :: This field is exclusively used by @FT_Open_Face; */
1891 /* it simply specifies the font driver to use to open */
1892 /* the face. If set to~0, FreeType tries to load the */
1893 /* face with each one of the drivers in its list. */
1895 /* num_params :: The number of extra parameters. */
1897 /* params :: Extra parameters passed to the font driver when */
1898 /* opening a new face. */
1901 /* The stream type is determined by the contents of `flags' that */
1902 /* are tested in the following order by @FT_Open_Face: */
1904 /* If the @FT_OPEN_MEMORY bit is set, assume that this is a */
1905 /* memory file of `memory_size' bytes, located at `memory_address'. */
1906 /* The data are are not copied, and the client is responsible for */
1907 /* releasing and destroying them _after_ the corresponding call to */
1908 /* @FT_Done_Face. */
1910 /* Otherwise, if the @FT_OPEN_STREAM bit is set, assume that a */
1911 /* custom input stream `stream' is used. */
1913 /* Otherwise, if the @FT_OPEN_PATHNAME bit is set, assume that this */
1914 /* is a normal file and use `pathname' to open it. */
1916 /* If the @FT_OPEN_DRIVER bit is set, @FT_Open_Face only tries to */
1917 /* open the file with the driver whose handler is in `driver'. */
1919 /* If the @FT_OPEN_PARAMS bit is set, the parameters given by */
1920 /* `num_params' and `params' is used. They are ignored otherwise. */
1922 /* Ideally, both the `pathname' and `params' fields should be tagged */
1923 /* as `const'; this is missing for API backwards compatibility. In */
1924 /* other words, applications should treat them as read-only. */
1926 typedef struct FT_Open_Args_
1929 const FT_Byte* memory_base;
1930 FT_Long memory_size;
1931 FT_String* pathname;
1935 FT_Parameter* params;
1940 /*************************************************************************/
1946 /* This function calls @FT_Open_Face to open a font by its pathname. */
1949 /* library :: A handle to the library resource. */
1952 /* pathname :: A path to the font file. */
1954 /* face_index :: The index of the face within the font. The first */
1955 /* face has index~0. */
1958 /* aface :: A handle to a new face object. If `face_index' is */
1959 /* greater than or equal to zero, it must be non-NULL. */
1960 /* See @FT_Open_Face for more details. */
1963 /* FreeType error code. 0~means success. */
1966 /* Use @FT_Done_Face to destroy the created @FT_Face object (along */
1967 /* with its slot and sizes). */
1969 FT_EXPORT( FT_Error )
1970 FT_New_Face( FT_Library library,
1971 const char* filepathname,
1976 /*************************************************************************/
1979 /* FT_New_Memory_Face */
1982 /* This function calls @FT_Open_Face to open a font that has been */
1983 /* loaded into memory. */
1986 /* library :: A handle to the library resource. */
1989 /* file_base :: A pointer to the beginning of the font data. */
1991 /* file_size :: The size of the memory chunk used by the font data. */
1993 /* face_index :: The index of the face within the font. The first */
1994 /* face has index~0. */
1997 /* aface :: A handle to a new face object. If `face_index' is */
1998 /* greater than or equal to zero, it must be non-NULL. */
1999 /* See @FT_Open_Face for more details. */
2002 /* FreeType error code. 0~means success. */
2005 /* You must not deallocate the memory before calling @FT_Done_Face. */
2007 FT_EXPORT( FT_Error )
2008 FT_New_Memory_Face( FT_Library library,
2009 const FT_Byte* file_base,
2015 /*************************************************************************/
2021 /* Create a face object from a given resource described by */
2022 /* @FT_Open_Args. */
2025 /* library :: A handle to the library resource. */
2028 /* args :: A pointer to an `FT_Open_Args' structure that must */
2029 /* be filled by the caller. */
2031 /* face_index :: The index of the face within the font. The first */
2032 /* face has index~0. */
2035 /* aface :: A handle to a new face object. If `face_index' is */
2036 /* greater than or equal to zero, it must be non-NULL. */
2037 /* See note below. */
2040 /* FreeType error code. 0~means success. */
2043 /* Unlike FreeType 1.x, this function automatically creates a glyph */
2044 /* slot for the face object that can be accessed directly through */
2045 /* `face->glyph'. */
2047 /* FT_Open_Face can be used to quickly check whether the font */
2048 /* format of a given font resource is supported by FreeType. If the */
2049 /* `face_index' field is negative, the function's return value is~0 */
2050 /* if the font format is recognized, or non-zero otherwise; */
2051 /* the function returns a more or less empty face handle in `*aface' */
2052 /* (if `aface' isn't NULL). The only useful field in this special */
2053 /* case is `face->num_faces' that gives the number of faces within */
2054 /* the font file. After examination, the returned @FT_Face structure */
2055 /* should be deallocated with a call to @FT_Done_Face. */
2057 /* Each new face object created with this function also owns a */
2058 /* default @FT_Size object, accessible as `face->size'. */
2060 /* One @FT_Library instance can have multiple face objects, this is, */
2061 /* @FT_Open_Face and its siblings can be called multiple times using */
2062 /* the same `library' argument. */
2064 /* See the discussion of reference counters in the description of */
2065 /* @FT_Reference_Face. */
2067 FT_EXPORT( FT_Error )
2068 FT_Open_Face( FT_Library library,
2069 const FT_Open_Args* args,
2074 /*************************************************************************/
2077 /* FT_Attach_File */
2080 /* This function calls @FT_Attach_Stream to attach a file. */
2083 /* face :: The target face object. */
2086 /* filepathname :: The pathname. */
2089 /* FreeType error code. 0~means success. */
2091 FT_EXPORT( FT_Error )
2092 FT_Attach_File( FT_Face face,
2093 const char* filepathname );
2096 /*************************************************************************/
2099 /* FT_Attach_Stream */
2102 /* `Attach' data to a face object. Normally, this is used to read */
2103 /* additional information for the face object. For example, you can */
2104 /* attach an AFM file that comes with a Type~1 font to get the */
2105 /* kerning values and other metrics. */
2108 /* face :: The target face object. */
2111 /* parameters :: A pointer to @FT_Open_Args that must be filled by */
2115 /* FreeType error code. 0~means success. */
2118 /* The meaning of the `attach' (i.e., what really happens when the */
2119 /* new file is read) is not fixed by FreeType itself. It really */
2120 /* depends on the font format (and thus the font driver). */
2122 /* Client applications are expected to know what they are doing */
2123 /* when invoking this function. Most drivers simply do not implement */
2124 /* file attachments. */
2126 FT_EXPORT( FT_Error )
2127 FT_Attach_Stream( FT_Face face,
2128 FT_Open_Args* parameters );
2131 /*************************************************************************/
2134 /* FT_Reference_Face */
2137 /* A counter gets initialized to~1 at the time an @FT_Face structure */
2138 /* is created. This function increments the counter. @FT_Done_Face */
2139 /* then only destroys a face if the counter is~1, otherwise it simply */
2140 /* decrements the counter. */
2142 /* This function helps in managing life-cycles of structures that */
2143 /* reference @FT_Face objects. */
2146 /* face :: A handle to a target face object. */
2149 /* FreeType error code. 0~means success. */
2154 FT_EXPORT( FT_Error )
2155 FT_Reference_Face( FT_Face face );
2158 /*************************************************************************/
2164 /* Discard a given face object, as well as all of its child slots and */
2168 /* face :: A handle to a target face object. */
2171 /* FreeType error code. 0~means success. */
2174 /* See the discussion of reference counters in the description of */
2175 /* @FT_Reference_Face. */
2177 FT_EXPORT( FT_Error )
2178 FT_Done_Face( FT_Face face );
2181 /*************************************************************************/
2184 /* FT_Select_Size */
2187 /* Select a bitmap strike. */
2190 /* face :: A handle to a target face object. */
2193 /* strike_index :: The index of the bitmap strike in the */
2194 /* `available_sizes' field of @FT_FaceRec structure. */
2197 /* FreeType error code. 0~means success. */
2199 FT_EXPORT( FT_Error )
2200 FT_Select_Size( FT_Face face,
2201 FT_Int strike_index );
2204 /*************************************************************************/
2207 /* FT_Size_Request_Type */
2210 /* An enumeration type that lists the supported size request types. */
2213 /* FT_SIZE_REQUEST_TYPE_NOMINAL :: */
2214 /* The nominal size. The `units_per_EM' field of @FT_FaceRec is */
2215 /* used to determine both scaling values. */
2217 /* FT_SIZE_REQUEST_TYPE_REAL_DIM :: */
2218 /* The real dimension. The sum of the the `ascender' and (minus */
2219 /* of) the `descender' fields of @FT_FaceRec are used to determine */
2220 /* both scaling values. */
2222 /* FT_SIZE_REQUEST_TYPE_BBOX :: */
2223 /* The font bounding box. The width and height of the `bbox' field */
2224 /* of @FT_FaceRec are used to determine the horizontal and vertical */
2225 /* scaling value, respectively. */
2227 /* FT_SIZE_REQUEST_TYPE_CELL :: */
2228 /* The `max_advance_width' field of @FT_FaceRec is used to */
2229 /* determine the horizontal scaling value; the vertical scaling */
2230 /* value is determined the same way as */
2231 /* @FT_SIZE_REQUEST_TYPE_REAL_DIM does. Finally, both scaling */
2232 /* values are set to the smaller one. This type is useful if you */
2233 /* want to specify the font size for, say, a window of a given */
2234 /* dimension and 80x24 cells. */
2236 /* FT_SIZE_REQUEST_TYPE_SCALES :: */
2237 /* Specify the scaling values directly. */
2240 /* The above descriptions only apply to scalable formats. For bitmap */
2241 /* formats, the behaviour is up to the driver. */
2243 /* See the note section of @FT_Size_Metrics if you wonder how size */
2244 /* requesting relates to scaling values. */
2246 typedef enum FT_Size_Request_Type_
2248 FT_SIZE_REQUEST_TYPE_NOMINAL,
2249 FT_SIZE_REQUEST_TYPE_REAL_DIM,
2250 FT_SIZE_REQUEST_TYPE_BBOX,
2251 FT_SIZE_REQUEST_TYPE_CELL,
2252 FT_SIZE_REQUEST_TYPE_SCALES,
2254 FT_SIZE_REQUEST_TYPE_MAX
2256 } FT_Size_Request_Type;
2259 /*************************************************************************/
2262 /* FT_Size_RequestRec */
2265 /* A structure used to model a size request. */
2268 /* type :: See @FT_Size_Request_Type. */
2270 /* width :: The desired width. */
2272 /* height :: The desired height. */
2274 /* horiResolution :: The horizontal resolution. If set to zero, */
2275 /* `width' is treated as a 26.6 fractional pixel */
2278 /* vertResolution :: The vertical resolution. If set to zero, */
2279 /* `height' is treated as a 26.6 fractional pixel */
2283 /* If `width' is zero, then the horizontal scaling value is set equal */
2284 /* to the vertical scaling value, and vice versa. */
2286 typedef struct FT_Size_RequestRec_
2288 FT_Size_Request_Type type;
2291 FT_UInt horiResolution;
2292 FT_UInt vertResolution;
2294 } FT_Size_RequestRec;
2297 /*************************************************************************/
2300 /* FT_Size_Request */
2303 /* A handle to a size request structure. */
2305 typedef struct FT_Size_RequestRec_ *FT_Size_Request;
2308 /*************************************************************************/
2311 /* FT_Request_Size */
2314 /* Resize the scale of the active @FT_Size object in a face. */
2317 /* face :: A handle to a target face object. */
2320 /* req :: A pointer to a @FT_Size_RequestRec. */
2323 /* FreeType error code. 0~means success. */
2326 /* Although drivers may select the bitmap strike matching the */
2327 /* request, you should not rely on this if you intend to select a */
2328 /* particular bitmap strike. Use @FT_Select_Size instead in that */
2331 /* The relation between the requested size and the resulting glyph */
2332 /* size is dependent entirely on how the size is defined in the */
2333 /* source face. The font designer chooses the final size of each */
2334 /* glyph relative to this size. For more information refer to */
2335 /* `http://www.freetype.org/freetype2/docs/glyphs/glyphs-2.html' */
2337 /* Don't use this function if you are using the FreeType cache API. */
2339 FT_EXPORT( FT_Error )
2340 FT_Request_Size( FT_Face face,
2341 FT_Size_Request req );
2344 /*************************************************************************/
2347 /* FT_Set_Char_Size */
2350 /* This function calls @FT_Request_Size to request the nominal size */
2354 /* face :: A handle to a target face object. */
2357 /* char_width :: The nominal width, in 26.6 fractional points. */
2359 /* char_height :: The nominal height, in 26.6 fractional points. */
2361 /* horz_resolution :: The horizontal resolution in dpi. */
2363 /* vert_resolution :: The vertical resolution in dpi. */
2366 /* FreeType error code. 0~means success. */
2369 /* If either the character width or height is zero, it is set equal */
2370 /* to the other value. */
2372 /* If either the horizontal or vertical resolution is zero, it is set */
2373 /* equal to the other value. */
2375 /* A character width or height smaller than 1pt is set to 1pt; if */
2376 /* both resolution values are zero, they are set to 72dpi. */
2378 /* Don't use this function if you are using the FreeType cache API. */
2380 FT_EXPORT( FT_Error )
2381 FT_Set_Char_Size( FT_Face face,
2382 FT_F26Dot6 char_width,
2383 FT_F26Dot6 char_height,
2384 FT_UInt horz_resolution,
2385 FT_UInt vert_resolution );
2388 /*************************************************************************/
2391 /* FT_Set_Pixel_Sizes */
2394 /* This function calls @FT_Request_Size to request the nominal size */
2398 /* face :: A handle to the target face object. */
2401 /* pixel_width :: The nominal width, in pixels. */
2403 /* pixel_height :: The nominal height, in pixels. */
2406 /* FreeType error code. 0~means success. */
2409 /* You should not rely on the resulting glyphs matching, or being */
2410 /* constrained, to this pixel size. Refer to @FT_Request_Size to */
2411 /* understand how requested sizes relate to actual sizes. */
2413 /* Don't use this function if you are using the FreeType cache API. */
2415 FT_EXPORT( FT_Error )
2416 FT_Set_Pixel_Sizes( FT_Face face,
2417 FT_UInt pixel_width,
2418 FT_UInt pixel_height );
2421 /*************************************************************************/
2427 /* A function used to load a single glyph into the glyph slot of a */
2431 /* face :: A handle to the target face object where the glyph */
2435 /* glyph_index :: The index of the glyph in the font file. For */
2436 /* CID-keyed fonts (either in PS or in CFF format) */
2437 /* this argument specifies the CID value. */
2439 /* load_flags :: A flag indicating what to load for this glyph. The */
2440 /* @FT_LOAD_XXX constants can be used to control the */
2441 /* glyph loading process (e.g., whether the outline */
2442 /* should be scaled, whether to load bitmaps or not, */
2443 /* whether to hint the outline, etc). */
2446 /* FreeType error code. 0~means success. */
2449 /* The loaded glyph may be transformed. See @FT_Set_Transform for */
2452 /* For subsetted CID-keyed fonts, `FT_Err_Invalid_Argument' is */
2453 /* returned for invalid CID values (this is, for CID values that */
2454 /* don't have a corresponding glyph in the font). See the discussion */
2455 /* of the @FT_FACE_FLAG_CID_KEYED flag for more details. */
2457 FT_EXPORT( FT_Error )
2458 FT_Load_Glyph( FT_Face face,
2459 FT_UInt glyph_index,
2460 FT_Int32 load_flags );
2463 /*************************************************************************/
2469 /* A function used to load a single glyph into the glyph slot of a */
2470 /* face object, according to its character code. */
2473 /* face :: A handle to a target face object where the glyph */
2477 /* char_code :: The glyph's character code, according to the */
2478 /* current charmap used in the face. */
2480 /* load_flags :: A flag indicating what to load for this glyph. The */
2481 /* @FT_LOAD_XXX constants can be used to control the */
2482 /* glyph loading process (e.g., whether the outline */
2483 /* should be scaled, whether to load bitmaps or not, */
2484 /* whether to hint the outline, etc). */
2487 /* FreeType error code. 0~means success. */
2490 /* This function simply calls @FT_Get_Char_Index and @FT_Load_Glyph. */
2492 FT_EXPORT( FT_Error )
2493 FT_Load_Char( FT_Face face,
2495 FT_Int32 load_flags );
2498 /*************************************************************************
2504 * A list of bit-field constants used with @FT_Load_Glyph to indicate
2505 * what kind of operations to perform during glyph loading.
2508 * FT_LOAD_DEFAULT ::
2509 * Corresponding to~0, this value is used as the default glyph load
2510 * operation. In this case, the following happens:
2512 * 1. FreeType looks for a bitmap for the glyph corresponding to the
2513 * face's current size. If one is found, the function returns.
2514 * The bitmap data can be accessed from the glyph slot (see note
2517 * 2. If no embedded bitmap is searched or found, FreeType looks for a
2518 * scalable outline. If one is found, it is loaded from the font
2519 * file, scaled to device pixels, then `hinted' to the pixel grid
2520 * in order to optimize it. The outline data can be accessed from
2521 * the glyph slot (see note below).
2523 * Note that by default, the glyph loader doesn't render outlines into
2524 * bitmaps. The following flags are used to modify this default
2525 * behaviour to more specific and useful cases.
2527 * FT_LOAD_NO_SCALE ::
2528 * Don't scale the loaded outline glyph but keep it in font units.
2530 * This flag implies @FT_LOAD_NO_HINTING and @FT_LOAD_NO_BITMAP, and
2531 * unsets @FT_LOAD_RENDER.
2533 * If the font is `tricky' (see @FT_FACE_FLAG_TRICKY for more), using
2534 * FT_LOAD_NO_SCALE usually yields meaningless outlines because the
2535 * subglyphs must be scaled and positioned with hinting instructions.
2536 * This can be solved by loading the font without FT_LOAD_NO_SCALE and
2537 * setting the character size to `font->units_per_EM'.
2539 * FT_LOAD_NO_HINTING ::
2540 * Disable hinting. This generally generates `blurrier' bitmap glyphs
2541 * when the glyph are rendered in any of the anti-aliased modes. See
2542 * also the note below.
2544 * This flag is implied by @FT_LOAD_NO_SCALE.
2547 * Call @FT_Render_Glyph after the glyph is loaded. By default, the
2548 * glyph is rendered in @FT_RENDER_MODE_NORMAL mode. This can be
2549 * overridden by @FT_LOAD_TARGET_XXX or @FT_LOAD_MONOCHROME.
2551 * This flag is unset by @FT_LOAD_NO_SCALE.
2553 * FT_LOAD_NO_BITMAP ::
2554 * Ignore bitmap strikes when loading. Bitmap-only fonts ignore this
2557 * @FT_LOAD_NO_SCALE always sets this flag.
2559 * FT_LOAD_VERTICAL_LAYOUT ::
2560 * Load the glyph for vertical text layout. In particular, the
2561 * `advance' value in the @FT_GlyphSlotRec structure is set to the
2562 * `vertAdvance' value of the `metrics' field.
2564 * In case @FT_HAS_VERTICAL doesn't return true, you shouldn't use
2565 * this flag currently. Reason is that in this case vertical metrics
2566 * get synthesized, and those values are not always consistent across
2567 * various font formats.
2569 * FT_LOAD_FORCE_AUTOHINT ::
2570 * Indicates that the auto-hinter is preferred over the font's native
2571 * hinter. See also the note below.
2573 * FT_LOAD_PEDANTIC ::
2574 * Indicates that the font driver should perform pedantic verifications
2575 * during glyph loading. This is mostly used to detect broken glyphs
2576 * in fonts. By default, FreeType tries to handle broken fonts also.
2578 * In particular, errors from the TrueType bytecode engine are not
2579 * passed to the application if this flag is not set; this might
2580 * result in partially hinted or distorted glyphs in case a glyph's
2581 * bytecode is buggy.
2583 * FT_LOAD_NO_RECURSE ::
2584 * Indicate that the font driver should not load composite glyphs
2585 * recursively. Instead, it should set the `num_subglyph' and
2586 * `subglyphs' values of the glyph slot accordingly, and set
2587 * `glyph->format' to @FT_GLYPH_FORMAT_COMPOSITE. The description of
2588 * subglyphs can then be accessed with @FT_Get_SubGlyph_Info.
2590 * This flag implies @FT_LOAD_NO_SCALE and @FT_LOAD_IGNORE_TRANSFORM.
2592 * FT_LOAD_IGNORE_TRANSFORM ::
2593 * Indicates that the transform matrix set by @FT_Set_Transform should
2596 * FT_LOAD_MONOCHROME ::
2597 * This flag is used with @FT_LOAD_RENDER to indicate that you want to
2598 * render an outline glyph to a 1-bit monochrome bitmap glyph, with
2599 * 8~pixels packed into each byte of the bitmap data.
2601 * Note that this has no effect on the hinting algorithm used. You
2602 * should rather use @FT_LOAD_TARGET_MONO so that the
2603 * monochrome-optimized hinting algorithm is used.
2605 * FT_LOAD_LINEAR_DESIGN ::
2606 * Indicates that the `linearHoriAdvance' and `linearVertAdvance'
2607 * fields of @FT_GlyphSlotRec should be kept in font units. See
2608 * @FT_GlyphSlotRec for details.
2610 * FT_LOAD_NO_AUTOHINT ::
2611 * Disable auto-hinter. See also the note below.
2614 * This flag is used to request loading of color embedded-bitmap
2615 * images. The resulting color bitmaps, if available, will have the
2616 * @FT_PIXEL_MODE_BGRA format. When the flag is not used and color
2617 * bitmaps are found, they will be converted to 256-level gray
2618 * bitmaps transparently. Those bitmaps will be in the
2619 * @FT_PIXEL_MODE_GRAY format.
2621 * FT_LOAD_CROP_BITMAP ::
2622 * Ignored. Deprecated.
2624 * FT_LOAD_IGNORE_GLOBAL_ADVANCE_WIDTH ::
2625 * Ignored. Deprecated.
2628 * By default, hinting is enabled and the font's native hinter (see
2629 * @FT_FACE_FLAG_HINTER) is preferred over the auto-hinter. You can
2630 * disable hinting by setting @FT_LOAD_NO_HINTING or change the
2631 * precedence by setting @FT_LOAD_FORCE_AUTOHINT. You can also set
2632 * @FT_LOAD_NO_AUTOHINT in case you don't want the auto-hinter to be
2635 * See the description of @FT_FACE_FLAG_TRICKY for a special exception
2636 * (affecting only a handful of Asian fonts).
2638 * Besides deciding which hinter to use, you can also decide which
2639 * hinting algorithm to use. See @FT_LOAD_TARGET_XXX for details.
2641 * Note that the auto-hinter needs a valid Unicode cmap (either a native
2642 * one or synthesized by FreeType) for producing correct results. If a
2643 * font provides an incorrect mapping (for example, assigning the
2644 * character code U+005A, LATIN CAPITAL LETTER Z, to a glyph depicting a
2645 * mathematical integral sign), the auto-hinter might produce useless
2649 #define FT_LOAD_DEFAULT 0x0
2650 #define FT_LOAD_NO_SCALE ( 1L << 0 )
2651 #define FT_LOAD_NO_HINTING ( 1L << 1 )
2652 #define FT_LOAD_RENDER ( 1L << 2 )
2653 #define FT_LOAD_NO_BITMAP ( 1L << 3 )
2654 #define FT_LOAD_VERTICAL_LAYOUT ( 1L << 4 )
2655 #define FT_LOAD_FORCE_AUTOHINT ( 1L << 5 )
2656 #define FT_LOAD_CROP_BITMAP ( 1L << 6 )
2657 #define FT_LOAD_PEDANTIC ( 1L << 7 )
2658 #define FT_LOAD_IGNORE_GLOBAL_ADVANCE_WIDTH ( 1L << 9 )
2659 #define FT_LOAD_NO_RECURSE ( 1L << 10 )
2660 #define FT_LOAD_IGNORE_TRANSFORM ( 1L << 11 )
2661 #define FT_LOAD_MONOCHROME ( 1L << 12 )
2662 #define FT_LOAD_LINEAR_DESIGN ( 1L << 13 )
2663 #define FT_LOAD_NO_AUTOHINT ( 1L << 15 )
2664 /* Bits 16..19 are used by `FT_LOAD_TARGET_' */
2665 #define FT_LOAD_COLOR ( 1L << 20 )
2669 /* used internally only by certain font drivers! */
2670 #define FT_LOAD_ADVANCE_ONLY ( 1L << 8 )
2671 #define FT_LOAD_SBITS_ONLY ( 1L << 14 )
2674 /**************************************************************************
2677 * FT_LOAD_TARGET_XXX
2680 * A list of values that are used to select a specific hinting algorithm
2681 * to use by the hinter. You should OR one of these values to your
2682 * `load_flags' when calling @FT_Load_Glyph.
2684 * Note that font's native hinters may ignore the hinting algorithm you
2685 * have specified (e.g., the TrueType bytecode interpreter). You can set
2686 * @FT_LOAD_FORCE_AUTOHINT to ensure that the auto-hinter is used.
2688 * Also note that @FT_LOAD_TARGET_LIGHT is an exception, in that it
2689 * always implies @FT_LOAD_FORCE_AUTOHINT.
2692 * FT_LOAD_TARGET_NORMAL ::
2693 * This corresponds to the default hinting algorithm, optimized for
2694 * standard gray-level rendering. For monochrome output, use
2695 * @FT_LOAD_TARGET_MONO instead.
2697 * FT_LOAD_TARGET_LIGHT ::
2698 * A lighter hinting algorithm for non-monochrome modes. Many
2699 * generated glyphs are more fuzzy but better resemble its original
2700 * shape. A bit like rendering on Mac OS~X.
2702 * As a special exception, this target implies @FT_LOAD_FORCE_AUTOHINT.
2704 * FT_LOAD_TARGET_MONO ::
2705 * Strong hinting algorithm that should only be used for monochrome
2706 * output. The result is probably unpleasant if the glyph is rendered
2707 * in non-monochrome modes.
2709 * FT_LOAD_TARGET_LCD ::
2710 * A variant of @FT_LOAD_TARGET_NORMAL optimized for horizontally
2711 * decimated LCD displays.
2713 * FT_LOAD_TARGET_LCD_V ::
2714 * A variant of @FT_LOAD_TARGET_NORMAL optimized for vertically
2715 * decimated LCD displays.
2718 * You should use only _one_ of the FT_LOAD_TARGET_XXX values in your
2719 * `load_flags'. They can't be ORed.
2721 * If @FT_LOAD_RENDER is also set, the glyph is rendered in the
2722 * corresponding mode (i.e., the mode that matches the used algorithm
2723 * best). An exeption is FT_LOAD_TARGET_MONO since it implies
2724 * @FT_LOAD_MONOCHROME.
2726 * You can use a hinting algorithm that doesn't correspond to the same
2727 * rendering mode. As an example, it is possible to use the `light'
2728 * hinting algorithm and have the results rendered in horizontal LCD
2729 * pixel mode, with code like
2732 * FT_Load_Glyph( face, glyph_index,
2733 * load_flags | FT_LOAD_TARGET_LIGHT );
2735 * FT_Render_Glyph( face->glyph, FT_RENDER_MODE_LCD );
2739 #define FT_LOAD_TARGET_( x ) ( (FT_Int32)( (x) & 15 ) << 16 )
2741 #define FT_LOAD_TARGET_NORMAL FT_LOAD_TARGET_( FT_RENDER_MODE_NORMAL )
2742 #define FT_LOAD_TARGET_LIGHT FT_LOAD_TARGET_( FT_RENDER_MODE_LIGHT )
2743 #define FT_LOAD_TARGET_MONO FT_LOAD_TARGET_( FT_RENDER_MODE_MONO )
2744 #define FT_LOAD_TARGET_LCD FT_LOAD_TARGET_( FT_RENDER_MODE_LCD )
2745 #define FT_LOAD_TARGET_LCD_V FT_LOAD_TARGET_( FT_RENDER_MODE_LCD_V )
2748 /**************************************************************************
2751 * FT_LOAD_TARGET_MODE
2754 * Return the @FT_Render_Mode corresponding to a given
2755 * @FT_LOAD_TARGET_XXX value.
2758 #define FT_LOAD_TARGET_MODE( x ) ( (FT_Render_Mode)( ( (x) >> 16 ) & 15 ) )
2761 /*************************************************************************/
2764 /* FT_Set_Transform */
2767 /* A function used to set the transformation that is applied to glyph */
2768 /* images when they are loaded into a glyph slot through */
2769 /* @FT_Load_Glyph. */
2772 /* face :: A handle to the source face object. */
2775 /* matrix :: A pointer to the transformation's 2x2 matrix. Use~0 for */
2776 /* the identity matrix. */
2777 /* delta :: A pointer to the translation vector. Use~0 for the null */
2781 /* The transformation is only applied to scalable image formats after */
2782 /* the glyph has been loaded. It means that hinting is unaltered by */
2783 /* the transformation and is performed on the character size given in */
2784 /* the last call to @FT_Set_Char_Size or @FT_Set_Pixel_Sizes. */
2786 /* Note that this also transforms the `face.glyph.advance' field, but */
2787 /* *not* the values in `face.glyph.metrics'. */
2790 FT_Set_Transform( FT_Face face,
2795 /*************************************************************************/
2798 /* FT_Render_Mode */
2801 /* An enumeration type that lists the render modes supported by */
2802 /* FreeType~2. Each mode corresponds to a specific type of scanline */
2803 /* conversion performed on the outline. */
2805 /* For bitmap fonts and embedded bitmaps the `bitmap->pixel_mode' */
2806 /* field in the @FT_GlyphSlotRec structure gives the format of the */
2807 /* returned bitmap. */
2809 /* All modes except @FT_RENDER_MODE_MONO use 256 levels of opacity. */
2812 /* FT_RENDER_MODE_NORMAL :: */
2813 /* This is the default render mode; it corresponds to 8-bit */
2814 /* anti-aliased bitmaps. */
2816 /* FT_RENDER_MODE_LIGHT :: */
2817 /* This is equivalent to @FT_RENDER_MODE_NORMAL. It is only */
2818 /* defined as a separate value because render modes are also used */
2819 /* indirectly to define hinting algorithm selectors. See */
2820 /* @FT_LOAD_TARGET_XXX for details. */
2822 /* FT_RENDER_MODE_MONO :: */
2823 /* This mode corresponds to 1-bit bitmaps (with 2~levels of */
2826 /* FT_RENDER_MODE_LCD :: */
2827 /* This mode corresponds to horizontal RGB and BGR sub-pixel */
2828 /* displays like LCD screens. It produces 8-bit bitmaps that are */
2829 /* 3~times the width of the original glyph outline in pixels, and */
2830 /* which use the @FT_PIXEL_MODE_LCD mode. */
2832 /* FT_RENDER_MODE_LCD_V :: */
2833 /* This mode corresponds to vertical RGB and BGR sub-pixel displays */
2834 /* (like PDA screens, rotated LCD displays, etc.). It produces */
2835 /* 8-bit bitmaps that are 3~times the height of the original */
2836 /* glyph outline in pixels and use the @FT_PIXEL_MODE_LCD_V mode. */
2839 /* The LCD-optimized glyph bitmaps produced by FT_Render_Glyph can be */
2840 /* filtered to reduce color-fringes by using @FT_Library_SetLcdFilter */
2841 /* (not active in the default builds). It is up to the caller to */
2842 /* either call @FT_Library_SetLcdFilter (if available) or do the */
2843 /* filtering itself. */
2845 /* The selected render mode only affects vector glyphs of a font. */
2846 /* Embedded bitmaps often have a different pixel mode like */
2847 /* @FT_PIXEL_MODE_MONO. You can use @FT_Bitmap_Convert to transform */
2848 /* them into 8-bit pixmaps. */
2850 typedef enum FT_Render_Mode_
2852 FT_RENDER_MODE_NORMAL = 0,
2853 FT_RENDER_MODE_LIGHT,
2854 FT_RENDER_MODE_MONO,
2856 FT_RENDER_MODE_LCD_V,
2863 /* these constants are deprecated; use the corresponding */
2864 /* `FT_Render_Mode' values instead */
2865 #define ft_render_mode_normal FT_RENDER_MODE_NORMAL
2866 #define ft_render_mode_mono FT_RENDER_MODE_MONO
2869 /*************************************************************************/
2872 /* FT_Render_Glyph */
2875 /* Convert a given glyph image to a bitmap. It does so by inspecting */
2876 /* the glyph image format, finding the relevant renderer, and */
2880 /* slot :: A handle to the glyph slot containing the image to */
2884 /* render_mode :: This is the render mode used to render the glyph */
2885 /* image into a bitmap. See @FT_Render_Mode for a */
2886 /* list of possible values. */
2889 /* FreeType error code. 0~means success. */
2892 /* To get meaningful results, font scaling values must be set with */
2893 /* functions like @FT_Set_Char_Size before calling FT_Render_Glyph. */
2895 FT_EXPORT( FT_Error )
2896 FT_Render_Glyph( FT_GlyphSlot slot,
2897 FT_Render_Mode render_mode );
2900 /*************************************************************************/
2903 /* FT_Kerning_Mode */
2906 /* An enumeration used to specify which kerning values to return in */
2907 /* @FT_Get_Kerning. */
2910 /* FT_KERNING_DEFAULT :: Return scaled and grid-fitted kerning */
2911 /* distances (value is~0). */
2913 /* FT_KERNING_UNFITTED :: Return scaled but un-grid-fitted kerning */
2916 /* FT_KERNING_UNSCALED :: Return the kerning vector in original font */
2919 typedef enum FT_Kerning_Mode_
2921 FT_KERNING_DEFAULT = 0,
2922 FT_KERNING_UNFITTED,
2928 /* these constants are deprecated; use the corresponding */
2929 /* `FT_Kerning_Mode' values instead */
2930 #define ft_kerning_default FT_KERNING_DEFAULT
2931 #define ft_kerning_unfitted FT_KERNING_UNFITTED
2932 #define ft_kerning_unscaled FT_KERNING_UNSCALED
2935 /*************************************************************************/
2938 /* FT_Get_Kerning */
2941 /* Return the kerning vector between two glyphs of a same face. */
2944 /* face :: A handle to a source face object. */
2946 /* left_glyph :: The index of the left glyph in the kern pair. */
2948 /* right_glyph :: The index of the right glyph in the kern pair. */
2950 /* kern_mode :: See @FT_Kerning_Mode for more information. */
2951 /* Determines the scale and dimension of the returned */
2952 /* kerning vector. */
2955 /* akerning :: The kerning vector. This is either in font units */
2956 /* or in pixels (26.6 format) for scalable formats, */
2957 /* and in pixels for fixed-sizes formats. */
2960 /* FreeType error code. 0~means success. */
2963 /* Only horizontal layouts (left-to-right & right-to-left) are */
2964 /* supported by this method. Other layouts, or more sophisticated */
2965 /* kernings, are out of the scope of this API function -- they can be */
2966 /* implemented through format-specific interfaces. */
2968 FT_EXPORT( FT_Error )
2969 FT_Get_Kerning( FT_Face face,
2971 FT_UInt right_glyph,
2973 FT_Vector *akerning );
2976 /*************************************************************************/
2979 /* FT_Get_Track_Kerning */
2982 /* Return the track kerning for a given face object at a given size. */
2985 /* face :: A handle to a source face object. */
2987 /* point_size :: The point size in 16.16 fractional points. */
2989 /* degree :: The degree of tightness. Increasingly negative */
2990 /* values represent tighter track kerning, while */
2991 /* increasingly positive values represent looser track */
2992 /* kerning. Value zero means no track kerning. */
2995 /* akerning :: The kerning in 16.16 fractional points, to be */
2996 /* uniformly applied between all glyphs. */
2999 /* FreeType error code. 0~means success. */
3002 /* Currently, only the Type~1 font driver supports track kerning, */
3003 /* using data from AFM files (if attached with @FT_Attach_File or */
3004 /* @FT_Attach_Stream). */
3006 /* Only very few AFM files come with track kerning data; please refer */
3007 /* to the Adobe's AFM specification for more details. */
3009 FT_EXPORT( FT_Error )
3010 FT_Get_Track_Kerning( FT_Face face,
3011 FT_Fixed point_size,
3013 FT_Fixed* akerning );
3016 /*************************************************************************/
3019 /* FT_Get_Glyph_Name */
3022 /* Retrieve the ASCII name of a given glyph in a face. This only */
3023 /* works for those faces where @FT_HAS_GLYPH_NAMES(face) returns~1. */
3026 /* face :: A handle to a source face object. */
3028 /* glyph_index :: The glyph index. */
3030 /* buffer_max :: The maximum number of bytes available in the */
3034 /* buffer :: A pointer to a target buffer where the name is */
3038 /* FreeType error code. 0~means success. */
3041 /* An error is returned if the face doesn't provide glyph names or if */
3042 /* the glyph index is invalid. In all cases of failure, the first */
3043 /* byte of `buffer' is set to~0 to indicate an empty name. */
3045 /* The glyph name is truncated to fit within the buffer if it is too */
3046 /* long. The returned string is always zero-terminated. */
3048 /* Be aware that FreeType reorders glyph indices internally so that */
3049 /* glyph index~0 always corresponds to the `missing glyph' (called */
3052 /* This function always returns an error if the config macro */
3053 /* `FT_CONFIG_OPTION_NO_GLYPH_NAMES' is not defined in `ftoptions.h'. */
3055 FT_EXPORT( FT_Error )
3056 FT_Get_Glyph_Name( FT_Face face,
3057 FT_UInt glyph_index,
3059 FT_UInt buffer_max );
3062 /*************************************************************************/
3065 /* FT_Get_Postscript_Name */
3068 /* Retrieve the ASCII PostScript name of a given face, if available. */
3069 /* This only works with PostScript and TrueType fonts. */
3072 /* face :: A handle to the source face object. */
3075 /* A pointer to the face's PostScript name. NULL if unavailable. */
3078 /* The returned pointer is owned by the face and is destroyed with */
3081 FT_EXPORT( const char* )
3082 FT_Get_Postscript_Name( FT_Face face );
3085 /*************************************************************************/
3088 /* FT_Select_Charmap */
3091 /* Select a given charmap by its encoding tag (as listed in */
3092 /* `freetype.h'). */
3095 /* face :: A handle to the source face object. */
3098 /* encoding :: A handle to the selected encoding. */
3101 /* FreeType error code. 0~means success. */
3104 /* This function returns an error if no charmap in the face */
3105 /* corresponds to the encoding queried here. */
3107 /* Because many fonts contain more than a single cmap for Unicode */
3108 /* encoding, this function has some special code to select the one */
3109 /* that covers Unicode best (`best' in the sense that a UCS-4 cmap is */
3110 /* preferred to a UCS-2 cmap). It is thus preferable to */
3111 /* @FT_Set_Charmap in this case. */
3113 FT_EXPORT( FT_Error )
3114 FT_Select_Charmap( FT_Face face,
3115 FT_Encoding encoding );
3118 /*************************************************************************/
3121 /* FT_Set_Charmap */
3124 /* Select a given charmap for character code to glyph index mapping. */
3127 /* face :: A handle to the source face object. */
3130 /* charmap :: A handle to the selected charmap. */
3133 /* FreeType error code. 0~means success. */
3136 /* This function returns an error if the charmap is not part of */
3137 /* the face (i.e., if it is not listed in the `face->charmaps' */
3140 /* It also fails if a type~14 charmap is selected. */
3142 FT_EXPORT( FT_Error )
3143 FT_Set_Charmap( FT_Face face,
3144 FT_CharMap charmap );
3147 /*************************************************************************
3150 * FT_Get_Charmap_Index
3153 * Retrieve index of a given charmap.
3157 * A handle to a charmap.
3160 * The index into the array of character maps within the face to which
3161 * `charmap' belongs. If an error occurs, -1 is returned.
3165 FT_Get_Charmap_Index( FT_CharMap charmap );
3168 /*************************************************************************/
3171 /* FT_Get_Char_Index */
3174 /* Return the glyph index of a given character code. This function */
3175 /* uses a charmap object to do the mapping. */
3178 /* face :: A handle to the source face object. */
3180 /* charcode :: The character code. */
3183 /* The glyph index. 0~means `undefined character code'. */
3186 /* If you use FreeType to manipulate the contents of font files */
3187 /* directly, be aware that the glyph index returned by this function */
3188 /* doesn't always correspond to the internal indices used within the */
3189 /* file. This is done to ensure that value~0 always corresponds to */
3190 /* the `missing glyph'. If the first glyph is not named `.notdef', */
3191 /* then for Type~1 and Type~42 fonts, `.notdef' will be moved into */
3192 /* the glyph ID~0 position, and whatever was there will be moved to */
3193 /* the position `.notdef' had. For Type~1 fonts, if there is no */
3194 /* `.notdef' glyph at all, then one will be created at index~0 and */
3195 /* whatever was there will be moved to the last index -- Type~42 */
3196 /* fonts are considered invalid under this condition. */
3198 FT_EXPORT( FT_UInt )
3199 FT_Get_Char_Index( FT_Face face,
3200 FT_ULong charcode );
3203 /*************************************************************************/
3206 /* FT_Get_First_Char */
3209 /* This function is used to return the first character code in the */
3210 /* current charmap of a given face. It also returns the */
3211 /* corresponding glyph index. */
3214 /* face :: A handle to the source face object. */
3217 /* agindex :: Glyph index of first character code. 0~if charmap is */
3221 /* The charmap's first character code. */
3224 /* You should use this function with @FT_Get_Next_Char to be able to */
3225 /* parse all character codes available in a given charmap. The code */
3226 /* should look like this: */
3229 /* FT_ULong charcode; */
3230 /* FT_UInt gindex; */
3233 /* charcode = FT_Get_First_Char( face, &gindex ); */
3234 /* while ( gindex != 0 ) */
3236 /* ... do something with (charcode,gindex) pair ... */
3238 /* charcode = FT_Get_Next_Char( face, charcode, &gindex ); */
3242 /* Note that `*agindex' is set to~0 if the charmap is empty. The */
3243 /* result itself can be~0 in two cases: if the charmap is empty or */
3244 /* if the value~0 is the first valid character code. */
3246 FT_EXPORT( FT_ULong )
3247 FT_Get_First_Char( FT_Face face,
3251 /*************************************************************************/
3254 /* FT_Get_Next_Char */
3257 /* This function is used to return the next character code in the */
3258 /* current charmap of a given face following the value `char_code', */
3259 /* as well as the corresponding glyph index. */
3262 /* face :: A handle to the source face object. */
3263 /* char_code :: The starting character code. */
3266 /* agindex :: Glyph index of next character code. 0~if charmap */
3270 /* The charmap's next character code. */
3273 /* You should use this function with @FT_Get_First_Char to walk */
3274 /* over all character codes available in a given charmap. See the */
3275 /* note for this function for a simple code example. */
3277 /* Note that `*agindex' is set to~0 when there are no more codes in */
3280 FT_EXPORT( FT_ULong )
3281 FT_Get_Next_Char( FT_Face face,
3286 /*************************************************************************/
3289 /* FT_Get_Name_Index */
3292 /* Return the glyph index of a given glyph name. This function uses */
3293 /* driver specific objects to do the translation. */
3296 /* face :: A handle to the source face object. */
3298 /* glyph_name :: The glyph name. */
3301 /* The glyph index. 0~means `undefined character code'. */
3303 FT_EXPORT( FT_UInt )
3304 FT_Get_Name_Index( FT_Face face,
3305 FT_String* glyph_name );
3308 /*************************************************************************
3311 * FT_SUBGLYPH_FLAG_XXX
3314 * A list of constants used to describe subglyphs. Please refer to the
3315 * TrueType specification for the meaning of the various flags.
3318 * FT_SUBGLYPH_FLAG_ARGS_ARE_WORDS ::
3319 * FT_SUBGLYPH_FLAG_ARGS_ARE_XY_VALUES ::
3320 * FT_SUBGLYPH_FLAG_ROUND_XY_TO_GRID ::
3321 * FT_SUBGLYPH_FLAG_SCALE ::
3322 * FT_SUBGLYPH_FLAG_XY_SCALE ::
3323 * FT_SUBGLYPH_FLAG_2X2 ::
3324 * FT_SUBGLYPH_FLAG_USE_MY_METRICS ::
3327 #define FT_SUBGLYPH_FLAG_ARGS_ARE_WORDS 1
3328 #define FT_SUBGLYPH_FLAG_ARGS_ARE_XY_VALUES 2
3329 #define FT_SUBGLYPH_FLAG_ROUND_XY_TO_GRID 4
3330 #define FT_SUBGLYPH_FLAG_SCALE 8
3331 #define FT_SUBGLYPH_FLAG_XY_SCALE 0x40
3332 #define FT_SUBGLYPH_FLAG_2X2 0x80
3333 #define FT_SUBGLYPH_FLAG_USE_MY_METRICS 0x200
3336 /*************************************************************************
3339 * FT_Get_SubGlyph_Info
3342 * Retrieve a description of a given subglyph. Only use it if
3343 * `glyph->format' is @FT_GLYPH_FORMAT_COMPOSITE; an error is
3344 * returned otherwise.
3348 * The source glyph slot.
3351 * The index of the subglyph. Must be less than
3352 * `glyph->num_subglyphs'.
3356 * The glyph index of the subglyph.
3359 * The subglyph flags, see @FT_SUBGLYPH_FLAG_XXX.
3362 * The subglyph's first argument (if any).
3365 * The subglyph's second argument (if any).
3368 * The subglyph transformation (if any).
3371 * FreeType error code. 0~means success.
3374 * The values of `*p_arg1', `*p_arg2', and `*p_transform' must be
3375 * interpreted depending on the flags returned in `*p_flags'. See the
3376 * TrueType specification for details.
3379 FT_EXPORT( FT_Error )
3380 FT_Get_SubGlyph_Info( FT_GlyphSlot glyph,
3386 FT_Matrix *p_transform );
3389 /*************************************************************************/
3395 /* A list of bit flags used in the `fsType' field of the OS/2 table */
3396 /* in a TrueType or OpenType font and the `FSType' entry in a */
3397 /* PostScript font. These bit flags are returned by */
3398 /* @FT_Get_FSType_Flags; they inform client applications of embedding */
3399 /* and subsetting restrictions associated with a font. */
3401 /* See http://www.adobe.com/devnet/acrobat/pdfs/FontPolicies.pdf for */
3405 /* FT_FSTYPE_INSTALLABLE_EMBEDDING :: */
3406 /* Fonts with no fsType bit set may be embedded and permanently */
3407 /* installed on the remote system by an application. */
3409 /* FT_FSTYPE_RESTRICTED_LICENSE_EMBEDDING :: */
3410 /* Fonts that have only this bit set must not be modified, embedded */
3411 /* or exchanged in any manner without first obtaining permission of */
3412 /* the font software copyright owner. */
3414 /* FT_FSTYPE_PREVIEW_AND_PRINT_EMBEDDING :: */
3415 /* If this bit is set, the font may be embedded and temporarily */
3416 /* loaded on the remote system. Documents containing Preview & */
3417 /* Print fonts must be opened `read-only'; no edits can be applied */
3418 /* to the document. */
3420 /* FT_FSTYPE_EDITABLE_EMBEDDING :: */
3421 /* If this bit is set, the font may be embedded but must only be */
3422 /* installed temporarily on other systems. In contrast to Preview */
3423 /* & Print fonts, documents containing editable fonts may be opened */
3424 /* for reading, editing is permitted, and changes may be saved. */
3426 /* FT_FSTYPE_NO_SUBSETTING :: */
3427 /* If this bit is set, the font may not be subsetted prior to */
3430 /* FT_FSTYPE_BITMAP_EMBEDDING_ONLY :: */
3431 /* If this bit is set, only bitmaps contained in the font may be */
3432 /* embedded; no outline data may be embedded. If there are no */
3433 /* bitmaps available in the font, then the font is unembeddable. */
3436 /* While the fsType flags can indicate that a font may be embedded, a */
3437 /* license with the font vendor may be separately required to use the */
3438 /* font in this way. */
3440 #define FT_FSTYPE_INSTALLABLE_EMBEDDING 0x0000
3441 #define FT_FSTYPE_RESTRICTED_LICENSE_EMBEDDING 0x0002
3442 #define FT_FSTYPE_PREVIEW_AND_PRINT_EMBEDDING 0x0004
3443 #define FT_FSTYPE_EDITABLE_EMBEDDING 0x0008
3444 #define FT_FSTYPE_NO_SUBSETTING 0x0100
3445 #define FT_FSTYPE_BITMAP_EMBEDDING_ONLY 0x0200
3448 /*************************************************************************/
3451 /* FT_Get_FSType_Flags */
3454 /* Return the fsType flags for a font. */
3457 /* face :: A handle to the source face object. */
3460 /* The fsType flags, @FT_FSTYPE_XXX. */
3463 /* Use this function rather than directly reading the `fs_type' field */
3464 /* in the @PS_FontInfoRec structure, which is only guaranteed to */
3465 /* return the correct results for Type~1 fonts. */
3470 FT_EXPORT( FT_UShort )
3471 FT_Get_FSType_Flags( FT_Face face );
3474 /*************************************************************************/
3477 /* glyph_variants */
3480 /* Glyph Variants */
3483 /* The FreeType~2 interface to Unicode Ideographic Variation */
3484 /* Sequences (IVS), using the SFNT cmap format~14. */
3487 /* Many CJK characters have variant forms. They are a sort of grey */
3488 /* area somewhere between being totally irrelevant and semantically */
3489 /* distinct; for this reason, the Unicode consortium decided to */
3490 /* introduce Ideographic Variation Sequences (IVS), consisting of a */
3491 /* Unicode base character and one of 240 variant selectors */
3492 /* (U+E0100-U+E01EF), instead of further extending the already huge */
3493 /* code range for CJK characters. */
3495 /* An IVS is registered and unique; for further details please refer */
3496 /* to Unicode Technical Standard #37, the Ideographic Variation */
3499 /* http://www.unicode.org/reports/tr37/ */
3501 /* To date (November 2014), the character with the most variants is */
3502 /* U+9089, having 32 such IVS. */
3504 /* Adobe and MS decided to support IVS with a new cmap subtable */
3505 /* (format~14). It is an odd subtable because it is not a mapping of */
3506 /* input code points to glyphs, but contains lists of all variants */
3507 /* supported by the font. */
3509 /* A variant may be either `default' or `non-default'. A default */
3510 /* variant is the one you will get for that code point if you look it */
3511 /* up in the standard Unicode cmap. A non-default variant is a */
3512 /* different glyph. */
3514 /*************************************************************************/
3517 /*************************************************************************/
3520 /* FT_Face_GetCharVariantIndex */
3523 /* Return the glyph index of a given character code as modified by */
3524 /* the variation selector. */
3528 /* A handle to the source face object. */
3531 /* The character code point in Unicode. */
3533 /* variantSelector :: */
3534 /* The Unicode code point of the variation selector. */
3537 /* The glyph index. 0~means either `undefined character code', or */
3538 /* `undefined selector code', or `no variation selector cmap */
3539 /* subtable', or `current CharMap is not Unicode'. */
3542 /* If you use FreeType to manipulate the contents of font files */
3543 /* directly, be aware that the glyph index returned by this function */
3544 /* doesn't always correspond to the internal indices used within */
3545 /* the file. This is done to ensure that value~0 always corresponds */
3546 /* to the `missing glyph'. */
3548 /* This function is only meaningful if */
3549 /* a) the font has a variation selector cmap sub table, */
3551 /* b) the current charmap has a Unicode encoding. */
3556 FT_EXPORT( FT_UInt )
3557 FT_Face_GetCharVariantIndex( FT_Face face,
3559 FT_ULong variantSelector );
3562 /*************************************************************************/
3565 /* FT_Face_GetCharVariantIsDefault */
3568 /* Check whether this variant of this Unicode character is the one to */
3569 /* be found in the `cmap'. */
3573 /* A handle to the source face object. */
3576 /* The character codepoint in Unicode. */
3578 /* variantSelector :: */
3579 /* The Unicode codepoint of the variation selector. */
3582 /* 1~if found in the standard (Unicode) cmap, 0~if found in the */
3583 /* variation selector cmap, or -1 if it is not a variant. */
3586 /* This function is only meaningful if the font has a variation */
3587 /* selector cmap subtable. */
3593 FT_Face_GetCharVariantIsDefault( FT_Face face,
3595 FT_ULong variantSelector );
3598 /*************************************************************************/
3601 /* FT_Face_GetVariantSelectors */
3604 /* Return a zero-terminated list of Unicode variant selectors found */
3609 /* A handle to the source face object. */
3612 /* A pointer to an array of selector code points, or NULL if there is */
3613 /* no valid variant selector cmap subtable. */
3616 /* The last item in the array is~0; the array is owned by the */
3617 /* @FT_Face object but can be overwritten or released on the next */
3618 /* call to a FreeType function. */
3623 FT_EXPORT( FT_UInt32* )
3624 FT_Face_GetVariantSelectors( FT_Face face );
3627 /*************************************************************************/
3630 /* FT_Face_GetVariantsOfChar */
3633 /* Return a zero-terminated list of Unicode variant selectors found */
3634 /* for the specified character code. */
3638 /* A handle to the source face object. */
3641 /* The character codepoint in Unicode. */
3644 /* A pointer to an array of variant selector code points that are */
3645 /* active for the given character, or NULL if the corresponding list */
3649 /* The last item in the array is~0; the array is owned by the */
3650 /* @FT_Face object but can be overwritten or released on the next */
3651 /* call to a FreeType function. */
3656 FT_EXPORT( FT_UInt32* )
3657 FT_Face_GetVariantsOfChar( FT_Face face,
3658 FT_ULong charcode );
3661 /*************************************************************************/
3664 /* FT_Face_GetCharsOfVariant */
3667 /* Return a zero-terminated list of Unicode character codes found for */
3668 /* the specified variant selector. */
3672 /* A handle to the source face object. */
3674 /* variantSelector :: */
3675 /* The variant selector code point in Unicode. */
3678 /* A list of all the code points that are specified by this selector */
3679 /* (both default and non-default codes are returned) or NULL if there */
3680 /* is no valid cmap or the variant selector is invalid. */
3683 /* The last item in the array is~0; the array is owned by the */
3684 /* @FT_Face object but can be overwritten or released on the next */
3685 /* call to a FreeType function. */
3690 FT_EXPORT( FT_UInt32* )
3691 FT_Face_GetCharsOfVariant( FT_Face face,
3692 FT_ULong variantSelector );
3695 /*************************************************************************/
3704 /* Crunching fixed numbers and vectors. */
3707 /* This section contains various functions used to perform */
3708 /* computations on 16.16 fixed-float numbers or 2d vectors. */
3717 /* FT_Vector_Transform */
3718 /* FT_Matrix_Multiply */
3719 /* FT_Matrix_Invert */
3721 /*************************************************************************/
3724 /*************************************************************************/
3730 /* A very simple function used to perform the computation `(a*b)/c' */
3731 /* with maximum accuracy (it uses a 64-bit intermediate integer */
3732 /* whenever necessary). */
3734 /* This function isn't necessarily as fast as some processor specific */
3735 /* operations, but is at least completely portable. */
3738 /* a :: The first multiplier. */
3739 /* b :: The second multiplier. */
3740 /* c :: The divisor. */
3743 /* The result of `(a*b)/c'. This function never traps when trying to */
3744 /* divide by zero; it simply returns `MaxInt' or `MinInt' depending */
3745 /* on the signs of `a' and `b'. */
3747 FT_EXPORT( FT_Long )
3748 FT_MulDiv( FT_Long a,
3753 /*************************************************************************/
3759 /* A very simple function used to perform the computation */
3760 /* `(a*b)/0x10000' with maximum accuracy. Most of the time this is */
3761 /* used to multiply a given value by a 16.16 fixed-point factor. */
3764 /* a :: The first multiplier. */
3765 /* b :: The second multiplier. Use a 16.16 factor here whenever */
3766 /* possible (see note below). */
3769 /* The result of `(a*b)/0x10000'. */
3772 /* This function has been optimized for the case where the absolute */
3773 /* value of `a' is less than 2048, and `b' is a 16.16 scaling factor. */
3774 /* As this happens mainly when scaling from notional units to */
3775 /* fractional pixels in FreeType, it resulted in noticeable speed */
3776 /* improvements between versions 2.x and 1.x. */
3778 /* As a conclusion, always try to place a 16.16 factor as the */
3779 /* _second_ argument of this function; this can make a great */
3782 FT_EXPORT( FT_Long )
3783 FT_MulFix( FT_Long a,
3787 /*************************************************************************/
3793 /* A very simple function used to perform the computation */
3794 /* `(a*0x10000)/b' with maximum accuracy. Most of the time, this is */
3795 /* used to divide a given value by a 16.16 fixed-point factor. */
3798 /* a :: The numerator. */
3799 /* b :: The denominator. Use a 16.16 factor here. */
3802 /* The result of `(a*0x10000)/b'. */
3804 FT_EXPORT( FT_Long )
3805 FT_DivFix( FT_Long a,
3809 /*************************************************************************/
3815 /* A very simple function used to round a 16.16 fixed number. */
3818 /* a :: The number to be rounded. */
3821 /* The result of `(a + 0x8000) & -0x10000'. */
3823 FT_EXPORT( FT_Fixed )
3824 FT_RoundFix( FT_Fixed a );
3827 /*************************************************************************/
3833 /* A very simple function used to compute the ceiling function of a */
3834 /* 16.16 fixed number. */
3837 /* a :: The number for which the ceiling function is to be computed. */
3840 /* The result of `(a + 0x10000 - 1) & -0x10000'. */
3842 FT_EXPORT( FT_Fixed )
3843 FT_CeilFix( FT_Fixed a );
3846 /*************************************************************************/
3852 /* A very simple function used to compute the floor function of a */
3853 /* 16.16 fixed number. */
3856 /* a :: The number for which the floor function is to be computed. */
3859 /* The result of `a & -0x10000'. */
3861 FT_EXPORT( FT_Fixed )
3862 FT_FloorFix( FT_Fixed a );
3865 /*************************************************************************/
3868 /* FT_Vector_Transform */
3871 /* Transform a single vector through a 2x2 matrix. */
3874 /* vector :: The target vector to transform. */
3877 /* matrix :: A pointer to the source 2x2 matrix. */
3880 /* The result is undefined if either `vector' or `matrix' is invalid. */
3883 FT_Vector_Transform( FT_Vector* vec,
3884 const FT_Matrix* matrix );
3887 /*************************************************************************/
3893 /* FreeType Version */
3896 /* Functions and macros related to FreeType versions. */
3899 /* Note that those functions and macros are of limited use because */
3900 /* even a new release of FreeType with only documentation changes */
3901 /* increases the version number. */
3904 /* FT_Library_Version */
3906 /* FREETYPE_MAJOR */
3907 /* FREETYPE_MINOR */
3908 /* FREETYPE_PATCH */
3910 /* FT_Face_CheckTrueTypePatents */
3911 /* FT_Face_SetUnpatentedHinting */
3915 /*************************************************************************/
3918 /*************************************************************************
3924 * These three macros identify the FreeType source code version.
3925 * Use @FT_Library_Version to access them at runtime.
3928 * FREETYPE_MAJOR :: The major version number.
3929 * FREETYPE_MINOR :: The minor version number.
3930 * FREETYPE_PATCH :: The patch level.
3933 * The version number of FreeType if built as a dynamic link library
3934 * with the `libtool' package is _not_ controlled by these three
3938 #define FREETYPE_MAJOR 2
3939 #define FREETYPE_MINOR 5
3940 #define FREETYPE_PATCH 5
3943 /*************************************************************************/
3946 /* FT_Library_Version */
3949 /* Return the version of the FreeType library being used. This is */
3950 /* useful when dynamically linking to the library, since one cannot */
3951 /* use the macros @FREETYPE_MAJOR, @FREETYPE_MINOR, and */
3952 /* @FREETYPE_PATCH. */
3955 /* library :: A source library handle. */
3958 /* amajor :: The major version number. */
3960 /* aminor :: The minor version number. */
3962 /* apatch :: The patch version number. */
3965 /* The reason why this function takes a `library' argument is because */
3966 /* certain programs implement library initialization in a custom way */
3967 /* that doesn't use @FT_Init_FreeType. */
3969 /* In such cases, the library version might not be available before */
3970 /* the library object has been created. */
3973 FT_Library_Version( FT_Library library,
3979 /*************************************************************************/
3982 /* FT_Face_CheckTrueTypePatents */
3985 /* Parse all bytecode instructions of a TrueType font file to check */
3986 /* whether any of the patented opcodes are used. This is only useful */
3987 /* if you want to be able to use the unpatented hinter with */
3988 /* fonts that do *not* use these opcodes. */
3990 /* Note that this function parses *all* glyph instructions in the */
3991 /* font file, which may be slow. */
3994 /* face :: A face handle. */
3997 /* 1~if this is a TrueType font that uses one of the patented */
3998 /* opcodes, 0~otherwise. */
4001 /* Since May 2010, TrueType hinting is no longer patented. */
4006 FT_EXPORT( FT_Bool )
4007 FT_Face_CheckTrueTypePatents( FT_Face face );
4010 /*************************************************************************/
4013 /* FT_Face_SetUnpatentedHinting */
4016 /* Enable or disable the unpatented hinter for a given face. */
4017 /* Only enable it if you have determined that the face doesn't */
4018 /* use any patented opcodes (see @FT_Face_CheckTrueTypePatents). */
4021 /* face :: A face handle. */
4023 /* value :: New boolean setting. */
4026 /* The old setting value. This will always be false if this is not */
4027 /* an SFNT font, or if the unpatented hinter is not compiled in this */
4028 /* instance of the library. */
4031 /* Since May 2010, TrueType hinting is no longer patented. */
4036 FT_EXPORT( FT_Bool )
4037 FT_Face_SetUnpatentedHinting( FT_Face face,
4045 #endif /* __FREETYPE_H__ */
projects / framework / graphics / freetype.git / blob