1 /***************************************************************************/
5 /* FreeType high-level API and common types (specification only). */
7 /* Copyright 1996-2013 by */
8 /* David Turner, Robert Wilhelm, and Werner Lemberg. */
10 /* This file is part of the FreeType project, and may only be used, */
11 /* modified, and distributed under the terms of the FreeType project */
12 /* license, LICENSE.TXT. By continuing to use, modify, or distribute */
13 /* this file you indicate that you have read the license and */
14 /* understand and accept it fully. */
16 /***************************************************************************/
19 #ifndef __FREETYPE_H__
20 #define __FREETYPE_H__
24 #error "`ft2build.h' hasn't been included yet!"
25 #error "Please always use macros to include FreeType header files."
27 #error " #include <ft2build.h>"
28 #error " #include FT_FREETYPE_H"
33 #include FT_CONFIG_CONFIG_H
42 /*************************************************************************/
51 /* How client applications should allocate FreeType data structures. */
54 /* FreeType assumes that structures allocated by the user and passed */
55 /* as arguments are zeroed out except for the actual data. In other */
56 /* words, it is recommended to use `calloc' (or variants of it) */
57 /* instead of `malloc' for allocation. */
59 /*************************************************************************/
63 /*************************************************************************/
64 /*************************************************************************/
66 /* B A S I C T Y P E S */
68 /*************************************************************************/
69 /*************************************************************************/
72 /*************************************************************************/
81 /* The FreeType~2 base font interface. */
84 /* This section describes the public high-level API of FreeType~2. */
96 /* FT_FACE_FLAG_SCALABLE */
97 /* FT_FACE_FLAG_FIXED_SIZES */
98 /* FT_FACE_FLAG_FIXED_WIDTH */
99 /* FT_FACE_FLAG_HORIZONTAL */
100 /* FT_FACE_FLAG_VERTICAL */
101 /* FT_FACE_FLAG_SFNT */
102 /* FT_FACE_FLAG_KERNING */
103 /* FT_FACE_FLAG_MULTIPLE_MASTERS */
104 /* FT_FACE_FLAG_GLYPH_NAMES */
105 /* FT_FACE_FLAG_EXTERNAL_STREAM */
106 /* FT_FACE_FLAG_FAST_GLYPHS */
107 /* FT_FACE_FLAG_HINTER */
109 /* FT_STYLE_FLAG_BOLD */
110 /* FT_STYLE_FLAG_ITALIC */
113 /* FT_Size_Metrics */
115 /* FT_GlyphSlotRec */
116 /* FT_Glyph_Metrics */
121 /* FT_Init_FreeType */
122 /* FT_Done_FreeType */
126 /* FT_New_Memory_Face */
131 /* FT_Attach_Stream */
133 /* FT_Set_Char_Size */
134 /* FT_Set_Pixel_Sizes */
135 /* FT_Request_Size */
137 /* FT_Size_Request_Type */
138 /* FT_Size_Request */
139 /* FT_Set_Transform */
141 /* FT_Get_Char_Index */
142 /* FT_Get_Name_Index */
147 /* FT_OPEN_PATHNAME */
151 /* FT_LOAD_DEFAULT */
153 /* FT_LOAD_MONOCHROME */
154 /* FT_LOAD_LINEAR_DESIGN */
155 /* FT_LOAD_NO_SCALE */
156 /* FT_LOAD_NO_HINTING */
157 /* FT_LOAD_NO_BITMAP */
158 /* FT_LOAD_CROP_BITMAP */
160 /* FT_LOAD_VERTICAL_LAYOUT */
161 /* FT_LOAD_IGNORE_TRANSFORM */
162 /* FT_LOAD_IGNORE_GLOBAL_ADVANCE_WIDTH */
163 /* FT_LOAD_FORCE_AUTOHINT */
164 /* FT_LOAD_NO_RECURSE */
165 /* FT_LOAD_PEDANTIC */
167 /* FT_LOAD_TARGET_NORMAL */
168 /* FT_LOAD_TARGET_LIGHT */
169 /* FT_LOAD_TARGET_MONO */
170 /* FT_LOAD_TARGET_LCD */
171 /* FT_LOAD_TARGET_LCD_V */
173 /* FT_Render_Glyph */
176 /* FT_Kerning_Mode */
177 /* FT_Get_Track_Kerning */
178 /* FT_Get_Glyph_Name */
179 /* FT_Get_Postscript_Name */
182 /* FT_Select_Charmap */
184 /* FT_Get_Charmap_Index */
186 /* FT_FSTYPE_INSTALLABLE_EMBEDDING */
187 /* FT_FSTYPE_RESTRICTED_LICENSE_EMBEDDING */
188 /* FT_FSTYPE_PREVIEW_AND_PRINT_EMBEDDING */
189 /* FT_FSTYPE_EDITABLE_EMBEDDING */
190 /* FT_FSTYPE_NO_SUBSETTING */
191 /* FT_FSTYPE_BITMAP_EMBEDDING_ONLY */
193 /* FT_Get_FSType_Flags */
195 /*************************************************************************/
198 /*************************************************************************/
201 /* FT_Glyph_Metrics */
204 /* A structure used to model the metrics of a single glyph. The */
205 /* values are expressed in 26.6 fractional pixel format; if the flag */
206 /* @FT_LOAD_NO_SCALE has been used while loading the glyph, values */
207 /* are expressed in font units instead. */
211 /* The glyph's width. */
214 /* The glyph's height. */
216 /* horiBearingX :: */
217 /* Left side bearing for horizontal layout. */
219 /* horiBearingY :: */
220 /* Top side bearing for horizontal layout. */
223 /* Advance width for horizontal layout. */
225 /* vertBearingX :: */
226 /* Left side bearing for vertical layout. */
228 /* vertBearingY :: */
229 /* Top side bearing for vertical layout. Larger positive values */
230 /* mean further below the vertical glyph origin. */
233 /* Advance height for vertical layout. Positive values mean the */
234 /* glyph has a positive advance downward. */
237 /* If not disabled with @FT_LOAD_NO_HINTING, the values represent */
238 /* dimensions of the hinted glyph (in case hinting is applicable). */
240 /* Stroking a glyph with an outside border does not increase */
241 /* `horiAdvance' or `vertAdvance'; you have to manually adjust these */
242 /* values to account for the added width and height. */
244 typedef struct FT_Glyph_Metrics_
260 /*************************************************************************/
266 /* This structure models the metrics of a bitmap strike (i.e., a set */
267 /* of glyphs for a given point size and resolution) in a bitmap font. */
268 /* It is used for the `available_sizes' field of @FT_Face. */
271 /* height :: The vertical distance, in pixels, between two */
272 /* consecutive baselines. It is always positive. */
274 /* width :: The average width, in pixels, of all glyphs in the */
277 /* size :: The nominal size of the strike in 26.6 fractional */
278 /* points. This field is not very useful. */
280 /* x_ppem :: The horizontal ppem (nominal width) in 26.6 fractional */
283 /* y_ppem :: The vertical ppem (nominal height) in 26.6 fractional */
288 /* The nominal size given in a FNT font is not reliable. Thus when */
289 /* the driver finds it incorrect, it sets `size' to some calculated */
290 /* values and sets `x_ppem' and `y_ppem' to the pixel width and */
291 /* height given in the font, respectively. */
293 /* TrueType embedded bitmaps: */
294 /* `size', `width', and `height' values are not contained in the */
295 /* bitmap strike itself. They are computed from the global font */
298 typedef struct FT_Bitmap_Size_
311 /*************************************************************************/
312 /*************************************************************************/
314 /* O B J E C T C L A S S E S */
316 /*************************************************************************/
317 /*************************************************************************/
319 /*************************************************************************/
325 /* A handle to a FreeType library instance. Each `library' is */
326 /* completely independent from the others; it is the `root' of a set */
327 /* of objects like fonts, faces, sizes, etc. */
329 /* It also embeds a memory manager (see @FT_Memory), as well as a */
330 /* scan-line converter object (see @FT_Raster). */
332 /* In multi-threaded applications, make sure that the same FT_Library */
333 /* object or any of its children doesn't get accessed in parallel. */
336 /* Library objects are normally created by @FT_Init_FreeType, and */
337 /* destroyed with @FT_Done_FreeType. If you need reference-counting */
338 /* (cf. @FT_Reference_Library), use @FT_New_Library and */
339 /* @FT_Done_Library. */
341 typedef struct FT_LibraryRec_
*FT_Library
;
344 /*************************************************************************/
350 /* A handle to a given FreeType module object. Each module can be a */
351 /* font driver, a renderer, or anything else that provides services */
352 /* to the formers. */
354 typedef struct FT_ModuleRec_
* FT_Module
;
357 /*************************************************************************/
363 /* A handle to a given FreeType font driver object. Each font driver */
364 /* is a special module capable of creating faces from font files. */
366 typedef struct FT_DriverRec_
* FT_Driver
;
369 /*************************************************************************/
375 /* A handle to a given FreeType renderer. A renderer is a special */
376 /* module in charge of converting a glyph image to a bitmap, when */
377 /* necessary. Each renderer supports a given glyph image format, and */
378 /* one or more target surface depths. */
380 typedef struct FT_RendererRec_
* FT_Renderer
;
383 /*************************************************************************/
389 /* A handle to a given typographic face object. A face object models */
390 /* a given typeface, in a given style. */
393 /* Each face object also owns a single @FT_GlyphSlot object, as well */
394 /* as one or more @FT_Size objects. */
396 /* Use @FT_New_Face or @FT_Open_Face to create a new face object from */
397 /* a given filepathname or a custom input stream. */
399 /* Use @FT_Done_Face to destroy it (along with its slot and sizes). */
402 /* See @FT_FaceRec for the publicly accessible fields of a given face */
405 typedef struct FT_FaceRec_
* FT_Face
;
408 /*************************************************************************/
414 /* A handle to an object used to model a face scaled to a given */
415 /* character size. */
418 /* Each @FT_Face has an _active_ @FT_Size object that is used by */
419 /* functions like @FT_Load_Glyph to determine the scaling */
420 /* transformation which is used to load and hint glyphs and metrics. */
422 /* You can use @FT_Set_Char_Size, @FT_Set_Pixel_Sizes, */
423 /* @FT_Request_Size or even @FT_Select_Size to change the content */
424 /* (i.e., the scaling values) of the active @FT_Size. */
426 /* You can use @FT_New_Size to create additional size objects for a */
427 /* given @FT_Face, but they won't be used by other functions until */
428 /* you activate it through @FT_Activate_Size. Only one size can be */
429 /* activated at any given time per face. */
432 /* See @FT_SizeRec for the publicly accessible fields of a given size */
435 typedef struct FT_SizeRec_
* FT_Size
;
438 /*************************************************************************/
444 /* A handle to a given `glyph slot'. A slot is a container where it */
445 /* is possible to load any of the glyphs contained in its parent */
448 /* In other words, each time you call @FT_Load_Glyph or */
449 /* @FT_Load_Char, the slot's content is erased by the new glyph data, */
450 /* i.e., the glyph's metrics, its image (bitmap or outline), and */
451 /* other control information. */
454 /* See @FT_GlyphSlotRec for the publicly accessible glyph fields. */
456 typedef struct FT_GlyphSlotRec_
* FT_GlyphSlot
;
459 /*************************************************************************/
465 /* A handle to a given character map. A charmap is used to translate */
466 /* character codes in a given encoding into glyph indexes for its */
467 /* parent's face. Some font formats may provide several charmaps per */
470 /* Each face object owns zero or more charmaps, but only one of them */
471 /* can be `active' and used by @FT_Get_Char_Index or @FT_Load_Char. */
473 /* The list of available charmaps in a face is available through the */
474 /* `face->num_charmaps' and `face->charmaps' fields of @FT_FaceRec. */
476 /* The currently active charmap is available as `face->charmap'. */
477 /* You should call @FT_Set_Charmap to change it. */
480 /* When a new face is created (either through @FT_New_Face or */
481 /* @FT_Open_Face), the library looks for a Unicode charmap within */
482 /* the list and automatically activates it. */
485 /* See @FT_CharMapRec for the publicly accessible fields of a given */
488 typedef struct FT_CharMapRec_
* FT_CharMap
;
491 /*************************************************************************/
497 /* This macro converts four-letter tags into an unsigned long. It is */
498 /* used to define `encoding' identifiers (see @FT_Encoding). */
501 /* Since many 16-bit compilers don't like 32-bit enumerations, you */
502 /* should redefine this macro in case of problems to something like */
506 /* #define FT_ENC_TAG( value, a, b, c, d ) value */
509 /* to get a simple enumeration without assigning special numbers. */
513 #define FT_ENC_TAG( value, a, b, c, d ) \
514 value = ( ( (FT_UInt32)(a) << 24 ) | \
515 ( (FT_UInt32)(b) << 16 ) | \
516 ( (FT_UInt32)(c) << 8 ) | \
519 #endif /* FT_ENC_TAG */
522 /*************************************************************************/
528 /* An enumeration used to specify character sets supported by */
529 /* charmaps. Used in the @FT_Select_Charmap API function. */
532 /* Despite the name, this enumeration lists specific character */
533 /* repertories (i.e., charsets), and not text encoding methods (e.g., */
534 /* UTF-8, UTF-16, etc.). */
536 /* Other encodings might be defined in the future. */
539 /* FT_ENCODING_NONE :: */
540 /* The encoding value~0 is reserved. */
542 /* FT_ENCODING_UNICODE :: */
543 /* Corresponds to the Unicode character set. This value covers */
544 /* all versions of the Unicode repertoire, including ASCII and */
545 /* Latin-1. Most fonts include a Unicode charmap, but not all */
548 /* For example, if you want to access Unicode value U+1F028 (and */
549 /* the font contains it), use value 0x1F028 as the input value for */
550 /* @FT_Get_Char_Index. */
552 /* FT_ENCODING_MS_SYMBOL :: */
553 /* Corresponds to the Microsoft Symbol encoding, used to encode */
554 /* mathematical symbols in the 32..255 character code range. For */
555 /* more information, see `http://www.ceviz.net/symbol.htm'. */
557 /* FT_ENCODING_SJIS :: */
558 /* Corresponds to Japanese SJIS encoding. More info at */
559 /* at `http://langsupport.japanreference.com/encoding.shtml'. */
560 /* See note on multi-byte encodings below. */
562 /* FT_ENCODING_GB2312 :: */
563 /* Corresponds to an encoding system for Simplified Chinese as used */
564 /* used in mainland China. */
566 /* FT_ENCODING_BIG5 :: */
567 /* Corresponds to an encoding system for Traditional Chinese as */
568 /* used in Taiwan and Hong Kong. */
570 /* FT_ENCODING_WANSUNG :: */
571 /* Corresponds to the Korean encoding system known as Wansung. */
572 /* For more information see */
573 /* `http://www.microsoft.com/typography/unicode/949.txt'. */
575 /* FT_ENCODING_JOHAB :: */
576 /* The Korean standard character set (KS~C 5601-1992), which */
577 /* corresponds to MS Windows code page 1361. This character set */
578 /* includes all possible Hangeul character combinations. */
580 /* FT_ENCODING_ADOBE_LATIN_1 :: */
581 /* Corresponds to a Latin-1 encoding as defined in a Type~1 */
582 /* PostScript font. It is limited to 256 character codes. */
584 /* FT_ENCODING_ADOBE_STANDARD :: */
585 /* Corresponds to the Adobe Standard encoding, as found in Type~1, */
586 /* CFF, and OpenType/CFF fonts. It is limited to 256 character */
589 /* FT_ENCODING_ADOBE_EXPERT :: */
590 /* Corresponds to the Adobe Expert encoding, as found in Type~1, */
591 /* CFF, and OpenType/CFF fonts. It is limited to 256 character */
594 /* FT_ENCODING_ADOBE_CUSTOM :: */
595 /* Corresponds to a custom encoding, as found in Type~1, CFF, and */
596 /* OpenType/CFF fonts. It is limited to 256 character codes. */
598 /* FT_ENCODING_APPLE_ROMAN :: */
599 /* Corresponds to the 8-bit Apple roman encoding. Many TrueType */
600 /* and OpenType fonts contain a charmap for this encoding, since */
601 /* older versions of Mac OS are able to use it. */
603 /* FT_ENCODING_OLD_LATIN_2 :: */
604 /* This value is deprecated and was never used nor reported by */
605 /* FreeType. Don't use or test for it. */
607 /* FT_ENCODING_MS_SJIS :: */
608 /* Same as FT_ENCODING_SJIS. Deprecated. */
610 /* FT_ENCODING_MS_GB2312 :: */
611 /* Same as FT_ENCODING_GB2312. Deprecated. */
613 /* FT_ENCODING_MS_BIG5 :: */
614 /* Same as FT_ENCODING_BIG5. Deprecated. */
616 /* FT_ENCODING_MS_WANSUNG :: */
617 /* Same as FT_ENCODING_WANSUNG. Deprecated. */
619 /* FT_ENCODING_MS_JOHAB :: */
620 /* Same as FT_ENCODING_JOHAB. Deprecated. */
623 /* By default, FreeType automatically synthesizes a Unicode charmap */
624 /* for PostScript fonts, using their glyph names dictionaries. */
625 /* However, it also reports the encodings defined explicitly in the */
626 /* font file, for the cases when they are needed, with the Adobe */
627 /* values as well. */
629 /* FT_ENCODING_NONE is set by the BDF and PCF drivers if the charmap */
630 /* is neither Unicode nor ISO-8859-1 (otherwise it is set to */
631 /* FT_ENCODING_UNICODE). Use @FT_Get_BDF_Charset_ID to find out */
632 /* which encoding is really present. If, for example, the */
633 /* `cs_registry' field is `KOI8' and the `cs_encoding' field is `R', */
634 /* the font is encoded in KOI8-R. */
636 /* FT_ENCODING_NONE is always set (with a single exception) by the */
637 /* winfonts driver. Use @FT_Get_WinFNT_Header and examine the */
638 /* `charset' field of the @FT_WinFNT_HeaderRec structure to find out */
639 /* which encoding is really present. For example, */
640 /* @FT_WinFNT_ID_CP1251 (204) means Windows code page 1251 (for */
643 /* FT_ENCODING_NONE is set if `platform_id' is @TT_PLATFORM_MACINTOSH */
644 /* and `encoding_id' is not @TT_MAC_ID_ROMAN (otherwise it is set to */
645 /* FT_ENCODING_APPLE_ROMAN). */
647 /* If `platform_id' is @TT_PLATFORM_MACINTOSH, use the function */
648 /* @FT_Get_CMap_Language_ID to query the Mac language ID which may */
649 /* be needed to be able to distinguish Apple encoding variants. See */
651 /* http://www.unicode.org/Public/MAPPINGS/VENDORS/APPLE/README.TXT */
653 /* to get an idea how to do that. Basically, if the language ID */
654 /* is~0, don't use it, otherwise subtract 1 from the language ID. */
655 /* Then examine `encoding_id'. If, for example, `encoding_id' is */
656 /* @TT_MAC_ID_ROMAN and the language ID (minus~1) is */
657 /* `TT_MAC_LANGID_GREEK', it is the Greek encoding, not Roman. */
658 /* @TT_MAC_ID_ARABIC with `TT_MAC_LANGID_FARSI' means the Farsi */
659 /* variant the Arabic encoding. */
661 typedef enum FT_Encoding_
663 FT_ENC_TAG( FT_ENCODING_NONE
, 0, 0, 0, 0 ),
665 FT_ENC_TAG( FT_ENCODING_MS_SYMBOL
, 's', 'y', 'm', 'b' ),
666 FT_ENC_TAG( FT_ENCODING_UNICODE
, 'u', 'n', 'i', 'c' ),
668 FT_ENC_TAG( FT_ENCODING_SJIS
, 's', 'j', 'i', 's' ),
669 FT_ENC_TAG( FT_ENCODING_GB2312
, 'g', 'b', ' ', ' ' ),
670 FT_ENC_TAG( FT_ENCODING_BIG5
, 'b', 'i', 'g', '5' ),
671 FT_ENC_TAG( FT_ENCODING_WANSUNG
, 'w', 'a', 'n', 's' ),
672 FT_ENC_TAG( FT_ENCODING_JOHAB
, 'j', 'o', 'h', 'a' ),
674 /* for backwards compatibility */
675 FT_ENCODING_MS_SJIS
= FT_ENCODING_SJIS
,
676 FT_ENCODING_MS_GB2312
= FT_ENCODING_GB2312
,
677 FT_ENCODING_MS_BIG5
= FT_ENCODING_BIG5
,
678 FT_ENCODING_MS_WANSUNG
= FT_ENCODING_WANSUNG
,
679 FT_ENCODING_MS_JOHAB
= FT_ENCODING_JOHAB
,
681 FT_ENC_TAG( FT_ENCODING_ADOBE_STANDARD
, 'A', 'D', 'O', 'B' ),
682 FT_ENC_TAG( FT_ENCODING_ADOBE_EXPERT
, 'A', 'D', 'B', 'E' ),
683 FT_ENC_TAG( FT_ENCODING_ADOBE_CUSTOM
, 'A', 'D', 'B', 'C' ),
684 FT_ENC_TAG( FT_ENCODING_ADOBE_LATIN_1
, 'l', 'a', 't', '1' ),
686 FT_ENC_TAG( FT_ENCODING_OLD_LATIN_2
, 'l', 'a', 't', '2' ),
688 FT_ENC_TAG( FT_ENCODING_APPLE_ROMAN
, 'a', 'r', 'm', 'n' )
693 /*************************************************************************/
696 /* ft_encoding_xxx */
699 /* These constants are deprecated; use the corresponding @FT_Encoding */
700 /* values instead. */
702 #define ft_encoding_none FT_ENCODING_NONE
703 #define ft_encoding_unicode FT_ENCODING_UNICODE
704 #define ft_encoding_symbol FT_ENCODING_MS_SYMBOL
705 #define ft_encoding_latin_1 FT_ENCODING_ADOBE_LATIN_1
706 #define ft_encoding_latin_2 FT_ENCODING_OLD_LATIN_2
707 #define ft_encoding_sjis FT_ENCODING_SJIS
708 #define ft_encoding_gb2312 FT_ENCODING_GB2312
709 #define ft_encoding_big5 FT_ENCODING_BIG5
710 #define ft_encoding_wansung FT_ENCODING_WANSUNG
711 #define ft_encoding_johab FT_ENCODING_JOHAB
713 #define ft_encoding_adobe_standard FT_ENCODING_ADOBE_STANDARD
714 #define ft_encoding_adobe_expert FT_ENCODING_ADOBE_EXPERT
715 #define ft_encoding_adobe_custom FT_ENCODING_ADOBE_CUSTOM
716 #define ft_encoding_apple_roman FT_ENCODING_APPLE_ROMAN
719 /*************************************************************************/
725 /* The base charmap structure. */
728 /* face :: A handle to the parent face object. */
730 /* encoding :: An @FT_Encoding tag identifying the charmap. Use */
731 /* this with @FT_Select_Charmap. */
733 /* platform_id :: An ID number describing the platform for the */
734 /* following encoding ID. This comes directly from */
735 /* the TrueType specification and should be emulated */
736 /* for other formats. */
738 /* encoding_id :: A platform specific encoding number. This also */
739 /* comes from the TrueType specification and should be */
740 /* emulated similarly. */
742 typedef struct FT_CharMapRec_
745 FT_Encoding encoding
;
746 FT_UShort platform_id
;
747 FT_UShort encoding_id
;
752 /*************************************************************************/
753 /*************************************************************************/
755 /* B A S E O B J E C T C L A S S E S */
757 /*************************************************************************/
758 /*************************************************************************/
761 /*************************************************************************/
764 /* FT_Face_Internal */
767 /* An opaque handle to an `FT_Face_InternalRec' structure, used to */
768 /* model private data of a given @FT_Face object. */
770 /* This structure might change between releases of FreeType~2 and is */
771 /* not generally available to client applications. */
773 typedef struct FT_Face_InternalRec_
* FT_Face_Internal
;
776 /*************************************************************************/
782 /* FreeType root face class structure. A face object models a */
783 /* typeface in a font file. */
786 /* num_faces :: The number of faces in the font file. Some */
787 /* font formats can have multiple faces in */
790 /* face_index :: The index of the face in the font file. It */
791 /* is set to~0 if there is only one face in */
794 /* face_flags :: A set of bit flags that give important */
795 /* information about the face; see */
796 /* @FT_FACE_FLAG_XXX for the details. */
798 /* style_flags :: A set of bit flags indicating the style of */
799 /* the face; see @FT_STYLE_FLAG_XXX for the */
802 /* num_glyphs :: The number of glyphs in the face. If the */
803 /* face is scalable and has sbits (see */
804 /* `num_fixed_sizes'), it is set to the number */
805 /* of outline glyphs. */
807 /* For CID-keyed fonts, this value gives the */
808 /* highest CID used in the font. */
810 /* family_name :: The face's family name. This is an ASCII */
811 /* string, usually in English, which describes */
812 /* the typeface's family (like `Times New */
813 /* Roman', `Bodoni', `Garamond', etc). This */
814 /* is a least common denominator used to list */
815 /* fonts. Some formats (TrueType & OpenType) */
816 /* provide localized and Unicode versions of */
817 /* this string. Applications should use the */
818 /* format specific interface to access them. */
819 /* Can be NULL (e.g., in fonts embedded in a */
822 /* style_name :: The face's style name. This is an ASCII */
823 /* string, usually in English, which describes */
824 /* the typeface's style (like `Italic', */
825 /* `Bold', `Condensed', etc). Not all font */
826 /* formats provide a style name, so this field */
827 /* is optional, and can be set to NULL. As */
828 /* for `family_name', some formats provide */
829 /* localized and Unicode versions of this */
830 /* string. Applications should use the format */
831 /* specific interface to access them. */
833 /* num_fixed_sizes :: The number of bitmap strikes in the face. */
834 /* Even if the face is scalable, there might */
835 /* still be bitmap strikes, which are called */
836 /* `sbits' in that case. */
838 /* available_sizes :: An array of @FT_Bitmap_Size for all bitmap */
839 /* strikes in the face. It is set to NULL if */
840 /* there is no bitmap strike. */
842 /* num_charmaps :: The number of charmaps in the face. */
844 /* charmaps :: An array of the charmaps of the face. */
846 /* generic :: A field reserved for client uses. See the */
847 /* @FT_Generic type description. */
849 /* bbox :: The font bounding box. Coordinates are */
850 /* expressed in font units (see */
851 /* `units_per_EM'). The box is large enough */
852 /* to contain any glyph from the font. Thus, */
853 /* `bbox.yMax' can be seen as the `maximum */
854 /* ascender', and `bbox.yMin' as the `minimum */
855 /* descender'. Only relevant for scalable */
858 /* Note that the bounding box might be off by */
859 /* (at least) one pixel for hinted fonts. See */
860 /* @FT_Size_Metrics for further discussion. */
862 /* units_per_EM :: The number of font units per EM square for */
863 /* this face. This is typically 2048 for */
864 /* TrueType fonts, and 1000 for Type~1 fonts. */
865 /* Only relevant for scalable formats. */
867 /* ascender :: The typographic ascender of the face, */
868 /* expressed in font units. For font formats */
869 /* not having this information, it is set to */
870 /* `bbox.yMax'. Only relevant for scalable */
873 /* descender :: The typographic descender of the face, */
874 /* expressed in font units. For font formats */
875 /* not having this information, it is set to */
876 /* `bbox.yMin'. Note that this field is */
877 /* usually negative. Only relevant for */
878 /* scalable formats. */
880 /* height :: This value is the vertical distance */
881 /* between two consecutive baselines, */
882 /* expressed in font units. It is always */
883 /* positive. Only relevant for scalable */
886 /* If you want the global glyph height, use */
887 /* `ascender - descender'. */
889 /* max_advance_width :: The maximum advance width, in font units, */
890 /* for all glyphs in this face. This can be */
891 /* used to make word wrapping computations */
892 /* faster. Only relevant for scalable */
895 /* max_advance_height :: The maximum advance height, in font units, */
896 /* for all glyphs in this face. This is only */
897 /* relevant for vertical layouts, and is set */
898 /* to `height' for fonts that do not provide */
899 /* vertical metrics. Only relevant for */
900 /* scalable formats. */
902 /* underline_position :: The position, in font units, of the */
903 /* underline line for this face. It is the */
904 /* center of the underlining stem. Only */
905 /* relevant for scalable formats. */
907 /* underline_thickness :: The thickness, in font units, of the */
908 /* underline for this face. Only relevant for */
909 /* scalable formats. */
911 /* glyph :: The face's associated glyph slot(s). */
913 /* size :: The current active size for this face. */
915 /* charmap :: The current active charmap for this face. */
918 /* Fields may be changed after a call to @FT_Attach_File or */
919 /* @FT_Attach_Stream. */
921 typedef struct FT_FaceRec_
931 FT_String
* family_name
;
932 FT_String
* style_name
;
934 FT_Int num_fixed_sizes
;
935 FT_Bitmap_Size
* available_sizes
;
938 FT_CharMap
* charmaps
;
942 /*# The following member variables (down to `underline_thickness') */
943 /*# are only relevant to scalable outlines; cf. @FT_Bitmap_Size */
944 /*# for bitmap fonts. */
947 FT_UShort units_per_EM
;
952 FT_Short max_advance_width
;
953 FT_Short max_advance_height
;
955 FT_Short underline_position
;
956 FT_Short underline_thickness
;
968 FT_ListRec sizes_list
;
970 FT_Generic autohint
; /* face-specific auto-hinter data */
971 void* extensions
; /* unused */
973 FT_Face_Internal internal
;
980 /*************************************************************************/
983 /* FT_FACE_FLAG_XXX */
986 /* A list of bit flags used in the `face_flags' field of the */
987 /* @FT_FaceRec structure. They inform client applications of */
988 /* properties of the corresponding face. */
991 /* FT_FACE_FLAG_SCALABLE :: */
992 /* Indicates that the face contains outline glyphs. This doesn't */
993 /* prevent bitmap strikes, i.e., a face can have both this and */
994 /* and @FT_FACE_FLAG_FIXED_SIZES set. */
996 /* FT_FACE_FLAG_FIXED_SIZES :: */
997 /* Indicates that the face contains bitmap strikes. See also the */
998 /* `num_fixed_sizes' and `available_sizes' fields of @FT_FaceRec. */
1000 /* FT_FACE_FLAG_FIXED_WIDTH :: */
1001 /* Indicates that the face contains fixed-width characters (like */
1002 /* Courier, Lucido, MonoType, etc.). */
1004 /* FT_FACE_FLAG_SFNT :: */
1005 /* Indicates that the face uses the `sfnt' storage scheme. For */
1006 /* now, this means TrueType and OpenType. */
1008 /* FT_FACE_FLAG_HORIZONTAL :: */
1009 /* Indicates that the face contains horizontal glyph metrics. This */
1010 /* should be set for all common formats. */
1012 /* FT_FACE_FLAG_VERTICAL :: */
1013 /* Indicates that the face contains vertical glyph metrics. This */
1014 /* is only available in some formats, not all of them. */
1016 /* FT_FACE_FLAG_KERNING :: */
1017 /* Indicates that the face contains kerning information. If set, */
1018 /* the kerning distance can be retrieved through the function */
1019 /* @FT_Get_Kerning. Otherwise the function always return the */
1020 /* vector (0,0). Note that FreeType doesn't handle kerning data */
1021 /* from the `GPOS' table (as present in some OpenType fonts). */
1023 /* FT_FACE_FLAG_FAST_GLYPHS :: */
1024 /* THIS FLAG IS DEPRECATED. DO NOT USE OR TEST IT. */
1026 /* FT_FACE_FLAG_MULTIPLE_MASTERS :: */
1027 /* Indicates that the font contains multiple masters and is capable */
1028 /* of interpolating between them. See the multiple-masters */
1029 /* specific API for details. */
1031 /* FT_FACE_FLAG_GLYPH_NAMES :: */
1032 /* Indicates that the font contains glyph names that can be */
1033 /* retrieved through @FT_Get_Glyph_Name. Note that some TrueType */
1034 /* fonts contain broken glyph name tables. Use the function */
1035 /* @FT_Has_PS_Glyph_Names when needed. */
1037 /* FT_FACE_FLAG_EXTERNAL_STREAM :: */
1038 /* Used internally by FreeType to indicate that a face's stream was */
1039 /* provided by the client application and should not be destroyed */
1040 /* when @FT_Done_Face is called. Don't read or test this flag. */
1042 /* FT_FACE_FLAG_HINTER :: */
1043 /* Set if the font driver has a hinting machine of its own. For */
1044 /* example, with TrueType fonts, it makes sense to use data from */
1045 /* the SFNT `gasp' table only if the native TrueType hinting engine */
1046 /* (with the bytecode interpreter) is available and active. */
1048 /* FT_FACE_FLAG_CID_KEYED :: */
1049 /* Set if the font is CID-keyed. In that case, the font is not */
1050 /* accessed by glyph indices but by CID values. For subsetted */
1051 /* CID-keyed fonts this has the consequence that not all index */
1052 /* values are a valid argument to FT_Load_Glyph. Only the CID */
1053 /* values for which corresponding glyphs in the subsetted font */
1054 /* exist make FT_Load_Glyph return successfully; in all other cases */
1055 /* you get an `FT_Err_Invalid_Argument' error. */
1057 /* Note that CID-keyed fonts which are in an SFNT wrapper don't */
1058 /* have this flag set since the glyphs are accessed in the normal */
1059 /* way (using contiguous indices); the `CID-ness' isn't visible to */
1060 /* the application. */
1062 /* FT_FACE_FLAG_TRICKY :: */
1063 /* Set if the font is `tricky', this is, it always needs the */
1064 /* font format's native hinting engine to get a reasonable result. */
1065 /* A typical example is the Chinese font `mingli.ttf' which uses */
1066 /* TrueType bytecode instructions to move and scale all of its */
1069 /* It is not possible to autohint such fonts using */
1070 /* @FT_LOAD_FORCE_AUTOHINT; it will also ignore */
1071 /* @FT_LOAD_NO_HINTING. You have to set both @FT_LOAD_NO_HINTING */
1072 /* and @FT_LOAD_NO_AUTOHINT to really disable hinting; however, you */
1073 /* probably never want this except for demonstration purposes. */
1075 /* Currently, there are about a dozen TrueType fonts in the list of */
1076 /* tricky fonts; they are hard-coded in file `ttobjs.c'. */
1078 #define FT_FACE_FLAG_SCALABLE ( 1L << 0 )
1079 #define FT_FACE_FLAG_FIXED_SIZES ( 1L << 1 )
1080 #define FT_FACE_FLAG_FIXED_WIDTH ( 1L << 2 )
1081 #define FT_FACE_FLAG_SFNT ( 1L << 3 )
1082 #define FT_FACE_FLAG_HORIZONTAL ( 1L << 4 )
1083 #define FT_FACE_FLAG_VERTICAL ( 1L << 5 )
1084 #define FT_FACE_FLAG_KERNING ( 1L << 6 )
1085 #define FT_FACE_FLAG_FAST_GLYPHS ( 1L << 7 )
1086 #define FT_FACE_FLAG_MULTIPLE_MASTERS ( 1L << 8 )
1087 #define FT_FACE_FLAG_GLYPH_NAMES ( 1L << 9 )
1088 #define FT_FACE_FLAG_EXTERNAL_STREAM ( 1L << 10 )
1089 #define FT_FACE_FLAG_HINTER ( 1L << 11 )
1090 #define FT_FACE_FLAG_CID_KEYED ( 1L << 12 )
1091 #define FT_FACE_FLAG_TRICKY ( 1L << 13 )
1094 /*************************************************************************
1097 * FT_HAS_HORIZONTAL( face )
1100 * A macro that returns true whenever a face object contains
1101 * horizontal metrics (this is true for all font formats though).
1104 * @FT_HAS_VERTICAL can be used to check for vertical metrics.
1107 #define FT_HAS_HORIZONTAL( face ) \
1108 ( face->face_flags & FT_FACE_FLAG_HORIZONTAL )
1111 /*************************************************************************
1114 * FT_HAS_VERTICAL( face )
1117 * A macro that returns true whenever a face object contains real
1118 * vertical metrics (and not only synthesized ones).
1121 #define FT_HAS_VERTICAL( face ) \
1122 ( face->face_flags & FT_FACE_FLAG_VERTICAL )
1125 /*************************************************************************
1128 * FT_HAS_KERNING( face )
1131 * A macro that returns true whenever a face object contains kerning
1132 * data that can be accessed with @FT_Get_Kerning.
1135 #define FT_HAS_KERNING( face ) \
1136 ( face->face_flags & FT_FACE_FLAG_KERNING )
1139 /*************************************************************************
1142 * FT_IS_SCALABLE( face )
1145 * A macro that returns true whenever a face object contains a scalable
1146 * font face (true for TrueType, Type~1, Type~42, CID, OpenType/CFF,
1147 * and PFR font formats.
1150 #define FT_IS_SCALABLE( face ) \
1151 ( face->face_flags & FT_FACE_FLAG_SCALABLE )
1154 /*************************************************************************
1157 * FT_IS_SFNT( face )
1160 * A macro that returns true whenever a face object contains a font
1161 * whose format is based on the SFNT storage scheme. This usually
1162 * means: TrueType fonts, OpenType fonts, as well as SFNT-based embedded
1165 * If this macro is true, all functions defined in @FT_SFNT_NAMES_H and
1166 * @FT_TRUETYPE_TABLES_H are available.
1169 #define FT_IS_SFNT( face ) \
1170 ( face->face_flags & FT_FACE_FLAG_SFNT )
1173 /*************************************************************************
1176 * FT_IS_FIXED_WIDTH( face )
1179 * A macro that returns true whenever a face object contains a font face
1180 * that contains fixed-width (or `monospace', `fixed-pitch', etc.)
1184 #define FT_IS_FIXED_WIDTH( face ) \
1185 ( face->face_flags & FT_FACE_FLAG_FIXED_WIDTH )
1188 /*************************************************************************
1191 * FT_HAS_FIXED_SIZES( face )
1194 * A macro that returns true whenever a face object contains some
1195 * embedded bitmaps. See the `available_sizes' field of the
1196 * @FT_FaceRec structure.
1199 #define FT_HAS_FIXED_SIZES( face ) \
1200 ( face->face_flags & FT_FACE_FLAG_FIXED_SIZES )
1203 /*************************************************************************
1206 * FT_HAS_FAST_GLYPHS( face )
1212 #define FT_HAS_FAST_GLYPHS( face ) 0
1215 /*************************************************************************
1218 * FT_HAS_GLYPH_NAMES( face )
1221 * A macro that returns true whenever a face object contains some glyph
1222 * names that can be accessed through @FT_Get_Glyph_Name.
1225 #define FT_HAS_GLYPH_NAMES( face ) \
1226 ( face->face_flags & FT_FACE_FLAG_GLYPH_NAMES )
1229 /*************************************************************************
1232 * FT_HAS_MULTIPLE_MASTERS( face )
1235 * A macro that returns true whenever a face object contains some
1236 * multiple masters. The functions provided by @FT_MULTIPLE_MASTERS_H
1237 * are then available to choose the exact design you want.
1240 #define FT_HAS_MULTIPLE_MASTERS( face ) \
1241 ( face->face_flags & FT_FACE_FLAG_MULTIPLE_MASTERS )
1244 /*************************************************************************
1247 * FT_IS_CID_KEYED( face )
1250 * A macro that returns true whenever a face object contains a CID-keyed
1251 * font. See the discussion of @FT_FACE_FLAG_CID_KEYED for more
1254 * If this macro is true, all functions defined in @FT_CID_H are
1258 #define FT_IS_CID_KEYED( face ) \
1259 ( face->face_flags & FT_FACE_FLAG_CID_KEYED )
1262 /*************************************************************************
1265 * FT_IS_TRICKY( face )
1268 * A macro that returns true whenever a face represents a `tricky' font.
1269 * See the discussion of @FT_FACE_FLAG_TRICKY for more details.
1272 #define FT_IS_TRICKY( face ) \
1273 ( face->face_flags & FT_FACE_FLAG_TRICKY )
1276 /*************************************************************************/
1279 /* FT_STYLE_FLAG_XXX */
1282 /* A list of bit-flags used to indicate the style of a given face. */
1283 /* These are used in the `style_flags' field of @FT_FaceRec. */
1286 /* FT_STYLE_FLAG_ITALIC :: */
1287 /* Indicates that a given face style is italic or oblique. */
1289 /* FT_STYLE_FLAG_BOLD :: */
1290 /* Indicates that a given face is bold. */
1293 /* The style information as provided by FreeType is very basic. More */
1294 /* details are beyond the scope and should be done on a higher level */
1295 /* (for example, by analyzing various fields of the `OS/2' table in */
1296 /* SFNT based fonts). */
1298 #define FT_STYLE_FLAG_ITALIC ( 1 << 0 )
1299 #define FT_STYLE_FLAG_BOLD ( 1 << 1 )
1302 /*************************************************************************/
1305 /* FT_Size_Internal */
1308 /* An opaque handle to an `FT_Size_InternalRec' structure, used to */
1309 /* model private data of a given @FT_Size object. */
1311 typedef struct FT_Size_InternalRec_
* FT_Size_Internal
;
1314 /*************************************************************************/
1317 /* FT_Size_Metrics */
1320 /* The size metrics structure gives the metrics of a size object. */
1323 /* x_ppem :: The width of the scaled EM square in pixels, hence */
1324 /* the term `ppem' (pixels per EM). It is also */
1325 /* referred to as `nominal width'. */
1327 /* y_ppem :: The height of the scaled EM square in pixels, */
1328 /* hence the term `ppem' (pixels per EM). It is also */
1329 /* referred to as `nominal height'. */
1331 /* x_scale :: A 16.16 fractional scaling value used to convert */
1332 /* horizontal metrics from font units to 26.6 */
1333 /* fractional pixels. Only relevant for scalable */
1336 /* y_scale :: A 16.16 fractional scaling value used to convert */
1337 /* vertical metrics from font units to 26.6 */
1338 /* fractional pixels. Only relevant for scalable */
1341 /* ascender :: The ascender in 26.6 fractional pixels. See */
1342 /* @FT_FaceRec for the details. */
1344 /* descender :: The descender in 26.6 fractional pixels. See */
1345 /* @FT_FaceRec for the details. */
1347 /* height :: The height in 26.6 fractional pixels. See */
1348 /* @FT_FaceRec for the details. */
1350 /* max_advance :: The maximum advance width in 26.6 fractional */
1351 /* pixels. See @FT_FaceRec for the details. */
1354 /* The scaling values, if relevant, are determined first during a */
1355 /* size changing operation. The remaining fields are then set by the */
1356 /* driver. For scalable formats, they are usually set to scaled */
1357 /* values of the corresponding fields in @FT_FaceRec. */
1359 /* Note that due to glyph hinting, these values might not be exact */
1360 /* for certain fonts. Thus they must be treated as unreliable */
1361 /* with an error margin of at least one pixel! */
1363 /* Indeed, the only way to get the exact metrics is to render _all_ */
1364 /* glyphs. As this would be a definite performance hit, it is up to */
1365 /* client applications to perform such computations. */
1367 /* The FT_Size_Metrics structure is valid for bitmap fonts also. */
1369 typedef struct FT_Size_Metrics_
1371 FT_UShort x_ppem
; /* horizontal pixels per EM */
1372 FT_UShort y_ppem
; /* vertical pixels per EM */
1374 FT_Fixed x_scale
; /* scaling values used to convert font */
1375 FT_Fixed y_scale
; /* units to 26.6 fractional pixels */
1377 FT_Pos ascender
; /* ascender in 26.6 frac. pixels */
1378 FT_Pos descender
; /* descender in 26.6 frac. pixels */
1379 FT_Pos height
; /* text height in 26.6 frac. pixels */
1380 FT_Pos max_advance
; /* max horizontal advance, in 26.6 pixels */
1385 /*************************************************************************/
1391 /* FreeType root size class structure. A size object models a face */
1392 /* object at a given size. */
1395 /* face :: Handle to the parent face object. */
1397 /* generic :: A typeless pointer, which is unused by the FreeType */
1398 /* library or any of its drivers. It can be used by */
1399 /* client applications to link their own data to each size */
1402 /* metrics :: Metrics for this size object. This field is read-only. */
1404 typedef struct FT_SizeRec_
1406 FT_Face face
; /* parent face object */
1407 FT_Generic generic
; /* generic pointer for client uses */
1408 FT_Size_Metrics metrics
; /* size metrics */
1409 FT_Size_Internal internal
;
1414 /*************************************************************************/
1420 /* The subglyph structure is an internal object used to describe */
1421 /* subglyphs (for example, in the case of composites). */
1424 /* The subglyph implementation is not part of the high-level API, */
1425 /* hence the forward structure declaration. */
1427 /* You can however retrieve subglyph information with */
1428 /* @FT_Get_SubGlyph_Info. */
1430 typedef struct FT_SubGlyphRec_
* FT_SubGlyph
;
1433 /*************************************************************************/
1436 /* FT_Slot_Internal */
1439 /* An opaque handle to an `FT_Slot_InternalRec' structure, used to */
1440 /* model private data of a given @FT_GlyphSlot object. */
1442 typedef struct FT_Slot_InternalRec_
* FT_Slot_Internal
;
1445 /*************************************************************************/
1448 /* FT_GlyphSlotRec */
1451 /* FreeType root glyph slot class structure. A glyph slot is a */
1452 /* container where individual glyphs can be loaded, be they in */
1453 /* outline or bitmap format. */
1456 /* library :: A handle to the FreeType library instance */
1457 /* this slot belongs to. */
1459 /* face :: A handle to the parent face object. */
1461 /* next :: In some cases (like some font tools), several */
1462 /* glyph slots per face object can be a good */
1463 /* thing. As this is rare, the glyph slots are */
1464 /* listed through a direct, single-linked list */
1465 /* using its `next' field. */
1467 /* generic :: A typeless pointer which is unused by the */
1468 /* FreeType library or any of its drivers. It */
1469 /* can be used by client applications to link */
1470 /* their own data to each glyph slot object. */
1472 /* metrics :: The metrics of the last loaded glyph in the */
1473 /* slot. The returned values depend on the last */
1474 /* load flags (see the @FT_Load_Glyph API */
1475 /* function) and can be expressed either in 26.6 */
1476 /* fractional pixels or font units. */
1478 /* Note that even when the glyph image is */
1479 /* transformed, the metrics are not. */
1481 /* linearHoriAdvance :: The advance width of the unhinted glyph. */
1482 /* Its value is expressed in 16.16 fractional */
1483 /* pixels, unless @FT_LOAD_LINEAR_DESIGN is set */
1484 /* when loading the glyph. This field can be */
1485 /* important to perform correct WYSIWYG layout. */
1486 /* Only relevant for outline glyphs. */
1488 /* linearVertAdvance :: The advance height of the unhinted glyph. */
1489 /* Its value is expressed in 16.16 fractional */
1490 /* pixels, unless @FT_LOAD_LINEAR_DESIGN is set */
1491 /* when loading the glyph. This field can be */
1492 /* important to perform correct WYSIWYG layout. */
1493 /* Only relevant for outline glyphs. */
1495 /* advance :: This shorthand is, depending on */
1496 /* @FT_LOAD_IGNORE_TRANSFORM, the transformed */
1497 /* advance width for the glyph (in 26.6 */
1498 /* fractional pixel format). As specified with */
1499 /* @FT_LOAD_VERTICAL_LAYOUT, it uses either the */
1500 /* `horiAdvance' or the `vertAdvance' value of */
1501 /* `metrics' field. */
1503 /* format :: This field indicates the format of the image */
1504 /* contained in the glyph slot. Typically */
1505 /* @FT_GLYPH_FORMAT_BITMAP, */
1506 /* @FT_GLYPH_FORMAT_OUTLINE, or */
1507 /* @FT_GLYPH_FORMAT_COMPOSITE, but others are */
1510 /* bitmap :: This field is used as a bitmap descriptor */
1511 /* when the slot format is */
1512 /* @FT_GLYPH_FORMAT_BITMAP. Note that the */
1513 /* address and content of the bitmap buffer can */
1514 /* change between calls of @FT_Load_Glyph and a */
1515 /* few other functions. */
1517 /* bitmap_left :: This is the bitmap's left bearing expressed */
1518 /* in integer pixels. Of course, this is only */
1519 /* valid if the format is */
1520 /* @FT_GLYPH_FORMAT_BITMAP. */
1522 /* bitmap_top :: This is the bitmap's top bearing expressed in */
1523 /* integer pixels. Remember that this is the */
1524 /* distance from the baseline to the top-most */
1525 /* glyph scanline, upwards y~coordinates being */
1528 /* outline :: The outline descriptor for the current glyph */
1529 /* image if its format is */
1530 /* @FT_GLYPH_FORMAT_OUTLINE. Once a glyph is */
1531 /* loaded, `outline' can be transformed, */
1532 /* distorted, embolded, etc. However, it must */
1535 /* num_subglyphs :: The number of subglyphs in a composite glyph. */
1536 /* This field is only valid for the composite */
1537 /* glyph format that should normally only be */
1538 /* loaded with the @FT_LOAD_NO_RECURSE flag. */
1539 /* For now this is internal to FreeType. */
1541 /* subglyphs :: An array of subglyph descriptors for */
1542 /* composite glyphs. There are `num_subglyphs' */
1543 /* elements in there. Currently internal to */
1546 /* control_data :: Certain font drivers can also return the */
1547 /* control data for a given glyph image (e.g. */
1548 /* TrueType bytecode, Type~1 charstrings, etc.). */
1549 /* This field is a pointer to such data. */
1551 /* control_len :: This is the length in bytes of the control */
1554 /* other :: Really wicked formats can use this pointer to */
1555 /* present their own glyph image to client */
1556 /* applications. Note that the application */
1557 /* needs to know about the image format. */
1559 /* lsb_delta :: The difference between hinted and unhinted */
1560 /* left side bearing while autohinting is */
1561 /* active. Zero otherwise. */
1563 /* rsb_delta :: The difference between hinted and unhinted */
1564 /* right side bearing while autohinting is */
1565 /* active. Zero otherwise. */
1568 /* If @FT_Load_Glyph is called with default flags (see */
1569 /* @FT_LOAD_DEFAULT) the glyph image is loaded in the glyph slot in */
1570 /* its native format (e.g., an outline glyph for TrueType and Type~1 */
1573 /* This image can later be converted into a bitmap by calling */
1574 /* @FT_Render_Glyph. This function finds the current renderer for */
1575 /* the native image's format, then invokes it. */
1577 /* The renderer is in charge of transforming the native image through */
1578 /* the slot's face transformation fields, then converting it into a */
1579 /* bitmap that is returned in `slot->bitmap'. */
1581 /* Note that `slot->bitmap_left' and `slot->bitmap_top' are also used */
1582 /* to specify the position of the bitmap relative to the current pen */
1583 /* position (e.g., coordinates (0,0) on the baseline). Of course, */
1584 /* `slot->format' is also changed to @FT_GLYPH_FORMAT_BITMAP. */
1587 /* Here a small pseudo code fragment which shows how to use */
1588 /* `lsb_delta' and `rsb_delta': */
1591 /* FT_Pos origin_x = 0; */
1592 /* FT_Pos prev_rsb_delta = 0; */
1595 /* for all glyphs do */
1596 /* <compute kern between current and previous glyph and add it to */
1599 /* <load glyph with `FT_Load_Glyph'> */
1601 /* if ( prev_rsb_delta - face->glyph->lsb_delta >= 32 ) */
1602 /* origin_x -= 64; */
1603 /* else if ( prev_rsb_delta - face->glyph->lsb_delta < -32 ) */
1604 /* origin_x += 64; */
1606 /* prev_rsb_delta = face->glyph->rsb_delta; */
1608 /* <save glyph image, or render glyph, or ...> */
1610 /* origin_x += face->glyph->advance.x; */
1614 typedef struct FT_GlyphSlotRec_
1619 FT_UInt reserved
; /* retained for binary compatibility */
1622 FT_Glyph_Metrics metrics
;
1623 FT_Fixed linearHoriAdvance
;
1624 FT_Fixed linearVertAdvance
;
1627 FT_Glyph_Format format
;
1635 FT_UInt num_subglyphs
;
1636 FT_SubGlyph subglyphs
;
1646 FT_Slot_Internal internal
;
1651 /*************************************************************************/
1652 /*************************************************************************/
1654 /* F U N C T I O N S */
1656 /*************************************************************************/
1657 /*************************************************************************/
1660 /*************************************************************************/
1663 /* FT_Init_FreeType */
1666 /* Initialize a new FreeType library object. The set of modules */
1667 /* that are registered by this function is determined at build time. */
1670 /* alibrary :: A handle to a new library object. */
1673 /* FreeType error code. 0~means success. */
1676 /* In case you want to provide your own memory allocating routines, */
1677 /* use @FT_New_Library instead, followed by a call to */
1678 /* @FT_Add_Default_Modules (or a series of calls to @FT_Add_Module). */
1680 /* For multi-threading applications each thread should have its own */
1681 /* FT_Library object. */
1683 /* If you need reference-counting (cf. @FT_Reference_Library), use */
1684 /* @FT_New_Library and @FT_Done_Library. */
1686 FT_EXPORT( FT_Error
)
1687 FT_Init_FreeType( FT_Library
*alibrary
);
1690 /*************************************************************************/
1693 /* FT_Done_FreeType */
1696 /* Destroy a given FreeType library object and all of its children, */
1697 /* including resources, drivers, faces, sizes, etc. */
1700 /* library :: A handle to the target library object. */
1703 /* FreeType error code. 0~means success. */
1705 FT_EXPORT( FT_Error
)
1706 FT_Done_FreeType( FT_Library library
);
1709 /*************************************************************************/
1715 /* A list of bit-field constants used within the `flags' field of the */
1716 /* @FT_Open_Args structure. */
1719 /* FT_OPEN_MEMORY :: This is a memory-based stream. */
1721 /* FT_OPEN_STREAM :: Copy the stream from the `stream' field. */
1723 /* FT_OPEN_PATHNAME :: Create a new input stream from a C~path */
1726 /* FT_OPEN_DRIVER :: Use the `driver' field. */
1728 /* FT_OPEN_PARAMS :: Use the `num_params' and `params' fields. */
1730 /* ft_open_memory :: Deprecated; use @FT_OPEN_MEMORY instead. */
1732 /* ft_open_stream :: Deprecated; use @FT_OPEN_STREAM instead. */
1734 /* ft_open_pathname :: Deprecated; use @FT_OPEN_PATHNAME instead. */
1736 /* ft_open_driver :: Deprecated; use @FT_OPEN_DRIVER instead. */
1738 /* ft_open_params :: Deprecated; use @FT_OPEN_PARAMS instead. */
1741 /* The `FT_OPEN_MEMORY', `FT_OPEN_STREAM', and `FT_OPEN_PATHNAME' */
1742 /* flags are mutually exclusive. */
1744 #define FT_OPEN_MEMORY 0x1
1745 #define FT_OPEN_STREAM 0x2
1746 #define FT_OPEN_PATHNAME 0x4
1747 #define FT_OPEN_DRIVER 0x8
1748 #define FT_OPEN_PARAMS 0x10
1750 #define ft_open_memory FT_OPEN_MEMORY /* deprecated */
1751 #define ft_open_stream FT_OPEN_STREAM /* deprecated */
1752 #define ft_open_pathname FT_OPEN_PATHNAME /* deprecated */
1753 #define ft_open_driver FT_OPEN_DRIVER /* deprecated */
1754 #define ft_open_params FT_OPEN_PARAMS /* deprecated */
1757 /*************************************************************************/
1763 /* A simple structure used to pass more or less generic parameters to */
1764 /* @FT_Open_Face. */
1767 /* tag :: A four-byte identification tag. */
1769 /* data :: A pointer to the parameter data. */
1772 /* The ID and function of parameters are driver-specific. See the */
1773 /* various FT_PARAM_TAG_XXX flags for more information. */
1775 typedef struct FT_Parameter_
1783 /*************************************************************************/
1789 /* A structure used to indicate how to open a new font file or */
1790 /* stream. A pointer to such a structure can be used as a parameter */
1791 /* for the functions @FT_Open_Face and @FT_Attach_Stream. */
1794 /* flags :: A set of bit flags indicating how to use the */
1797 /* memory_base :: The first byte of the file in memory. */
1799 /* memory_size :: The size in bytes of the file in memory. */
1801 /* pathname :: A pointer to an 8-bit file pathname. */
1803 /* stream :: A handle to a source stream object. */
1805 /* driver :: This field is exclusively used by @FT_Open_Face; */
1806 /* it simply specifies the font driver to use to open */
1807 /* the face. If set to~0, FreeType tries to load the */
1808 /* face with each one of the drivers in its list. */
1810 /* num_params :: The number of extra parameters. */
1812 /* params :: Extra parameters passed to the font driver when */
1813 /* opening a new face. */
1816 /* The stream type is determined by the contents of `flags' which */
1817 /* are tested in the following order by @FT_Open_Face: */
1819 /* If the `FT_OPEN_MEMORY' bit is set, assume that this is a */
1820 /* memory file of `memory_size' bytes, located at `memory_address'. */
1821 /* The data are are not copied, and the client is responsible for */
1822 /* releasing and destroying them _after_ the corresponding call to */
1823 /* @FT_Done_Face. */
1825 /* Otherwise, if the `FT_OPEN_STREAM' bit is set, assume that a */
1826 /* custom input stream `stream' is used. */
1828 /* Otherwise, if the `FT_OPEN_PATHNAME' bit is set, assume that this */
1829 /* is a normal file and use `pathname' to open it. */
1831 /* If the `FT_OPEN_DRIVER' bit is set, @FT_Open_Face only tries to */
1832 /* open the file with the driver whose handler is in `driver'. */
1834 /* If the `FT_OPEN_PARAMS' bit is set, the parameters given by */
1835 /* `num_params' and `params' is used. They are ignored otherwise. */
1837 /* Ideally, both the `pathname' and `params' fields should be tagged */
1838 /* as `const'; this is missing for API backwards compatibility. In */
1839 /* other words, applications should treat them as read-only. */
1841 typedef struct FT_Open_Args_
1844 const FT_Byte
* memory_base
;
1845 FT_Long memory_size
;
1846 FT_String
* pathname
;
1850 FT_Parameter
* params
;
1855 /*************************************************************************/
1861 /* This function calls @FT_Open_Face to open a font by its pathname. */
1864 /* library :: A handle to the library resource. */
1867 /* pathname :: A path to the font file. */
1869 /* face_index :: The index of the face within the font. The first */
1870 /* face has index~0. */
1873 /* aface :: A handle to a new face object. If `face_index' is */
1874 /* greater than or equal to zero, it must be non-NULL. */
1875 /* See @FT_Open_Face for more details. */
1878 /* FreeType error code. 0~means success. */
1881 /* Use @FT_Done_Face to destroy the created @FT_Face object (along */
1882 /* with its slot and sizes). */
1884 FT_EXPORT( FT_Error
)
1885 FT_New_Face( FT_Library library
,
1886 const char* filepathname
,
1891 /*************************************************************************/
1894 /* FT_New_Memory_Face */
1897 /* This function calls @FT_Open_Face to open a font which has been */
1898 /* loaded into memory. */
1901 /* library :: A handle to the library resource. */
1904 /* file_base :: A pointer to the beginning of the font data. */
1906 /* file_size :: The size of the memory chunk used by the font data. */
1908 /* face_index :: The index of the face within the font. The first */
1909 /* face has index~0. */
1912 /* aface :: A handle to a new face object. If `face_index' is */
1913 /* greater than or equal to zero, it must be non-NULL. */
1914 /* See @FT_Open_Face for more details. */
1917 /* FreeType error code. 0~means success. */
1920 /* You must not deallocate the memory before calling @FT_Done_Face. */
1922 FT_EXPORT( FT_Error
)
1923 FT_New_Memory_Face( FT_Library library
,
1924 const FT_Byte
* file_base
,
1930 /*************************************************************************/
1936 /* Create a face object from a given resource described by */
1937 /* @FT_Open_Args. */
1940 /* library :: A handle to the library resource. */
1943 /* args :: A pointer to an `FT_Open_Args' structure which must */
1944 /* be filled by the caller. */
1946 /* face_index :: The index of the face within the font. The first */
1947 /* face has index~0. */
1950 /* aface :: A handle to a new face object. If `face_index' is */
1951 /* greater than or equal to zero, it must be non-NULL. */
1952 /* See note below. */
1955 /* FreeType error code. 0~means success. */
1958 /* Unlike FreeType 1.x, this function automatically creates a glyph */
1959 /* slot for the face object which can be accessed directly through */
1960 /* `face->glyph'. */
1962 /* FT_Open_Face can be used to quickly check whether the font */
1963 /* format of a given font resource is supported by FreeType. If the */
1964 /* `face_index' field is negative, the function's return value is~0 */
1965 /* if the font format is recognized, or non-zero otherwise; */
1966 /* the function returns a more or less empty face handle in `*aface' */
1967 /* (if `aface' isn't NULL). The only useful field in this special */
1968 /* case is `face->num_faces' which gives the number of faces within */
1969 /* the font file. After examination, the returned @FT_Face structure */
1970 /* should be deallocated with a call to @FT_Done_Face. */
1972 /* Each new face object created with this function also owns a */
1973 /* default @FT_Size object, accessible as `face->size'. */
1975 /* One @FT_Library instance can have multiple face objects, this is, */
1976 /* @FT_Open_Face and its siblings can be called multiple times using */
1977 /* the same `library' argument. */
1979 /* See the discussion of reference counters in the description of */
1980 /* @FT_Reference_Face. */
1982 FT_EXPORT( FT_Error
)
1983 FT_Open_Face( FT_Library library
,
1984 const FT_Open_Args
* args
,
1989 /*************************************************************************/
1992 /* FT_Attach_File */
1995 /* This function calls @FT_Attach_Stream to attach a file. */
1998 /* face :: The target face object. */
2001 /* filepathname :: The pathname. */
2004 /* FreeType error code. 0~means success. */
2006 FT_EXPORT( FT_Error
)
2007 FT_Attach_File( FT_Face face
,
2008 const char* filepathname
);
2011 /*************************************************************************/
2014 /* FT_Attach_Stream */
2017 /* `Attach' data to a face object. Normally, this is used to read */
2018 /* additional information for the face object. For example, you can */
2019 /* attach an AFM file that comes with a Type~1 font to get the */
2020 /* kerning values and other metrics. */
2023 /* face :: The target face object. */
2026 /* parameters :: A pointer to @FT_Open_Args which must be filled by */
2030 /* FreeType error code. 0~means success. */
2033 /* The meaning of the `attach' (i.e., what really happens when the */
2034 /* new file is read) is not fixed by FreeType itself. It really */
2035 /* depends on the font format (and thus the font driver). */
2037 /* Client applications are expected to know what they are doing */
2038 /* when invoking this function. Most drivers simply do not implement */
2039 /* file attachments. */
2041 FT_EXPORT( FT_Error
)
2042 FT_Attach_Stream( FT_Face face
,
2043 FT_Open_Args
* parameters
);
2046 /*************************************************************************/
2049 /* FT_Reference_Face */
2052 /* A counter gets initialized to~1 at the time an @FT_Face structure */
2053 /* is created. This function increments the counter. @FT_Done_Face */
2054 /* then only destroys a face if the counter is~1, otherwise it simply */
2055 /* decrements the counter. */
2057 /* This function helps in managing life-cycles of structures which */
2058 /* reference @FT_Face objects. */
2061 /* face :: A handle to a target face object. */
2064 /* FreeType error code. 0~means success. */
2069 FT_EXPORT( FT_Error
)
2070 FT_Reference_Face( FT_Face face
);
2073 /*************************************************************************/
2079 /* Discard a given face object, as well as all of its child slots and */
2083 /* face :: A handle to a target face object. */
2086 /* FreeType error code. 0~means success. */
2089 /* See the discussion of reference counters in the description of */
2090 /* @FT_Reference_Face. */
2092 FT_EXPORT( FT_Error
)
2093 FT_Done_Face( FT_Face face
);
2096 /*************************************************************************/
2099 /* FT_Select_Size */
2102 /* Select a bitmap strike. */
2105 /* face :: A handle to a target face object. */
2108 /* strike_index :: The index of the bitmap strike in the */
2109 /* `available_sizes' field of @FT_FaceRec structure. */
2112 /* FreeType error code. 0~means success. */
2114 FT_EXPORT( FT_Error
)
2115 FT_Select_Size( FT_Face face
,
2116 FT_Int strike_index
);
2119 /*************************************************************************/
2122 /* FT_Size_Request_Type */
2125 /* An enumeration type that lists the supported size request types. */
2128 /* FT_SIZE_REQUEST_TYPE_NOMINAL :: */
2129 /* The nominal size. The `units_per_EM' field of @FT_FaceRec is */
2130 /* used to determine both scaling values. */
2132 /* FT_SIZE_REQUEST_TYPE_REAL_DIM :: */
2133 /* The real dimension. The sum of the the `ascender' and (minus */
2134 /* of) the `descender' fields of @FT_FaceRec are used to determine */
2135 /* both scaling values. */
2137 /* FT_SIZE_REQUEST_TYPE_BBOX :: */
2138 /* The font bounding box. The width and height of the `bbox' field */
2139 /* of @FT_FaceRec are used to determine the horizontal and vertical */
2140 /* scaling value, respectively. */
2142 /* FT_SIZE_REQUEST_TYPE_CELL :: */
2143 /* The `max_advance_width' field of @FT_FaceRec is used to */
2144 /* determine the horizontal scaling value; the vertical scaling */
2145 /* value is determined the same way as */
2146 /* @FT_SIZE_REQUEST_TYPE_REAL_DIM does. Finally, both scaling */
2147 /* values are set to the smaller one. This type is useful if you */
2148 /* want to specify the font size for, say, a window of a given */
2149 /* dimension and 80x24 cells. */
2151 /* FT_SIZE_REQUEST_TYPE_SCALES :: */
2152 /* Specify the scaling values directly. */
2155 /* The above descriptions only apply to scalable formats. For bitmap */
2156 /* formats, the behaviour is up to the driver. */
2158 /* See the note section of @FT_Size_Metrics if you wonder how size */
2159 /* requesting relates to scaling values. */
2161 typedef enum FT_Size_Request_Type_
2163 FT_SIZE_REQUEST_TYPE_NOMINAL
,
2164 FT_SIZE_REQUEST_TYPE_REAL_DIM
,
2165 FT_SIZE_REQUEST_TYPE_BBOX
,
2166 FT_SIZE_REQUEST_TYPE_CELL
,
2167 FT_SIZE_REQUEST_TYPE_SCALES
,
2169 FT_SIZE_REQUEST_TYPE_MAX
2171 } FT_Size_Request_Type
;
2174 /*************************************************************************/
2177 /* FT_Size_RequestRec */
2180 /* A structure used to model a size request. */
2183 /* type :: See @FT_Size_Request_Type. */
2185 /* width :: The desired width. */
2187 /* height :: The desired height. */
2189 /* horiResolution :: The horizontal resolution. If set to zero, */
2190 /* `width' is treated as a 26.6 fractional pixel */
2193 /* vertResolution :: The vertical resolution. If set to zero, */
2194 /* `height' is treated as a 26.6 fractional pixel */
2198 /* If `width' is zero, then the horizontal scaling value is set equal */
2199 /* to the vertical scaling value, and vice versa. */
2201 typedef struct FT_Size_RequestRec_
2203 FT_Size_Request_Type type
;
2206 FT_UInt horiResolution
;
2207 FT_UInt vertResolution
;
2209 } FT_Size_RequestRec
;
2212 /*************************************************************************/
2215 /* FT_Size_Request */
2218 /* A handle to a size request structure. */
2220 typedef struct FT_Size_RequestRec_
*FT_Size_Request
;
2223 /*************************************************************************/
2226 /* FT_Request_Size */
2229 /* Resize the scale of the active @FT_Size object in a face. */
2232 /* face :: A handle to a target face object. */
2235 /* req :: A pointer to a @FT_Size_RequestRec. */
2238 /* FreeType error code. 0~means success. */
2241 /* Although drivers may select the bitmap strike matching the */
2242 /* request, you should not rely on this if you intend to select a */
2243 /* particular bitmap strike. Use @FT_Select_Size instead in that */
2246 /* The relation between the requested size and the resulting glyph */
2247 /* size is dependent entirely on how the size is defined in the */
2248 /* source face. The font designer chooses the final size of each */
2249 /* glyph relative to this size. For more information refer to */
2250 /* `http://www.freetype.org/freetype2/docs/glyphs/glyphs-2.html' */
2252 FT_EXPORT( FT_Error
)
2253 FT_Request_Size( FT_Face face
,
2254 FT_Size_Request req
);
2257 /*************************************************************************/
2260 /* FT_Set_Char_Size */
2263 /* This function calls @FT_Request_Size to request the nominal size */
2267 /* face :: A handle to a target face object. */
2270 /* char_width :: The nominal width, in 26.6 fractional points. */
2272 /* char_height :: The nominal height, in 26.6 fractional points. */
2274 /* horz_resolution :: The horizontal resolution in dpi. */
2276 /* vert_resolution :: The vertical resolution in dpi. */
2279 /* FreeType error code. 0~means success. */
2282 /* If either the character width or height is zero, it is set equal */
2283 /* to the other value. */
2285 /* If either the horizontal or vertical resolution is zero, it is set */
2286 /* equal to the other value. */
2288 /* A character width or height smaller than 1pt is set to 1pt; if */
2289 /* both resolution values are zero, they are set to 72dpi. */
2291 /* Don't use this function if you are using the FreeType cache API. */
2293 FT_EXPORT( FT_Error
)
2294 FT_Set_Char_Size( FT_Face face
,
2295 FT_F26Dot6 char_width
,
2296 FT_F26Dot6 char_height
,
2297 FT_UInt horz_resolution
,
2298 FT_UInt vert_resolution
);
2301 /*************************************************************************/
2304 /* FT_Set_Pixel_Sizes */
2307 /* This function calls @FT_Request_Size to request the nominal size */
2311 /* face :: A handle to the target face object. */
2314 /* pixel_width :: The nominal width, in pixels. */
2316 /* pixel_height :: The nominal height, in pixels. */
2319 /* FreeType error code. 0~means success. */
2322 /* You should not rely on the resulting glyphs matching, or being */
2323 /* constrained, to this pixel size. Refer to @FT_Request_Size to */
2324 /* understand how requested sizes relate to actual sizes. */
2326 FT_EXPORT( FT_Error
)
2327 FT_Set_Pixel_Sizes( FT_Face face
,
2328 FT_UInt pixel_width
,
2329 FT_UInt pixel_height
);
2332 /*************************************************************************/
2338 /* A function used to load a single glyph into the glyph slot of a */
2342 /* face :: A handle to the target face object where the glyph */
2346 /* glyph_index :: The index of the glyph in the font file. For */
2347 /* CID-keyed fonts (either in PS or in CFF format) */
2348 /* this argument specifies the CID value. */
2350 /* load_flags :: A flag indicating what to load for this glyph. The */
2351 /* @FT_LOAD_XXX constants can be used to control the */
2352 /* glyph loading process (e.g., whether the outline */
2353 /* should be scaled, whether to load bitmaps or not, */
2354 /* whether to hint the outline, etc). */
2357 /* FreeType error code. 0~means success. */
2360 /* The loaded glyph may be transformed. See @FT_Set_Transform for */
2363 /* For subsetted CID-keyed fonts, `FT_Err_Invalid_Argument' is */
2364 /* returned for invalid CID values (this is, for CID values which */
2365 /* don't have a corresponding glyph in the font). See the discussion */
2366 /* of the @FT_FACE_FLAG_CID_KEYED flag for more details. */
2368 FT_EXPORT( FT_Error
)
2369 FT_Load_Glyph( FT_Face face
,
2370 FT_UInt glyph_index
,
2371 FT_Int32 load_flags
);
2374 /*************************************************************************/
2380 /* A function used to load a single glyph into the glyph slot of a */
2381 /* face object, according to its character code. */
2384 /* face :: A handle to a target face object where the glyph */
2388 /* char_code :: The glyph's character code, according to the */
2389 /* current charmap used in the face. */
2391 /* load_flags :: A flag indicating what to load for this glyph. The */
2392 /* @FT_LOAD_XXX constants can be used to control the */
2393 /* glyph loading process (e.g., whether the outline */
2394 /* should be scaled, whether to load bitmaps or not, */
2395 /* whether to hint the outline, etc). */
2398 /* FreeType error code. 0~means success. */
2401 /* This function simply calls @FT_Get_Char_Index and @FT_Load_Glyph. */
2403 FT_EXPORT( FT_Error
)
2404 FT_Load_Char( FT_Face face
,
2406 FT_Int32 load_flags
);
2409 /*************************************************************************
2415 * A list of bit-field constants used with @FT_Load_Glyph to indicate
2416 * what kind of operations to perform during glyph loading.
2419 * FT_LOAD_DEFAULT ::
2420 * Corresponding to~0, this value is used as the default glyph load
2421 * operation. In this case, the following happens:
2423 * 1. FreeType looks for a bitmap for the glyph corresponding to the
2424 * face's current size. If one is found, the function returns.
2425 * The bitmap data can be accessed from the glyph slot (see note
2428 * 2. If no embedded bitmap is searched or found, FreeType looks for a
2429 * scalable outline. If one is found, it is loaded from the font
2430 * file, scaled to device pixels, then `hinted' to the pixel grid
2431 * in order to optimize it. The outline data can be accessed from
2432 * the glyph slot (see note below).
2434 * Note that by default, the glyph loader doesn't render outlines into
2435 * bitmaps. The following flags are used to modify this default
2436 * behaviour to more specific and useful cases.
2438 * FT_LOAD_NO_SCALE ::
2439 * Don't scale the loaded outline glyph but keep it in font units.
2441 * This flag implies @FT_LOAD_NO_HINTING and @FT_LOAD_NO_BITMAP, and
2442 * unsets @FT_LOAD_RENDER.
2444 * If the font is `tricky' (see @FT_FACE_FLAG_TRICKY for more), using
2445 * FT_LOAD_NO_SCALE usually yields meaningless outlines because the
2446 * subglyphs must be scaled and positioned with hinting instructions.
2447 * This can be solved by loading the font without FT_LOAD_NO_SCALE and
2448 * setting the character size to `font->units_per_EM'.
2450 * FT_LOAD_NO_HINTING ::
2451 * Disable hinting. This generally generates `blurrier' bitmap glyphs
2452 * when the glyph are rendered in any of the anti-aliased modes. See
2453 * also the note below.
2455 * This flag is implied by @FT_LOAD_NO_SCALE.
2458 * Call @FT_Render_Glyph after the glyph is loaded. By default, the
2459 * glyph is rendered in @FT_RENDER_MODE_NORMAL mode. This can be
2460 * overridden by @FT_LOAD_TARGET_XXX or @FT_LOAD_MONOCHROME.
2462 * This flag is unset by @FT_LOAD_NO_SCALE.
2464 * FT_LOAD_NO_BITMAP ::
2465 * Ignore bitmap strikes when loading. Bitmap-only fonts ignore this
2468 * @FT_LOAD_NO_SCALE always sets this flag.
2470 * FT_LOAD_VERTICAL_LAYOUT ::
2471 * Load the glyph for vertical text layout. In particular, the
2472 * `advance' value in the @FT_GlyphSlotRec structure is set to the
2473 * `vertAdvance' value of the `metrics' field.
2475 * In case @FT_HAS_VERTICAL doesn't return true, you shouldn't use
2476 * this flag currently. Reason is that in this case vertical metrics
2477 * get synthesized, and those values are not always consistent across
2478 * various font formats.
2480 * FT_LOAD_FORCE_AUTOHINT ::
2481 * Indicates that the auto-hinter is preferred over the font's native
2482 * hinter. See also the note below.
2484 * FT_LOAD_CROP_BITMAP ::
2485 * Indicates that the font driver should crop the loaded bitmap glyph
2486 * (i.e., remove all space around its black bits). Not all drivers
2489 * FT_LOAD_PEDANTIC ::
2490 * Indicates that the font driver should perform pedantic verifications
2491 * during glyph loading. This is mostly used to detect broken glyphs
2492 * in fonts. By default, FreeType tries to handle broken fonts also.
2494 * In particular, errors from the TrueType bytecode engine are not
2495 * passed to the application if this flag is not set; this might
2496 * result in partially hinted or distorted glyphs in case a glyph's
2497 * bytecode is buggy.
2499 * FT_LOAD_IGNORE_GLOBAL_ADVANCE_WIDTH ::
2500 * Ignored. Deprecated.
2502 * FT_LOAD_NO_RECURSE ::
2503 * This flag is only used internally. It merely indicates that the
2504 * font driver should not load composite glyphs recursively. Instead,
2505 * it should set the `num_subglyph' and `subglyphs' values of the
2506 * glyph slot accordingly, and set `glyph->format' to
2507 * @FT_GLYPH_FORMAT_COMPOSITE.
2509 * The description of sub-glyphs is not available to client
2510 * applications for now.
2512 * This flag implies @FT_LOAD_NO_SCALE and @FT_LOAD_IGNORE_TRANSFORM.
2514 * FT_LOAD_IGNORE_TRANSFORM ::
2515 * Indicates that the transform matrix set by @FT_Set_Transform should
2518 * FT_LOAD_MONOCHROME ::
2519 * This flag is used with @FT_LOAD_RENDER to indicate that you want to
2520 * render an outline glyph to a 1-bit monochrome bitmap glyph, with
2521 * 8~pixels packed into each byte of the bitmap data.
2523 * Note that this has no effect on the hinting algorithm used. You
2524 * should rather use @FT_LOAD_TARGET_MONO so that the
2525 * monochrome-optimized hinting algorithm is used.
2527 * FT_LOAD_LINEAR_DESIGN ::
2528 * Indicates that the `linearHoriAdvance' and `linearVertAdvance'
2529 * fields of @FT_GlyphSlotRec should be kept in font units. See
2530 * @FT_GlyphSlotRec for details.
2532 * FT_LOAD_NO_AUTOHINT ::
2533 * Disable auto-hinter. See also the note below.
2536 * This flag is used to request loading of color embedded-bitmap
2537 * images. The resulting color bitmaps, if available, will have the
2538 * @FT_PIXEL_MODE_BGRA format. When the flag is not used and color
2539 * bitmaps are found, they will be converted to 256-level gray
2540 * bitmaps transparently. Those bitmaps will be in the
2541 * @FT_PIXEL_MODE_GRAY format.
2544 * By default, hinting is enabled and the font's native hinter (see
2545 * @FT_FACE_FLAG_HINTER) is preferred over the auto-hinter. You can
2546 * disable hinting by setting @FT_LOAD_NO_HINTING or change the
2547 * precedence by setting @FT_LOAD_FORCE_AUTOHINT. You can also set
2548 * @FT_LOAD_NO_AUTOHINT in case you don't want the auto-hinter to be
2551 * See the description of @FT_FACE_FLAG_TRICKY for a special exception
2552 * (affecting only a handful of Asian fonts).
2554 * Besides deciding which hinter to use, you can also decide which
2555 * hinting algorithm to use. See @FT_LOAD_TARGET_XXX for details.
2557 * Note that the auto-hinter needs a valid Unicode cmap (either a native
2558 * one or synthesized by FreeType) for producing correct results. If a
2559 * font provides an incorrect mapping (for example, assigning the
2560 * character code U+005A, LATIN CAPITAL LETTER Z, to a glyph depicting a
2561 * mathematical integral sign), the auto-hinter might produce useless
2565 #define FT_LOAD_DEFAULT 0x0
2566 #define FT_LOAD_NO_SCALE ( 1L << 0 )
2567 #define FT_LOAD_NO_HINTING ( 1L << 1 )
2568 #define FT_LOAD_RENDER ( 1L << 2 )
2569 #define FT_LOAD_NO_BITMAP ( 1L << 3 )
2570 #define FT_LOAD_VERTICAL_LAYOUT ( 1L << 4 )
2571 #define FT_LOAD_FORCE_AUTOHINT ( 1L << 5 )
2572 #define FT_LOAD_CROP_BITMAP ( 1L << 6 )
2573 #define FT_LOAD_PEDANTIC ( 1L << 7 )
2574 #define FT_LOAD_IGNORE_GLOBAL_ADVANCE_WIDTH ( 1L << 9 )
2575 #define FT_LOAD_NO_RECURSE ( 1L << 10 )
2576 #define FT_LOAD_IGNORE_TRANSFORM ( 1L << 11 )
2577 #define FT_LOAD_MONOCHROME ( 1L << 12 )
2578 #define FT_LOAD_LINEAR_DESIGN ( 1L << 13 )
2579 #define FT_LOAD_NO_AUTOHINT ( 1L << 15 )
2580 /* Bits 16..19 are used by `FT_LOAD_TARGET_' */
2581 #define FT_LOAD_COLOR ( 1L << 20 )
2585 /* used internally only by certain font drivers! */
2586 #define FT_LOAD_ADVANCE_ONLY ( 1L << 8 )
2587 #define FT_LOAD_SBITS_ONLY ( 1L << 14 )
2590 /**************************************************************************
2593 * FT_LOAD_TARGET_XXX
2596 * A list of values that are used to select a specific hinting algorithm
2597 * to use by the hinter. You should OR one of these values to your
2598 * `load_flags' when calling @FT_Load_Glyph.
2600 * Note that font's native hinters may ignore the hinting algorithm you
2601 * have specified (e.g., the TrueType bytecode interpreter). You can set
2602 * @FT_LOAD_FORCE_AUTOHINT to ensure that the auto-hinter is used.
2604 * Also note that @FT_LOAD_TARGET_LIGHT is an exception, in that it
2605 * always implies @FT_LOAD_FORCE_AUTOHINT.
2608 * FT_LOAD_TARGET_NORMAL ::
2609 * This corresponds to the default hinting algorithm, optimized for
2610 * standard gray-level rendering. For monochrome output, use
2611 * @FT_LOAD_TARGET_MONO instead.
2613 * FT_LOAD_TARGET_LIGHT ::
2614 * A lighter hinting algorithm for non-monochrome modes. Many
2615 * generated glyphs are more fuzzy but better resemble its original
2616 * shape. A bit like rendering on Mac OS~X.
2618 * As a special exception, this target implies @FT_LOAD_FORCE_AUTOHINT.
2620 * FT_LOAD_TARGET_MONO ::
2621 * Strong hinting algorithm that should only be used for monochrome
2622 * output. The result is probably unpleasant if the glyph is rendered
2623 * in non-monochrome modes.
2625 * FT_LOAD_TARGET_LCD ::
2626 * A variant of @FT_LOAD_TARGET_NORMAL optimized for horizontally
2627 * decimated LCD displays.
2629 * FT_LOAD_TARGET_LCD_V ::
2630 * A variant of @FT_LOAD_TARGET_NORMAL optimized for vertically
2631 * decimated LCD displays.
2634 * You should use only _one_ of the FT_LOAD_TARGET_XXX values in your
2635 * `load_flags'. They can't be ORed.
2637 * If @FT_LOAD_RENDER is also set, the glyph is rendered in the
2638 * corresponding mode (i.e., the mode which matches the used algorithm
2639 * best). An exeption is FT_LOAD_TARGET_MONO since it implies
2640 * @FT_LOAD_MONOCHROME.
2642 * You can use a hinting algorithm that doesn't correspond to the same
2643 * rendering mode. As an example, it is possible to use the `light'
2644 * hinting algorithm and have the results rendered in horizontal LCD
2645 * pixel mode, with code like
2648 * FT_Load_Glyph( face, glyph_index,
2649 * load_flags | FT_LOAD_TARGET_LIGHT );
2651 * FT_Render_Glyph( face->glyph, FT_RENDER_MODE_LCD );
2655 #define FT_LOAD_TARGET_( x ) ( (FT_Int32)( (x) & 15 ) << 16 )
2657 #define FT_LOAD_TARGET_NORMAL FT_LOAD_TARGET_( FT_RENDER_MODE_NORMAL )
2658 #define FT_LOAD_TARGET_LIGHT FT_LOAD_TARGET_( FT_RENDER_MODE_LIGHT )
2659 #define FT_LOAD_TARGET_MONO FT_LOAD_TARGET_( FT_RENDER_MODE_MONO )
2660 #define FT_LOAD_TARGET_LCD FT_LOAD_TARGET_( FT_RENDER_MODE_LCD )
2661 #define FT_LOAD_TARGET_LCD_V FT_LOAD_TARGET_( FT_RENDER_MODE_LCD_V )
2664 /**************************************************************************
2667 * FT_LOAD_TARGET_MODE
2670 * Return the @FT_Render_Mode corresponding to a given
2671 * @FT_LOAD_TARGET_XXX value.
2674 #define FT_LOAD_TARGET_MODE( x ) ( (FT_Render_Mode)( ( (x) >> 16 ) & 15 ) )
2677 /*************************************************************************/
2680 /* FT_Set_Transform */
2683 /* A function used to set the transformation that is applied to glyph */
2684 /* images when they are loaded into a glyph slot through */
2685 /* @FT_Load_Glyph. */
2688 /* face :: A handle to the source face object. */
2691 /* matrix :: A pointer to the transformation's 2x2 matrix. Use~0 for */
2692 /* the identity matrix. */
2693 /* delta :: A pointer to the translation vector. Use~0 for the null */
2697 /* The transformation is only applied to scalable image formats after */
2698 /* the glyph has been loaded. It means that hinting is unaltered by */
2699 /* the transformation and is performed on the character size given in */
2700 /* the last call to @FT_Set_Char_Size or @FT_Set_Pixel_Sizes. */
2702 /* Note that this also transforms the `face.glyph.advance' field, but */
2703 /* *not* the values in `face.glyph.metrics'. */
2706 FT_Set_Transform( FT_Face face
,
2711 /*************************************************************************/
2714 /* FT_Render_Mode */
2717 /* An enumeration type that lists the render modes supported by */
2718 /* FreeType~2. Each mode corresponds to a specific type of scanline */
2719 /* conversion performed on the outline. */
2721 /* For bitmap fonts and embedded bitmaps the `bitmap->pixel_mode' */
2722 /* field in the @FT_GlyphSlotRec structure gives the format of the */
2723 /* returned bitmap. */
2725 /* All modes except @FT_RENDER_MODE_MONO use 256 levels of opacity. */
2728 /* FT_RENDER_MODE_NORMAL :: */
2729 /* This is the default render mode; it corresponds to 8-bit */
2730 /* anti-aliased bitmaps. */
2732 /* FT_RENDER_MODE_LIGHT :: */
2733 /* This is equivalent to @FT_RENDER_MODE_NORMAL. It is only */
2734 /* defined as a separate value because render modes are also used */
2735 /* indirectly to define hinting algorithm selectors. See */
2736 /* @FT_LOAD_TARGET_XXX for details. */
2738 /* FT_RENDER_MODE_MONO :: */
2739 /* This mode corresponds to 1-bit bitmaps (with 2~levels of */
2742 /* FT_RENDER_MODE_LCD :: */
2743 /* This mode corresponds to horizontal RGB and BGR sub-pixel */
2744 /* displays like LCD screens. It produces 8-bit bitmaps that are */
2745 /* 3~times the width of the original glyph outline in pixels, and */
2746 /* which use the @FT_PIXEL_MODE_LCD mode. */
2748 /* FT_RENDER_MODE_LCD_V :: */
2749 /* This mode corresponds to vertical RGB and BGR sub-pixel displays */
2750 /* (like PDA screens, rotated LCD displays, etc.). It produces */
2751 /* 8-bit bitmaps that are 3~times the height of the original */
2752 /* glyph outline in pixels and use the @FT_PIXEL_MODE_LCD_V mode. */
2755 /* The LCD-optimized glyph bitmaps produced by FT_Render_Glyph can be */
2756 /* filtered to reduce color-fringes by using @FT_Library_SetLcdFilter */
2757 /* (not active in the default builds). It is up to the caller to */
2758 /* either call @FT_Library_SetLcdFilter (if available) or do the */
2759 /* filtering itself. */
2761 /* The selected render mode only affects vector glyphs of a font. */
2762 /* Embedded bitmaps often have a different pixel mode like */
2763 /* @FT_PIXEL_MODE_MONO. You can use @FT_Bitmap_Convert to transform */
2764 /* them into 8-bit pixmaps. */
2766 typedef enum FT_Render_Mode_
2768 FT_RENDER_MODE_NORMAL
= 0,
2769 FT_RENDER_MODE_LIGHT
,
2770 FT_RENDER_MODE_MONO
,
2772 FT_RENDER_MODE_LCD_V
,
2779 /*************************************************************************/
2782 /* ft_render_mode_xxx */
2785 /* These constants are deprecated. Use the corresponding */
2786 /* @FT_Render_Mode values instead. */
2789 /* ft_render_mode_normal :: see @FT_RENDER_MODE_NORMAL */
2790 /* ft_render_mode_mono :: see @FT_RENDER_MODE_MONO */
2792 #define ft_render_mode_normal FT_RENDER_MODE_NORMAL
2793 #define ft_render_mode_mono FT_RENDER_MODE_MONO
2796 /*************************************************************************/
2799 /* FT_Render_Glyph */
2802 /* Convert a given glyph image to a bitmap. It does so by inspecting */
2803 /* the glyph image format, finding the relevant renderer, and */
2807 /* slot :: A handle to the glyph slot containing the image to */
2811 /* render_mode :: This is the render mode used to render the glyph */
2812 /* image into a bitmap. See @FT_Render_Mode for a */
2813 /* list of possible values. */
2816 /* FreeType error code. 0~means success. */
2818 FT_EXPORT( FT_Error
)
2819 FT_Render_Glyph( FT_GlyphSlot slot
,
2820 FT_Render_Mode render_mode
);
2823 /*************************************************************************/
2826 /* FT_Kerning_Mode */
2829 /* An enumeration used to specify which kerning values to return in */
2830 /* @FT_Get_Kerning. */
2833 /* FT_KERNING_DEFAULT :: Return scaled and grid-fitted kerning */
2834 /* distances (value is~0). */
2836 /* FT_KERNING_UNFITTED :: Return scaled but un-grid-fitted kerning */
2839 /* FT_KERNING_UNSCALED :: Return the kerning vector in original font */
2842 typedef enum FT_Kerning_Mode_
2844 FT_KERNING_DEFAULT
= 0,
2845 FT_KERNING_UNFITTED
,
2851 /*************************************************************************/
2854 /* ft_kerning_default */
2857 /* This constant is deprecated. Please use @FT_KERNING_DEFAULT */
2860 #define ft_kerning_default FT_KERNING_DEFAULT
2863 /*************************************************************************/
2866 /* ft_kerning_unfitted */
2869 /* This constant is deprecated. Please use @FT_KERNING_UNFITTED */
2872 #define ft_kerning_unfitted FT_KERNING_UNFITTED
2875 /*************************************************************************/
2878 /* ft_kerning_unscaled */
2881 /* This constant is deprecated. Please use @FT_KERNING_UNSCALED */
2884 #define ft_kerning_unscaled FT_KERNING_UNSCALED
2887 /*************************************************************************/
2890 /* FT_Get_Kerning */
2893 /* Return the kerning vector between two glyphs of a same face. */
2896 /* face :: A handle to a source face object. */
2898 /* left_glyph :: The index of the left glyph in the kern pair. */
2900 /* right_glyph :: The index of the right glyph in the kern pair. */
2902 /* kern_mode :: See @FT_Kerning_Mode for more information. */
2903 /* Determines the scale and dimension of the returned */
2904 /* kerning vector. */
2907 /* akerning :: The kerning vector. This is either in font units */
2908 /* or in pixels (26.6 format) for scalable formats, */
2909 /* and in pixels for fixed-sizes formats. */
2912 /* FreeType error code. 0~means success. */
2915 /* Only horizontal layouts (left-to-right & right-to-left) are */
2916 /* supported by this method. Other layouts, or more sophisticated */
2917 /* kernings, are out of the scope of this API function -- they can be */
2918 /* implemented through format-specific interfaces. */
2920 FT_EXPORT( FT_Error
)
2921 FT_Get_Kerning( FT_Face face
,
2923 FT_UInt right_glyph
,
2925 FT_Vector
*akerning
);
2928 /*************************************************************************/
2931 /* FT_Get_Track_Kerning */
2934 /* Return the track kerning for a given face object at a given size. */
2937 /* face :: A handle to a source face object. */
2939 /* point_size :: The point size in 16.16 fractional points. */
2941 /* degree :: The degree of tightness. Increasingly negative */
2942 /* values represent tighter track kerning, while */
2943 /* increasingly positive values represent looser track */
2944 /* kerning. Value zero means no track kerning. */
2947 /* akerning :: The kerning in 16.16 fractional points, to be */
2948 /* uniformly applied between all glyphs. */
2951 /* FreeType error code. 0~means success. */
2954 /* Currently, only the Type~1 font driver supports track kerning, */
2955 /* using data from AFM files (if attached with @FT_Attach_File or */
2956 /* @FT_Attach_Stream). */
2958 /* Only very few AFM files come with track kerning data; please refer */
2959 /* to the Adobe's AFM specification for more details. */
2961 FT_EXPORT( FT_Error
)
2962 FT_Get_Track_Kerning( FT_Face face
,
2963 FT_Fixed point_size
,
2965 FT_Fixed
* akerning
);
2968 /*************************************************************************/
2971 /* FT_Get_Glyph_Name */
2974 /* Retrieve the ASCII name of a given glyph in a face. This only */
2975 /* works for those faces where @FT_HAS_GLYPH_NAMES(face) returns~1. */
2978 /* face :: A handle to a source face object. */
2980 /* glyph_index :: The glyph index. */
2982 /* buffer_max :: The maximum number of bytes available in the */
2986 /* buffer :: A pointer to a target buffer where the name is */
2990 /* FreeType error code. 0~means success. */
2993 /* An error is returned if the face doesn't provide glyph names or if */
2994 /* the glyph index is invalid. In all cases of failure, the first */
2995 /* byte of `buffer' is set to~0 to indicate an empty name. */
2997 /* The glyph name is truncated to fit within the buffer if it is too */
2998 /* long. The returned string is always zero-terminated. */
3000 /* Be aware that FreeType reorders glyph indices internally so that */
3001 /* glyph index~0 always corresponds to the `missing glyph' (called */
3004 /* This function is not compiled within the library if the config */
3005 /* macro `FT_CONFIG_OPTION_NO_GLYPH_NAMES' is defined in */
3006 /* `include/freetype/config/ftoptions.h'. */
3008 FT_EXPORT( FT_Error
)
3009 FT_Get_Glyph_Name( FT_Face face
,
3010 FT_UInt glyph_index
,
3012 FT_UInt buffer_max
);
3015 /*************************************************************************/
3018 /* FT_Get_Postscript_Name */
3021 /* Retrieve the ASCII PostScript name of a given face, if available. */
3022 /* This only works with PostScript and TrueType fonts. */
3025 /* face :: A handle to the source face object. */
3028 /* A pointer to the face's PostScript name. NULL if unavailable. */
3031 /* The returned pointer is owned by the face and is destroyed with */
3034 FT_EXPORT( const char* )
3035 FT_Get_Postscript_Name( FT_Face face
);
3038 /*************************************************************************/
3041 /* FT_Select_Charmap */
3044 /* Select a given charmap by its encoding tag (as listed in */
3045 /* `freetype.h'). */
3048 /* face :: A handle to the source face object. */
3051 /* encoding :: A handle to the selected encoding. */
3054 /* FreeType error code. 0~means success. */
3057 /* This function returns an error if no charmap in the face */
3058 /* corresponds to the encoding queried here. */
3060 /* Because many fonts contain more than a single cmap for Unicode */
3061 /* encoding, this function has some special code to select the one */
3062 /* which covers Unicode best (`best' in the sense that a UCS-4 cmap */
3063 /* is preferred to a UCS-2 cmap). It is thus preferable to */
3064 /* @FT_Set_Charmap in this case. */
3066 FT_EXPORT( FT_Error
)
3067 FT_Select_Charmap( FT_Face face
,
3068 FT_Encoding encoding
);
3071 /*************************************************************************/
3074 /* FT_Set_Charmap */
3077 /* Select a given charmap for character code to glyph index mapping. */
3080 /* face :: A handle to the source face object. */
3083 /* charmap :: A handle to the selected charmap. */
3086 /* FreeType error code. 0~means success. */
3089 /* This function returns an error if the charmap is not part of */
3090 /* the face (i.e., if it is not listed in the `face->charmaps' */
3093 /* It also fails if a type~14 charmap is selected. */
3095 FT_EXPORT( FT_Error
)
3096 FT_Set_Charmap( FT_Face face
,
3097 FT_CharMap charmap
);
3100 /*************************************************************************
3103 * FT_Get_Charmap_Index
3106 * Retrieve index of a given charmap.
3110 * A handle to a charmap.
3113 * The index into the array of character maps within the face to which
3114 * `charmap' belongs. If an error occurs, -1 is returned.
3118 FT_Get_Charmap_Index( FT_CharMap charmap
);
3121 /*************************************************************************/
3124 /* FT_Get_Char_Index */
3127 /* Return the glyph index of a given character code. This function */
3128 /* uses a charmap object to do the mapping. */
3131 /* face :: A handle to the source face object. */
3133 /* charcode :: The character code. */
3136 /* The glyph index. 0~means `undefined character code'. */
3139 /* If you use FreeType to manipulate the contents of font files */
3140 /* directly, be aware that the glyph index returned by this function */
3141 /* doesn't always correspond to the internal indices used within the */
3142 /* file. This is done to ensure that value~0 always corresponds to */
3143 /* the `missing glyph'. If the first glyph is not named `.notdef', */
3144 /* then for Type~1 and Type~42 fonts, `.notdef' will be moved into */
3145 /* the glyph ID~0 position, and whatever was there will be moved to */
3146 /* the position `.notdef' had. For Type~1 fonts, if there is no */
3147 /* `.notdef' glyph at all, then one will be created at index~0 and */
3148 /* whatever was there will be moved to the last index -- Type~42 */
3149 /* fonts are considered invalid under this condition. */
3151 FT_EXPORT( FT_UInt
)
3152 FT_Get_Char_Index( FT_Face face
,
3153 FT_ULong charcode
);
3156 /*************************************************************************/
3159 /* FT_Get_First_Char */
3162 /* This function is used to return the first character code in the */
3163 /* current charmap of a given face. It also returns the */
3164 /* corresponding glyph index. */
3167 /* face :: A handle to the source face object. */
3170 /* agindex :: Glyph index of first character code. 0~if charmap is */
3174 /* The charmap's first character code. */
3177 /* You should use this function with @FT_Get_Next_Char to be able to */
3178 /* parse all character codes available in a given charmap. The code */
3179 /* should look like this: */
3182 /* FT_ULong charcode; */
3183 /* FT_UInt gindex; */
3186 /* charcode = FT_Get_First_Char( face, &gindex ); */
3187 /* while ( gindex != 0 ) */
3189 /* ... do something with (charcode,gindex) pair ... */
3191 /* charcode = FT_Get_Next_Char( face, charcode, &gindex ); */
3195 /* Note that `*agindex' is set to~0 if the charmap is empty. The */
3196 /* result itself can be~0 in two cases: if the charmap is empty or */
3197 /* if the value~0 is the first valid character code. */
3199 FT_EXPORT( FT_ULong
)
3200 FT_Get_First_Char( FT_Face face
,
3204 /*************************************************************************/
3207 /* FT_Get_Next_Char */
3210 /* This function is used to return the next character code in the */
3211 /* current charmap of a given face following the value `char_code', */
3212 /* as well as the corresponding glyph index. */
3215 /* face :: A handle to the source face object. */
3216 /* char_code :: The starting character code. */
3219 /* agindex :: Glyph index of next character code. 0~if charmap */
3223 /* The charmap's next character code. */
3226 /* You should use this function with @FT_Get_First_Char to walk */
3227 /* over all character codes available in a given charmap. See the */
3228 /* note for this function for a simple code example. */
3230 /* Note that `*agindex' is set to~0 when there are no more codes in */
3233 FT_EXPORT( FT_ULong
)
3234 FT_Get_Next_Char( FT_Face face
,
3239 /*************************************************************************/
3242 /* FT_Get_Name_Index */
3245 /* Return the glyph index of a given glyph name. This function uses */
3246 /* driver specific objects to do the translation. */
3249 /* face :: A handle to the source face object. */
3251 /* glyph_name :: The glyph name. */
3254 /* The glyph index. 0~means `undefined character code'. */
3256 FT_EXPORT( FT_UInt
)
3257 FT_Get_Name_Index( FT_Face face
,
3258 FT_String
* glyph_name
);
3261 /*************************************************************************
3264 * FT_SUBGLYPH_FLAG_XXX
3267 * A list of constants used to describe subglyphs. Please refer to the
3268 * TrueType specification for the meaning of the various flags.
3271 * FT_SUBGLYPH_FLAG_ARGS_ARE_WORDS ::
3272 * FT_SUBGLYPH_FLAG_ARGS_ARE_XY_VALUES ::
3273 * FT_SUBGLYPH_FLAG_ROUND_XY_TO_GRID ::
3274 * FT_SUBGLYPH_FLAG_SCALE ::
3275 * FT_SUBGLYPH_FLAG_XY_SCALE ::
3276 * FT_SUBGLYPH_FLAG_2X2 ::
3277 * FT_SUBGLYPH_FLAG_USE_MY_METRICS ::
3280 #define FT_SUBGLYPH_FLAG_ARGS_ARE_WORDS 1
3281 #define FT_SUBGLYPH_FLAG_ARGS_ARE_XY_VALUES 2
3282 #define FT_SUBGLYPH_FLAG_ROUND_XY_TO_GRID 4
3283 #define FT_SUBGLYPH_FLAG_SCALE 8
3284 #define FT_SUBGLYPH_FLAG_XY_SCALE 0x40
3285 #define FT_SUBGLYPH_FLAG_2X2 0x80
3286 #define FT_SUBGLYPH_FLAG_USE_MY_METRICS 0x200
3289 /*************************************************************************
3292 * FT_Get_SubGlyph_Info
3295 * Retrieve a description of a given subglyph. Only use it if
3296 * `glyph->format' is @FT_GLYPH_FORMAT_COMPOSITE; an error is
3297 * returned otherwise.
3301 * The source glyph slot.
3304 * The index of the subglyph. Must be less than
3305 * `glyph->num_subglyphs'.
3309 * The glyph index of the subglyph.
3312 * The subglyph flags, see @FT_SUBGLYPH_FLAG_XXX.
3315 * The subglyph's first argument (if any).
3318 * The subglyph's second argument (if any).
3321 * The subglyph transformation (if any).
3324 * FreeType error code. 0~means success.
3327 * The values of `*p_arg1', `*p_arg2', and `*p_transform' must be
3328 * interpreted depending on the flags returned in `*p_flags'. See the
3329 * TrueType specification for details.
3332 FT_EXPORT( FT_Error
)
3333 FT_Get_SubGlyph_Info( FT_GlyphSlot glyph
,
3339 FT_Matrix
*p_transform
);
3342 /*************************************************************************/
3348 /* A list of bit flags used in the `fsType' field of the OS/2 table */
3349 /* in a TrueType or OpenType font and the `FSType' entry in a */
3350 /* PostScript font. These bit flags are returned by */
3351 /* @FT_Get_FSType_Flags; they inform client applications of embedding */
3352 /* and subsetting restrictions associated with a font. */
3354 /* See http://www.adobe.com/devnet/acrobat/pdfs/FontPolicies.pdf for */
3358 /* FT_FSTYPE_INSTALLABLE_EMBEDDING :: */
3359 /* Fonts with no fsType bit set may be embedded and permanently */
3360 /* installed on the remote system by an application. */
3362 /* FT_FSTYPE_RESTRICTED_LICENSE_EMBEDDING :: */
3363 /* Fonts that have only this bit set must not be modified, embedded */
3364 /* or exchanged in any manner without first obtaining permission of */
3365 /* the font software copyright owner. */
3367 /* FT_FSTYPE_PREVIEW_AND_PRINT_EMBEDDING :: */
3368 /* If this bit is set, the font may be embedded and temporarily */
3369 /* loaded on the remote system. Documents containing Preview & */
3370 /* Print fonts must be opened `read-only'; no edits can be applied */
3371 /* to the document. */
3373 /* FT_FSTYPE_EDITABLE_EMBEDDING :: */
3374 /* If this bit is set, the font may be embedded but must only be */
3375 /* installed temporarily on other systems. In contrast to Preview */
3376 /* & Print fonts, documents containing editable fonts may be opened */
3377 /* for reading, editing is permitted, and changes may be saved. */
3379 /* FT_FSTYPE_NO_SUBSETTING :: */
3380 /* If this bit is set, the font may not be subsetted prior to */
3383 /* FT_FSTYPE_BITMAP_EMBEDDING_ONLY :: */
3384 /* If this bit is set, only bitmaps contained in the font may be */
3385 /* embedded; no outline data may be embedded. If there are no */
3386 /* bitmaps available in the font, then the font is unembeddable. */
3389 /* While the fsType flags can indicate that a font may be embedded, a */
3390 /* license with the font vendor may be separately required to use the */
3391 /* font in this way. */
3393 #define FT_FSTYPE_INSTALLABLE_EMBEDDING 0x0000
3394 #define FT_FSTYPE_RESTRICTED_LICENSE_EMBEDDING 0x0002
3395 #define FT_FSTYPE_PREVIEW_AND_PRINT_EMBEDDING 0x0004
3396 #define FT_FSTYPE_EDITABLE_EMBEDDING 0x0008
3397 #define FT_FSTYPE_NO_SUBSETTING 0x0100
3398 #define FT_FSTYPE_BITMAP_EMBEDDING_ONLY 0x0200
3401 /*************************************************************************/
3404 /* FT_Get_FSType_Flags */
3407 /* Return the fsType flags for a font. */
3410 /* face :: A handle to the source face object. */
3413 /* The fsType flags, @FT_FSTYPE_XXX. */
3416 /* Use this function rather than directly reading the `fs_type' field */
3417 /* in the @PS_FontInfoRec structure which is only guaranteed to */
3418 /* return the correct results for Type~1 fonts. */
3423 FT_EXPORT( FT_UShort
)
3424 FT_Get_FSType_Flags( FT_Face face
);
3427 /*************************************************************************/
3430 /* glyph_variants */
3433 /* Glyph Variants */
3436 /* The FreeType~2 interface to Unicode Ideographic Variation */
3437 /* Sequences (IVS), using the SFNT cmap format~14. */
3440 /* Many CJK characters have variant forms. They are a sort of grey */
3441 /* area somewhere between being totally irrelevant and semantically */
3442 /* distinct; for this reason, the Unicode consortium decided to */
3443 /* introduce Ideographic Variation Sequences (IVS), consisting of a */
3444 /* Unicode base character and one of 240 variant selectors */
3445 /* (U+E0100-U+E01EF), instead of further extending the already huge */
3446 /* code range for CJK characters. */
3448 /* An IVS is registered and unique; for further details please refer */
3449 /* to Unicode Technical Standard #37, the Ideographic Variation */
3452 /* http://www.unicode.org/reports/tr37/ */
3454 /* To date (November 2012), the character with the most variants is */
3455 /* U+9089, having 31 such IVS. */
3457 /* Adobe and MS decided to support IVS with a new cmap subtable */
3458 /* (format~14). It is an odd subtable because it is not a mapping of */
3459 /* input code points to glyphs, but contains lists of all variants */
3460 /* supported by the font. */
3462 /* A variant may be either `default' or `non-default'. A default */
3463 /* variant is the one you will get for that code point if you look it */
3464 /* up in the standard Unicode cmap. A non-default variant is a */
3465 /* different glyph. */
3467 /*************************************************************************/
3470 /*************************************************************************/
3473 /* FT_Face_GetCharVariantIndex */
3476 /* Return the glyph index of a given character code as modified by */
3477 /* the variation selector. */
3481 /* A handle to the source face object. */
3484 /* The character code point in Unicode. */
3486 /* variantSelector :: */
3487 /* The Unicode code point of the variation selector. */
3490 /* The glyph index. 0~means either `undefined character code', or */
3491 /* `undefined selector code', or `no variation selector cmap */
3492 /* subtable', or `current CharMap is not Unicode'. */
3495 /* If you use FreeType to manipulate the contents of font files */
3496 /* directly, be aware that the glyph index returned by this function */
3497 /* doesn't always correspond to the internal indices used within */
3498 /* the file. This is done to ensure that value~0 always corresponds */
3499 /* to the `missing glyph'. */
3501 /* This function is only meaningful if */
3502 /* a) the font has a variation selector cmap sub table, */
3504 /* b) the current charmap has a Unicode encoding. */
3509 FT_EXPORT( FT_UInt
)
3510 FT_Face_GetCharVariantIndex( FT_Face face
,
3512 FT_ULong variantSelector
);
3515 /*************************************************************************/
3518 /* FT_Face_GetCharVariantIsDefault */
3521 /* Check whether this variant of this Unicode character is the one to */
3522 /* be found in the `cmap'. */
3526 /* A handle to the source face object. */
3529 /* The character codepoint in Unicode. */
3531 /* variantSelector :: */
3532 /* The Unicode codepoint of the variation selector. */
3535 /* 1~if found in the standard (Unicode) cmap, 0~if found in the */
3536 /* variation selector cmap, or -1 if it is not a variant. */
3539 /* This function is only meaningful if the font has a variation */
3540 /* selector cmap subtable. */
3546 FT_Face_GetCharVariantIsDefault( FT_Face face
,
3548 FT_ULong variantSelector
);
3551 /*************************************************************************/
3554 /* FT_Face_GetVariantSelectors */
3557 /* Return a zero-terminated list of Unicode variant selectors found */
3562 /* A handle to the source face object. */
3565 /* A pointer to an array of selector code points, or NULL if there is */
3566 /* no valid variant selector cmap subtable. */
3569 /* The last item in the array is~0; the array is owned by the */
3570 /* @FT_Face object but can be overwritten or released on the next */
3571 /* call to a FreeType function. */
3576 FT_EXPORT( FT_UInt32
* )
3577 FT_Face_GetVariantSelectors( FT_Face face
);
3580 /*************************************************************************/
3583 /* FT_Face_GetVariantsOfChar */
3586 /* Return a zero-terminated list of Unicode variant selectors found */
3587 /* for the specified character code. */
3591 /* A handle to the source face object. */
3594 /* The character codepoint in Unicode. */
3597 /* A pointer to an array of variant selector code points which are */
3598 /* active for the given character, or NULL if the corresponding list */
3602 /* The last item in the array is~0; the array is owned by the */
3603 /* @FT_Face object but can be overwritten or released on the next */
3604 /* call to a FreeType function. */
3609 FT_EXPORT( FT_UInt32
* )
3610 FT_Face_GetVariantsOfChar( FT_Face face
,
3611 FT_ULong charcode
);
3614 /*************************************************************************/
3617 /* FT_Face_GetCharsOfVariant */
3620 /* Return a zero-terminated list of Unicode character codes found for */
3621 /* the specified variant selector. */
3625 /* A handle to the source face object. */
3627 /* variantSelector :: */
3628 /* The variant selector code point in Unicode. */
3631 /* A list of all the code points which are specified by this selector */
3632 /* (both default and non-default codes are returned) or NULL if there */
3633 /* is no valid cmap or the variant selector is invalid. */
3636 /* The last item in the array is~0; the array is owned by the */
3637 /* @FT_Face object but can be overwritten or released on the next */
3638 /* call to a FreeType function. */
3643 FT_EXPORT( FT_UInt32
* )
3644 FT_Face_GetCharsOfVariant( FT_Face face
,
3645 FT_ULong variantSelector
);
3648 /*************************************************************************/
3657 /* Crunching fixed numbers and vectors. */
3660 /* This section contains various functions used to perform */
3661 /* computations on 16.16 fixed-float numbers or 2d vectors. */
3670 /* FT_Vector_Transform */
3671 /* FT_Matrix_Multiply */
3672 /* FT_Matrix_Invert */
3674 /*************************************************************************/
3677 /*************************************************************************/
3683 /* A very simple function used to perform the computation `(a*b)/c' */
3684 /* with maximum accuracy (it uses a 64-bit intermediate integer */
3685 /* whenever necessary). */
3687 /* This function isn't necessarily as fast as some processor specific */
3688 /* operations, but is at least completely portable. */
3691 /* a :: The first multiplier. */
3692 /* b :: The second multiplier. */
3693 /* c :: The divisor. */
3696 /* The result of `(a*b)/c'. This function never traps when trying to */
3697 /* divide by zero; it simply returns `MaxInt' or `MinInt' depending */
3698 /* on the signs of `a' and `b'. */
3700 FT_EXPORT( FT_Long
)
3701 FT_MulDiv( FT_Long a
,
3708 /* The following #if 0 ... #endif is for the documentation formatter, */
3709 /* hiding the internal `FT_MULFIX_INLINED' macro. */
3712 /*************************************************************************/
3718 /* A very simple function used to perform the computation */
3719 /* `(a*b)/0x10000' with maximum accuracy. Most of the time this is */
3720 /* used to multiply a given value by a 16.16 fixed-point factor. */
3723 /* a :: The first multiplier. */
3724 /* b :: The second multiplier. Use a 16.16 factor here whenever */
3725 /* possible (see note below). */
3728 /* The result of `(a*b)/0x10000'. */
3731 /* This function has been optimized for the case where the absolute */
3732 /* value of `a' is less than 2048, and `b' is a 16.16 scaling factor. */
3733 /* As this happens mainly when scaling from notional units to */
3734 /* fractional pixels in FreeType, it resulted in noticeable speed */
3735 /* improvements between versions 2.x and 1.x. */
3737 /* As a conclusion, always try to place a 16.16 factor as the */
3738 /* _second_ argument of this function; this can make a great */
3741 FT_EXPORT( FT_Long
)
3742 FT_MulFix( FT_Long a
,
3748 #ifdef FT_MULFIX_INLINED
3749 #define FT_MulFix( a, b ) FT_MULFIX_INLINED( a, b )
3751 FT_EXPORT( FT_Long
)
3752 FT_MulFix( FT_Long a
,
3757 /*************************************************************************/
3763 /* A very simple function used to perform the computation */
3764 /* `(a*0x10000)/b' with maximum accuracy. Most of the time, this is */
3765 /* used to divide a given value by a 16.16 fixed-point factor. */
3768 /* a :: The first multiplier. */
3769 /* b :: The second multiplier. Use a 16.16 factor here whenever */
3770 /* possible (see note below). */
3773 /* The result of `(a*0x10000)/b'. */
3776 /* The optimization for FT_DivFix() is simple: If (a~<<~16) fits in */
3777 /* 32~bits, then the division is computed directly. Otherwise, we */
3778 /* use a specialized version of @FT_MulDiv. */
3780 FT_EXPORT( FT_Long
)
3781 FT_DivFix( FT_Long a
,
3785 /*************************************************************************/
3791 /* A very simple function used to round a 16.16 fixed number. */
3794 /* a :: The number to be rounded. */
3797 /* The result of `(a + 0x8000) & -0x10000'. */
3799 FT_EXPORT( FT_Fixed
)
3800 FT_RoundFix( FT_Fixed a
);
3803 /*************************************************************************/
3809 /* A very simple function used to compute the ceiling function of a */
3810 /* 16.16 fixed number. */
3813 /* a :: The number for which the ceiling function is to be computed. */
3816 /* The result of `(a + 0x10000 - 1) & -0x10000'. */
3818 FT_EXPORT( FT_Fixed
)
3819 FT_CeilFix( FT_Fixed a
);
3822 /*************************************************************************/
3828 /* A very simple function used to compute the floor function of a */
3829 /* 16.16 fixed number. */
3832 /* a :: The number for which the floor function is to be computed. */
3835 /* The result of `a & -0x10000'. */
3837 FT_EXPORT( FT_Fixed
)
3838 FT_FloorFix( FT_Fixed a
);
3841 /*************************************************************************/
3844 /* FT_Vector_Transform */
3847 /* Transform a single vector through a 2x2 matrix. */
3850 /* vector :: The target vector to transform. */
3853 /* matrix :: A pointer to the source 2x2 matrix. */
3856 /* The result is undefined if either `vector' or `matrix' is invalid. */
3859 FT_Vector_Transform( FT_Vector
* vec
,
3860 const FT_Matrix
* matrix
);
3863 /*************************************************************************/
3869 /* FreeType Version */
3872 /* Functions and macros related to FreeType versions. */
3875 /* Note that those functions and macros are of limited use because */
3876 /* even a new release of FreeType with only documentation changes */
3877 /* increases the version number. */
3879 /*************************************************************************/
3882 /*************************************************************************
3888 * These three macros identify the FreeType source code version.
3889 * Use @FT_Library_Version to access them at runtime.
3892 * FREETYPE_MAJOR :: The major version number.
3893 * FREETYPE_MINOR :: The minor version number.
3894 * FREETYPE_PATCH :: The patch level.
3897 * The version number of FreeType if built as a dynamic link library
3898 * with the `libtool' package is _not_ controlled by these three
3902 #define FREETYPE_MAJOR 2
3903 #define FREETYPE_MINOR 5
3904 #define FREETYPE_PATCH 0
3907 /*************************************************************************/
3910 /* FT_Library_Version */
3913 /* Return the version of the FreeType library being used. This is */
3914 /* useful when dynamically linking to the library, since one cannot */
3915 /* use the macros @FREETYPE_MAJOR, @FREETYPE_MINOR, and */
3916 /* @FREETYPE_PATCH. */
3919 /* library :: A source library handle. */
3922 /* amajor :: The major version number. */
3924 /* aminor :: The minor version number. */
3926 /* apatch :: The patch version number. */
3929 /* The reason why this function takes a `library' argument is because */
3930 /* certain programs implement library initialization in a custom way */
3931 /* that doesn't use @FT_Init_FreeType. */
3933 /* In such cases, the library version might not be available before */
3934 /* the library object has been created. */
3937 FT_Library_Version( FT_Library library
,
3943 /*************************************************************************/
3946 /* FT_Face_CheckTrueTypePatents */
3949 /* Parse all bytecode instructions of a TrueType font file to check */
3950 /* whether any of the patented opcodes are used. This is only useful */
3951 /* if you want to be able to use the unpatented hinter with */
3952 /* fonts that do *not* use these opcodes. */
3954 /* Note that this function parses *all* glyph instructions in the */
3955 /* font file, which may be slow. */
3958 /* face :: A face handle. */
3961 /* 1~if this is a TrueType font that uses one of the patented */
3962 /* opcodes, 0~otherwise. */
3965 /* Since May 2010, TrueType hinting is no longer patented. */
3970 FT_EXPORT( FT_Bool
)
3971 FT_Face_CheckTrueTypePatents( FT_Face face
);
3974 /*************************************************************************/
3977 /* FT_Face_SetUnpatentedHinting */
3980 /* Enable or disable the unpatented hinter for a given face. */
3981 /* Only enable it if you have determined that the face doesn't */
3982 /* use any patented opcodes (see @FT_Face_CheckTrueTypePatents). */
3985 /* face :: A face handle. */
3987 /* value :: New boolean setting. */
3990 /* The old setting value. This will always be false if this is not */
3991 /* an SFNT font, or if the unpatented hinter is not compiled in this */
3992 /* instance of the library. */
3995 /* Since May 2010, TrueType hinting is no longer patented. */
4000 FT_EXPORT( FT_Bool
)
4001 FT_Face_SetUnpatentedHinting( FT_Face face
,
4009 #endif /* __FREETYPE_H__ */
projects / reactos.git / blob