Searched refs:advances (Results 1 - 8 of 8) sorted by relevance

/xsrc/external/mit/freetype/dist/src/type1/
H A Dt1gload.h38 FT_Fixed* advances );
H A Dt1gload.c280 FT_Fixed* advances )
296 advances[nn] = 0;
332 advances[nn] = FIXED_TO_INT( decoder.builder.advance.x );
334 advances[nn] = 0;
338 advances[nn],
339 advances[nn] == 1 ? "" : "s" ));
276 T1_Get_Advances(FT_Face t1face,FT_UInt first,FT_UInt count,FT_Int32 load_flags,FT_Fixed * advances) argument
/xsrc/external/mit/freetype/dist/src/base/
H A Dftadvanc.c27 FT_Fixed* advances,
50 advances[nn] = FT_MulDiv( advances[nn], scale, 64 );
26 _ft_face_scale_advances(FT_Face face,FT_Fixed * advances,FT_UInt count,FT_Int32 flags) argument
/xsrc/external/mit/freetype/dist/src/truetype/
H A Dttdriver.c226 FT_Fixed *advances )
251 advances[nn] = ah;
270 advances[nn] = aw;
222 tt_get_advances(FT_Face ttface,FT_UInt start,FT_UInt count,FT_Int32 flags,FT_Fixed * advances) argument
/xsrc/external/mit/freetype/dist/include/freetype/internal/
H A Dftdrv.h87 FT_Fixed* advances );
147 * set to get vertical advance heights. The 'advances' buffer is
/xsrc/external/mit/freetype/dist/src/cff/
H A Dcffdrivr.c206 FT_Fixed* advances )
254 advances[nn] = ah;
285 advances[nn] = aw;
301 advances[nn] = ( flags & FT_LOAD_VERTICAL_LAYOUT )
202 cff_get_advances(FT_Face face,FT_UInt start,FT_UInt count,FT_Int32 flags,FT_Fixed * advances) argument
/xsrc/external/mit/fontconfig/dist/src/
H A Dfcfreetype.c2529 FT_Pos advances[3] = {0}; local in function:FcFreeTypeSpacing
2574 if (fc_approximately_equal (advance, advances[j]))
2577 advances[num_advances++] = advance;
2588 fc_approximately_equal (fc_min (advances[0], advances[1]) * 2,
2589 fc_max (advances[0], advances[1])))
/xsrc/external/mit/freetype/dist/docs/reference/search/
H A Dsearch_index.json1 {"config":{"lang":["en"],"prebuild_index":false,"separator":"[\\s\\-]+"},"docs":[{"location":"index.html","text":"FreeType \u00bb Docs \u00bb Table of Contents FreeType-2.10.4 API Reference \u00b6 Table of Contents \u00b6 General Remarks \u00b6 FreeType's header inclusion scheme How client applications should include FreeType header files. User allocation How client applications should allocate FreeType data structures. Core API \u00b6 FreeType Version Functions and macros related to FreeType versions. Basic Data Types The basic data types defined by the library. Base Interface The FreeType 2 base font interface. Unicode Variation Sequences The FreeType 2 interface to Unicode Variation Sequences (UVS), using the SFNT cmap format 14. Glyph Color Management Retrieving and manipulating OpenType's \u2018CPAL\u2019 table data. Glyph Layer Management Retrieving and manipulating OpenType's \u2018COLR\u2019 table data. Glyph Management Generic interface to manage individual glyph data. Mac Specific Interface Only available on the Macintosh. Size Management Managing multiple sizes per face. Header File Macros Macro definitions used to #include specific header files. Format-Specific API \u00b6 Multiple Masters How to manage Multiple Masters fonts. TrueType Tables TrueType-specific table types and functions. Type 1 Tables Type 1-specific font tables. SFNT Names Access the names embedded in TrueType and OpenType files. BDF and PCF Files BDF and PCF specific API. CID Fonts CID-keyed font-specific API. PFR Fonts PFR/TrueDoc-specific API. Window FNT Files Windows FNT-specific API. Font Formats Getting the font format. Gasp Table Retrieving TrueType \u2018gasp\u2019 table entries. Controlling FreeType Modules \u00b6 The auto-hinter Controlling the auto-hinting module. The CFF driver Controlling the CFF driver module. The Type 1 and CID drivers Controlling the Type 1 and CID driver modules. The TrueType driver Controlling the TrueType driver module. The PCF driver Controlling the PCF driver module. Driver properties Controlling driver modules. Parameter Tags Macros for driver property and font loading parameter tags. Subpixel Rendering API to control subpixel rendering. Cache Sub-System \u00b6 Cache Sub-System How to cache face, size, and glyph data with FreeType 2. Support API \u00b6 Computations Crunching fixed numbers and vectors. List Processing Simple management of lists. Outline Processing Functions to create, transform, and render vectorial glyph images. Quick retrieval of advance values Retrieve horizontal and vertical advance values without processing glyph outlines, if possible. Bitmap Handling Handling FT_Bitmap objects. Scanline Converter How vectorial outlines are converted into bitmaps and pixmaps. Glyph Stroker Generating bordered and stroked glyphs. System Interface How FreeType manages memory and i/o. Module Management How to add, upgrade, remove, and control modules from FreeType. GZIP Streams Using gzip-compressed font files. LZW Streams Using LZW-compressed font files. BZIP2 Streams Using bzip2-compressed font files. Error Codes \u00b6 Error Enumerations How to handle errors and error strings. Error Code Values All possible error codes returned by FreeType functions. Miscellaneous \u00b6 TrueTypeGX/AAT Validation An API to validate TrueTypeGX/AAT tables. Incremental Loading Custom Glyph Loading. The TrueType Engine TrueType bytecode support. OpenType Validation An API to validate OpenType tables. Global Index \u00b6 generated on Tue Oct 20 05:14:52 2020 UTC","title":"TOC"},{"location":"index.html#freetype-2104-api-reference","text":"","title":"FreeType-2.10.4 API Reference"},{"location":"index.html#table-of-contents","text":"","title":"Table of Contents"},{"location":"index.html#general-remarks","text":"FreeType's header inclusion scheme How client applications should include FreeType header files. User allocation How client applications should allocate FreeType data structures.","title":"General Remarks"},{"location":"index.html#core-api","text":"FreeType Version Functions and macros related to FreeType versions. Basic Data Types The basic data types defined by the library. Base Interface The FreeType 2 base font interface. Unicode Variation Sequences The FreeType 2 interface to Unicode Variation Sequences (UVS), using the SFNT cmap format 14. Glyph Color Management Retrieving and manipulating OpenType's \u2018CPAL\u2019 table data. Glyph Layer Management Retrieving and manipulating OpenType's \u2018COLR\u2019 table data. Glyph Management Generic interface to manage individual glyph data. Mac Specific Interface Only available on the Macintosh. Size Management Managing multiple sizes per face. Header File Macros Macro definitions used to #include specific header files.","title":"Core API"},{"location":"index.html#format-specific-api","text":"Multiple Masters How to manage Multiple Masters fonts. TrueType Tables TrueType-specific table types and functions. Type 1 Tables Type 1-specific font tables. SFNT Names Access the names embedded in TrueType and OpenType files. BDF and PCF Files BDF and PCF specific API. CID Fonts CID-keyed font-specific API. PFR Fonts PFR/TrueDoc-specific API. Window FNT Files Windows FNT-specific API. Font Formats Getting the font format. Gasp Table Retrieving TrueType \u2018gasp\u2019 table entries.","title":"Format-Specific API"},{"location":"index.html#controlling-freetype-modules","text":"The auto-hinter Controlling the auto-hinting module. The CFF driver Controlling the CFF driver module. The Type 1 and CID drivers Controlling the Type 1 and CID driver modules. The TrueType driver Controlling the TrueType driver module. The PCF driver Controlling the PCF driver module. Driver properties Controlling driver modules. Parameter Tags Macros for driver property and font loading parameter tags. Subpixel Rendering API to control subpixel rendering.","title":"Controlling FreeType Modules"},{"location":"index.html#cache-sub-system","text":"Cache Sub-System How to cache face, size, and glyph data with FreeType 2.","title":"Cache Sub-System"},{"location":"index.html#support-api","text":"Computations Crunching fixed numbers and vectors. List Processing Simple management of lists. Outline Processing Functions to create, transform, and render vectorial glyph images. Quick retrieval of advance values Retrieve horizontal and vertical advance values without processing glyph outlines, if possible. Bitmap Handling Handling FT_Bitmap objects. Scanline Converter How vectorial outlines are converted into bitmaps and pixmaps. Glyph Stroker Generating bordered and stroked glyphs. System Interface How FreeType manages memory and i/o. Module Management How to add, upgrade, remove, and control modules from FreeType. GZIP Streams Using gzip-compressed font files. LZW Streams Using LZW-compressed font files. BZIP2 Streams Using bzip2-compressed font files.","title":"Support API"},{"location":"index.html#error-codes","text":"Error Enumerations How to handle errors and error strings. Error Code Values All possible error codes returned by FreeType functions.","title":"Error Codes"},{"location":"index.html#miscellaneous","text":"TrueTypeGX/AAT Validation An API to validate TrueTypeGX/AAT tables. Incremental Loading Custom Glyph Loading. The TrueType Engine TrueType bytecode support. OpenType Validation An API to validate OpenType tables.","title":"Miscellaneous"},{"location":"index.html#global-index","text":"generated on Tue Oct 20 05:14:52 2020 UTC","title":"Global Index"},{"location":"ft2-auto_hinter.html","text":"FreeType \u00bb Docs \u00bb Controlling FreeType Modules \u00bb The auto-hinter The auto-hinter \u00b6 Synopsis \u00b6 While FreeType's auto-hinter doesn't expose API functions by itself, it is possible to control its behaviour with FT_Property_Set and FT_Property_Get . The following lists the available properties together with the necessary macros and structures. Note that the auto-hinter's module name is \u2018autofitter\u2019 for historical reasons. Available properties are increase-x-height , no-stem-darkening (experimental), darkening-parameters (experimental), warping (experimental), glyph-to-script-map (experimental), fallback-script (experimental), and default-script (experimental), as documented in the \u2018 Driver properties \u2019 section.","title":"The auto-hinter"},{"location":"ft2-auto_hinter.html#the-auto-hinter","text":"","title":"The auto-hinter"},{"location":"ft2-auto_hinter.html#synopsis","text":"While FreeType's auto-hinter doesn't expose API functions by itself, it is possible to control its behaviour with FT_Property_Set and FT_Property_Get . The following lists the available properties together with the necessary macros and structures. Note that the auto-hinter's module name is \u2018autofitter\u2019 for historical reasons. Available properties are increase-x-height , no-stem-darkening (experimental), darkening-parameters (experimental), warping (experimental), glyph-to-script-map (experimental), fallback-script (experimental), and default-script (experimental), as documented in the \u2018 Driver properties \u2019 section.","title":"Synopsis"},{"location":"ft2-base_interface.html","text":"FreeType \u00bb Docs \u00bb Core API \u00bb Base Interface Base Interface \u00b6 Synopsis \u00b6 This section describes the most important public high-level API functions of FreeType 2. FT_Library \u00b6 Defined in FT_FREETYPE_H (freetype/freetype.h). typedef struct FT_LibraryRec_ * FT_Library ; A handle to a FreeType library instance. Each \u2018library\u2019 is completely independent from the others; it is the \u2018root\u2019 of a set of objects like fonts, faces, sizes, etc. It also embeds a memory manager (see FT_Memory ), as well as a scan-line converter object (see FT_Raster ). [Since 2.5.6] In multi-threaded applications it is easiest to use one FT_Library object per thread. In case this is too cumbersome, a single FT_Library object across threads is possible also, as long as a mutex lock is used around FT_New_Face and FT_Done_Face . note Library objects are normally created by FT_Init_FreeType , and destroyed with FT_Done_FreeType . If you need reference-counting (cf. FT_Reference_Library ), use FT_New_Library and FT_Done_Library . FT_Face \u00b6 Defined in FT_FREETYPE_H (freetype/freetype.h). typedef struct FT_FaceRec_* FT_Face ; A handle to a typographic face object. A face object models a given typeface, in a given style. note A face object also owns a single FT_GlyphSlot object, as well as one or more FT_Size objects. Use FT_New_Face or FT_Open_Face to create a new face object from a given filepath or a custom input stream. Use FT_Done_Face to destroy it (along with its slot and sizes). An FT_Face object can only be safely used from one thread at a time. Similarly, creation and destruction of FT_Face with the same FT_Library object can only be done from one thread at a time. On the other hand, functions like FT_Load_Glyph and its siblings are thread-safe and do not need the lock to be held as long as the same FT_Face object is not used from multiple threads at the same time. also See FT_FaceRec for the publicly accessible fields of a given face object. FT_Size \u00b6 Defined in FT_FREETYPE_H (freetype/freetype.h). typedef struct FT_SizeRec_* FT_Size ; A handle to an object that models a face scaled to a given character size. note An FT_Face has one active FT_Size object that is used by functions like FT_Load_Glyph to determine the scaling transformation that in turn is used to load and hint glyphs and metrics. You can use FT_Set_Char_Size , FT_Set_Pixel_Sizes , FT_Request_Size or even FT_Select_Size to change the content (i.e., the scaling values) of the active FT_Size . You can use FT_New_Size to create additional size objects for a given FT_Face , but they won't be used by other functions until you activate it through FT_Activate_Size . Only one size can be activated at any given time per face. also See FT_SizeRec for the publicly accessible fields of a given size object. FT_GlyphSlot \u00b6 Defined in FT_FREETYPE_H (freetype/freetype.h). typedef struct FT_GlyphSlotRec_* FT_GlyphSlot ; A handle to a given \u2018glyph slot\u2019. A slot is a container that can hold any of the glyphs contained in its parent face. In other words, each time you call FT_Load_Glyph or FT_Load_Char , the slot's content is erased by the new glyph data, i.e., the glyph's metrics, its image (bitmap or outline), and other control information. also See FT_GlyphSlotRec for the publicly accessible glyph fields. FT_CharMap \u00b6 Defined in FT_FREETYPE_H (freetype/freetype.h). typedef struct FT_CharMapRec_* FT_CharMap ; A handle to a character map (usually abbreviated to \u2018charmap\u2019). A charmap is used to translate character codes in a given encoding into glyph indexes for its parent's face. Some font formats may provide several charmaps per font. Each face object owns zero or more charmaps, but only one of them can be \u2018active\u2019, providing the data used by FT_Get_Char_Index or FT_Load_Char . The list of available charmaps in a face is available through the face->num_charmaps and face->charmaps fields of FT_FaceRec . The currently active charmap is available as face->charmap . You should call FT_Set_Charmap to change it. note When a new face is created (either through FT_New_Face or FT_Open_Face ), the library looks for a Unicode charmap within the list and automatically activates it. If there is no Unicode charmap, FreeType doesn't set an \u2018active\u2019 charmap. also See FT_CharMapRec for the publicly accessible fields of a given character map. FT_Encoding \u00b6 Defined in FT_FREETYPE_H (freetype/freetype.h). typedef enum FT_Encoding_ { FT_ENC_TAG ( FT_ENCODING_NONE , 0, 0, 0, 0 ), FT_ENC_TAG ( FT_ENCODING_MS_SYMBOL , 's', 'y', 'm', 'b' ), FT_ENC_TAG ( FT_ENCODING_UNICODE , 'u', 'n', 'i', 'c' ), FT_ENC_TAG ( FT_ENCODING_SJIS , 's', 'j', 'i', 's' ), FT_ENC_TAG ( FT_ENCODING_PRC , 'g', 'b', ' ', ' ' ), FT_ENC_TAG ( FT_ENCODING_BIG5 , 'b', 'i', 'g', '5' ), FT_ENC_TAG ( FT_ENCODING_WANSUNG , 'w', 'a', 'n', 's' ), FT_ENC_TAG ( FT_ENCODING_JOHAB , 'j', 'o', 'h', 'a' ), /* for backward compatibility */ FT_ENCODING_GB2312 = FT_ENCODING_PRC , FT_ENCODING_MS_SJIS = FT_ENCODING_SJIS , FT_ENCODING_MS_GB2312 = FT_ENCODING_PRC , FT_ENCODING_MS_BIG5 = FT_ENCODING_BIG5 , FT_ENCODING_MS_WANSUNG = FT_ENCODING_WANSUNG , FT_ENCODING_MS_JOHAB = FT_ENCODING_JOHAB , FT_ENC_TAG ( FT_ENCODING_ADOBE_STANDARD , 'A', 'D', 'O', 'B' ), FT_ENC_TAG ( FT_ENCODING_ADOBE_EXPERT , 'A', 'D', 'B', 'E' ), FT_ENC_TAG ( FT_ENCODING_ADOBE_CUSTOM , 'A', 'D', 'B', 'C' ), FT_ENC_TAG ( FT_ENCODING_ADOBE_LATIN_1 , 'l', 'a', 't', '1' ), FT_ENC_TAG ( FT_ENCODING_OLD_LATIN_2 , 'l', 'a', 't', '2' ), FT_ENC_TAG ( FT_ENCODING_APPLE_ROMAN , 'a', 'r', 'm', 'n' ) } FT_Encoding ; /* these constants are deprecated; use the corresponding ` FT_Encoding ` */ /* values instead */ # define ft_encoding_none FT_ENCODING_NONE # define ft_encoding_unicode FT_ENCODING_UNICODE # define ft_encoding_symbol FT_ENCODING_MS_SYMBOL # define ft_encoding_latin_1 FT_ENCODING_ADOBE_LATIN_1 # define ft_encoding_latin_2 FT_ENCODING_OLD_LATIN_2 # define ft_encoding_sjis FT_ENCODING_SJIS # define ft_encoding_gb2312 FT_ENCODING_PRC # define ft_encoding_big5 FT_ENCODING_BIG5 # define ft_encoding_wansung FT_ENCODING_WANSUNG # define ft_encoding_johab FT_ENCODING_JOHAB # define ft_encoding_adobe_standard FT_ENCODING_ADOBE_STANDARD # define ft_encoding_adobe_expert FT_ENCODING_ADOBE_EXPERT # define ft_encoding_adobe_custom FT_ENCODING_ADOBE_CUSTOM # define ft_encoding_apple_roman FT_ENCODING_APPLE_ROMAN An enumeration to specify character sets supported by charmaps. Used in the FT_Select_Charmap API function. note Despite the name, this enumeration lists specific character repertories (i.e., charsets), and not text encoding methods (e.g., UTF-8, UTF-16, etc.). Other encodings might be defined in the future. values FT_ENCODING_NONE The encoding value 0 is reserved for all formats except BDF, PCF, and Windows FNT; see below for more information. FT_ENCODING_UNICODE The Unicode character set. This value covers all versions of the Unicode repertoire, including ASCII and Latin-1. Most fonts include a Unicode charmap, but not all of them. For example, if you want to access Unicode value U+1F028 (and the font contains it), use value 0x1F028 as the input value for FT_Get_Char_Index . FT_ENCODING_MS_SYMBOL Microsoft Symbol encoding, used to encode mathematical symbols and wingdings. For more information, see \u2018 https://www.microsoft.com/typography/otspec/recom.htm#non-standard-symbol-fonts \u2019, \u2018 http://www.kostis.net/charsets/symbol.htm \u2019, and \u2018 http://www.kostis.net/charsets/wingding.htm \u2019. This encoding uses character codes from the PUA (Private Unicode Area) in the range U+F020-U+F0FF. FT_ENCODING_SJIS Shift JIS encoding for Japanese. More info at \u2018 https://en.wikipedia.org/wiki/Shift_JIS \u2019. See note on multi-byte encodings below. FT_ENCODING_PRC Corresponds to encoding systems mainly for Simplified Chinese as used in People's Republic of China (PRC). The encoding layout is based on GB 2312 and its supersets GBK and GB 18030. FT_ENCODING_BIG5 Corresponds to an encoding system for Traditional Chinese as used in Taiwan and Hong Kong. FT_ENCODING_WANSUNG Corresponds to the Korean encoding system known as Extended Wansung (MS Windows code page 949). For more information see \u2018 https://www.unicode.org/Public/MAPPINGS/VENDORS/MICSFT/WindowsBestFit/bestfit949.txt \u2019. FT_ENCODING_JOHAB The Korean standard character set (KS C 5601-1992), which corresponds to MS Windows code page 1361. This character set includes all possible Hangul character combinations. FT_ENCODING_ADOBE_LATIN_1 Corresponds to a Latin-1 encoding as defined in a Type 1 PostScript font. It is limited to 256 character codes. FT_ENCODING_ADOBE_STANDARD Adobe Standard encoding, as found in Type 1, CFF, and OpenType/CFF fonts. It is limited to 256 character codes. FT_ENCODING_ADOBE_EXPERT Adobe Expert encoding, as found in Type 1, CFF, and OpenType/CFF fonts. It is limited to 256 character codes. FT_ENCODING_ADOBE_CUSTOM Corresponds to a custom encoding, as found in Type 1, CFF, and OpenType/CFF fonts. It is limited to 256 character codes. FT_ENCODING_APPLE_ROMAN Apple roman encoding. Many TrueType and OpenType fonts contain a charmap for this 8-bit encoding, since older versions of Mac OS are able to use it. FT_ENCODING_OLD_LATIN_2 This value is deprecated and was neither used nor reported by FreeType. Don't use or test for it. FT_ENCODING_MS_SJIS Same as FT_ENCODING_SJIS. Deprecated. FT_ENCODING_MS_GB2312 Same as FT_ENCODING_PRC. Deprecated. FT_ENCODING_MS_BIG5 Same as FT_ENCODING_BIG5. Deprecated. FT_ENCODING_MS_WANSUNG Same as FT_ENCODING_WANSUNG. Deprecated. FT_ENCODING_MS_JOHAB Same as FT_ENCODING_JOHAB. Deprecated. note By default, FreeType enables a Unicode charmap and tags it with FT_ENCODING_UNICODE when it is either provided or can be generated from PostScript glyph name dictionaries in the font file. All other encodings are considered legacy and tagged only if explicitly defined in the font file. Otherwise, FT_ENCODING_NONE is used. FT_ENCODING_NONE is set by the BDF and PCF drivers if the charmap is neither Unicode nor ISO-8859-1 (otherwise it is set to FT_ENCODING_UNICODE ). Use FT_Get_BDF_Charset_ID to find out which encoding is really present. If, for example, the cs_registry field is \u2018KOI8\u2019 and the cs_encoding field is \u2018R\u2019, the font is encoded in KOI8-R. FT_ENCODING_NONE is always set (with a single exception) by the winfonts driver. Use FT_Get_WinFNT_Header and examine the charset field of the FT_WinFNT_HeaderRec structure to find out which encoding is really present. For example, FT_WinFNT_ID_CP1251 (204) means Windows code page 1251 (for Russian). FT_ENCODING_NONE is set if platform_id is TT_PLATFORM_MACINTOSH and encoding_id is not TT_MAC_ID_ROMAN (otherwise it is set to FT_ENCODING_APPLE_ROMAN ). If platform_id is TT_PLATFORM_MACINTOSH , use the function FT_Get_CMap_Language_ID to query the Mac language ID that may be needed to be able to distinguish Apple encoding variants. See https://www.unicode.org/Public/MAPPINGS/VENDORS/APPLE/Readme.txt to get an idea how to do that. Basically, if the language ID is 0, don't use it, otherwise subtract 1 from the language ID. Then examine encoding_id . If, for example, encoding_id is TT_MAC_ID_ROMAN and the language ID (minus 1) is TT_MAC_LANGID_GREEK , it is the Greek encoding, not Roman. TT_MAC_ID_ARABIC with TT_MAC_LANGID_FARSI means the Farsi variant the Arabic encoding. FT_ENC_TAG \u00b6 Defined in FT_FREETYPE_H (freetype/freetype.h). # ifndef FT_ENC_TAG # define FT_ENC_TAG ( value, a, b, c, d ) \\ value = ( ( ( FT_UInt32 )(a) << 24 ) | \\ ( ( FT_UInt32 )(b) << 16 ) | \\ ( ( FT_UInt32 )(c) << 8 ) | \\ ( FT_UInt32 )(d) ) # endif /* FT_ENC_TAG */ This macro converts four-letter tags into an unsigned long. It is used to define \u2018encoding\u2019 identifiers (see FT_Encoding ). note Since many 16-bit compilers don't like 32-bit enumerations, you should redefine this macro in case of problems to something like this: #define FT_ENC_TAG( value, a, b, c, d ) value to get a simple enumeration without assigning special numbers. FT_FaceRec \u00b6 Defined in FT_FREETYPE_H (freetype/freetype.h). typedef struct FT_FaceRec_ { FT_Long num_faces; FT_Long face_index; FT_Long face_flags; FT_Long style_flags; FT_Long num_glyphs; FT_String * family_name; FT_String * style_name; FT_Int num_fixed_sizes; FT_Bitmap_Size * available_sizes; FT_Int num_charmaps; FT_CharMap * charmaps; FT_Generic generic; /*# The following member variables (down to `underline_thickness`) */ /*# are only relevant to scalable outlines; cf. @ FT_Bitmap_Size */ /*# for bitmap fonts. */ FT_BBox bbox; FT_UShort units_per_EM; FT_Short ascender; FT_Short descender; FT_Short height; FT_Short max_advance_width; FT_Short max_advance_height; FT_Short underline_position; FT_Short underline_thickness; FT_GlyphSlot glyph; FT_Size size; FT_CharMap charmap; /*@private begin */ FT_Driver driver; FT_Memory memory; FT_Stream stream; FT_ListRec sizes_list; FT_Generic autohint; /* face-specific auto-hinter data */ void * extensions; /* unused */ FT_Face_Internal internal; /*@private end */ } FT_FaceRec ; FreeType root face class structure. A face object models a typeface in a font file. fields num_faces The number of faces in the font file. Some font formats can have multiple faces in a single font file. face_index This field holds two different values. Bits 0-15 are the index of the face in the font file (starting with value 0). They are set to 0 if there is only one face in the font file. [Since 2.6.1] Bits 16-30 are relevant to GX and OpenType variation fonts only, holding the named instance index for the current face index (starting with value 1; value 0 indicates font access without a named instance). For non-variation fonts, bits 16-30 are ignored. If we have the third named instance of face 4, say, face_index is set to 0x00030004. Bit 31 is always zero (this is, face_index is always a positive value). [Since 2.9] Changing the design coordinates with FT_Set_Var_Design_Coordinates or FT_Set_Var_Blend_Coordinates does not influence the named instance index value (only FT_Set_Named_Instance does that). face_flags A set of bit flags that give important information about the face; see FT_FACE_FLAG_XXX for the details. style_flags The lower 16 bits contain a set of bit flags indicating the style of the face; see FT_STYLE_FLAG_XXX for the details. [Since 2.6.1] Bits 16-30 hold the number of named instances available for the current face if we have a GX or OpenType variation (sub)font. Bit 31 is always zero (this is, style_flags is always a positive value). Note that a variation font has always at least one named instance, namely the default instance. num_glyphs The number of glyphs in the face. If the face is scalable and has sbits (see num_fixed_sizes ), it is set to the number of outline glyphs. For CID-keyed fonts (not in an SFNT wrapper) this value gives the highest CID used in the font. family_name The face's family name. This is an ASCII string, usually in English, that describes the typeface's family (like \u2018Times New Roman\u2019, \u2018Bodoni\u2019, \u2018Garamond\u2019, etc). This is a least common denominator used to list fonts. Some formats (TrueType & OpenType) provide localized and Unicode versions of this string. Applications should use the format-specific interface to access them. Can be NULL (e.g., in fonts embedded in a PDF file). In case the font doesn't provide a specific family name entry, FreeType tries to synthesize one, deriving it from other name entries. style_name The face's style name. This is an ASCII string, usually in English, that describes the typeface's style (like \u2018Italic\u2019, \u2018Bold\u2019, \u2018Condensed\u2019, etc). Not all font formats provide a style name, so this field is optional, and can be set to NULL . As for family_name , some formats provide localized and Unicode versions of this string. Applications should use the format-specific interface to access them. num_fixed_sizes The number of bitmap strikes in the face. Even if the face is scalable, there might still be bitmap strikes, which are called \u2018sbits\u2019 in that case. available_sizes An array of FT_Bitmap_Size for all bitmap strikes in the face. It is set to NULL if there is no bitmap strike. Note that FreeType tries to sanitize the strike data since they are sometimes sloppy or incorrect, but this can easily fail. num_charmaps The number of charmaps in the face. charmaps An array of the charmaps of the face. generic A field reserved for client uses. See the FT_Generic type description. bbox The font bounding box. Coordinates are expressed in font units (see units_per_EM ). The box is large enough to contain any glyph from the font. Thus, bbox.yMax can be seen as the \u2018maximum ascender\u2019, and bbox.yMin as the \u2018minimum descender\u2019. Only relevant for scalable formats. Note that the bounding box might be off by (at least) one pixel for hinted fonts. See FT_Size_Metrics for further discussion. Note that the bounding box does not vary in OpenType variable fonts and should only be used in relation to the default instance. units_per_EM The number of font units per EM square for this face. This is typically 2048 for TrueType fonts, and 1000 for Type 1 fonts. Only relevant for scalable formats. ascender The typographic ascender of the face, expressed in font units. For font formats not having this information, it is set to bbox.yMax . Only relevant for scalable formats. descender The typographic descender of the face, expressed in font units. For font formats not having this information, it is set to bbox.yMin . Note that this field is negative for values below the baseline. Only relevant for scalable formats. height This value is the vertical distance between two consecutive baselines, expressed in font units. It is always positive. Only relevant for scalable formats. If you want the global glyph height, use ascender - descender . max_advance_width The maximum advance width, in font units, for all glyphs in this face. This can be used to make word wrapping computations faster. Only relevant for scalable formats. max_advance_height The maximum advance height, in font units, for all glyphs in this face. This is only relevant for vertical layouts, and is set to height for fonts that do not provide vertical metrics. Only relevant for scalable formats. underline_position The position, in font units, of the underline line for this face. It is the center of the underlining stem. Only relevant for scalable formats. underline_thickness The thickness, in font units, of the underline for this face. Only relevant for scalable formats. glyph The face's associated glyph slot(s). size The current active size for this face. charmap The current active charmap for this face. note Fields may be changed after a call to FT_Attach_File or FT_Attach_Stream . For an OpenType variation font, the values of the following fields can change after a call to FT_Set_Var_Design_Coordinates (and friends) if the font contains an \u2018MVAR\u2019 table: ascender , descender , height , underline_position , and underline_thickness . Especially for TrueType fonts see also the documentation for FT_Size_Metrics . FT_HAS_HORIZONTAL \u00b6 Defined in FT_FREETYPE_H (freetype/freetype.h). # define FT_HAS_HORIZONTAL ( face ) \\ ( !!( (face)->face_flags & FT_FACE_FLAG_HORIZONTAL ) ) A macro that returns true whenever a face object contains horizontal metrics (this is true for all font formats though). also FT_HAS_VERTICAL can be used to check for vertical metrics. FT_HAS_VERTICAL \u00b6 Defined in FT_FREETYPE_H (freetype/freetype.h). # define FT_HAS_VERTICAL ( face ) \\ ( !!( (face)->face_flags & FT_FACE_FLAG_VERTICAL ) ) A macro that returns true whenever a face object contains real vertical metrics (and not only synthesized ones). FT_HAS_KERNING \u00b6 Defined in FT_FREETYPE_H (freetype/freetype.h). # define FT_HAS_KERNING ( face ) \\ ( !!( (face)->face_flags & FT_FACE_FLAG_KERNING ) ) A macro that returns true whenever a face object contains kerning data that can be accessed with FT_Get_Kerning . FT_HAS_FIXED_SIZES \u00b6 Defined in FT_FREETYPE_H (freetype/freetype.h). # define FT_HAS_FIXED_SIZES ( face ) \\ ( !!( (face)->face_flags & FT_FACE_FLAG_FIXED_SIZES ) ) A macro that returns true whenever a face object contains some embedded bitmaps. See the available_sizes field of the FT_FaceRec structure. FT_HAS_GLYPH_NAMES \u00b6 Defined in FT_FREETYPE_H (freetype/freetype.h). # define FT_HAS_GLYPH_NAMES ( face ) \\ ( !!( (face)->face_flags & FT_FACE_FLAG_GLYPH_NAMES ) ) A macro that returns true whenever a face object contains some glyph names that can be accessed through FT_Get_Glyph_Name . FT_HAS_COLOR \u00b6 Defined in FT_FREETYPE_H (freetype/freetype.h). # define FT_HAS_COLOR ( face ) \\ ( !!( (face)->face_flags & FT_FACE_FLAG_COLOR ) ) A macro that returns true whenever a face object contains tables for color glyphs. since 2.5.1 FT_HAS_MULTIPLE_MASTERS \u00b6 Defined in FT_FREETYPE_H (freetype/freetype.h). # define FT_HAS_MULTIPLE_MASTERS ( face ) \\ ( !!( (face)->face_flags & FT_FACE_FLAG_MULTIPLE_MASTERS ) ) A macro that returns true whenever a face object contains some multiple masters. The functions provided by FT_MULTIPLE_MASTERS_H are then available to choose the exact design you want. FT_IS_SFNT \u00b6 Defined in FT_FREETYPE_H (freetype/freetype.h). # define FT_IS_SFNT ( face ) \\ ( !!( (face)->face_flags & FT_FACE_FLAG_SFNT ) ) A macro that returns true whenever a face object contains a font whose format is based on the SFNT storage scheme. This usually means: TrueType fonts, OpenType fonts, as well as SFNT-based embedded bitmap fonts. If this macro is true, all functions defined in FT_SFNT_NAMES_H and FT_TRUETYPE_TABLES_H are available. FT_IS_SCALABLE \u00b6 Defined in FT_FREETYPE_H (freetype/freetype.h). # define FT_IS_SCALABLE ( face ) \\ ( !!( (face)->face_flags & FT_FACE_FLAG_SCALABLE ) ) A macro that returns true whenever a face object contains a scalable font face (true for TrueType, Type 1, Type 42, CID, OpenType/CFF, and PFR font formats). FT_IS_FIXED_WIDTH \u00b6 Defined in FT_FREETYPE_H (freetype/freetype.h). # define FT_IS_FIXED_WIDTH ( face ) \\ ( !!( (face)->face_flags & FT_FACE_FLAG_FIXED_WIDTH ) ) A macro that returns true whenever a face object contains a font face that contains fixed-width (or \u2018monospace\u2019, \u2018fixed-pitch\u2019, etc.) glyphs. FT_IS_CID_KEYED \u00b6 Defined in FT_FREETYPE_H (freetype/freetype.h). # define FT_IS_CID_KEYED ( face ) \\ ( !!( (face)->face_flags & FT_FACE_FLAG_CID_KEYED ) ) A macro that returns true whenever a face object contains a CID-keyed font. See the discussion of FT_FACE_FLAG_CID_KEYED for more details. If this macro is true, all functions defined in FT_CID_H are available. FT_IS_TRICKY \u00b6 Defined in FT_FREETYPE_H (freetype/freetype.h). # define FT_IS_TRICKY ( face ) \\ ( !!( (face)->face_flags & FT_FACE_FLAG_TRICKY ) ) A macro that returns true whenever a face represents a \u2018tricky\u2019 font. See the discussion of FT_FACE_FLAG_TRICKY for more details. FT_IS_NAMED_INSTANCE \u00b6 Defined in FT_FREETYPE_H (freetype/freetype.h). # define FT_IS_NAMED_INSTANCE ( face ) \\ ( !!( (face)->face_index & 0x7FFF0000L ) ) A macro that returns true whenever a face object is a named instance of a GX or OpenType variation font. [Since 2.9] Changing the design coordinates with FT_Set_Var_Design_Coordinates or FT_Set_Var_Blend_Coordinates does not influence the return value of this macro (only FT_Set_Named_Instance does that). since 2.7 FT_IS_VARIATION \u00b6 Defined in FT_FREETYPE_H (freetype/freetype.h). # define FT_IS_VARIATION ( face ) \\ ( !!( (face)->face_flags & FT_FACE_FLAG_VARIATION ) ) A macro that returns true whenever a face object has been altered by FT_Set_MM_Design_Coordinates , FT_Set_Var_Design_Coordinates , or FT_Set_Var_Blend_Coordinates . since 2.9 FT_SizeRec \u00b6 Defined in FT_FREETYPE_H (freetype/freetype.h). typedef struct FT_SizeRec_ { FT_Face face; /* parent face object */ FT_Generic generic; /* generic pointer for client uses */ FT_Size_Metrics metrics; /* size metrics */ FT_Size_Internal internal; } FT_SizeRec ; FreeType root size class structure. A size object models a face object at a given size. fields face Handle to the parent face object. generic A typeless pointer, unused by the FreeType library or any of its drivers. It can be used by client applications to link their own data to each size object. metrics Metrics for this size object. This field is read-only. FT_Size_Metrics \u00b6 Defined in FT_FREETYPE_H (freetype/freetype.h). typedef struct FT_Size_Metrics_ { FT_UShort x_ppem; /* horizontal pixels per EM */ FT_UShort y_ppem; /* vertical pixels per EM */ FT_Fixed x_scale; /* scaling values used to convert font */ FT_Fixed y_scale; /* units to 26.6 fractional pixels */ FT_Pos ascender; /* ascender in 26.6 frac. pixels */ FT_Pos descender; /* descender in 26.6 frac. pixels */ FT_Pos height; /* text height in 26.6 frac. pixels */ FT_Pos max_advance; /* max horizontal advance, in 26.6 pixels */ } FT_Size_Metrics ; The size metrics structure gives the metrics of a size object. fields x_ppem The width of the scaled EM square in pixels, hence the term \u2018ppem\u2019 (pixels per EM). It is also referred to as \u2018nominal width\u2019. y_ppem The height of the scaled EM square in pixels, hence the term \u2018ppem\u2019 (pixels per EM). It is also referred to as \u2018nominal height\u2019. x_scale A 16.16 fractional scaling value to convert horizontal metrics from font units to 26.6 fractional pixels. Only relevant for scalable font formats. y_scale A 16.16 fractional scaling value to convert vertical metrics from font units to 26.6 fractional pixels. Only relevant for scalable font formats. ascender The ascender in 26.6 fractional pixels, rounded up to an integer value. See FT_FaceRec for the details. descender The descender in 26.6 fractional pixels, rounded down to an integer value. See FT_FaceRec for the details. height The height in 26.6 fractional pixels, rounded to an integer value. See FT_FaceRec for the details. max_advance The maximum advance width in 26.6 fractional pixels, rounded to an integer value. See FT_FaceRec for the details. note The scaling values, if relevant, are determined first during a size changing operation. The remaining fields are then set by the driver. For scalable formats, they are usually set to scaled values of the corresponding fields in FT_FaceRec . Some values like ascender or descender are rounded for historical reasons; more precise values (for outline fonts) can be derived by scaling the corresponding FT_FaceRec values manually, with code similar to the following. scaled_ascender = FT_MulFix( face->ascender, size_metrics->y_scale ); Note that due to glyph hinting and the selected rendering mode these values are usually not exact; consequently, they must be treated as unreliable with an error margin of at least one pixel! Indeed, the only way to get the exact metrics is to render all glyphs. As this would be a definite performance hit, it is up to client applications to perform such computations. The FT_Size_Metrics structure is valid for bitmap fonts also. TrueType fonts with native bytecode hinting All applications that handle TrueType fonts with native hinting must be aware that TTFs expect different rounding of vertical font dimensions. The application has to cater for this, especially if it wants to rely on a TTF's vertical data (for example, to properly align box characters vertically). Only the application knows in advance that it is going to use native hinting for TTFs! FreeType, on the other hand, selects the hinting mode not at the time of creating an FT_Size object but much later, namely while calling FT_Load_Glyph . Here is some pseudo code that illustrates a possible solution. font_format = FT_Get_Font_Format( face ); if ( !strcmp( font_format, \"TrueType\" ) && do_native_bytecode_hinting ) { ascender = ROUND( FT_MulFix( face->ascender, size_metrics->y_scale ) ); descender = ROUND( FT_MulFix( face->descender, size_metrics->y_scale ) ); } else { ascender = size_metrics->ascender; descender = size_metrics->descender; } height = size_metrics->height; max_advance = size_metrics->max_advance; FT_GlyphSlotRec \u00b6 Defined in FT_FREETYPE_H (freetype/freetype.h). typedef struct FT_GlyphSlotRec_ { FT_Library library; FT_Face face; FT_GlyphSlot next; FT_UInt glyph_index; /* new in 2.10; was reserved previously */ FT_Generic generic; FT_Glyph_Metrics metrics; FT_Fixed linearHoriAdvance; FT_Fixed linearVertAdvance; FT_Vector advance; FT_Glyph_Format format; FT_Bitmap bitmap; FT_Int bitmap_left; FT_Int bitmap_top; FT_Outline outline; FT_UInt num_subglyphs; FT_SubGlyph subglyphs; void * control_data; long control_len; FT_Pos lsb_delta; FT_Pos rsb_delta; void * other; FT_Slot_Internal internal; } FT_GlyphSlotRec ; FreeType root glyph slot class structure. A glyph slot is a container where individual glyphs can be loaded, be they in outline or bitmap format. fields library A handle to the FreeType library instance this slot belongs to. face A handle to the parent face object. next In some cases (like some font tools), several glyph slots per face object can be a good thing. As this is rare, the glyph slots are listed through a direct, single-linked list using its next field. glyph_index [Since 2.10] The glyph index passed as an argument to FT_Load_Glyph while initializing the glyph slot. generic A typeless pointer unused by the FreeType library or any of its drivers. It can be used by client applications to link their own data to each glyph slot object. metrics The metrics of the last loaded glyph in the slot. The returned values depend on the last load flags (see the FT_Load_Glyph API function) and can be expressed either in 26.6 fractional pixels or font units. Note that even when the glyph image is transformed, the metrics are not. linearHoriAdvance The advance width of the unhinted glyph. Its value is expressed in 16.16 fractional pixels, unless FT_LOAD_LINEAR_DESIGN is set when loading the glyph. This field can be important to perform correct WYSIWYG layout. Only relevant for outline glyphs. linearVertAdvance The advance height of the unhinted glyph. Its value is expressed in 16.16 fractional pixels, unless FT_LOAD_LINEAR_DESIGN is set when loading the glyph. This field can be important to perform correct WYSIWYG layout. Only relevant for outline glyphs. advance This shorthand is, depending on FT_LOAD_IGNORE_TRANSFORM , the transformed (hinted) advance width for the glyph, in 26.6 fractional pixel format. As specified with FT_LOAD_VERTICAL_LAYOUT , it uses either the horiAdvance or the vertAdvance value of metrics field. format This field indicates the format of the image contained in the glyph slot. Typically FT_GLYPH_FORMAT_BITMAP , FT_GLYPH_FORMAT_OUTLINE , or FT_GLYPH_FORMAT_COMPOSITE , but other values are possible. bitmap This field is used as a bitmap descriptor. Note that the address and content of the bitmap buffer can change between calls of FT_Load_Glyph and a few other functions. bitmap_left The bitmap's left bearing expressed in integer pixels. bitmap_top The bitmap's top bearing expressed in integer pixels. This is the distance from the baseline to the top-most glyph scanline, upwards y coordinates being positive . outline The outline descriptor for the current glyph image if its format is FT_GLYPH_FORMAT_OUTLINE . Once a glyph is loaded, outline can be transformed, distorted, emboldened, etc. However, it must not be freed. [Since 2.10.1] If FT_LOAD_NO_SCALE is set, outline coordinates of OpenType variation fonts for a selected instance are internally handled as 26.6 fractional font units but returned as (rounded) integers, as expected. To get unrounded font units, don't use FT_LOAD_NO_SCALE but load the glyph with FT_LOAD_NO_HINTING and scale it, using the font's units_per_EM value as the ppem. num_subglyphs The number of subglyphs in a composite glyph. This field is only valid for the composite glyph format that should normally only be loaded with the FT_LOAD_NO_RECURSE flag. subglyphs An array of subglyph descriptors for composite glyphs. There are num_subglyphs elements in there. Currently internal to FreeType. control_data Certain font drivers can also return the control data for a given glyph image (e.g. TrueType bytecode, Type 1 charstrings, etc.). This field is a pointer to such data; it is currently internal to FreeType. control_len This is the length in bytes of the control data. Currently internal to FreeType. other Reserved. lsb_delta The difference between hinted and unhinted left side bearing while auto-hinting is active. Zero otherwise. rsb_delta The difference between hinted and unhinted right side bearing while auto-hinting is active. Zero otherwise. note If FT_Load_Glyph is called with default flags (see FT_LOAD_DEFAULT ) the glyph image is loaded in the glyph slot in its native format (e.g., an outline glyph for TrueType and Type 1 formats). [Since 2.9] The prospective bitmap metrics are calculated according to FT_LOAD_TARGET_XXX and other flags even for the outline glyph, even if FT_LOAD_RENDER is not set. This image can later be converted into a bitmap by calling FT_Render_Glyph . This function searches the current renderer for the native image's format, then invokes it. The renderer is in charge of transforming the native image through the slot's face transformation fields, then converting it into a bitmap that is returned in slot->bitmap . Note that slot->bitmap_left and slot->bitmap_top are also used to specify the position of the bitmap relative to the current pen position (e.g., coordinates (0,0) on the baseline). Of course, slot->format is also changed to FT_GLYPH_FORMAT_BITMAP . Here is a small pseudo code fragment that shows how to use lsb_delta and rsb_delta to do fractional positioning of glyphs: FT_GlyphSlot slot = face->glyph; FT_Pos origin_x = 0; for all glyphs do <load glyph with `FT_Load_Glyph'> FT_Outline_Translate( slot->outline, origin_x & 63, 0 ); <save glyph image, or render glyph, or ...> <compute kern between current and next glyph and add it to `origin_x'> origin_x += slot->advance.x; origin_x += slot->lsb_delta - slot->rsb_delta; endfor Here is another small pseudo code fragment that shows how to use lsb_delta and rsb_delta to improve integer positioning of glyphs: FT_GlyphSlot slot = face->glyph; FT_Pos origin_x = 0; FT_Pos prev_rsb_delta = 0; for all glyphs do <compute kern between current and previous glyph and add it to `origin_x'> <load glyph with `FT_Load_Glyph'> if ( prev_rsb_delta - slot->lsb_delta > 32 ) origin_x -= 64; else if ( prev_rsb_delta - slot->lsb_delta < -31 ) origin_x += 64; prev_rsb_delta = slot->rsb_delta; <save glyph image, or render glyph, or ...> origin_x += slot->advance.x; endfor If you use strong auto-hinting, you must apply these delta values! Otherwise you will experience far too large inter-glyph spacing at small rendering sizes in most cases. Note that it doesn't harm to use the above code for other hinting modes also, since the delta values are zero then. FT_Glyph_Metrics \u00b6 Defined in FT_FREETYPE_H (freetype/freetype.h). typedef struct FT_Glyph_Metrics_ { FT_Pos width; FT_Pos height; FT_Pos horiBearingX; FT_Pos horiBearingY; FT_Pos horiAdvance; FT_Pos vertBearingX; FT_Pos vertBearingY; FT_Pos vertAdvance; } FT_Glyph_Metrics ; A structure to model the metrics of a single glyph. The values are expressed in 26.6 fractional pixel format; if the flag FT_LOAD_NO_SCALE has been used while loading the glyph, values are expressed in font units instead. fields width The glyph's width. height The glyph's height. horiBearingX Left side bearing for horizontal layout. horiBearingY Top side bearing for horizontal layout. horiAdvance Advance width for horizontal layout. vertBearingX Left side bearing for vertical layout. vertBearingY Top side bearing for vertical layout. Larger positive values mean further below the vertical glyph origin. vertAdvance Advance height for vertical layout. Positive values mean the glyph has a positive advance downward. note If not disabled with FT_LOAD_NO_HINTING , the values represent dimensions of the hinted glyph (in case hinting is applicable). Stroking a glyph with an outside border does not increase horiAdvance or vertAdvance ; you have to manually adjust these values to account for the added width and height. FreeType doesn't use the \u2018VORG\u2019 table data for CFF fonts because it doesn't have an interface to quickly retrieve the glyph height. The y coordinate of the vertical origin can be simply computed as vertBearingY + height after loading a glyph. FT_SubGlyph \u00b6 Defined in FT_FREETYPE_H (freetype/freetype.h). typedef struct FT_SubGlyphRec_* FT_SubGlyph ; The subglyph structure is an internal object used to describe subglyphs (for example, in the case of composites). note The subglyph implementation is not part of the high-level API, hence the forward structure declaration. You can however retrieve subglyph information with FT_Get_SubGlyph_Info . FT_Bitmap_Size \u00b6 Defined in FT_FREETYPE_H (freetype/freetype.h). typedef struct FT_Bitmap_Size_ { FT_Short height; FT_Short width; FT_Pos size; FT_Pos x_ppem; FT_Pos y_ppem; } FT_Bitmap_Size ; This structure models the metrics of a bitmap strike (i.e., a set of glyphs for a given point size and resolution) in a bitmap font. It is used for the available_sizes field of FT_Face . fields height The vertical distance, in pixels, between two consecutive baselines. It is always positive. width The average width, in pixels, of all glyphs in the strike. size The nominal size of the strike in 26.6 fractional points. This field is not very useful. x_ppem The horizontal ppem (nominal width) in 26.6 fractional pixels. y_ppem The vertical ppem (nominal height) in 26.6 fractional pixels. note Windows FNT: The nominal size given in a FNT font is not reliable. If the driver finds it incorrect, it sets size to some calculated values, and x_ppem and y_ppem to the pixel width and height given in the font, respectively. TrueType embedded bitmaps: size , width , and height values are not contained in the bitmap strike itself. They are computed from the global font parameters. FT_Init_FreeType \u00b6 Defined in FT_FREETYPE_H (freetype/freetype.h). FT_EXPORT( FT_Error ) FT_Init_FreeType ( FT_Library *alibrary ); Initialize a new FreeType library object. The set of modules that are registered by this function is determined at build time. output alibrary A handle to a new library object. return FreeType error code. 0 means success. note In case you want to provide your own memory allocating routines, use FT_New_Library instead, followed by a call to FT_Add_Default_Modules (or a series of calls to FT_Add_Module ) and FT_Set_Default_Properties . See the documentation of FT_Library and FT_Face for multi-threading issues. If you need reference-counting (cf. FT_Reference_Library ), use FT_New_Library and FT_Done_Library . If compilation option FT_CONFIG_OPTION_ENVIRONMENT_PROPERTIES is set, this function reads the FREETYPE_PROPERTIES environment variable to control driver properties. See section \u2018 Driver properties \u2019 for more. FT_Done_FreeType \u00b6 Defined in FT_FREETYPE_H (freetype/freetype.h). FT_EXPORT( FT_Error ) FT_Done_FreeType ( FT_Library library ); Destroy a given FreeType library object and all of its children, including resources, drivers, faces, sizes, etc. input library A handle to the target library object. return FreeType error code. 0 means success. FT_New_Face \u00b6 Defined in FT_FREETYPE_H (freetype/freetype.h). FT_EXPORT( FT_Error ) FT_New_Face ( FT_Library library, const char * filepathname, FT_Long face_index, FT_Face *aface ); Call FT_Open_Face to open a font by its pathname. inout library A handle to the library resource. input pathname A path to the font file. face_index See FT_Open_Face for a detailed description of this parameter. output aface A handle to a new face object. If face_index is greater than or equal to zero, it must be non- NULL . return FreeType error code. 0 means success. note Use FT_Done_Face to destroy the created FT_Face object (along with its slot and sizes). FT_Done_Face \u00b6 Defined in FT_FREETYPE_H (freetype/freetype.h). FT_EXPORT( FT_Error ) FT_Done_Face ( FT_Face face ); Discard a given face object, as well as all of its child slots and sizes. input face A handle to a target face object. return FreeType error code. 0 means success. note See the discussion of reference counters in the description of FT_Reference_Face . FT_Reference_Face \u00b6 Defined in FT_FREETYPE_H (freetype/freetype.h). FT_EXPORT( FT_Error ) FT_Reference_Face ( FT_Face face ); A counter gets initialized to 1 at the time an FT_Face structure is created. This function increments the counter. FT_Done_Face then only destroys a face if the counter is 1, otherwise it simply decrements the counter. This function helps in managing life-cycles of structures that reference FT_Face objects. input face A handle to a target face object. return FreeType error code. 0 means success. since 2.4.2 FT_New_Memory_Face \u00b6 Defined in FT_FREETYPE_H (freetype/freetype.h). FT_EXPORT( FT_Error ) FT_New_Memory_Face ( FT_Library library, const FT_Byte * file_base, FT_Long file_size, FT_Long face_index, FT_Face *aface ); Call FT_Open_Face to open a font that has been loaded into memory. inout library A handle to the library resource. input file_base A pointer to the beginning of the font data. file_size The size of the memory chunk used by the font data. face_index See FT_Open_Face for a detailed description of this parameter. output aface A handle to a new face object. If face_index is greater than or equal to zero, it must be non- NULL . return FreeType error code. 0 means success. note You must not deallocate the memory before calling FT_Done_Face . FT_Face_Properties \u00b6 Defined in FT_FREETYPE_H (freetype/freetype.h). FT_EXPORT( FT_Error ) FT_Face_Properties ( FT_Face face, FT_UInt num_properties, FT_Parameter * properties ); Set or override certain (library or module-wide) properties on a face-by-face basis. Useful for finer-grained control and avoiding locks on shared structures (threads can modify their own faces as they see fit). Contrary to FT_Property_Set , this function uses FT_Parameter so that you can pass multiple properties to the target face in one call. Note that only a subset of the available properties can be controlled. FT_PARAM_TAG_STEM_DARKENING (stem darkening, corresponding to the property no-stem-darkening provided by the \u2018autofit\u2019, \u2018cff\u2019, \u2018type1\u2019, and \u2018t1cid\u2019 modules; see no-stem-darkening ). FT_PARAM_TAG_LCD_FILTER_WEIGHTS (LCD filter weights, corresponding to function FT_Library_SetLcdFilterWeights ). FT_PARAM_TAG_RANDOM_SEED (seed value for the CFF, Type 1, and CID \u2018random\u2019 operator, corresponding to the random-seed property provided by the \u2018cff\u2019, \u2018type1\u2019, and \u2018t1cid\u2019 modules; see random-seed ). Pass NULL as data in FT_Parameter for a given tag to reset the option and use the library or module default again. input face A handle to the source face object. num_properties The number of properties that follow. properties A handle to an FT_Parameter array with num_properties elements. return FreeType error code. 0 means success. example Here is an example that sets three properties. You must define FT_CONFIG_OPTION_SUBPIXEL_RENDERING to make the LCD filter examples work. FT_Parameter property1; FT_Bool darken_stems = 1; FT_Parameter property2; FT_LcdFiveTapFilter custom_weight = { 0x11, 0x44, 0x56, 0x44, 0x11 }; FT_Parameter property3; FT_Int32 random_seed = 314159265; FT_Parameter properties[3] = { property1, property2, property3 }; property1.tag = FT_PARAM_TAG_STEM_DARKENING; property1.data = &darken_stems; property2.tag = FT_PARAM_TAG_LCD_FILTER_WEIGHTS; property2.data = custom_weight; property3.tag = FT_PARAM_TAG_RANDOM_SEED; property3.data = &random_seed; FT_Face_Properties( face, 3, properties ); The next example resets a single property to its default value. FT_Parameter property; property.tag = FT_PARAM_TAG_LCD_FILTER_WEIGHTS; property.data = NULL; FT_Face_Properties( face, 1, &property ); since 2.8 FT_Open_Face \u00b6 Defined in FT_FREETYPE_H (freetype/freetype.h). FT_EXPORT( FT_Error ) FT_Open_Face ( FT_Library library, const FT_Open_Args * args, FT_Long face_index, FT_Face *aface ); Create a face object from a given resource described by FT_Open_Args . inout library A handle to the library resource. input args A pointer to an FT_Open_Args structure that must be filled by the caller. face_index This field holds two different values. Bits 0-15 are the index of the face in the font file (starting with value 0). Set it to 0 if there is only one face in the font file. [Since 2.6.1] Bits 16-30 are relevant to GX and OpenType variation fonts only, specifying the named instance index for the current face index (starting with value 1; value 0 makes FreeType ignore named instances). For non-variation fonts, bits 16-30 are ignored. Assuming that you want to access the third named instance in face 4, face_index should be set to 0x00030004. If you want to access face 4 without variation handling, simply set face_index to value 4. FT_Open_Face and its siblings can be used to quickly check whether the font format of a given font resource is supported by FreeType. In general, if the face_index argument is negative, the function's return value is 0 if the font format is recognized, or non-zero otherwise. The function allocates a more or less empty face handle in *aface (if aface isn't NULL ); the only two useful fields in this special case are face->num_faces and face->style_flags . For any negative value of face_index , face->num_faces gives the number of faces within the font file. For the negative value \u2018-(N+1)\u2019 (with \u2018N\u2019 a non-negative 16-bit value), bits 16-30 in face->style_flags give the number of named instances in face \u2018N\u2019 if we have a variation font (or zero otherwise). After examination, the returned FT_Face structure should be deallocated with a call to FT_Done_Face . output aface A handle to a new face object. If face_index is greater than or equal to zero, it must be non- NULL . return FreeType error code. 0 means success. note Unlike FreeType 1.x, this function automatically creates a glyph slot for the face object that can be accessed directly through face->glyph . Each new face object created with this function also owns a default FT_Size object, accessible as face->size . One FT_Library instance can have multiple face objects, this is, FT_Open_Face and its siblings can be called multiple times using the same library argument. See the discussion of reference counters in the description of FT_Reference_Face . example To loop over all faces, use code similar to the following snippet (omitting the error handling). ... FT_Face face; FT_Long i, num_faces; error = FT_Open_Face( library, args, -1, &face ); if ( error ) { ... } num_faces = face->num_faces; FT_Done_Face( face ); for ( i = 0; i < num_faces; i++ ) { ... error = FT_Open_Face( library, args, i, &face ); ... FT_Done_Face( face ); ... } To loop over all valid values for face_index , use something similar to the following snippet, again without error handling. The code accesses all faces immediately (thus only a single call of FT_Open_Face within the do-loop), with and without named instances. ... FT_Face face; FT_Long num_faces = 0; FT_Long num_instances = 0; FT_Long face_idx = 0; FT_Long instance_idx = 0; do { FT_Long id = ( instance_idx << 16 ) + face_idx; error = FT_Open_Face( library, args, id, &face ); if ( error ) { ... } num_faces = face->num_faces; num_instances = face->style_flags >> 16; ... FT_Done_Face( face ); if ( instance_idx < num_instances ) instance_idx++; else { face_idx++; instance_idx = 0; } } while ( face_idx < num_faces ) FT_Open_Args \u00b6 Defined in FT_FREETYPE_H (freetype/freetype.h). typedef struct FT_Open_Args_ { FT_UInt flags; const FT_Byte * memory_base; FT_Long memory_size; FT_String * pathname; FT_Stream stream; FT_Module driver; FT_Int num_params; FT_Parameter * params; } FT_Open_Args ; A structure to indicate how to open a new font file or stream. A pointer to such a structure can be used as a parameter for the functions FT_Open_Face and FT_Attach_Stream . fields flags A set of bit flags indicating how to use the structure. memory_base The first byte of the file in memory. memory_size The size in bytes of the file in memory. pathname A pointer to an 8-bit file pathname. The pointer is not owned by FreeType. stream A handle to a source stream object. driver This field is exclusively used by FT_Open_Face ; it simply specifies the font driver to use for opening the face. If set to NULL , FreeType tries to load the face with each one of the drivers in its list. num_params The number of extra parameters. params Extra parameters passed to the font driver when opening a new face. note The stream type is determined by the contents of flags that are tested in the following order by FT_Open_Face : If the FT_OPEN_MEMORY bit is set, assume that this is a memory file of memory_size bytes, located at memory_address . The data are not copied, and the client is responsible for releasing and destroying them after the corresponding call to FT_Done_Face . Otherwise, if the FT_OPEN_STREAM bit is set, assume that a custom input stream stream is used. Otherwise, if the FT_OPEN_PATHNAME bit is set, assume that this is a normal file and use pathname to open it. If the FT_OPEN_DRIVER bit is set, FT_Open_Face only tries to open the file with the driver whose handler is in driver . If the FT_OPEN_PARAMS bit is set, the parameters given by num_params and params is used. They are ignored otherwise. Ideally, both the pathname and params fields should be tagged as \u2018const\u2019; this is missing for API backward compatibility. In other words, applications should treat them as read-only. FT_Parameter \u00b6 Defined in FT_FREETYPE_H (freetype/freetype.h). typedef struct FT_Parameter_ { FT_ULong tag; FT_Pointer data; } FT_Parameter ; A simple structure to pass more or less generic parameters to FT_Open_Face and FT_Face_Properties . fields tag A four-byte identification tag. data A pointer to the parameter data. note The ID and function of parameters are driver-specific. See section \u2018 Parameter Tags \u2019 for more information. FT_Attach_File \u00b6 Defined in FT_FREETYPE_H (freetype/freetype.h). FT_EXPORT( FT_Error ) FT_Attach_File ( FT_Face face, const char * filepathname ); Call FT_Attach_Stream to attach a file. inout face The target face object. input filepathname The pathname. return FreeType error code. 0 means success. FT_Attach_Stream \u00b6 Defined in FT_FREETYPE_H (freetype/freetype.h). FT_EXPORT( FT_Error ) FT_Attach_Stream ( FT_Face face, FT_Open_Args * parameters ); \u2018Attach\u2019 data to a face object. Normally, this is used to read additional information for the face object. For example, you can attach an AFM file that comes with a Type 1 font to get the kerning values and other metrics. inout face The target face object. input parameters A pointer to FT_Open_Args that must be filled by the caller. return FreeType error code. 0 means success. note The meaning of the \u2018attach\u2019 (i.e., what really happens when the new file is read) is not fixed by FreeType itself. It really depends on the font format (and thus the font driver). Client applications are expected to know what they are doing when invoking this function. Most drivers simply do not implement file or stream attachments. FT_Set_Char_Size \u00b6 Defined in FT_FREETYPE_H (freetype/freetype.h). FT_EXPORT( FT_Error ) FT_Set_Char_Size ( FT_Face face, FT_F26Dot6 char_width, FT_F26Dot6 char_height, FT_UInt horz_resolution, FT_UInt vert_resolution ); Call FT_Request_Size to request the nominal size (in points). inout face A handle to a target face object. input char_width The nominal width, in 26.6 fractional points. char_height The nominal height, in 26.6 fractional points. horz_resolution The horizontal resolution in dpi. vert_resolution The vertical resolution in dpi. return FreeType error code. 0 means success. note While this function allows fractional points as input values, the resulting ppem value for the given resolution is always rounded to the nearest integer. If either the character width or height is zero, it is set equal to the other value. If either the horizontal or vertical resolution is zero, it is set equal to the other value. A character width or height smaller than 1pt is set to 1pt; if both resolution values are zero, they are set to 72dpi. Don't use this function if you are using the FreeType cache API. FT_Set_Pixel_Sizes \u00b6 Defined in FT_FREETYPE_H (freetype/freetype.h). FT_EXPORT( FT_Error ) FT_Set_Pixel_Sizes ( FT_Face face, FT_UInt pixel_width, FT_UInt pixel_height ); Call FT_Request_Size to request the nominal size (in pixels). inout face A handle to the target face object. input pixel_width The nominal width, in pixels. pixel_height The nominal height, in pixels. return FreeType error code. 0 means success. note You should not rely on the resulting glyphs matching or being constrained to this pixel size. Refer to FT_Request_Size to understand how requested sizes relate to actual sizes. Don't use this function if you are using the FreeType cache API. FT_Request_Size \u00b6 Defined in FT_FREETYPE_H (freetype/freetype.h). FT_EXPORT( FT_Error ) FT_Request_Size ( FT_Face face, FT_Size_Request req ); Resize the scale of the active FT_Size object in a face. inout face A handle to a target face object. input req A pointer to a FT_Size_RequestRec . return FreeType error code. 0 means success. note Although drivers may select the bitmap strike matching the request, you should not rely on this if you intend to select a particular bitmap strike. Use FT_Select_Size instead in that case. The relation between the requested size and the resulting glyph size is dependent entirely on how the size is defined in the source face. The font designer chooses the final size of each glyph relative to this size. For more information refer to \u2018 https://www.freetype.org/freetype2/docs/glyphs/glyphs-2.html \u2019. Contrary to FT_Set_Char_Size , this function doesn't have special code to normalize zero-valued widths, heights, or resolutions (which lead to errors in most cases). Don't use this function if you are using the FreeType cache API. FT_Select_Size \u00b6 Defined in FT_FREETYPE_H (freetype/freetype.h). FT_EXPORT( FT_Error ) FT_Select_Size ( FT_Face face, FT_Int strike_index ); Select a bitmap strike. To be more precise, this function sets the scaling factors of the active FT_Size object in a face so that bitmaps from this particular strike are taken by FT_Load_Glyph and friends. inout face A handle to a target face object. input strike_index The index of the bitmap strike in the available_sizes field of FT_FaceRec structure. return FreeType error code. 0 means success. note For bitmaps embedded in outline fonts it is common that only a subset of the available glyphs at a given ppem value is available. FreeType silently uses outlines if there is no bitmap for a given glyph index. For GX and OpenType variation fonts, a bitmap strike makes sense only if the default instance is active (this is, no glyph variation takes place); otherwise, FreeType simply ignores bitmap strikes. The same is true for all named instances that are different from the default instance. Don't use this function if you are using the FreeType cache API. FT_Size_Request_Type \u00b6 Defined in FT_FREETYPE_H (freetype/freetype.h). typedef enum FT_Size_Request_Type_ { FT_SIZE_REQUEST_TYPE_NOMINAL , FT_SIZE_REQUEST_TYPE_REAL_DIM , FT_SIZE_REQUEST_TYPE_BBOX , FT_SIZE_REQUEST_TYPE_CELL , FT_SIZE_REQUEST_TYPE_SCALES , FT_SIZE_REQUEST_TYPE_MAX } FT_Size_Request_Type ; An enumeration type that lists the supported size request types, i.e., what input size (in font units) maps to the requested output size (in pixels, as computed from the arguments of FT_Size_Request ). values FT_SIZE_REQUEST_TYPE_NOMINAL The nominal size. The units_per_EM field of FT_FaceRec is used to determine both scaling values. This is the standard scaling found in most applications. In particular, use this size request type for TrueType fonts if they provide optical scaling or something similar. Note, however, that units_per_EM is a rather abstract value which bears no relation to the actual size of the glyphs in a font. FT_SIZE_REQUEST_TYPE_REAL_DIM The real dimension. The sum of the ascender and (minus of) the descender fields of FT_FaceRec is used to determine both scaling values. FT_SIZE_REQUEST_TYPE_BBOX The font bounding box. The width and height of the bbox field of FT_FaceRec are used to determine the horizontal and vertical scaling value, respectively. FT_SIZE_REQUEST_TYPE_CELL The max_advance_width field of FT_FaceRec is used to determine the horizontal scaling value; the vertical scaling value is determined the same way as FT_SIZE_REQUEST_TYPE_REAL_DIM does. Finally, both scaling values are set to the smaller one. This type is useful if you want to specify the font size for, say, a window of a given dimension and 80x24 cells. FT_SIZE_REQUEST_TYPE_SCALES Specify the scaling values directly. note The above descriptions only apply to scalable formats. For bitmap formats, the behaviour is up to the driver. See the note section of FT_Size_Metrics if you wonder how size requesting relates to scaling values. FT_Size_RequestRec \u00b6 Defined in FT_FREETYPE_H (freetype/freetype.h). typedef struct FT_Size_RequestRec_ { FT_Size_Request_Type type; FT_Long width; FT_Long height; FT_UInt horiResolution; FT_UInt vertResolution; } FT_Size_RequestRec ; A structure to model a size request. fields type See FT_Size_Request_Type . width The desired width, given as a 26.6 fractional point value (with 72pt = 1in). height The desired height, given as a 26.6 fractional point value (with 72pt = 1in). horiResolution The horizontal resolution (dpi, i.e., pixels per inch). If set to zero, width is treated as a 26.6 fractional pixel value, which gets internally rounded to an integer. vertResolution The vertical resolution (dpi, i.e., pixels per inch). If set to zero, height is treated as a 26.6 fractional pixel value, which gets internally rounded to an integer. note If width is zero, the horizontal scaling value is set equal to the vertical scaling value, and vice versa. If type is FT_SIZE_REQUEST_TYPE_SCALES , width and height are interpreted directly as 16.16 fractional scaling values, without any further modification, and both horiResolution and vertResolution are ignored. FT_Size_Request \u00b6 Defined in FT_FREETYPE_H (freetype/freetype.h). typedef struct FT_Size_RequestRec_ * FT_Size_Request ; A handle to a size request structure. FT_Set_Transform \u00b6 Defined in FT_FREETYPE_H (freetype/freetype.h). FT_EXPORT( void ) FT_Set_Transform ( FT_Face face, FT_Matrix * matrix, FT_Vector * delta ); Set the transformation that is applied to glyph images when they are loaded into a glyph slot through FT_Load_Glyph . inout face A handle to the source face object. input matrix A pointer to the transformation's 2x2 matrix. Use NULL for the identity matrix. delta A pointer to the translation vector. Use NULL for the null vector. note This function is provided as a convenience, but keep in mind that FT_Matrix coefficients are only 16.16 fixed point values, which can limit the accuracy of the results. Using floating-point computations to perform the transform directly in client code instead will always yield better numbers. The transformation is only applied to scalable image formats after the glyph has been loaded. It means that hinting is unaltered by the transformation and is performed on the character size given in the last call to FT_Set_Char_Size or FT_Set_Pixel_Sizes . Note that this also transforms the face.glyph.advance field, but not the values in face.glyph.metrics . FT_Load_Glyph \u00b6 Defined in FT_FREETYPE_H (freetype/freetype.h). FT_EXPORT( FT_Error ) FT_Load_Glyph ( FT_Face face, FT_UInt glyph_index, FT_Int32 load_flags ); Load a glyph into the glyph slot of a face object. inout face A handle to the target face object where the glyph is loaded. input glyph_index The index of the glyph in the font file. For CID-keyed fonts (either in PS or in CFF format) this argument specifies the CID value. load_flags A flag indicating what to load for this glyph. The FT_LOAD_XXX constants can be used to control the glyph loading process (e.g., whether the outline should be scaled, whether to load bitmaps or not, whether to hint the outline, etc). return FreeType error code. 0 means success. note The loaded glyph may be transformed. See FT_Set_Transform for the details. For subsetted CID-keyed fonts, FT_Err_Invalid_Argument is returned for invalid CID values (this is, for CID values that don't have a corresponding glyph in the font). See the discussion of the FT_FACE_FLAG_CID_KEYED flag for more details. If you receive FT_Err_Glyph_Too_Big , try getting the glyph outline at EM size, then scale it manually and fill it as a graphics operation. FT_Get_Char_Index \u00b6 Defined in FT_FREETYPE_H (freetype/freetype.h). FT_EXPORT( FT_UInt ) FT_Get_Char_Index ( FT_Face face, FT_ULong charcode ); Return the glyph index of a given character code. This function uses the currently selected charmap to do the mapping. input face A handle to the source face object. charcode The character code. return The glyph index. 0 means \u2018undefined character code\u2019. note If you use FreeType to manipulate the contents of font files directly, be aware that the glyph index returned by this function doesn't always correspond to the internal indices used within the file. This is done to ensure that value 0 always corresponds to the \u2018missing glyph\u2019. If the first glyph is not named \u2018.notdef\u2019, then for Type 1 and Type 42 fonts, \u2018.notdef\u2019 will be moved into the glyph ID 0 position, and whatever was there will be moved to the position \u2018.notdef\u2019 had. For Type 1 fonts, if there is no \u2018.notdef\u2019 glyph at all, then one will be created at index 0 and whatever was there will be moved to the last index -- Type 42 fonts are considered invalid under this condition. FT_Get_First_Char \u00b6 Defined in FT_FREETYPE_H (freetype/freetype.h). FT_EXPORT( FT_ULong ) FT_Get_First_Char ( FT_Face face, FT_UInt *agindex ); Return the first character code in the current charmap of a given face, together with its corresponding glyph index. input face A handle to the source face object. output agindex Glyph index of first character code. 0 if charmap is empty. return The charmap's first character code. note You should use this function together with FT_Get_Next_Char to parse all character codes available in a given charmap. The code should look like this: FT_ULong charcode; FT_UInt gindex; charcode = FT_Get_First_Char( face, &gindex ); while ( gindex != 0 ) { ... do something with (charcode,gindex) pair ... charcode = FT_Get_Next_Char( face, charcode, &gindex ); } Be aware that character codes can have values up to 0xFFFFFFFF; this might happen for non-Unicode or malformed cmaps. However, even with regular Unicode encoding, so-called \u2018last resort fonts\u2019 (using SFNT cmap format 13, see function FT_Get_CMap_Format ) normally have entries for all Unicode characters up to 0x1FFFFF, which can cause a lot of iterations. Note that *agindex is set to 0 if the charmap is empty. The result itself can be 0 in two cases: if the charmap is empty or if the value 0 is the first valid character code. FT_Get_Next_Char \u00b6 Defined in FT_FREETYPE_H (freetype/freetype.h). FT_EXPORT( FT_ULong ) FT_Get_Next_Char ( FT_Face face, FT_ULong char_code, FT_UInt *agindex ); Return the next character code in the current charmap of a given face following the value char_code , as well as the corresponding glyph index. input face A handle to the source face object. char_code The starting character code. output agindex Glyph index of next character code. 0 if charmap is empty. return The charmap's next character code. note You should use this function with FT_Get_First_Char to walk over all character codes available in a given charmap. See the note for that function for a simple code example. Note that *agindex is set to 0 when there are no more codes in the charmap. FT_Get_Name_Index \u00b6 Defined in FT_FREETYPE_H (freetype/freetype.h). FT_EXPORT( FT_UInt ) FT_Get_Name_Index ( FT_Face face, const FT_String * glyph_name ); Return the glyph index of a given glyph name. input face A handle to the source face object. glyph_name The glyph name. return The glyph index. 0 means \u2018undefined character code\u2019. FT_Load_Char \u00b6 Defined in FT_FREETYPE_H (freetype/freetype.h). FT_EXPORT( FT_Error ) FT_Load_Char ( FT_Face face, FT_ULong char_code, FT_Int32 load_flags ); Load a glyph into the glyph slot of a face object, accessed by its character code. inout face A handle to a target face object where the glyph is loaded. input char_code The glyph's character code, according to the current charmap used in the face. load_flags A flag indicating what to load for this glyph. The FT_LOAD_XXX constants can be used to control the glyph loading process (e.g., whether the outline should be scaled, whether to load bitmaps or not, whether to hint the outline, etc). return FreeType error code. 0 means success. note This function simply calls FT_Get_Char_Index and FT_Load_Glyph . Many fonts contain glyphs that can't be loaded by this function since its glyph indices are not listed in any of the font's charmaps. If no active cmap is set up (i.e., face->charmap is zero), the call to FT_Get_Char_Index is omitted, and the function behaves identically to FT_Load_Glyph . FT_LOAD_TARGET_MODE \u00b6 Defined in FT_FREETYPE_H (freetype/freetype.h). # define FT_LOAD_TARGET_MODE ( x ) ( ( FT_Render_Mode )( ( (x) >> 16 ) & 15 ) ) Return the FT_Render_Mode corresponding to a given FT_LOAD_TARGET_XXX value. FT_Render_Glyph \u00b6 Defined in FT_FREETYPE_H (freetype/freetype.h). FT_EXPORT( FT_Error ) FT_Render_Glyph ( FT_GlyphSlot slot, FT_Render_Mode render_mode ); Convert a given glyph image to a bitmap. It does so by inspecting the glyph image format, finding the relevant renderer, and invoking it. inout slot A handle to the glyph slot containing the image to convert. input render_mode The render mode used to render the glyph image into a bitmap. See FT_Render_Mode for a list of possible values. If FT_RENDER_MODE_NORMAL is used, a previous call of FT_Load_Glyph with flag FT_LOAD_COLOR makes FT_Render_Glyph provide a default blending of colored glyph layers associated with the current glyph slot (provided the font contains such layers) instead of rendering the glyph slot's outline. This is an experimental feature; see FT_LOAD_COLOR for more information. return FreeType error code. 0 means success. note To get meaningful results, font scaling values must be set with functions like FT_Set_Char_Size before calling FT_Render_Glyph . When FreeType outputs a bitmap of a glyph, it really outputs an alpha coverage map. If a pixel is completely covered by a filled-in outline, the bitmap contains 0xFF at that pixel, meaning that 0xFF/0xFF fraction of that pixel is covered, meaning the pixel is 100% black (or 0% bright). If a pixel is only 50% covered (value 0x80), the pixel is made 50% black (50% bright or a middle shade of grey). 0% covered means 0% black (100% bright or white). On high-DPI screens like on smartphones and tablets, the pixels are so small that their chance of being completely covered and therefore completely black are fairly good. On the low-DPI screens, however, the situation is different. The pixels are too large for most of the details of a glyph and shades of gray are the norm rather than the exception. This is relevant because all our screens have a second problem: they are not linear. 1 + 1 is not 2. Twice the value does not result in twice the brightness. When a pixel is only 50% covered, the coverage map says 50% black, and this translates to a pixel value of 128 when you use 8 bits per channel (0-255). However, this does not translate to 50% brightness for that pixel on our sRGB and gamma 2.2 screens. Due to their non-linearity, they dwell longer in the darks and only a pixel value of about 186 results in 50% brightness -- 128 ends up too dark on both bright and dark backgrounds. The net result is that dark text looks burnt-out, pixely and blotchy on bright background, bright text too frail on dark backgrounds, and colored text on colored background (for example, red on green) seems to have dark halos or \u2018dirt\u2019 around it. The situation is especially ugly for diagonal stems like in \u2018w\u2019 glyph shapes where the quality of FreeType's anti-aliasing depends on the correct display of grays. On high-DPI screens where smaller, fully black pixels reign supreme, this doesn't matter, but on our low-DPI screens with all the gray shades, it does. 0% and 100% brightness are the same things in linear and non-linear space, just all the shades in-between aren't. The blending function for placing text over a background is dst = alpha * src + (1 - alpha) * dst , which is known as the OVER operator. To correctly composite an antialiased pixel of a glyph onto a surface, take the foreground and background colors (e.g., in sRGB space) and apply gamma to get them in a linear space, use OVER to blend the two linear colors using the glyph pixel as the alpha value (remember, the glyph bitmap is an alpha coverage bitmap), and apply inverse gamma to the blended pixel and write it back to the image. Internal testing at Adobe found that a target inverse gamma of 1.8 for step 3 gives good results across a wide range of displays with an sRGB gamma curve or a similar one. This process can cost performance. There is an approximation that does not need to know about the background color; see https://bel.fi/alankila/lcd/ and https://bel.fi/alankila/lcd/alpcor.html for details. ATTENTION : Linear blending is even more important when dealing with subpixel-rendered glyphs to prevent color-fringing! A subpixel-rendered glyph must first be filtered with a filter that gives equal weight to the three color primaries and does not exceed a sum of 0x100, see section \u2018 Subpixel Rendering \u2019. Then the only difference to gray linear blending is that subpixel-rendered linear blending is done 3 times per pixel: red foreground subpixel to red background subpixel and so on for green and blue. FT_Render_Mode \u00b6 Defined in FT_FREETYPE_H (freetype/freetype.h). typedef enum FT_Render_Mode_ { FT_RENDER_MODE_NORMAL = 0, FT_RENDER_MODE_LIGHT , FT_RENDER_MODE_MONO , FT_RENDER_MODE_LCD , FT_RENDER_MODE_LCD_V , FT_RENDER_MODE_MAX } FT_Render_Mode ; /* these constants are deprecated; use the corresponding */ /* ` FT_Render_Mode ` values instead */ # define ft_render_mode_normal FT_RENDER_MODE_NORMAL # define ft_render_mode_mono FT_RENDER_MODE_MONO Render modes supported by FreeType 2. Each mode corresponds to a specific type of scanline conversion performed on the outline. For bitmap fonts and embedded bitmaps the bitmap->pixel_mode field in the FT_GlyphSlotRec structure gives the format of the returned bitmap. All modes except FT_RENDER_MODE_MONO use 256 levels of opacity, indicating pixel coverage. Use linear alpha blending and gamma correction to correctly render non-monochrome glyph bitmaps onto a surface; see FT_Render_Glyph . values FT_RENDER_MODE_NORMAL Default render mode; it corresponds to 8-bit anti-aliased bitmaps. FT_RENDER_MODE_LIGHT This is equivalent to FT_RENDER_MODE_NORMAL . It is only defined as a separate value because render modes are also used indirectly to define hinting algorithm selectors. See FT_LOAD_TARGET_XXX for details. FT_RENDER_MODE_MONO This mode corresponds to 1-bit bitmaps (with 2 levels of opacity). FT_RENDER_MODE_LCD This mode corresponds to horizontal RGB and BGR subpixel displays like LCD screens. It produces 8-bit bitmaps that are 3 times the width of the original glyph outline in pixels, and which use the FT_PIXEL_MODE_LCD mode. FT_RENDER_MODE_LCD_V This mode corresponds to vertical RGB and BGR subpixel displays (like PDA screens, rotated LCD displays, etc.). It produces 8-bit bitmaps that are 3 times the height of the original glyph outline in pixels and use the FT_PIXEL_MODE_LCD_V mode. note The selected render mode only affects vector glyphs of a font. Embedded bitmaps often have a different pixel mode like FT_PIXEL_MODE_MONO . You can use FT_Bitmap_Convert to transform them into 8-bit pixmaps. FT_Get_Kerning \u00b6 Defined in FT_FREETYPE_H (freetype/freetype.h). FT_EXPORT( FT_Error ) FT_Get_Kerning ( FT_Face face, FT_UInt left_glyph, FT_UInt right_glyph, FT_UInt kern_mode, FT_Vector *akerning ); Return the kerning vector between two glyphs of the same face. input face A handle to a source face object. left_glyph The index of the left glyph in the kern pair. right_glyph The index of the right glyph in the kern pair. kern_mode See FT_Kerning_Mode for more information. Determines the scale and dimension of the returned kerning vector. output akerning The kerning vector. This is either in font units, fractional pixels (26.6 format), or pixels for scalable formats, and in pixels for fixed-sizes formats. return FreeType error code. 0 means success. note Only horizontal layouts (left-to-right & right-to-left) are supported by this method. Other layouts, or more sophisticated kernings, are out of the scope of this API function -- they can be implemented through format-specific interfaces. Kerning for OpenType fonts implemented in a \u2018GPOS\u2019 table is not supported; use FT_HAS_KERNING to find out whether a font has data that can be extracted with FT_Get_Kerning . FT_Kerning_Mode \u00b6 Defined in FT_FREETYPE_H (freetype/freetype.h). typedef enum FT_Kerning_Mode_ { FT_KERNING_DEFAULT = 0, FT_KERNING_UNFITTED , FT_KERNING_UNSCALED } FT_Kerning_Mode ; /* these constants are deprecated; use the corresponding */ /* ` FT_Kerning_Mode ` values instead */ # define ft_kerning_default FT_KERNING_DEFAULT # define ft_kerning_unfitted FT_KERNING_UNFITTED # define ft_kerning_unscaled FT_KERNING_UNSCALED An enumeration to specify the format of kerning values returned by FT_Get_Kerning . values FT_KERNING_DEFAULT Return grid-fitted kerning distances in 26.6 fractional pixels. FT_KERNING_UNFITTED Return un-grid-fitted kerning distances in 26.6 fractional pixels. FT_KERNING_UNSCALED Return the kerning vector in original font units. note FT_KERNING_DEFAULT returns full pixel values; it also makes FreeType heuristically scale down kerning distances at small ppem values so that they don't become too big. Both FT_KERNING_DEFAULT and FT_KERNING_UNFITTED use the current horizontal scaling factor (as set e.g. with FT_Set_Char_Size ) to convert font units to pixels. FT_Get_Track_Kerning \u00b6 Defined in FT_FREETYPE_H (freetype/freetype.h). FT_EXPORT( FT_Error ) FT_Get_Track_Kerning ( FT_Face face, FT_Fixed point_size, FT_Int degree, FT_Fixed * akerning ); Return the track kerning for a given face object at a given size. input face A handle to a source face object. point_size The point size in 16.16 fractional points. degree The degree of tightness. Increasingly negative values represent tighter track kerning, while increasingly positive values represent looser track kerning. Value zero means no track kerning. output akerning The kerning in 16.16 fractional points, to be uniformly applied between all glyphs. return FreeType error code. 0 means success. note Currently, only the Type 1 font driver supports track kerning, using data from AFM files (if attached with FT_Attach_File or FT_Attach_Stream ). Only very few AFM files come with track kerning data; please refer to Adobe's AFM specification for more details. FT_Get_Glyph_Name \u00b6 Defined in FT_FREETYPE_H (freetype/freetype.h). FT_EXPORT( FT_Error ) FT_Get_Glyph_Name ( FT_Face face, FT_UInt glyph_index, FT_Pointer buffer, FT_UInt buffer_max ); Retrieve the ASCII name of a given glyph in a face. This only works for those faces where FT_HAS_GLYPH_NAMES (face) returns 1. input face A handle to a source face object. glyph_index The glyph index. buffer_max The maximum number of bytes available in the buffer. output buffer A pointer to a target buffer where the name is copied to. return FreeType error code. 0 means success. note An error is returned if the face doesn't provide glyph names or if the glyph index is invalid. In all cases of failure, the first byte of buffer is set to 0 to indicate an empty name. The glyph name is truncated to fit within the buffer if it is too long. The returned string is always zero-terminated. Be aware that FreeType reorders glyph indices internally so that glyph index 0 always corresponds to the \u2018missing glyph\u2019 (called \u2018.notdef\u2019). This function always returns an error if the config macro FT_CONFIG_OPTION_NO_GLYPH_NAMES is not defined in ftoption.h . FT_Get_Postscript_Name \u00b6 Defined in FT_FREETYPE_H (freetype/freetype.h). FT_EXPORT( const char * ) FT_Get_Postscript_Name ( FT_Face face ); Retrieve the ASCII PostScript name of a given face, if available. This only works with PostScript, TrueType, and OpenType fonts. input face A handle to the source face object. return A pointer to the face's PostScript name. NULL if unavailable. note The returned pointer is owned by the face and is destroyed with it. For variation fonts, this string changes if you select a different instance, and you have to call FT_Get_PostScript_Name again to retrieve it. FreeType follows Adobe TechNote #5902, \u2018Generating PostScript Names for Fonts Using OpenType Font Variations\u2019. https://download.macromedia.com/pub/developer/opentype/tech-notes/5902.AdobePSNameGeneration.html [Since 2.9] Special PostScript names for named instances are only returned if the named instance is set with FT_Set_Named_Instance (and the font has corresponding entries in its \u2018fvar\u2019 table). If FT_IS_VARIATION returns true, the algorithmically derived PostScript name is provided, not looking up special entries for named instances. FT_CharMapRec \u00b6 Defined in FT_FREETYPE_H (freetype/freetype.h). typedef struct FT_CharMapRec_ { FT_Face face; FT_Encoding encoding; FT_UShort platform_id; FT_UShort encoding_id; } FT_CharMapRec ; The base charmap structure. fields face A handle to the parent face object. encoding An FT_Encoding tag identifying the charmap. Use this with FT_Select_Charmap . platform_id An ID number describing the platform for the following encoding ID. This comes directly from the TrueType specification and gets emulated for other formats. encoding_id A platform-specific encoding number. This also comes from the TrueType specification and gets emulated similarly. FT_Select_Charmap \u00b6 Defined in FT_FREETYPE_H (freetype/freetype.h). FT_EXPORT( FT_Error ) FT_Select_Charmap ( FT_Face face, FT_Encoding encoding ); Select a given charmap by its encoding tag (as listed in freetype.h ). inout face A handle to the source face object. input encoding A handle to the selected encoding. return FreeType error code. 0 means success. note This function returns an error if no charmap in the face corresponds to the encoding queried here. Because many fonts contain more than a single cmap for Unicode encoding, this function has some special code to select the one that covers Unicode best (\u2018best\u2019 in the sense that a UCS-4 cmap is preferred to a UCS-2 cmap). It is thus preferable to FT_Set_Charmap in this case. FT_Set_Charmap \u00b6 Defined in FT_FREETYPE_H (freetype/freetype.h). FT_EXPORT( FT_Error ) FT_Set_Charmap ( FT_Face face, FT_CharMap charmap ); Select a given charmap for character code to glyph index mapping. inout face A handle to the source face object. input charmap A handle to the selected charmap. return FreeType error code. 0 means success. note This function returns an error if the charmap is not part of the face (i.e., if it is not listed in the face->charmaps table). It also fails if an OpenType type 14 charmap is selected (which doesn't map character codes to glyph indices at all). FT_Get_Charmap_Index \u00b6 Defined in FT_FREETYPE_H (freetype/freetype.h). FT_EXPORT( FT_Int ) FT_Get_Charmap_Index ( FT_CharMap charmap ); Retrieve index of a given charmap. input charmap A handle to a charmap. return The index into the array of character maps within the face to which charmap belongs. If an error occurs, -1 is returned. FT_Get_FSType_Flags \u00b6 Defined in FT_FREETYPE_H (freetype/freetype.h). FT_EXPORT( FT_UShort ) FT_Get_FSType_Flags ( FT_Face face ); Return the fsType flags for a font. input face A handle to the source face object. return The fsType flags, see FT_FSTYPE_XXX . note Use this function rather than directly reading the fs_type field in the PS_FontInfoRec structure, which is only guaranteed to return the correct results for Type 1 fonts. since 2.3.8 FT_Get_SubGlyph_Info \u00b6 Defined in FT_FREETYPE_H (freetype/freetype.h). FT_EXPORT( FT_Error ) FT_Get_SubGlyph_Info ( FT_GlyphSlot glyph, FT_UInt sub_index, FT_Int *p_index, FT_UInt *p_flags, FT_Int *p_arg1, FT_Int *p_arg2, FT_Matrix *p_transform ); Retrieve a description of a given subglyph. Only use it if glyph->format is FT_GLYPH_FORMAT_COMPOSITE ; an error is returned otherwise. input glyph The source glyph slot. sub_index The index of the subglyph. Must be less than glyph->num_subglyphs . output p_index The glyph index of the subglyph. p_flags The subglyph flags, see FT_SUBGLYPH_FLAG_XXX . p_arg1 The subglyph's first argument (if any). p_arg2 The subglyph's second argument (if any). p_transform The subglyph transformation (if any). return FreeType error code. 0 means success. note The values of *p_arg1 , *p_arg2 , and *p_transform must be interpreted depending on the flags returned in *p_flags . See the OpenType specification for details. https://docs.microsoft.com/en-us/typography/opentype/spec/glyf#composite-glyph-description FT_Face_Internal \u00b6 Defined in FT_FREETYPE_H (freetype/freetype.h). typedef struct FT_Face_InternalRec_* FT_Face_Internal ; An opaque handle to an FT_Face_InternalRec structure that models the private data of a given FT_Face object. This structure might change between releases of FreeType 2 and is not generally available to client applications. FT_Size_Internal \u00b6 Defined in FT_FREETYPE_H (freetype/freetype.h). typedef struct FT_Size_InternalRec_* FT_Size_Internal ; An opaque handle to an FT_Size_InternalRec structure, used to model private data of a given FT_Size object. FT_Slot_Internal \u00b6 Defined in FT_FREETYPE_H (freetype/freetype.h). typedef struct FT_Slot_InternalRec_* FT_Slot_Internal ; An opaque handle to an FT_Slot_InternalRec structure, used to model private data of a given FT_GlyphSlot object. FT_FACE_FLAG_XXX \u00b6 Defined in FT_FREETYPE_H (freetype/freetype.h). # define FT_FACE_FLAG_SCALABLE ( 1L << 0 ) # define FT_FACE_FLAG_FIXED_SIZES ( 1L << 1 ) # define FT_FACE_FLAG_FIXED_WIDTH ( 1L << 2 ) # define FT_FACE_FLAG_SFNT ( 1L << 3 ) # define FT_FACE_FLAG_HORIZONTAL ( 1L << 4 ) # define FT_FACE_FLAG_VERTICAL ( 1L << 5 ) # define FT_FACE_FLAG_KERNING ( 1L << 6 ) # define FT_FACE_FLAG_FAST_GLYPHS ( 1L << 7 ) # define FT_FACE_FLAG_MULTIPLE_MASTERS ( 1L << 8 ) # define FT_FACE_FLAG_GLYPH_NAMES ( 1L << 9 ) # define FT_FACE_FLAG_EXTERNAL_STREAM ( 1L << 10 ) # define FT_FACE_FLAG_HINTER ( 1L << 11 ) # define FT_FACE_FLAG_CID_KEYED ( 1L << 12 ) # define FT_FACE_FLAG_TRICKY ( 1L << 13 ) # define FT_FACE_FLAG_COLOR ( 1L << 14 ) # define FT_FACE_FLAG_VARIATION ( 1L << 15 ) A list of bit flags used in the face_flags field of the FT_FaceRec structure. They inform client applications of properties of the corresponding face. values FT_FACE_FLAG_SCALABLE The face contains outline glyphs. Note that a face can contain bitmap strikes also, i.e., a face can have both this flag and FT_FACE_FLAG_FIXED_SIZES set. FT_FACE_FLAG_FIXED_SIZES The face contains bitmap strikes. See also the num_fixed_sizes and available_sizes fields of FT_FaceRec . FT_FACE_FLAG_FIXED_WIDTH The face contains fixed-width characters (like Courier, Lucida, MonoType, etc.). FT_FACE_FLAG_SFNT The face uses the SFNT storage scheme. For now, this means TrueType and OpenType. FT_FACE_FLAG_HORIZONTAL The face contains horizontal glyph metrics. This should be set for all common formats. FT_FACE_FLAG_VERTICAL The face contains vertical glyph metrics. This is only available in some formats, not all of them. FT_FACE_FLAG_KERNING The face contains kerning information. If set, the kerning distance can be retrieved using the function FT_Get_Kerning . Otherwise the function always return the vector (0,0). Note that FreeType doesn't handle kerning data from the SFNT \u2018GPOS\u2019 table (as present in many OpenType fonts). FT_FACE_FLAG_FAST_GLYPHS THIS FLAG IS DEPRECATED. DO NOT USE OR TEST IT. FT_FACE_FLAG_MULTIPLE_MASTERS The face contains multiple masters and is capable of interpolating between them. Supported formats are Adobe MM, TrueType GX, and OpenType variation fonts. See section \u2018 Multiple Masters \u2019 for API details. FT_FACE_FLAG_GLYPH_NAMES The face contains glyph names, which can be retrieved using FT_Get_Glyph_Name . Note that some TrueType fonts contain broken glyph name tables. Use the function FT_Has_PS_Glyph_Names when needed. FT_FACE_FLAG_EXTERNAL_STREAM Used internally by FreeType to indicate that a face's stream was provided by the client application and should not be destroyed when FT_Done_Face is called. Don't read or test this flag. FT_FACE_FLAG_HINTER The font driver has a hinting machine of its own. For example, with TrueType fonts, it makes sense to use data from the SFNT \u2018gasp\u2019 table only if the native TrueType hinting engine (with the bytecode interpreter) is available and active. FT_FACE_FLAG_CID_KEYED The face is CID-keyed. In that case, the face is not accessed by glyph indices but by CID values. For subsetted CID-keyed fonts this has the consequence that not all index values are a valid argument to FT_Load_Glyph . Only the CID values for which corresponding glyphs in the subsetted font exist make FT_Load_Glyph return successfully; in all other cases you get an FT_Err_Invalid_Argument error. Note that CID-keyed fonts that are in an SFNT wrapper (this is, all OpenType/CFF fonts) don't have this flag set since the glyphs are accessed in the normal way (using contiguous indices); the \u2018CID-ness\u2019 isn't visible to the application. FT_FACE_FLAG_TRICKY The face is \u2018tricky\u2019, this is, it always needs the font format's native hinting engine to get a reasonable result. A typical example is the old Chinese font mingli.ttf (but not mingliu.ttc ) that uses TrueType bytecode instructions to move and scale all of its subglyphs. It is not possible to auto-hint such fonts using FT_LOAD_FORCE_AUTOHINT ; it will also ignore FT_LOAD_NO_HINTING . You have to set both FT_LOAD_NO_HINTING and FT_LOAD_NO_AUTOHINT to really disable hinting; however, you probably never want this except for demonstration purposes. Currently, there are about a dozen TrueType fonts in the list of tricky fonts; they are hard-coded in file ttobjs.c . FT_FACE_FLAG_COLOR [Since 2.5.1] The face has color glyph tables. See FT_LOAD_COLOR for more information. FT_FACE_FLAG_VARIATION [Since 2.9] Set if the current face (or named instance) has been altered with FT_Set_MM_Design_Coordinates , FT_Set_Var_Design_Coordinates , or FT_Set_Var_Blend_Coordinates . This flag is unset by a call to FT_Set_Named_Instance . FT_STYLE_FLAG_XXX \u00b6 Defined in FT_FREETYPE_H (freetype/freetype.h). # define FT_STYLE_FLAG_ITALIC ( 1 << 0 ) # define FT_STYLE_FLAG_BOLD ( 1 << 1 ) A list of bit flags to indicate the style of a given face. These are used in the style_flags field of FT_FaceRec . values FT_STYLE_FLAG_ITALIC The face style is italic or oblique. FT_STYLE_FLAG_BOLD The face is bold. note The style information as provided by FreeType is very basic. More details are beyond the scope and should be done on a higher level (for example, by analyzing various fields of the \u2018OS/2\u2019 table in SFNT based fonts). FT_OPEN_XXX \u00b6 Defined in FT_FREETYPE_H (freetype/freetype.h). # define FT_OPEN_MEMORY 0x1 # define FT_OPEN_STREAM 0x2 # define FT_OPEN_PATHNAME 0x4 # define FT_OPEN_DRIVER 0x8 # define FT_OPEN_PARAMS 0x10 /* these constants are deprecated; use the corresponding ` FT_OPEN_XXX ` */ /* values instead */ # define ft_open_memory FT_OPEN_MEMORY # define ft_open_stream FT_OPEN_STREAM # define ft_open_pathname FT_OPEN_PATHNAME # define ft_open_driver FT_OPEN_DRIVER # define ft_open_params FT_OPEN_PARAMS A list of bit field constants used within the flags field of the FT_Open_Args structure. values FT_OPEN_MEMORY This is a memory-based stream. FT_OPEN_STREAM Copy the stream from the stream field. FT_OPEN_PATHNAME Create a new input stream from a C path name. FT_OPEN_DRIVER Use the driver field. FT_OPEN_PARAMS Use the num_params and params fields. note The FT_OPEN_MEMORY , FT_OPEN_STREAM , and FT_OPEN_PATHNAME flags are mutually exclusive. FT_LOAD_XXX \u00b6 Defined in FT_FREETYPE_H (freetype/freetype.h). # define FT_LOAD_DEFAULT 0x0 # define FT_LOAD_NO_SCALE ( 1L << 0 ) # define FT_LOAD_NO_HINTING ( 1L << 1 ) # define FT_LOAD_RENDER ( 1L << 2 ) # define FT_LOAD_NO_BITMAP ( 1L << 3 ) # define FT_LOAD_VERTICAL_LAYOUT ( 1L << 4 ) # define FT_LOAD_FORCE_AUTOHINT ( 1L << 5 ) # define FT_LOAD_CROP_BITMAP ( 1L << 6 ) # define FT_LOAD_PEDANTIC ( 1L << 7 ) # define FT_LOAD_IGNORE_GLOBAL_ADVANCE_WIDTH ( 1L << 9 ) # define FT_LOAD_NO_RECURSE ( 1L << 10 ) # define FT_LOAD_IGNORE_TRANSFORM ( 1L << 11 ) # define FT_LOAD_MONOCHROME ( 1L << 12 ) # define FT_LOAD_LINEAR_DESIGN ( 1L << 13 ) # define FT_LOAD_NO_AUTOHINT ( 1L << 15 ) /* Bits 16-19 are used by `FT_LOAD_TARGET_` */ # define FT_LOAD_COLOR ( 1L << 20 ) # define FT_LOAD_COMPUTE_METRICS ( 1L << 21 ) # define FT_LOAD_BITMAP_METRICS_ONLY ( 1L << 22 ) A list of bit field constants for FT_Load_Glyph to indicate what kind of operations to perform during glyph loading. values FT_LOAD_DEFAULT Corresponding to 0, this value is used as the default glyph load operation. In this case, the following happens: FreeType looks for a bitmap for the glyph corresponding to the face's current size. If one is found, the function returns. The bitmap data can be accessed from the glyph slot (see note below). If no embedded bitmap is searched for or found, FreeType looks for a scalable outline. If one is found, it is loaded from the font file, scaled to device pixels, then \u2018hinted\u2019 to the pixel grid in order to optimize it. The outline data can be accessed from the glyph slot (see note below). Note that by default the glyph loader doesn't render outlines into bitmaps. The following flags are used to modify this default behaviour to more specific and useful cases. FT_LOAD_NO_SCALE Don't scale the loaded outline glyph but keep it in font units. This flag implies FT_LOAD_NO_HINTING and FT_LOAD_NO_BITMAP , and unsets FT_LOAD_RENDER . If the font is \u2018tricky\u2019 (see FT_FACE_FLAG_TRICKY for more), using FT_LOAD_NO_SCALE usually yields meaningless outlines because the subglyphs must be scaled and positioned with hinting instructions. This can be solved by loading the font without FT_LOAD_NO_SCALE and setting the character size to font->units_per_EM . FT_LOAD_NO_HINTING Disable hinting. This generally generates \u2018blurrier\u2019 bitmap glyphs when the glyph are rendered in any of the anti-aliased modes. See also the note below. This flag is implied by FT_LOAD_NO_SCALE . FT_LOAD_RENDER Call FT_Render_Glyph after the glyph is loaded. By default, the glyph is rendered in FT_RENDER_MODE_NORMAL mode. This can be overridden by FT_LOAD_TARGET_XXX or FT_LOAD_MONOCHROME . This flag is unset by FT_LOAD_NO_SCALE . FT_LOAD_NO_BITMAP Ignore bitmap strikes when loading. Bitmap-only fonts ignore this flag. FT_LOAD_NO_SCALE always sets this flag. FT_LOAD_VERTICAL_LAYOUT Load the glyph for vertical text layout. In particular, the advance value in the FT_GlyphSlotRec structure is set to the vertAdvance value of the metrics field. In case FT_HAS_VERTICAL doesn't return true, you shouldn't use this flag currently. Reason is that in this case vertical metrics get synthesized, and those values are not always consistent across various font formats. FT_LOAD_FORCE_AUTOHINT Prefer the auto-hinter over the font's native hinter. See also the note below. FT_LOAD_PEDANTIC Make the font driver perform pedantic verifications during glyph loading and hinting. This is mostly used to detect broken glyphs in fonts. By default, FreeType tries to handle broken fonts also. In particular, errors from the TrueType bytecode engine are not passed to the application if this flag is not set; this might result in partially hinted or distorted glyphs in case a glyph's bytecode is buggy. FT_LOAD_NO_RECURSE Don't load composite glyphs recursively. Instead, the font driver fills the num_subglyph and subglyphs values of the glyph slot; it also sets glyph->format to FT_GLYPH_FORMAT_COMPOSITE . The description of subglyphs can then be accessed with FT_Get_SubGlyph_Info . Don't use this flag for retrieving metrics information since some font drivers only return rudimentary data. This flag implies FT_LOAD_NO_SCALE and FT_LOAD_IGNORE_TRANSFORM . FT_LOAD_IGNORE_TRANSFORM Ignore the transform matrix set by FT_Set_Transform . FT_LOAD_MONOCHROME This flag is used with FT_LOAD_RENDER to indicate that you want to render an outline glyph to a 1-bit monochrome bitmap glyph, with 8 pixels packed into each byte of the bitmap data. Note that this has no effect on the hinting algorithm used. You should rather use FT_LOAD_TARGET_MONO so that the monochrome-optimized hinting algorithm is used. FT_LOAD_LINEAR_DESIGN Keep linearHoriAdvance and linearVertAdvance fields of FT_GlyphSlotRec in font units. See FT_GlyphSlotRec for details. FT_LOAD_NO_AUTOHINT Disable the auto-hinter. See also the note below. FT_LOAD_COLOR Load colored glyphs. There are slight differences depending on the font format. [Since 2.5] Load embedded color bitmap images. The resulting color bitmaps, if available, will have the FT_PIXEL_MODE_BGRA format, with pre-multiplied color channels. If the flag is not set and color bitmaps are found, they are converted to 256-level gray bitmaps, using the FT_PIXEL_MODE_GRAY format. [Since 2.10, experimental] If the glyph index contains an entry in the face's \u2018COLR\u2019 table with a \u2018CPAL\u2019 palette table (as defined in the OpenType specification), make FT_Render_Glyph provide a default blending of the color glyph layers associated with the glyph index, using the same bitmap format as embedded color bitmap images. This is mainly for convenience; for full control of color layers use FT_Get_Color_Glyph_Layer and FreeType's color functions like FT_Palette_Select instead of setting FT_LOAD_COLOR for rendering so that the client application can handle blending by itself. FT_LOAD_COMPUTE_METRICS [Since 2.6.1] Compute glyph metrics from the glyph data, without the use of bundled metrics tables (for example, the \u2018hdmx\u2019 table in TrueType fonts). This flag is mainly used by font validating or font editing applications, which need to ignore, verify, or edit those tables. Currently, this flag is only implemented for TrueType fonts. FT_LOAD_BITMAP_METRICS_ONLY [Since 2.7.1] Request loading of the metrics and bitmap image information of a (possibly embedded) bitmap glyph without allocating or copying the bitmap image data itself. No effect if the target glyph is not a bitmap image. This flag unsets FT_LOAD_RENDER . FT_LOAD_CROP_BITMAP Ignored. Deprecated. FT_LOAD_IGNORE_GLOBAL_ADVANCE_WIDTH Ignored. Deprecated. note By default, hinting is enabled and the font's native hinter (see FT_FACE_FLAG_HINTER ) is preferred over the auto-hinter. You can disable hinting by setting FT_LOAD_NO_HINTING or change the precedence by setting FT_LOAD_FORCE_AUTOHINT . You can also set FT_LOAD_NO_AUTOHINT in case you don't want the auto-hinter to be used at all. See the description of FT_FACE_FLAG_TRICKY for a special exception (affecting only a handful of Asian fonts). Besides deciding which hinter to use, you can also decide which hinting algorithm to use. See FT_LOAD_TARGET_XXX for details. Note that the auto-hinter needs a valid Unicode cmap (either a native one or synthesized by FreeType) for producing correct results. If a font provides an incorrect mapping (for example, assigning the character code U+005A, LATIN CAPITAL LETTER Z, to a glyph depicting a mathematical integral sign), the auto-hinter might produce useless results. FT_LOAD_TARGET_XXX \u00b6 Defined in FT_FREETYPE_H (freetype/freetype.h). # define FT_LOAD_TARGET_( x ) ( ( FT_Int32 )( (x) & 15 ) << 16 ) # define FT_LOAD_TARGET_NORMAL FT_LOAD_TARGET_( FT_RENDER_MODE_NORMAL ) # define FT_LOAD_TARGET_LIGHT FT_LOAD_TARGET_( FT_RENDER_MODE_LIGHT ) # define FT_LOAD_TARGET_MONO FT_LOAD_TARGET_( FT_RENDER_MODE_MONO ) # define FT_LOAD_TARGET_LCD FT_LOAD_TARGET_( FT_RENDER_MODE_LCD ) # define FT_LOAD_TARGET_LCD_V FT_LOAD_TARGET_( FT_RENDER_MODE_LCD_V ) A list of values to select a specific hinting algorithm for the hinter. You should OR one of these values to your load_flags when calling FT_Load_Glyph . Note that a font's native hinters may ignore the hinting algorithm you have specified (e.g., the TrueType bytecode interpreter). You can set FT_LOAD_FORCE_AUTOHINT to ensure that the auto-hinter is used. values FT_LOAD_TARGET_NORMAL The default hinting algorithm, optimized for standard gray-level rendering. For monochrome output, use FT_LOAD_TARGET_MONO instead. FT_LOAD_TARGET_LIGHT A lighter hinting algorithm for gray-level modes. Many generated glyphs are fuzzier but better resemble their original shape. This is achieved by snapping glyphs to the pixel grid only vertically (Y-axis), as is done by FreeType's new CFF engine or Microsoft's ClearType font renderer. This preserves inter-glyph spacing in horizontal text. The snapping is done either by the native font driver, if the driver itself and the font support it, or by the auto-hinter. Advance widths are rounded to integer values; however, using the lsb_delta and rsb_delta fields of FT_GlyphSlotRec , it is possible to get fractional advance widths for subpixel positioning (which is recommended to use). If configuration option AF_CONFIG_OPTION_TT_SIZE_METRICS is active, TrueType-like metrics are used to make this mode behave similarly as in unpatched FreeType versions between 2.4.6 and 2.7.1 (inclusive). FT_LOAD_TARGET_MONO Strong hinting algorithm that should only be used for monochrome output. The result is probably unpleasant if the glyph is rendered in non-monochrome modes. Note that for outline fonts only the TrueType font driver has proper monochrome hinting support, provided the TTFs contain hints for B/W rendering (which most fonts no longer provide). If these conditions are not met it is very likely that you get ugly results at smaller sizes. FT_LOAD_TARGET_LCD A variant of FT_LOAD_TARGET_LIGHT optimized for horizontally decimated LCD displays. FT_LOAD_TARGET_LCD_V A variant of FT_LOAD_TARGET_NORMAL optimized for vertically decimated LCD displays. note You should use only one of the FT_LOAD_TARGET_XXX values in your load_flags . They can't be ORed. If FT_LOAD_RENDER is also set, the glyph is rendered in the corresponding mode (i.e., the mode that matches the used algorithm best). An exception is FT_LOAD_TARGET_MONO since it implies FT_LOAD_MONOCHROME . You can use a hinting algorithm that doesn't correspond to the same rendering mode. As an example, it is possible to use the \u2018light\u2019 hinting algorithm and have the results rendered in horizontal LCD pixel mode, with code like FT_Load_Glyph( face, glyph_index, load_flags | FT_LOAD_TARGET_LIGHT ); FT_Render_Glyph( face->glyph, FT_RENDER_MODE_LCD ); In general, you should stick with one rendering mode. For example, switching between FT_LOAD_TARGET_NORMAL and FT_LOAD_TARGET_MONO enforces a lot of recomputation for TrueType fonts, which is slow. Another reason is caching: Selecting a different mode usually causes changes in both the outlines and the rasterized bitmaps; it is thus necessary to empty the cache after a mode switch to avoid false hits. FT_SUBGLYPH_FLAG_XXX \u00b6 Defined in FT_FREETYPE_H (freetype/freetype.h). # define FT_SUBGLYPH_FLAG_ARGS_ARE_WORDS 1 # define FT_SUBGLYPH_FLAG_ARGS_ARE_XY_VALUES 2 # define FT_SUBGLYPH_FLAG_ROUND_XY_TO_GRID 4 # define FT_SUBGLYPH_FLAG_SCALE 8 # define FT_SUBGLYPH_FLAG_XY_SCALE 0x40 # define FT_SUBGLYPH_FLAG_2X2 0x80 # define FT_SUBGLYPH_FLAG_USE_MY_METRICS 0x200 A list of constants describing subglyphs. Please refer to the \u2018glyf\u2019 table description in the OpenType specification for the meaning of the various flags (which get synthesized for non-OpenType subglyphs). https://docs.microsoft.com/en-us/typography/opentype/spec/glyf#composite-glyph-description values FT_SUBGLYPH_FLAG_ARGS_ARE_WORDS FT_SUBGLYPH_FLAG_ARGS_ARE_XY_VALUES FT_SUBGLYPH_FLAG_ROUND_XY_TO_GRID FT_SUBGLYPH_FLAG_SCALE FT_SUBGLYPH_FLAG_XY_SCALE FT_SUBGLYPH_FLAG_2X2 FT_SUBGLYPH_FLAG_USE_MY_METRICS FT_FSTYPE_XXX \u00b6 Defined in FT_FREETYPE_H (freetype/freetype.h). # define FT_FSTYPE_INSTALLABLE_EMBEDDING 0x0000 # define FT_FSTYPE_RESTRICTED_LICENSE_EMBEDDING 0x0002 # define FT_FSTYPE_PREVIEW_AND_PRINT_EMBEDDING 0x0004 # define FT_FSTYPE_EDITABLE_EMBEDDING 0x0008 # define FT_FSTYPE_NO_SUBSETTING 0x0100 # define FT_FSTYPE_BITMAP_EMBEDDING_ONLY 0x0200 A list of bit flags used in the fsType field of the OS/2 table in a TrueType or OpenType font and the FSType entry in a PostScript font. These bit flags are returned by FT_Get_FSType_Flags ; they inform client applications of embedding and subsetting restrictions associated with a font. See https://www.adobe.com/content/dam/Adobe/en/devnet/acrobat/pdfs/FontPolicies.pdf for more details. values FT_FSTYPE_INSTALLABLE_EMBEDDING Fonts with no fsType bit set may be embedded and permanently installed on the remote system by an application. FT_FSTYPE_RESTRICTED_LICENSE_EMBEDDING Fonts that have only this bit set must not be modified, embedded or exchanged in any manner without first obtaining permission of the font software copyright owner. FT_FSTYPE_PREVIEW_AND_PRINT_EMBEDDING The font may be embedded and temporarily loaded on the remote system. Documents containing Preview & Print fonts must be opened \u2018read-only\u2019; no edits can be applied to the document. FT_FSTYPE_EDITABLE_EMBEDDING The font may be embedded but must only be installed temporarily on other systems. In contrast to Preview & Print fonts, documents containing editable fonts may be opened for reading, editing is permitted, and changes may be saved. FT_FSTYPE_NO_SUBSETTING The font may not be subsetted prior to embedding. FT_FSTYPE_BITMAP_EMBEDDING_ONLY Only bitmaps contained in the font may be embedded; no outline data may be embedded. If there are no bitmaps available in the font, then the font is unembeddable. note The flags are ORed together, thus more than a single value can be returned. While the fsType flags can indicate that a font may be embedded, a license with the font vendor may be separately required to use the font in this way. FT_HAS_FAST_GLYPHS \u00b6 Defined in FT_FREETYPE_H (freetype/freetype.h). # define FT_HAS_FAST_GLYPHS ( face ) 0 Deprecated.","title":"Base Interface"},{"location":"ft2-base_interface.html#base-interface","text":"","title":"Base Interface"},{"location":"ft2-base_interface.html#synopsis","text":"This section describes the most important public high-level API functions of FreeType 2.","title":"Synopsis"},{"location":"ft2-base_interface.html#ft_library","text":"Defined in FT_FREETYPE_H (freetype/freetype.h). typedef struct FT_LibraryRec_ * FT_Library ; A handle to a FreeType library instance. Each \u2018library\u2019 is completely independent from the others; it is the \u2018root\u2019 of a set of objects like fonts, faces, sizes, etc. It also embeds a memory manager (see FT_Memory ), as well as a scan-line converter object (see FT_Raster ). [Since 2.5.6] In multi-threaded applications it is easiest to use one FT_Library object per thread. In case this is too cumbersome, a single FT_Library object across threads is possible also, as long as a mutex lock is used around FT_New_Face and FT_Done_Face .","title":"FT_Library"},{"location":"ft2-base_interface.html#ft_face","text":"Defined in FT_FREETYPE_H (freetype/freetype.h). typedef struct FT_FaceRec_* FT_Face ; A handle to a typographic face object. A face object models a given typeface, in a given style.","title":"FT_Face"},{"location":"ft2-base_interface.html#ft_size","text":"Defined in FT_FREETYPE_H (freetype/freetype.h). typedef struct FT_SizeRec_* FT_Size ; A handle to an object that models a face scaled to a given character size.","title":"FT_Size"},{"location":"ft2-base_interface.html#ft_glyphslot","text":"Defined in FT_FREETYPE_H (freetype/freetype.h). typedef struct FT_GlyphSlotRec_* FT_GlyphSlot ; A handle to a given \u2018glyph slot\u2019. A slot is a container that can hold any of the glyphs contained in its parent face. In other words, each time you call FT_Load_Glyph or FT_Load_Char , the slot's content is erased by the new glyph data, i.e., the glyph's metrics, its image (bitmap or outline), and other control information.","title":"FT_GlyphSlot"},{"location":"ft2-base_interface.html#ft_charmap","text":"Defined in FT_FREETYPE_H (freetype/freetype.h). typedef struct FT_CharMapRec_* FT_CharMap ; A handle to a character map (usually abbreviated to \u2018charmap\u2019). A charmap is used to translate character codes in a given encoding into glyph indexes for its parent's face. Some font formats may provide several charmaps per font. Each face object owns zero or more charmaps, but only one of them can be \u2018active\u2019, providing the data used by FT_Get_Char_Index or FT_Load_Char . The list of available charmaps in a face is available through the face->num_charmaps and face->charmaps fields of FT_FaceRec . The currently active charmap is available as face->charmap . You should call FT_Set_Charmap to change it.","title":"FT_CharMap"},{"location":"ft2-base_interface.html#ft_encoding","text":"Defined in FT_FREETYPE_H (freetype/freetype.h). typedef enum FT_Encoding_ { FT_ENC_TAG ( FT_ENCODING_NONE , 0, 0, 0, 0 ), FT_ENC_TAG ( FT_ENCODING_MS_SYMBOL , 's', 'y', 'm', 'b' ), FT_ENC_TAG ( FT_ENCODING_UNICODE , 'u', 'n', 'i', 'c' ), FT_ENC_TAG ( FT_ENCODING_SJIS , 's', 'j', 'i', 's' ), FT_ENC_TAG ( FT_ENCODING_PRC , 'g', 'b', ' ', ' ' ), FT_ENC_TAG ( FT_ENCODING_BIG5 , 'b', 'i', 'g', '5' ), FT_ENC_TAG ( FT_ENCODING_WANSUNG , 'w', 'a', 'n', 's' ), FT_ENC_TAG ( FT_ENCODING_JOHAB , 'j', 'o', 'h', 'a' ), /* for backward compatibility */ FT_ENCODING_GB2312 = FT_ENCODING_PRC , FT_ENCODING_MS_SJIS = FT_ENCODING_SJIS , FT_ENCODING_MS_GB2312 = FT_ENCODING_PRC , FT_ENCODING_MS_BIG5 = FT_ENCODING_BIG5 , FT_ENCODING_MS_WANSUNG = FT_ENCODING_WANSUNG , FT_ENCODING_MS_JOHAB = FT_ENCODING_JOHAB , FT_ENC_TAG ( FT_ENCODING_ADOBE_STANDARD , 'A', 'D', 'O', 'B' ), FT_ENC_TAG ( FT_ENCODING_ADOBE_EXPERT , 'A', 'D', 'B', 'E' ), FT_ENC_TAG ( FT_ENCODING_ADOBE_CUSTOM , 'A', 'D', 'B', 'C' ), FT_ENC_TAG ( FT_ENCODING_ADOBE_LATIN_1 , 'l', 'a', 't', '1' ), FT_ENC_TAG ( FT_ENCODING_OLD_LATIN_2 , 'l', 'a', 't', '2' ), FT_ENC_TAG ( FT_ENCODING_APPLE_ROMAN , 'a', 'r', 'm', 'n' ) } FT_Encoding ; /* these constants are deprecated; use the corresponding ` FT_Encoding ` */ /* values instead */ # define ft_encoding_none FT_ENCODING_NONE # define ft_encoding_unicode FT_ENCODING_UNICODE # define ft_encoding_symbol FT_ENCODING_MS_SYMBOL # define ft_encoding_latin_1 FT_ENCODING_ADOBE_LATIN_1 # define ft_encoding_latin_2 FT_ENCODING_OLD_LATIN_2 # define ft_encoding_sjis FT_ENCODING_SJIS # define ft_encoding_gb2312 FT_ENCODING_PRC # define ft_encoding_big5 FT_ENCODING_BIG5 # define ft_encoding_wansung FT_ENCODING_WANSUNG # define ft_encoding_johab FT_ENCODING_JOHAB # define ft_encoding_adobe_standard FT_ENCODING_ADOBE_STANDARD # define ft_encoding_adobe_expert FT_ENCODING_ADOBE_EXPERT # define ft_encoding_adobe_custom FT_ENCODING_ADOBE_CUSTOM # define ft_encoding_apple_roman FT_ENCODING_APPLE_ROMAN An enumeration to specify character sets supported by charmaps. Used in the FT_Select_Charmap API function.","title":"FT_Encoding"},{"location":"ft2-base_interface.html#ft_enc_tag","text":"Defined in FT_FREETYPE_H (freetype/freetype.h). # ifndef FT_ENC_TAG # define FT_ENC_TAG ( value, a, b, c, d ) \\ value = ( ( ( FT_UInt32 )(a) << 24 ) | \\ ( ( FT_UInt32 )(b) << 16 ) | \\ ( ( FT_UInt32 )(c) << 8 ) | \\ ( FT_UInt32 )(d) ) # endif /* FT_ENC_TAG */ This macro converts four-letter tags into an unsigned long. It is used to define \u2018encoding\u2019 identifiers (see FT_Encoding ).","title":"FT_ENC_TAG"},{"location":"ft2-base_interface.html#ft_facerec","text":"Defined in FT_FREETYPE_H (freetype/freetype.h). typedef struct FT_FaceRec_ { FT_Long num_faces; FT_Long face_index; FT_Long face_flags; FT_Long style_flags; FT_Long num_glyphs; FT_String * family_name; FT_String * style_name; FT_Int num_fixed_sizes; FT_Bitmap_Size * available_sizes; FT_Int num_charmaps; FT_CharMap * charmaps; FT_Generic generic; /*# The following member variables (down to `underline_thickness`) */ /*# are only relevant to scalable outlines; cf. @ FT_Bitmap_Size */ /*# for bitmap fonts. */ FT_BBox bbox; FT_UShort units_per_EM; FT_Short ascender; FT_Short descender; FT_Short height; FT_Short max_advance_width; FT_Short max_advance_height; FT_Short underline_position; FT_Short underline_thickness; FT_GlyphSlot glyph; FT_Size size; FT_CharMap charmap; /*@private begin */ FT_Driver driver; FT_Memory memory; FT_Stream stream; FT_ListRec sizes_list; FT_Generic autohint; /* face-specific auto-hinter data */ void * extensions; /* unused */ FT_Face_Internal internal; /*@private end */ } FT_FaceRec ; FreeType root face class structure. A face object models a typeface in a font file.","title":"FT_FaceRec"},{"location":"ft2-base_interface.html#ft_has_horizontal","text":"Defined in FT_FREETYPE_H (freetype/freetype.h). # define FT_HAS_HORIZONTAL ( face ) \\ ( !!( (face)->face_flags & FT_FACE_FLAG_HORIZONTAL ) ) A macro that returns true whenever a face object contains horizontal metrics (this is true for all font formats though).","title":"FT_HAS_HORIZONTAL"},{"location":"ft2-base_interface.html#ft_has_vertical","text":"Defined in FT_FREETYPE_H (freetype/freetype.h). # define FT_HAS_VERTICAL ( face ) \\ ( !!( (face)->face_flags & FT_FACE_FLAG_VERTICAL ) ) A macro that returns true whenever a face object contains real vertical metrics (and not only synthesized ones).","title":"FT_HAS_VERTICAL"},{"location":"ft2-base_interface.html#ft_has_kerning","text":"Defined in FT_FREETYPE_H (freetype/freetype.h). # define FT_HAS_KERNING ( face ) \\ ( !!( (face)->face_flags & FT_FACE_FLAG_KERNING ) ) A macro that returns true whenever a face object contains kerning data that can be accessed with FT_Get_Kerning .","title":"FT_HAS_KERNING"},{"location":"ft2-base_interface.html#ft_has_fixed_sizes","text":"Defined in FT_FREETYPE_H (freetype/freetype.h). # define FT_HAS_FIXED_SIZES ( face ) \\ ( !!( (face)->face_flags & FT_FACE_FLAG_FIXED_SIZES ) ) A macro that returns true whenever a face object contains some embedded bitmaps. See the available_sizes field of the FT_FaceRec structure.","title":"FT_HAS_FIXED_SIZES"},{"location":"ft2-base_interface.html#ft_has_glyph_names","text":"Defined in FT_FREETYPE_H (freetype/freetype.h). # define FT_HAS_GLYPH_NAMES ( face ) \\ ( !!( (face)->face_flags & FT_FACE_FLAG_GLYPH_NAMES ) ) A macro that returns true whenever a face object contains some glyph names that can be accessed through FT_Get_Glyph_Name .","title":"FT_HAS_GLYPH_NAMES"},{"location":"ft2-base_interface.html#ft_has_color","text":"Defined in FT_FREETYPE_H (freetype/freetype.h). # define FT_HAS_COLOR ( face ) \\ ( !!( (face)->face_flags & FT_FACE_FLAG_COLOR ) ) A macro that returns true whenever a face object contains tables for color glyphs.","title":"FT_HAS_COLOR"},{"location":"ft2-base_interface.html#ft_has_multiple_masters","text":"Defined in FT_FREETYPE_H (freetype/freetype.h). # define FT_HAS_MULTIPLE_MASTERS ( face ) \\ ( !!( (face)->face_flags & FT_FACE_FLAG_MULTIPLE_MASTERS ) ) A macro that returns true whenever a face object contains some multiple masters. The functions provided by FT_MULTIPLE_MASTERS_H are then available to choose the exact design you want.","title":"FT_HAS_MULTIPLE_MASTERS"},{"location":"ft2-base_interface.html#ft_is_sfnt","text":"Defined in FT_FREETYPE_H (freetype/freetype.h). # define FT_IS_SFNT ( face ) \\ ( !!( (face)->face_flags & FT_FACE_FLAG_SFNT ) ) A macro that returns true whenever a face object contains a font whose format is based on the SFNT storage scheme. This usually means: TrueType fonts, OpenType fonts, as well as SFNT-based embedded bitmap fonts. If this macro is true, all functions defined in FT_SFNT_NAMES_H and FT_TRUETYPE_TABLES_H are available.","title":"FT_IS_SFNT"},{"location":"ft2-base_interface.html#ft_is_scalable","text":"Defined in FT_FREETYPE_H (freetype/freetype.h). # define FT_IS_SCALABLE ( face ) \\ ( !!( (face)->face_flags & FT_FACE_FLAG_SCALABLE ) ) A macro that returns true whenever a face object contains a scalable font face (true for TrueType, Type 1, Type 42, CID, OpenType/CFF, and PFR font formats).","title":"FT_IS_SCALABLE"},{"location":"ft2-base_interface.html#ft_is_fixed_width","text":"Defined in FT_FREETYPE_H (freetype/freetype.h). # define FT_IS_FIXED_WIDTH ( face ) \\ ( !!( (face)->face_flags & FT_FACE_FLAG_FIXED_WIDTH ) ) A macro that returns true whenever a face object contains a font face that contains fixed-width (or \u2018monospace\u2019, \u2018fixed-pitch\u2019, etc.) glyphs.","title":"FT_IS_FIXED_WIDTH"},{"location":"ft2-base_interface.html#ft_is_cid_keyed","text":"Defined in FT_FREETYPE_H (freetype/freetype.h). # define FT_IS_CID_KEYED ( face ) \\ ( !!( (face)->face_flags & FT_FACE_FLAG_CID_KEYED ) ) A macro that returns true whenever a face object contains a CID-keyed font. See the discussion of FT_FACE_FLAG_CID_KEYED for more details. If this macro is true, all functions defined in FT_CID_H are available.","title":"FT_IS_CID_KEYED"},{"location":"ft2-base_interface.html#ft_is_tricky","text":"Defined in FT_FREETYPE_H (freetype/freetype.h). # define FT_IS_TRICKY ( face ) \\ ( !!( (face)->face_flags & FT_FACE_FLAG_TRICKY ) ) A macro that returns true whenever a face represents a \u2018tricky\u2019 font. See the discussion of FT_FACE_FLAG_TRICKY for more details.","title":"FT_IS_TRICKY"},{"location":"ft2-base_interface.html#ft_is_named_instance","text":"Defined in FT_FREETYPE_H (freetype/freetype.h). # define FT_IS_NAMED_INSTANCE ( face ) \\ ( !!( (face)->face_index & 0x7FFF0000L ) ) A macro that returns true whenever a face object is a named instance of a GX or OpenType variation font. [Since 2.9] Changing the design coordinates with FT_Set_Var_Design_Coordinates or FT_Set_Var_Blend_Coordinates does not influence the return value of this macro (only FT_Set_Named_Instance does that).","title":"FT_IS_NAMED_INSTANCE"},{"location":"ft2-base_interface.html#ft_is_variation","text":"Defined in FT_FREETYPE_H (freetype/freetype.h). # define FT_IS_VARIATION ( face ) \\ ( !!( (face)->face_flags & FT_FACE_FLAG_VARIATION ) ) A macro that returns true whenever a face object has been altered by FT_Set_MM_Design_Coordinates , FT_Set_Var_Design_Coordinates , or FT_Set_Var_Blend_Coordinates .","title":"FT_IS_VARIATION"},{"location":"ft2-base_interface.html#ft_sizerec","text":"Defined in FT_FREETYPE_H (freetype/freetype.h). typedef struct FT_SizeRec_ { FT_Face face; /* parent face object */ FT_Generic generic; /* generic pointer for client uses */ FT_Size_Metrics metrics; /* size metrics */ FT_Size_Internal internal; } FT_SizeRec ; FreeType root size class structure. A size object models a face object at a given size.","title":"FT_SizeRec"},{"location":"ft2-base_interface.html#ft_size_metrics","text":"Defined in FT_FREETYPE_H (freetype/freetype.h). typedef struct FT_Size_Metrics_ { FT_UShort x_ppem; /* horizontal pixels per EM */ FT_UShort y_ppem; /* vertical pixels per EM */ FT_Fixed x_scale; /* scaling values used to convert font */ FT_Fixed y_scale; /* units to 26.6 fractional pixels */ FT_Pos ascender; /* ascender in 26.6 frac. pixels */ FT_Pos descender; /* descender in 26.6 frac. pixels */ FT_Pos height; /* text height in 26.6 frac. pixels */ FT_Pos max_advance; /* max horizontal advance, in 26.6 pixels */ } FT_Size_Metrics ; The size metrics structure gives the metrics of a size object.","title":"FT_Size_Metrics"},{"location":"ft2-base_interface.html#ft_glyphslotrec","text":"Defined in FT_FREETYPE_H (freetype/freetype.h). typedef struct FT_GlyphSlotRec_ { FT_Library library; FT_Face face; FT_GlyphSlot next; FT_UInt glyph_index; /* new in 2.10; was reserved previously */ FT_Generic generic; FT_Glyph_Metrics metrics; FT_Fixed linearHoriAdvance; FT_Fixed linearVertAdvance; FT_Vector advance; FT_Glyph_Format format; FT_Bitmap bitmap; FT_Int bitmap_left; FT_Int bitmap_top; FT_Outline outline; FT_UInt num_subglyphs; FT_SubGlyph subglyphs; void * control_data; long control_len; FT_Pos lsb_delta; FT_Pos rsb_delta; void * other; FT_Slot_Internal internal; } FT_GlyphSlotRec ; FreeType root glyph slot class structure. A glyph slot is a container where individual glyphs can be loaded, be they in outline or bitmap format.","title":"FT_GlyphSlotRec"},{"location":"ft2-base_interface.html#ft_glyph_metrics","text":"Defined in FT_FREETYPE_H (freetype/freetype.h). typedef struct FT_Glyph_Metrics_ { FT_Pos width; FT_Pos height; FT_Pos horiBearingX; FT_Pos horiBearingY; FT_Pos horiAdvance; FT_Pos vertBearingX; FT_Pos vertBearingY; FT_Pos vertAdvance; } FT_Glyph_Metrics ; A structure to model the metrics of a single glyph. The values are expressed in 26.6 fractional pixel format; if the flag FT_LOAD_NO_SCALE has been used while loading the glyph, values are expressed in font units instead.","title":"FT_Glyph_Metrics"},{"location":"ft2-base_interface.html#ft_subglyph","text":"Defined in FT_FREETYPE_H (freetype/freetype.h). typedef struct FT_SubGlyphRec_* FT_SubGlyph ; The subglyph structure is an internal object used to describe subglyphs (for example, in the case of composites).","title":"FT_SubGlyph"},{"location":"ft2-base_interface.html#ft_bitmap_size","text":"Defined in FT_FREETYPE_H (freetype/freetype.h). typedef struct FT_Bitmap_Size_ { FT_Short height; FT_Short width; FT_Pos size; FT_Pos x_ppem; FT_Pos y_ppem; } FT_Bitmap_Size ; This structure models the metrics of a bitmap strike (i.e., a set of glyphs for a given point size and resolution) in a bitmap font. It is used for the available_sizes field of FT_Face .","title":"FT_Bitmap_Size"},{"location":"ft2-base_interface.html#ft_init_freetype","text":"Defined in FT_FREETYPE_H (freetype/freetype.h). FT_EXPORT( FT_Error ) FT_Init_FreeType ( FT_Library *alibrary ); Initialize a new FreeType library object. The set of modules that are registered by this function is determined at build time.","title":"FT_Init_FreeType"},{"location":"ft2-base_interface.html#ft_done_freetype","text":"Defined in FT_FREETYPE_H (freetype/freetype.h). FT_EXPORT( FT_Error ) FT_Done_FreeType ( FT_Library library ); Destroy a given FreeType library object and all of its children, including resources, drivers, faces, sizes, etc.","title":"FT_Done_FreeType"},{"location":"ft2-base_interface.html#ft_new_face","text":"Defined in FT_FREETYPE_H (freetype/freetype.h). FT_EXPORT( FT_Error ) FT_New_Face ( FT_Library library, const char * filepathname, FT_Long face_index, FT_Face *aface ); Call FT_Open_Face to open a font by its pathname.","title":"FT_New_Face"},{"location":"ft2-base_interface.html#ft_done_face","text":"Defined in FT_FREETYPE_H (freetype/freetype.h). FT_EXPORT( FT_Error ) FT_Done_Face ( FT_Face face ); Discard a given face object, as well as all of its child slots and sizes.","title":"FT_Done_Face"},{"location":"ft2-base_interface.html#ft_reference_face","text":"Defined in FT_FREETYPE_H (freetype/freetype.h). FT_EXPORT( FT_Error ) FT_Reference_Face ( FT_Face face ); A counter gets initialized to 1 at the time an FT_Face structure is created. This function increments the counter. FT_Done_Face then only destroys a face if the counter is 1, otherwise it simply decrements the counter. This function helps in managing life-cycles of structures that reference FT_Face objects.","title":"FT_Reference_Face"},{"location":"ft2-base_interface.html#ft_new_memory_face","text":"Defined in FT_FREETYPE_H (freetype/freetype.h). FT_EXPORT( FT_Error ) FT_New_Memory_Face ( FT_Library library, const FT_Byte * file_base, FT_Long file_size, FT_Long face_index, FT_Face *aface ); Call FT_Open_Face to open a font that has been loaded into memory.","title":"FT_New_Memory_Face"},{"location":"ft2-base_interface.html#ft_face_properties","text":"Defined in FT_FREETYPE_H (freetype/freetype.h). FT_EXPORT( FT_Error ) FT_Face_Properties ( FT_Face face, FT_UInt num_properties, FT_Parameter * properties ); Set or override certain (library or module-wide) properties on a face-by-face basis. Useful for finer-grained control and avoiding locks on shared structures (threads can modify their own faces as they see fit). Contrary to FT_Property_Set , this function uses FT_Parameter so that you can pass multiple properties to the target face in one call. Note that only a subset of the available properties can be controlled. FT_PARAM_TAG_STEM_DARKENING (stem darkening, corresponding to the property no-stem-darkening provided by the \u2018autofit\u2019, \u2018cff\u2019, \u2018type1\u2019, and \u2018t1cid\u2019 modules; see no-stem-darkening ). FT_PARAM_TAG_LCD_FILTER_WEIGHTS (LCD filter weights, corresponding to function FT_Library_SetLcdFilterWeights ). FT_PARAM_TAG_RANDOM_SEED (seed value for the CFF, Type 1, and CID \u2018random\u2019 operator, corresponding to the random-seed property provided by the \u2018cff\u2019, \u2018type1\u2019, and \u2018t1cid\u2019 modules; see random-seed ). Pass NULL as data in FT_Parameter for a given tag to reset the option and use the library or module default again.","title":"FT_Face_Properties"},{"location":"ft2-base_interface.html#ft_open_face","text":"Defined in FT_FREETYPE_H (freetype/freetype.h). FT_EXPORT( FT_Error ) FT_Open_Face ( FT_Library library, const FT_Open_Args * args, FT_Long face_index, FT_Face *aface ); Create a face object from a given resource described by FT_Open_Args .","title":"FT_Open_Face"},{"location":"ft2-base_interface.html#ft_open_args","text":"Defined in FT_FREETYPE_H (freetype/freetype.h). typedef struct FT_Open_Args_ { FT_UInt flags; const FT_Byte * memory_base; FT_Long memory_size; FT_String * pathname; FT_Stream stream; FT_Module driver; FT_Int num_params; FT_Parameter * params; } FT_Open_Args ; A structure to indicate how to open a new font file or stream. A pointer to such a structure can be used as a parameter for the functions FT_Open_Face and FT_Attach_Stream .","title":"FT_Open_Args"},{"location":"ft2-base_interface.html#ft_parameter","text":"Defined in FT_FREETYPE_H (freetype/freetype.h). typedef struct FT_Parameter_ { FT_ULong tag; FT_Pointer data; } FT_Parameter ; A simple structure to pass more or less generic parameters to FT_Open_Face and FT_Face_Properties .","title":"FT_Parameter"},{"location":"ft2-base_interface.html#ft_attach_file","text":"Defined in FT_FREETYPE_H (freetype/freetype.h). FT_EXPORT( FT_Error ) FT_Attach_File ( FT_Face face, const char * filepathname ); Call FT_Attach_Stream to attach a file.","title":"FT_Attach_File"},{"location":"ft2-base_interface.html#ft_attach_stream","text":"Defined in FT_FREETYPE_H (freetype/freetype.h). FT_EXPORT( FT_Error ) FT_Attach_Stream ( FT_Face face, FT_Open_Args * parameters ); \u2018Attach\u2019 data to a face object. Normally, this is used to read additional information for the face object. For example, you can attach an AFM file that comes with a Type 1 font to get the kerning values and other metrics.","title":"FT_Attach_Stream"},{"location":"ft2-base_interface.html#ft_set_char_size","text":"Defined in FT_FREETYPE_H (freetype/freetype.h). FT_EXPORT( FT_Error ) FT_Set_Char_Size ( FT_Face face, FT_F26Dot6 char_width, FT_F26Dot6 char_height, FT_UInt horz_resolution, FT_UInt vert_resolution ); Call FT_Request_Size to request the nominal size (in points).","title":"FT_Set_Char_Size"},{"location":"ft2-base_interface.html#ft_set_pixel_sizes","text":"Defined in FT_FREETYPE_H (freetype/freetype.h). FT_EXPORT( FT_Error ) FT_Set_Pixel_Sizes ( FT_Face face, FT_UInt pixel_width, FT_UInt pixel_height ); Call FT_Request_Size to request the nominal size (in pixels).","title":"FT_Set_Pixel_Sizes"},{"location":"ft2-base_interface.html#ft_request_size","text":"Defined in FT_FREETYPE_H (freetype/freetype.h). FT_EXPORT( FT_Error ) FT_Request_Size ( FT_Face face, FT_Size_Request req ); Resize the scale of the active FT_Size object in a face.","title":"FT_Request_Size"},{"location":"ft2-base_interface.html#ft_select_size","text":"Defined in FT_FREETYPE_H (freetype/freetype.h). FT_EXPORT( FT_Error ) FT_Select_Size ( FT_Face face, FT_Int strike_index ); Select a bitmap strike. To be more precise, this function sets the scaling factors of the active FT_Size object in a face so that bitmaps from this particular strike are taken by FT_Load_Glyph and friends.","title":"FT_Select_Size"},{"location":"ft2-base_interface.html#ft_size_request_type","text":"Defined in FT_FREETYPE_H (freetype/freetype.h). typedef enum FT_Size_Request_Type_ { FT_SIZE_REQUEST_TYPE_NOMINAL , FT_SIZE_REQUEST_TYPE_REAL_DIM , FT_SIZE_REQUEST_TYPE_BBOX , FT_SIZE_REQUEST_TYPE_CELL , FT_SIZE_REQUEST_TYPE_SCALES , FT_SIZE_REQUEST_TYPE_MAX } FT_Size_Request_Type ; An enumeration type that lists the supported size request types, i.e., what input size (in font units) maps to the requested output size (in pixels, as computed from the arguments of FT_Size_Request ).","title":"FT_Size_Request_Type"},{"location":"ft2-base_interface.html#ft_size_requestrec","text":"Defined in FT_FREETYPE_H (freetype/freetype.h). typedef struct FT_Size_RequestRec_ { FT_Size_Request_Type type; FT_Long width; FT_Long height; FT_UInt horiResolution; FT_UInt vertResolution; } FT_Size_RequestRec ; A structure to model a size request.","title":"FT_Size_RequestRec"},{"location":"ft2-base_interface.html#ft_size_request","text":"Defined in FT_FREETYPE_H (freetype/freetype.h). typedef struct FT_Size_RequestRec_ * FT_Size_Request ; A handle to a size request structure.","title":"FT_Size_Request"},{"location":"ft2-base_interface.html#ft_set_transform","text":"Defined in FT_FREETYPE_H (freetype/freetype.h). FT_EXPORT( void ) FT_Set_Transform ( FT_Face face, FT_Matrix * matrix, FT_Vector * delta ); Set the transformation that is applied to glyph images when they are loaded into a glyph slot through FT_Load_Glyph .","title":"FT_Set_Transform"},{"location":"ft2-base_interface.html#ft_load_glyph","text":"Defined in FT_FREETYPE_H (freetype/freetype.h). FT_EXPORT( FT_Error ) FT_Load_Glyph ( FT_Face face, FT_UInt glyph_index, FT_Int32 load_flags ); Load a glyph into the glyph slot of a face object.","title":"FT_Load_Glyph"},{"location":"ft2-base_interface.html#ft_get_char_index","text":"Defined in FT_FREETYPE_H (freetype/freetype.h). FT_EXPORT( FT_UInt ) FT_Get_Char_Index ( FT_Face face, FT_ULong charcode ); Return the glyph index of a given character code. This function uses the currently selected charmap to do the mapping.","title":"FT_Get_Char_Index"},{"location":"ft2-base_interface.html#ft_get_first_char","text":"Defined in FT_FREETYPE_H (freetype/freetype.h). FT_EXPORT( FT_ULong ) FT_Get_First_Char ( FT_Face face, FT_UInt *agindex ); Return the first character code in the current charmap of a given face, together with its corresponding glyph index.","title":"FT_Get_First_Char"},{"location":"ft2-base_interface.html#ft_get_next_char","text":"Defined in FT_FREETYPE_H (freetype/freetype.h). FT_EXPORT( FT_ULong ) FT_Get_Next_Char ( FT_Face face, FT_ULong char_code, FT_UInt *agindex ); Return the next character code in the current charmap of a given face following the value char_code , as well as the corresponding glyph index.","title":"FT_Get_Next_Char"},{"location":"ft2-base_interface.html#ft_get_name_index","text":"Defined in FT_FREETYPE_H (freetype/freetype.h). FT_EXPORT( FT_UInt ) FT_Get_Name_Index ( FT_Face face, const FT_String * glyph_name ); Return the glyph index of a given glyph name.","title":"FT_Get_Name_Index"},{"location":"ft2-base_interface.html#ft_load_char","text":"Defined in FT_FREETYPE_H (freetype/freetype.h). FT_EXPORT( FT_Error ) FT_Load_Char ( FT_Face face, FT_ULong char_code, FT_Int32 load_flags ); Load a glyph into the glyph slot of a face object, accessed by its character code.","title":"FT_Load_Char"},{"location":"ft2-base_interface.html#ft_load_target_mode","text":"Defined in FT_FREETYPE_H (freetype/freetype.h). # define FT_LOAD_TARGET_MODE ( x ) ( ( FT_Render_Mode )( ( (x) >> 16 ) & 15 ) ) Return the FT_Render_Mode corresponding to a given FT_LOAD_TARGET_XXX value.","title":"FT_LOAD_TARGET_MODE"},{"location":"ft2-base_interface.html#ft_render_glyph","text":"Defined in FT_FREETYPE_H (freetype/freetype.h). FT_EXPORT( FT_Error ) FT_Render_Glyph ( FT_GlyphSlot slot, FT_Render_Mode render_mode ); Convert a given glyph image to a bitmap. It does so by inspecting the glyph image format, finding the relevant renderer, and invoking it.","title":"FT_Render_Glyph"},{"location":"ft2-base_interface.html#ft_render_mode","text":"Defined in FT_FREETYPE_H (freetype/freetype.h). typedef enum FT_Render_Mode_ { FT_RENDER_MODE_NORMAL = 0, FT_RENDER_MODE_LIGHT , FT_RENDER_MODE_MONO , FT_RENDER_MODE_LCD , FT_RENDER_MODE_LCD_V , FT_RENDER_MODE_MAX } FT_Render_Mode ; /* these constants are deprecated; use the corresponding */ /* ` FT_Render_Mode ` values instead */ # define ft_render_mode_normal FT_RENDER_MODE_NORMAL # define ft_render_mode_mono FT_RENDER_MODE_MONO Render modes supported by FreeType 2. Each mode corresponds to a specific type of scanline conversion performed on the outline. For bitmap fonts and embedded bitmaps the bitmap->pixel_mode field in the FT_GlyphSlotRec structure gives the format of the returned bitmap. All modes except FT_RENDER_MODE_MONO use 256 levels of opacity, indicating pixel coverage. Use linear alpha blending and gamma correction to correctly render non-monochrome glyph bitmaps onto a surface; see FT_Render_Glyph .","title":"FT_Render_Mode"},{"location":"ft2-base_interface.html#ft_get_kerning","text":"Defined in FT_FREETYPE_H (freetype/freetype.h). FT_EXPORT( FT_Error ) FT_Get_Kerning ( FT_Face face, FT_UInt left_glyph, FT_UInt right_glyph, FT_UInt kern_mode, FT_Vector *akerning ); Return the kerning vector between two glyphs of the same face.","title":"FT_Get_Kerning"},{"location":"ft2-base_interface.html#ft_kerning_mode","text":"Defined in FT_FREETYPE_H (freetype/freetype.h). typedef enum FT_Kerning_Mode_ { FT_KERNING_DEFAULT = 0, FT_KERNING_UNFITTED , FT_KERNING_UNSCALED } FT_Kerning_Mode ; /* these constants are deprecated; use the corresponding */ /* ` FT_Kerning_Mode ` values instead */ # define ft_kerning_default FT_KERNING_DEFAULT # define ft_kerning_unfitted FT_KERNING_UNFITTED # define ft_kerning_unscaled FT_KERNING_UNSCALED An enumeration to specify the format of kerning values returned by FT_Get_Kerning .","title":"FT_Kerning_Mode"},{"location":"ft2-base_interface.html#ft_get_track_kerning","text":"Defined in FT_FREETYPE_H (freetype/freetype.h). FT_EXPORT( FT_Error ) FT_Get_Track_Kerning ( FT_Face face, FT_Fixed point_size, FT_Int degree, FT_Fixed * akerning ); Return the track kerning for a given face object at a given size.","title":"FT_Get_Track_Kerning"},{"location":"ft2-base_interface.html#ft_get_glyph_name","text":"Defined in FT_FREETYPE_H (freetype/freetype.h). FT_EXPORT( FT_Error ) FT_Get_Glyph_Name ( FT_Face face, FT_UInt glyph_index, FT_Pointer buffer, FT_UInt buffer_max ); Retrieve the ASCII name of a given glyph in a face. This only works for those faces where FT_HAS_GLYPH_NAMES (face) returns 1.","title":"FT_Get_Glyph_Name"},{"location":"ft2-base_interface.html#ft_get_postscript_name","text":"Defined in FT_FREETYPE_H (freetype/freetype.h). FT_EXPORT( const char * ) FT_Get_Postscript_Name ( FT_Face face ); Retrieve the ASCII PostScript name of a given face, if available. This only works with PostScript, TrueType, and OpenType fonts.","title":"FT_Get_Postscript_Name"},{"location":"ft2-base_interface.html#ft_charmaprec","text":"Defined in FT_FREETYPE_H (freetype/freetype.h). typedef struct FT_CharMapRec_ { FT_Face face; FT_Encoding encoding; FT_UShort platform_id; FT_UShort encoding_id; } FT_CharMapRec ; The base charmap structure.","title":"FT_CharMapRec"},{"location":"ft2-base_interface.html#ft_select_charmap","text":"Defined in FT_FREETYPE_H (freetype/freetype.h). FT_EXPORT( FT_Error ) FT_Select_Charmap ( FT_Face face, FT_Encoding encoding ); Select a given charmap by its encoding tag (as listed in freetype.h ).","title":"FT_Select_Charmap"},{"location":"ft2-base_interface.html#ft_set_charmap","text":"Defined in FT_FREETYPE_H (freetype/freetype.h). FT_EXPORT( FT_Error ) FT_Set_Charmap ( FT_Face face, FT_CharMap charmap ); Select a given charmap for character code to glyph index mapping.","title":"FT_Set_Charmap"},{"location":"ft2-base_interface.html#ft_get_charmap_index","text":"Defined in FT_FREETYPE_H (freetype/freetype.h). FT_EXPORT( FT_Int ) FT_Get_Charmap_Index ( FT_CharMap charmap ); Retrieve index of a given charmap.","title":"FT_Get_Charmap_Index"},{"location":"ft2-base_interface.html#ft_get_fstype_flags","text":"Defined in FT_FREETYPE_H (freetype/freetype.h). FT_EXPORT( FT_UShort ) FT_Get_FSType_Flags ( FT_Face face ); Return the fsType flags for a font.","title":"FT_Get_FSType_Flags"},{"location":"ft2-base_interface.html#ft_get_subglyph_info","text":"Defined in FT_FREETYPE_H (freetype/freetype.h). FT_EXPORT( FT_Error ) FT_Get_SubGlyph_Info ( FT_GlyphSlot glyph, FT_UInt sub_index, FT_Int *p_index, FT_UInt *p_flags, FT_Int *p_arg1, FT_Int *p_arg2, FT_Matrix *p_transform ); Retrieve a description of a given subglyph. Only use it if glyph->format is FT_GLYPH_FORMAT_COMPOSITE ; an error is returned otherwise.","title":"FT_Get_SubGlyph_Info"},{"location":"ft2-base_interface.html#ft_face_internal","text":"Defined in FT_FREETYPE_H (freetype/freetype.h). typedef struct FT_Face_InternalRec_* FT_Face_Internal ; An opaque handle to an FT_Face_InternalRec structure that models the private data of a given FT_Face object. This structure might change between releases of FreeType 2 and is not generally available to client applications.","title":"FT_Face_Internal"},{"location":"ft2-base_interface.html#ft_size_internal","text":"Defined in FT_FREETYPE_H (freetype/freetype.h). typedef struct FT_Size_InternalRec_* FT_Size_Internal ; An opaque handle to an FT_Size_InternalRec structure, used to model private data of a given FT_Size object.","title":"FT_Size_Internal"},{"location":"ft2-base_interface.html#ft_slot_internal","text":"Defined in FT_FREETYPE_H (freetype/freetype.h). typedef struct FT_Slot_InternalRec_* FT_Slot_Internal ; An opaque handle to an FT_Slot_InternalRec structure, used to model private data of a given FT_GlyphSlot object.","title":"FT_Slot_Internal"},{"location":"ft2-base_interface.html#ft_face_flag_xxx","text":"Defined in FT_FREETYPE_H (freetype/freetype.h). # define FT_FACE_FLAG_SCALABLE ( 1L << 0 ) # define FT_FACE_FLAG_FIXED_SIZES ( 1L << 1 ) # define FT_FACE_FLAG_FIXED_WIDTH ( 1L << 2 ) # define FT_FACE_FLAG_SFNT ( 1L << 3 ) # define FT_FACE_FLAG_HORIZONTAL ( 1L << 4 ) # define FT_FACE_FLAG_VERTICAL ( 1L << 5 ) # define FT_FACE_FLAG_KERNING ( 1L << 6 ) # define FT_FACE_FLAG_FAST_GLYPHS ( 1L << 7 ) # define FT_FACE_FLAG_MULTIPLE_MASTERS ( 1L << 8 ) # define FT_FACE_FLAG_GLYPH_NAMES ( 1L << 9 ) # define FT_FACE_FLAG_EXTERNAL_STREAM ( 1L << 10 ) # define FT_FACE_FLAG_HINTER ( 1L << 11 ) # define FT_FACE_FLAG_CID_KEYED ( 1L << 12 ) # define FT_FACE_FLAG_TRICKY ( 1L << 13 ) # define FT_FACE_FLAG_COLOR ( 1L << 14 ) # define FT_FACE_FLAG_VARIATION ( 1L << 15 ) A list of bit flags used in the face_flags field of the FT_FaceRec structure. They inform client applications of properties of the corresponding face.","title":"FT_FACE_FLAG_XXX"},{"location":"ft2-base_interface.html#ft_style_flag_xxx","text":"Defined in FT_FREETYPE_H (freetype/freetype.h). # define FT_STYLE_FLAG_ITALIC ( 1 << 0 ) # define FT_STYLE_FLAG_BOLD ( 1 << 1 ) A list of bit flags to indicate the style of a given face. These are used in the style_flags field of FT_FaceRec .","title":"FT_STYLE_FLAG_XXX"},{"location":"ft2-base_interface.html#ft_open_xxx","text":"Defined in FT_FREETYPE_H (freetype/freetype.h). # define FT_OPEN_MEMORY 0x1 # define FT_OPEN_STREAM 0x2 # define FT_OPEN_PATHNAME 0x4 # define FT_OPEN_DRIVER 0x8 # define FT_OPEN_PARAMS 0x10 /* these constants are deprecated; use the corresponding ` FT_OPEN_XXX ` */ /* values instead */ # define ft_open_memory FT_OPEN_MEMORY # define ft_open_stream FT_OPEN_STREAM # define ft_open_pathname FT_OPEN_PATHNAME # define ft_open_driver FT_OPEN_DRIVER # define ft_open_params FT_OPEN_PARAMS A list of bit field constants used within the flags field of the FT_Open_Args structure.","title":"FT_OPEN_XXX"},{"location":"ft2-base_interface.html#ft_load_xxx","text":"Defined in FT_FREETYPE_H (freetype/freetype.h). # define FT_LOAD_DEFAULT 0x0 # define FT_LOAD_NO_SCALE ( 1L << 0 ) # define FT_LOAD_NO_HINTING ( 1L << 1 ) # define FT_LOAD_RENDER ( 1L << 2 ) # define FT_LOAD_NO_BITMAP ( 1L << 3 ) # define FT_LOAD_VERTICAL_LAYOUT ( 1L << 4 ) # define FT_LOAD_FORCE_AUTOHINT ( 1L << 5 ) # define FT_LOAD_CROP_BITMAP ( 1L << 6 ) # define FT_LOAD_PEDANTIC ( 1L << 7 ) # define FT_LOAD_IGNORE_GLOBAL_ADVANCE_WIDTH ( 1L << 9 ) # define FT_LOAD_NO_RECURSE ( 1L << 10 ) # define FT_LOAD_IGNORE_TRANSFORM ( 1L << 11 ) # define FT_LOAD_MONOCHROME ( 1L << 12 ) # define FT_LOAD_LINEAR_DESIGN ( 1L << 13 ) # define FT_LOAD_NO_AUTOHINT ( 1L << 15 ) /* Bits 16-19 are used by `FT_LOAD_TARGET_` */ # define FT_LOAD_COLOR ( 1L << 20 ) # define FT_LOAD_COMPUTE_METRICS ( 1L << 21 ) # define FT_LOAD_BITMAP_METRICS_ONLY ( 1L << 22 ) A list of bit field constants for FT_Load_Glyph to indicate what kind of operations to perform during glyph loading.","title":"FT_LOAD_XXX"},{"location":"ft2-base_interface.html#ft_load_target_xxx","text":"Defined in FT_FREETYPE_H (freetype/freetype.h). # define FT_LOAD_TARGET_( x ) ( ( FT_Int32 )( (x) & 15 ) << 16 ) # define FT_LOAD_TARGET_NORMAL FT_LOAD_TARGET_( FT_RENDER_MODE_NORMAL ) # define FT_LOAD_TARGET_LIGHT FT_LOAD_TARGET_( FT_RENDER_MODE_LIGHT ) # define FT_LOAD_TARGET_MONO FT_LOAD_TARGET_( FT_RENDER_MODE_MONO ) # define FT_LOAD_TARGET_LCD FT_LOAD_TARGET_( FT_RENDER_MODE_LCD ) # define FT_LOAD_TARGET_LCD_V FT_LOAD_TARGET_( FT_RENDER_MODE_LCD_V ) A list of values to select a specific hinting algorithm for the hinter. You should OR one of these values to your load_flags when calling FT_Load_Glyph . Note that a font's native hinters may ignore the hinting algorithm you have specified (e.g., the TrueType bytecode interpreter). You can set FT_LOAD_FORCE_AUTOHINT to ensure that the auto-hinter is used.","title":"FT_LOAD_TARGET_XXX"},{"location":"ft2-base_interface.html#ft_subglyph_flag_xxx","text":"Defined in FT_FREETYPE_H (freetype/freetype.h). # define FT_SUBGLYPH_FLAG_ARGS_ARE_WORDS 1 # define FT_SUBGLYPH_FLAG_ARGS_ARE_XY_VALUES 2 # define FT_SUBGLYPH_FLAG_ROUND_XY_TO_GRID 4 # define FT_SUBGLYPH_FLAG_SCALE 8 # define FT_SUBGLYPH_FLAG_XY_SCALE 0x40 # define FT_SUBGLYPH_FLAG_2X2 0x80 # define FT_SUBGLYPH_FLAG_USE_MY_METRICS 0x200 A list of constants describing subglyphs. Please refer to the \u2018glyf\u2019 table description in the OpenType specification for the meaning of the various flags (which get synthesized for non-OpenType subglyphs). https://docs.microsoft.com/en-us/typography/opentype/spec/glyf#composite-glyph-description","title":"FT_SUBGLYPH_FLAG_XXX"},{"location":"ft2-base_interface.html#ft_fstype_xxx","text":"Defined in FT_FREETYPE_H (freetype/freetype.h). # define FT_FSTYPE_INSTALLABLE_EMBEDDING 0x0000 # define FT_FSTYPE_RESTRICTED_LICENSE_EMBEDDING 0x0002 # define FT_FSTYPE_PREVIEW_AND_PRINT_EMBEDDING 0x0004 # define FT_FSTYPE_EDITABLE_EMBEDDING 0x0008 # define FT_FSTYPE_NO_SUBSETTING 0x0100 # define FT_FSTYPE_BITMAP_EMBEDDING_ONLY 0x0200 A list of bit flags used in the fsType field of the OS/2 table in a TrueType or OpenType font and the FSType entry in a PostScript font. These bit flags are returned by FT_Get_FSType_Flags ; they inform client applications of embedding and subsetting restrictions associated with a font. See https://www.adobe.com/content/dam/Adobe/en/devnet/acrobat/pdfs/FontPolicies.pdf for more details.","title":"FT_FSTYPE_XXX"},{"location":"ft2-base_interface.html#ft_has_fast_glyphs","text":"Defined in FT_FREETYPE_H (freetype/freetype.h). # define FT_HAS_FAST_GLYPHS ( face ) 0 Deprecated.","title":"FT_HAS_FAST_GLYPHS"},{"location":"ft2-basic_types.html","text":"FreeType \u00bb Docs \u00bb Core API \u00bb Basic Data Types Basic Data Types \u00b6 Synopsis \u00b6 This section contains the basic data types defined by FreeType 2, ranging from simple scalar types to bitmap descriptors. More font-specific structures are defined in a different section. FT_Byte \u00b6 Defined in FT_TYPES_H (freetype/fttypes.h). typedef unsigned char FT_Byte ; A simple typedef for the unsigned char type. FT_Bytes \u00b6 Defined in FT_TYPES_H (freetype/fttypes.h). typedef const FT_Byte * FT_Bytes ; A typedef for constant memory areas. FT_Char \u00b6 Defined in FT_TYPES_H (freetype/fttypes.h). typedef signed char FT_Char ; A simple typedef for the signed char type. FT_Int \u00b6 Defined in FT_TYPES_H (freetype/fttypes.h). typedef signed int FT_Int ; A typedef for the int type. FT_UInt \u00b6 Defined in FT_TYPES_H (freetype/fttypes.h). typedef unsigned int FT_UInt ; A typedef for the unsigned int type. FT_Int16 \u00b6 typedef signed short FT_Int16 ; A typedef for a 16bit signed integer type. FT_UInt16 \u00b6 typedef unsigned short FT_UInt16 ; A typedef for a 16bit unsigned integer type. FT_Int32 \u00b6 typedef signed XXX FT_Int32 ; A typedef for a 32bit signed integer type. The size depends on the configuration. FT_UInt32 \u00b6 typedef unsigned XXX FT_UInt32 ; FT_Int64 \u00b6 typedef signed XXX FT_Int64 ; FT_UInt64 \u00b6 typedef unsigned XXX FT_UInt64 ; FT_Short \u00b6 Defined in FT_TYPES_H (freetype/fttypes.h). typedef signed short FT_Short ; A typedef for signed short. FT_UShort \u00b6 Defined in FT_TYPES_H (freetype/fttypes.h). typedef unsigned short FT_UShort ; A typedef for unsigned short. FT_Long \u00b6 Defined in FT_TYPES_H (freetype/fttypes.h). typedef signed long FT_Long ; A typedef for signed long. FT_ULong \u00b6 Defined in FT_TYPES_H (freetype/fttypes.h). typedef unsigned long FT_ULong ; A typedef for unsigned long. FT_Bool \u00b6 Defined in FT_TYPES_H (freetype/fttypes.h). typedef unsigned char FT_Bool ; A typedef of unsigned char, used for simple booleans. As usual, values 1 and 0 represent true and false, respectively. FT_Offset \u00b6 Defined in FT_TYPES_H (freetype/fttypes.h). typedef size_t FT_Offset ; This is equivalent to the ANSI C size_t type, i.e., the largest unsigned integer type used to express a file size or position, or a memory block size. FT_PtrDist \u00b6 Defined in FT_TYPES_H (freetype/fttypes.h). typedef ft_ptrdiff_t FT_PtrDist ; This is equivalent to the ANSI C ptrdiff_t type, i.e., the largest signed integer type used to express the distance between two pointers. FT_String \u00b6 Defined in FT_TYPES_H (freetype/fttypes.h). typedef char FT_String ; A simple typedef for the char type, usually used for strings. FT_Tag \u00b6 Defined in FT_TYPES_H (freetype/fttypes.h). typedef FT_UInt32 FT_Tag ; A typedef for 32-bit tags (as used in the SFNT format). FT_Error \u00b6 Defined in FT_TYPES_H (freetype/fttypes.h). typedef int FT_Error ; The FreeType error code type. A value of 0 is always interpreted as a successful operation. FT_Fixed \u00b6 Defined in FT_TYPES_H (freetype/fttypes.h). typedef signed long FT_Fixed ; This type is used to store 16.16 fixed-point values, like scaling values or matrix coefficients. FT_Pointer \u00b6 Defined in FT_TYPES_H (freetype/fttypes.h). typedef void * FT_Pointer ; A simple typedef for a typeless pointer. FT_Pos \u00b6 Defined in FT_IMAGE_H (freetype/ftimage.h). typedef signed long FT_Pos ; The type FT_Pos is used to store vectorial coordinates. Depending on the context, these can represent distances in integer font units, or 16.16, or 26.6 fixed-point pixel coordinates. FT_Vector \u00b6 Defined in FT_IMAGE_H (freetype/ftimage.h). typedef struct FT_Vector_ { FT_Pos x; FT_Pos y; } FT_Vector ; A simple structure used to store a 2D vector; coordinates are of the FT_Pos type. fields x The horizontal coordinate. y The vertical coordinate. FT_BBox \u00b6 Defined in FT_IMAGE_H (freetype/ftimage.h). typedef struct FT_BBox_ { FT_Pos xMin, yMin; FT_Pos xMax, yMax; } FT_BBox ; A structure used to hold an outline's bounding box, i.e., the coordinates of its extrema in the horizontal and vertical directions. fields xMin The horizontal minimum (left-most). yMin The vertical minimum (bottom-most). xMax The horizontal maximum (right-most). yMax The vertical maximum (top-most). note The bounding box is specified with the coordinates of the lower left and the upper right corner. In PostScript, those values are often called (llx,lly) and (urx,ury), respectively. If yMin is negative, this value gives the glyph's descender. Otherwise, the glyph doesn't descend below the baseline. Similarly, if ymax is positive, this value gives the glyph's ascender. xMin gives the horizontal distance from the glyph's origin to the left edge of the glyph's bounding box. If xMin is negative, the glyph extends to the left of the origin. FT_Matrix \u00b6 Defined in FT_TYPES_H (freetype/fttypes.h). typedef struct FT_Matrix_ { FT_Fixed xx, xy; FT_Fixed yx, yy; } FT_Matrix ; A simple structure used to store a 2x2 matrix. Coefficients are in 16.16 fixed-point format. The computation performed is: x' = x*xx + y*xy y' = x*yx + y*yy fields xx Matrix coefficient. xy Matrix coefficient. yx Matrix coefficient. yy Matrix coefficient. FT_FWord \u00b6 Defined in FT_TYPES_H (freetype/fttypes.h). typedef signed short FT_FWord ; /* distance in FUnits */ A signed 16-bit integer used to store a distance in original font units. FT_UFWord \u00b6 Defined in FT_TYPES_H (freetype/fttypes.h). typedef unsigned short FT_UFWord ; /* unsigned distance */ An unsigned 16-bit integer used to store a distance in original font units. FT_F2Dot14 \u00b6 Defined in FT_TYPES_H (freetype/fttypes.h). typedef signed short FT_F2Dot14 ; A signed 2.14 fixed-point type used for unit vectors. FT_UnitVector \u00b6 Defined in FT_TYPES_H (freetype/fttypes.h). typedef struct FT_UnitVector_ { FT_F2Dot14 x; FT_F2Dot14 y; } FT_UnitVector ; A simple structure used to store a 2D vector unit vector. Uses FT_F2Dot14 types. fields x Horizontal coordinate. y Vertical coordinate. FT_F26Dot6 \u00b6 Defined in FT_TYPES_H (freetype/fttypes.h). typedef signed long FT_F26Dot6 ; A signed 26.6 fixed-point type used for vectorial pixel coordinates. FT_Data \u00b6 Defined in FT_TYPES_H (freetype/fttypes.h). typedef struct FT_Data_ { const FT_Byte * pointer; FT_Int length; } FT_Data ; Read-only binary data represented as a pointer and a length. fields pointer The data. length The length of the data in bytes. FT_MAKE_TAG \u00b6 Defined in FT_TYPES_H (freetype/fttypes.h). # define FT_MAKE_TAG ( _x1, _x2, _x3, _x4 ) \\ ( FT_Tag ) \\ ( ( ( FT_ULong )_x1 << 24 ) | \\ ( ( FT_ULong )_x2 << 16 ) | \\ ( ( FT_ULong )_x3 << 8 ) | \\ ( FT_ULong )_x4 ) This macro converts four-letter tags that are used to label TrueType tables into an unsigned long, to be used within FreeType. note The produced values must be 32-bit integers. Don't redefine this macro. FT_Generic \u00b6 Defined in FT_TYPES_H (freetype/fttypes.h). typedef struct FT_Generic_ { void * data; FT_Generic_Finalizer finalizer; } FT_Generic ; Client applications often need to associate their own data to a variety of FreeType core objects. For example, a text layout API might want to associate a glyph cache to a given size object. Some FreeType object contains a generic field, of type FT_Generic , which usage is left to client applications and font servers. It can be used to store a pointer to client-specific data, as well as the address of a \u2018finalizer\u2019 function, which will be called by FreeType when the object is destroyed (for example, the previous client example would put the address of the glyph cache destructor in the finalizer field). fields data A typeless pointer to any client-specified data. This field is completely ignored by the FreeType library. finalizer A pointer to a \u2018generic finalizer\u2019 function, which will be called when the object is destroyed. If this field is set to NULL , no code will be called. FT_Generic_Finalizer \u00b6 Defined in FT_TYPES_H (freetype/fttypes.h). typedef void (* FT_Generic_Finalizer )( void * object ); Describe a function used to destroy the \u2018client\u2019 data of any FreeType object. See the description of the FT_Generic type for details of usage. input The address of the FreeType object that is under finalization. Its client data is accessed through its generic field. FT_Bitmap \u00b6 Defined in FT_IMAGE_H (freetype/ftimage.h). typedef struct FT_Bitmap_ { unsigned int rows; unsigned int width; int pitch; unsigned char * buffer; unsigned short num_grays; unsigned char pixel_mode; unsigned char palette_mode; void * palette; } FT_Bitmap ; A structure used to describe a bitmap or pixmap to the raster. Note that we now manage pixmaps of various depths through the pixel_mode field. fields rows The number of bitmap rows. width The number of pixels in bitmap row. pitch The pitch's absolute value is the number of bytes taken by one bitmap row, including padding. However, the pitch is positive when the bitmap has a \u2018down\u2019 flow, and negative when it has an \u2018up\u2019 flow. In all cases, the pitch is an offset to add to a bitmap pointer in order to go down one row. Note that \u2018padding\u2019 means the alignment of a bitmap to a byte border, and FreeType functions normally align to the smallest possible integer value. For the B/W rasterizer, pitch is always an even number. To change the pitch of a bitmap (say, to make it a multiple of 4), use FT_Bitmap_Convert . Alternatively, you might use callback functions to directly render to the application's surface; see the file example2.cpp in the tutorial for a demonstration. buffer A typeless pointer to the bitmap buffer. This value should be aligned on 32-bit boundaries in most cases. num_grays This field is only used with FT_PIXEL_MODE_GRAY ; it gives the number of gray levels used in the bitmap. pixel_mode The pixel mode, i.e., how pixel bits are stored. See FT_Pixel_Mode for possible values. palette_mode This field is intended for paletted pixel modes; it indicates how the palette is stored. Not used currently. palette A typeless pointer to the bitmap palette; this field is intended for paletted pixel modes. Not used currently. FT_Pixel_Mode \u00b6 Defined in FT_IMAGE_H (freetype/ftimage.h). typedef enum FT_Pixel_Mode_ { FT_PIXEL_MODE_NONE = 0, FT_PIXEL_MODE_MONO , FT_PIXEL_MODE_GRAY , FT_PIXEL_MODE_GRAY2 , FT_PIXEL_MODE_GRAY4 , FT_PIXEL_MODE_LCD , FT_PIXEL_MODE_LCD_V , FT_PIXEL_MODE_BGRA , FT_PIXEL_MODE_MAX /* do not remove */ } FT_Pixel_Mode ; /* these constants are deprecated; use the corresponding ` FT_Pixel_Mode ` */ /* values instead. */ # define ft_pixel_mode_none FT_PIXEL_MODE_NONE # define ft_pixel_mode_mono FT_PIXEL_MODE_MONO # define ft_pixel_mode_grays FT_PIXEL_MODE_GRAY # define ft_pixel_mode_pal2 FT_PIXEL_MODE_GRAY2 # define ft_pixel_mode_pal4 FT_PIXEL_MODE_GRAY4 An enumeration type used to describe the format of pixels in a given bitmap. Note that additional formats may be added in the future. values FT_PIXEL_MODE_NONE Value 0 is reserved. FT_PIXEL_MODE_MONO A monochrome bitmap, using 1 bit per pixel. Note that pixels are stored in most-significant order (MSB), which means that the left-most pixel in a byte has value 128. FT_PIXEL_MODE_GRAY An 8-bit bitmap, generally used to represent anti-aliased glyph images. Each pixel is stored in one byte. Note that the number of \u2018gray\u2019 levels is stored in the num_grays field of the FT_Bitmap structure (it generally is 256). FT_PIXEL_MODE_GRAY2 A 2-bit per pixel bitmap, used to represent embedded anti-aliased bitmaps in font files according to the OpenType specification. We haven't found a single font using this format, however. FT_PIXEL_MODE_GRAY4 A 4-bit per pixel bitmap, representing embedded anti-aliased bitmaps in font files according to the OpenType specification. We haven't found a single font using this format, however. FT_PIXEL_MODE_LCD An 8-bit bitmap, representing RGB or BGR decimated glyph images used for display on LCD displays; the bitmap is three times wider than the original glyph image. See also FT_RENDER_MODE_LCD . FT_PIXEL_MODE_LCD_V An 8-bit bitmap, representing RGB or BGR decimated glyph images used for display on rotated LCD displays; the bitmap is three times taller than the original glyph image. See also FT_RENDER_MODE_LCD_V . FT_PIXEL_MODE_BGRA [Since 2.5] An image with four 8-bit channels per pixel, representing a color image (such as emoticons) with alpha channel. For each pixel, the format is BGRA, which means, the blue channel comes first in memory. The color channels are pre-multiplied and in the sRGB colorspace. For example, full red at half-translucent opacity will be represented as \u201800,00,80,80\u2019, not \u201800,00,FF,80\u2019. See also FT_LOAD_COLOR . FT_Glyph_Format \u00b6 Defined in FT_IMAGE_H (freetype/ftimage.h). typedef enum FT_Glyph_Format_ { FT_IMAGE_TAG ( FT_GLYPH_FORMAT_NONE , 0, 0, 0, 0 ), FT_IMAGE_TAG ( FT_GLYPH_FORMAT_COMPOSITE , 'c', 'o', 'm', 'p' ), FT_IMAGE_TAG ( FT_GLYPH_FORMAT_BITMAP , 'b', 'i', 't', 's' ), FT_IMAGE_TAG ( FT_GLYPH_FORMAT_OUTLINE , 'o', 'u', 't', 'l' ), FT_IMAGE_TAG ( FT_GLYPH_FORMAT_PLOTTER , 'p', 'l', 'o', 't' ) } FT_Glyph_Format ; /* these constants are deprecated; use the corresponding */ /* ` FT_Glyph_Format ` values instead. */ # define ft_glyph_format_none FT_GLYPH_FORMAT_NONE # define ft_glyph_format_composite FT_GLYPH_FORMAT_COMPOSITE # define ft_glyph_format_bitmap FT_GLYPH_FORMAT_BITMAP # define ft_glyph_format_outline FT_GLYPH_FORMAT_OUTLINE # define ft_glyph_format_plotter FT_GLYPH_FORMAT_PLOTTER An enumeration type used to describe the format of a given glyph image. Note that this version of FreeType only supports two image formats, even though future font drivers will be able to register their own format. values FT_GLYPH_FORMAT_NONE The value 0 is reserved. FT_GLYPH_FORMAT_COMPOSITE The glyph image is a composite of several other images. This format is only used with FT_LOAD_NO_RECURSE , and is used to report compound glyphs (like accented characters). FT_GLYPH_FORMAT_BITMAP The glyph image is a bitmap, and can be described as an FT_Bitmap . You generally need to access the bitmap field of the FT_GlyphSlotRec structure to read it. FT_GLYPH_FORMAT_OUTLINE The glyph image is a vectorial outline made of line segments and Bezier arcs; it can be described as an FT_Outline ; you generally want to access the outline field of the FT_GlyphSlotRec structure to read it. FT_GLYPH_FORMAT_PLOTTER The glyph image is a vectorial path with no inside and outside contours. Some Type 1 fonts, like those in the Hershey family, contain glyphs in this format. These are described as FT_Outline , but FreeType isn't currently capable of rendering them correctly. FT_IMAGE_TAG \u00b6 Defined in FT_IMAGE_H (freetype/ftimage.h). # ifndef FT_IMAGE_TAG # define FT_IMAGE_TAG ( value, _x1, _x2, _x3, _x4 ) \\ value = ( ( ( unsigned long )_x1 << 24 ) | \\ ( ( unsigned long )_x2 << 16 ) | \\ ( ( unsigned long )_x3 << 8 ) | \\ ( unsigned long )_x4 ) # endif /* FT_IMAGE_TAG */ This macro converts four-letter tags to an unsigned long type. note Since many 16-bit compilers don't like 32-bit enumerations, you should redefine this macro in case of problems to something like this: #define FT_IMAGE_TAG( value, _x1, _x2, _x3, _x4 ) value to get a simple enumeration without assigning special numbers.","title":"Basic Data Types"},{"location":"ft2-basic_types.html#basic-data-types","text":"","title":"Basic Data Types"},{"location":"ft2-basic_types.html#synopsis","text":"This section contains the basic data types defined by FreeType 2, ranging from simple scalar types to bitmap descriptors. More font-specific structures are defined in a different section.","title":"Synopsis"},{"location":"ft2-basic_types.html#ft_byte","text":"Defined in FT_TYPES_H (freetype/fttypes.h). typedef unsigned char FT_Byte ; A simple typedef for the unsigned char type.","title":"FT_Byte"},{"location":"ft2-basic_types.html#ft_bytes","text":"Defined in FT_TYPES_H (freetype/fttypes.h). typedef const FT_Byte * FT_Bytes ; A typedef for constant memory areas.","title":"FT_Bytes"},{"location":"ft2-basic_types.html#ft_char","text":"Defined in FT_TYPES_H (freetype/fttypes.h). typedef signed char FT_Char ; A simple typedef for the signed char type.","title":"FT_Char"},{"location":"ft2-basic_types.html#ft_int","text":"Defined in FT_TYPES_H (freetype/fttypes.h). typedef signed int FT_Int ; A typedef for the int type.","title":"FT_Int"},{"location":"ft2-basic_types.html#ft_uint","text":"Defined in FT_TYPES_H (freetype/fttypes.h). typedef unsigned int FT_UInt ; A typedef for the unsigned int type.","title":"FT_UInt"},{"location":"ft2-basic_types.html#ft_int16","text":"typedef signed short FT_Int16 ; A typedef for a 16bit signed integer type.","title":"FT_Int16"},{"location":"ft2-basic_types.html#ft_uint16","text":"typedef unsigned short FT_UInt16 ; A typedef for a 16bit unsigned integer type.","title":"FT_UInt16"},{"location":"ft2-basic_types.html#ft_int32","text":"typedef signed XXX FT_Int32 ; A typedef for a 32bit signed integer type. The size depends on the configuration.","title":"FT_Int32"},{"location":"ft2-basic_types.html#ft_uint32","text":"typedef unsigned XXX FT_UInt32 ;","title":"FT_UInt32"},{"location":"ft2-basic_types.html#ft_int64","text":"typedef signed XXX FT_Int64 ;","title":"FT_Int64"},{"location":"ft2-basic_types.html#ft_uint64","text":"typedef unsigned XXX FT_UInt64 ;","title":"FT_UInt64"},{"location":"ft2-basic_types.html#ft_short","text":"Defined in FT_TYPES_H (freetype/fttypes.h). typedef signed short FT_Short ; A typedef for signed short.","title":"FT_Short"},{"location":"ft2-basic_types.html#ft_ushort","text":"Defined in FT_TYPES_H (freetype/fttypes.h). typedef unsigned short FT_UShort ; A typedef for unsigned short.","title":"FT_UShort"},{"location":"ft2-basic_types.html#ft_long","text":"Defined in FT_TYPES_H (freetype/fttypes.h). typedef signed long FT_Long ; A typedef for signed long.","title":"FT_Long"},{"location":"ft2-basic_types.html#ft_ulong","text":"Defined in FT_TYPES_H (freetype/fttypes.h). typedef unsigned long FT_ULong ; A typedef for unsigned long.","title":"FT_ULong"},{"location":"ft2-basic_types.html#ft_bool","text":"Defined in FT_TYPES_H (freetype/fttypes.h). typedef unsigned char FT_Bool ; A typedef of unsigned char, used for simple booleans. As usual, values 1 and 0 represent true and false, respectively.","title":"FT_Bool"},{"location":"ft2-basic_types.html#ft_offset","text":"Defined in FT_TYPES_H (freetype/fttypes.h). typedef size_t FT_Offset ; This is equivalent to the ANSI C size_t type, i.e., the largest unsigned integer type used to express a file size or position, or a memory block size.","title":"FT_Offset"},{"location":"ft2-basic_types.html#ft_ptrdist","text":"Defined in FT_TYPES_H (freetype/fttypes.h). typedef ft_ptrdiff_t FT_PtrDist ; This is equivalent to the ANSI C ptrdiff_t type, i.e., the largest signed integer type used to express the distance between two pointers.","title":"FT_PtrDist"},{"location":"ft2-basic_types.html#ft_string","text":"Defined in FT_TYPES_H (freetype/fttypes.h). typedef char FT_String ; A simple typedef for the char type, usually used for strings.","title":"FT_String"},{"location":"ft2-basic_types.html#ft_tag","text":"Defined in FT_TYPES_H (freetype/fttypes.h). typedef FT_UInt32 FT_Tag ; A typedef for 32-bit tags (as used in the SFNT format).","title":"FT_Tag"},{"location":"ft2-basic_types.html#ft_error","text":"Defined in FT_TYPES_H (freetype/fttypes.h). typedef int FT_Error ; The FreeType error code type. A value of 0 is always interpreted as a successful operation.","title":"FT_Error"},{"location":"ft2-basic_types.html#ft_fixed","text":"Defined in FT_TYPES_H (freetype/fttypes.h). typedef signed long FT_Fixed ; This type is used to store 16.16 fixed-point values, like scaling values or matrix coefficients.","title":"FT_Fixed"},{"location":"ft2-basic_types.html#ft_pointer","text":"Defined in FT_TYPES_H (freetype/fttypes.h). typedef void * FT_Pointer ; A simple typedef for a typeless pointer.","title":"FT_Pointer"},{"location":"ft2-basic_types.html#ft_pos","text":"Defined in FT_IMAGE_H (freetype/ftimage.h). typedef signed long FT_Pos ; The type FT_Pos is used to store vectorial coordinates. Depending on the context, these can represent distances in integer font units, or 16.16, or 26.6 fixed-point pixel coordinates.","title":"FT_Pos"},{"location":"ft2-basic_types.html#ft_vector","text":"Defined in FT_IMAGE_H (freetype/ftimage.h). typedef struct FT_Vector_ { FT_Pos x; FT_Pos y; } FT_Vector ; A simple structure used to store a 2D vector; coordinates are of the FT_Pos type.","title":"FT_Vector"},{"location":"ft2-basic_types.html#ft_bbox","text":"Defined in FT_IMAGE_H (freetype/ftimage.h). typedef struct FT_BBox_ { FT_Pos xMin, yMin; FT_Pos xMax, yMax; } FT_BBox ; A structure used to hold an outline's bounding box, i.e., the coordinates of its extrema in the horizontal and vertical directions.","title":"FT_BBox"},{"location":"ft2-basic_types.html#ft_matrix","text":"Defined in FT_TYPES_H (freetype/fttypes.h). typedef struct FT_Matrix_ { FT_Fixed xx, xy; FT_Fixed yx, yy; } FT_Matrix ; A simple structure used to store a 2x2 matrix. Coefficients are in 16.16 fixed-point format. The computation performed is: x' = x*xx + y*xy y' = x*yx + y*yy","title":"FT_Matrix"},{"location":"ft2-basic_types.html#ft_fword","text":"Defined in FT_TYPES_H (freetype/fttypes.h). typedef signed short FT_FWord ; /* distance in FUnits */ A signed 16-bit integer used to store a distance in original font units.","title":"FT_FWord"},{"location":"ft2-basic_types.html#ft_ufword","text":"Defined in FT_TYPES_H (freetype/fttypes.h). typedef unsigned short FT_UFWord ; /* unsigned distance */ An unsigned 16-bit integer used to store a distance in original font units.","title":"FT_UFWord"},{"location":"ft2-basic_types.html#ft_f2dot14","text":"Defined in FT_TYPES_H (freetype/fttypes.h). typedef signed short FT_F2Dot14 ; A signed 2.14 fixed-point type used for unit vectors.","title":"FT_F2Dot14"},{"location":"ft2-basic_types.html#ft_unitvector","text":"Defined in FT_TYPES_H (freetype/fttypes.h). typedef struct FT_UnitVector_ { FT_F2Dot14 x; FT_F2Dot14 y; } FT_UnitVector ; A simple structure used to store a 2D vector unit vector. Uses FT_F2Dot14 types.","title":"FT_UnitVector"},{"location":"ft2-basic_types.html#ft_f26dot6","text":"Defined in FT_TYPES_H (freetype/fttypes.h). typedef signed long FT_F26Dot6 ; A signed 26.6 fixed-point type used for vectorial pixel coordinates.","title":"FT_F26Dot6"},{"location":"ft2-basic_types.html#ft_data","text":"Defined in FT_TYPES_H (freetype/fttypes.h). typedef struct FT_Data_ { const FT_Byte * pointer; FT_Int length; } FT_Data ; Read-only binary data represented as a pointer and a length.","title":"FT_Data"},{"location":"ft2-basic_types.html#ft_make_tag","text":"Defined in FT_TYPES_H (freetype/fttypes.h). # define FT_MAKE_TAG ( _x1, _x2, _x3, _x4 ) \\ ( FT_Tag ) \\ ( ( ( FT_ULong )_x1 << 24 ) | \\ ( ( FT_ULong )_x2 << 16 ) | \\ ( ( FT_ULong )_x3 << 8 ) | \\ ( FT_ULong )_x4 ) This macro converts four-letter tags that are used to label TrueType tables into an unsigned long, to be used within FreeType.","title":"FT_MAKE_TAG"},{"location":"ft2-basic_types.html#ft_generic","text":"Defined in FT_TYPES_H (freetype/fttypes.h). typedef struct FT_Generic_ { void * data; FT_Generic_Finalizer finalizer; } FT_Generic ; Client applications often need to associate their own data to a variety of FreeType core objects. For example, a text layout API might want to associate a glyph cache to a given size object. Some FreeType object contains a generic field, of type FT_Generic , which usage is left to client applications and font servers. It can be used to store a pointer to client-specific data, as well as the address of a \u2018finalizer\u2019 function, which will be called by FreeType when the object is destroyed (for example, the previous client example would put the address of the glyph cache destructor in the finalizer field).","title":"FT_Generic"},{"location":"ft2-basic_types.html#ft_generic_finalizer","text":"Defined in FT_TYPES_H (freetype/fttypes.h). typedef void (* FT_Generic_Finalizer )( void * object ); Describe a function used to destroy the \u2018client\u2019 data of any FreeType object. See the description of the FT_Generic type for details of usage.","title":"FT_Generic_Finalizer"},{"location":"ft2-basic_types.html#ft_bitmap","text":"Defined in FT_IMAGE_H (freetype/ftimage.h). typedef struct FT_Bitmap_ { unsigned int rows; unsigned int width; int pitch; unsigned char * buffer; unsigned short num_grays; unsigned char pixel_mode; unsigned char palette_mode; void * palette; } FT_Bitmap ; A structure used to describe a bitmap or pixmap to the raster. Note that we now manage pixmaps of various depths through the pixel_mode field.","title":"FT_Bitmap"},{"location":"ft2-basic_types.html#ft_pixel_mode","text":"Defined in FT_IMAGE_H (freetype/ftimage.h). typedef enum FT_Pixel_Mode_ { FT_PIXEL_MODE_NONE = 0, FT_PIXEL_MODE_MONO , FT_PIXEL_MODE_GRAY , FT_PIXEL_MODE_GRAY2 , FT_PIXEL_MODE_GRAY4 , FT_PIXEL_MODE_LCD , FT_PIXEL_MODE_LCD_V , FT_PIXEL_MODE_BGRA , FT_PIXEL_MODE_MAX /* do not remove */ } FT_Pixel_Mode ; /* these constants are deprecated; use the corresponding ` FT_Pixel_Mode ` */ /* values instead. */ # define ft_pixel_mode_none FT_PIXEL_MODE_NONE # define ft_pixel_mode_mono FT_PIXEL_MODE_MONO # define ft_pixel_mode_grays FT_PIXEL_MODE_GRAY # define ft_pixel_mode_pal2 FT_PIXEL_MODE_GRAY2 # define ft_pixel_mode_pal4 FT_PIXEL_MODE_GRAY4 An enumeration type used to describe the format of pixels in a given bitmap. Note that additional formats may be added in the future.","title":"FT_Pixel_Mode"},{"location":"ft2-basic_types.html#ft_glyph_format","text":"Defined in FT_IMAGE_H (freetype/ftimage.h). typedef enum FT_Glyph_Format_ { FT_IMAGE_TAG ( FT_GLYPH_FORMAT_NONE , 0, 0, 0, 0 ), FT_IMAGE_TAG ( FT_GLYPH_FORMAT_COMPOSITE , 'c', 'o', 'm', 'p' ), FT_IMAGE_TAG ( FT_GLYPH_FORMAT_BITMAP , 'b', 'i', 't', 's' ), FT_IMAGE_TAG ( FT_GLYPH_FORMAT_OUTLINE , 'o', 'u', 't', 'l' ), FT_IMAGE_TAG ( FT_GLYPH_FORMAT_PLOTTER , 'p', 'l', 'o', 't' ) } FT_Glyph_Format ; /* these constants are deprecated; use the corresponding */ /* ` FT_Glyph_Format ` values instead. */ # define ft_glyph_format_none FT_GLYPH_FORMAT_NONE # define ft_glyph_format_composite FT_GLYPH_FORMAT_COMPOSITE # define ft_glyph_format_bitmap FT_GLYPH_FORMAT_BITMAP # define ft_glyph_format_outline FT_GLYPH_FORMAT_OUTLINE # define ft_glyph_format_plotter FT_GLYPH_FORMAT_PLOTTER An enumeration type used to describe the format of a given glyph image. Note that this version of FreeType only supports two image formats, even though future font drivers will be able to register their own format.","title":"FT_Glyph_Format"},{"location":"ft2-basic_types.html#ft_image_tag","text":"Defined in FT_IMAGE_H (freetype/ftimage.h). # ifndef FT_IMAGE_TAG # define FT_IMAGE_TAG ( value, _x1, _x2, _x3, _x4 ) \\ value = ( ( ( unsigned long )_x1 << 24 ) | \\ ( ( unsigned long )_x2 << 16 ) | \\ ( ( unsigned long )_x3 << 8 ) | \\ ( unsigned long )_x4 ) # endif /* FT_IMAGE_TAG */ This macro converts four-letter tags to an unsigned long type.","title":"FT_IMAGE_TAG"},{"location":"ft2-bdf_fonts.html","text":"FreeType \u00bb Docs \u00bb Format-Specific API \u00bb BDF and PCF Files BDF and PCF Files \u00b6 Synopsis \u00b6 This section contains the declaration of functions specific to BDF and PCF fonts. BDF_PropertyType \u00b6 Defined in FT_BDF_H (freetype/ftbdf.h). typedef enum BDF_PropertyType_ { BDF_PROPERTY_TYPE_NONE = 0, BDF_PROPERTY_TYPE_ATOM = 1, BDF_PROPERTY_TYPE_INTEGER = 2, BDF_PROPERTY_TYPE_CARDINAL = 3 } BDF_PropertyType ; A list of BDF property types. values BDF_PROPERTY_TYPE_NONE Value 0 is used to indicate a missing property. BDF_PROPERTY_TYPE_ATOM Property is a string atom. BDF_PROPERTY_TYPE_INTEGER Property is a 32-bit signed integer. BDF_PROPERTY_TYPE_CARDINAL Property is a 32-bit unsigned integer. BDF_Property \u00b6 Defined in FT_BDF_H (freetype/ftbdf.h). typedef struct BDF_PropertyRec_* BDF_Property ; A handle to a BDF_PropertyRec structure to model a given BDF/PCF property. BDF_PropertyRec \u00b6 Defined in FT_BDF_H (freetype/ftbdf.h). typedef struct BDF_PropertyRec_ { BDF_PropertyType type; union { const char * atom; FT_Int32 integer; FT_UInt32 cardinal; } u; } BDF_PropertyRec ; This structure models a given BDF/PCF property. fields type The property type. u.atom The atom string, if type is BDF_PROPERTY_TYPE_ATOM . May be NULL , indicating an empty string. u.integer A signed integer, if type is BDF_PROPERTY_TYPE_INTEGER . u.cardinal An unsigned integer, if type is BDF_PROPERTY_TYPE_CARDINAL . FT_Get_BDF_Charset_ID \u00b6 Defined in FT_BDF_H (freetype/ftbdf.h). FT_EXPORT( FT_Error ) FT_Get_BDF_Charset_ID ( FT_Face face, const char * *acharset_encoding, const char * *acharset_registry ); Retrieve a BDF font character set identity, according to the BDF specification. input face A handle to the input face. output acharset_encoding Charset encoding, as a C string, owned by the face. acharset_registry Charset registry, as a C string, owned by the face. return FreeType error code. 0 means success. note This function only works with BDF faces, returning an error otherwise. FT_Get_BDF_Property \u00b6 Defined in FT_BDF_H (freetype/ftbdf.h). FT_EXPORT( FT_Error ) FT_Get_BDF_Property ( FT_Face face, const char * prop_name, BDF_PropertyRec *aproperty ); Retrieve a BDF property from a BDF or PCF font file. input face A handle to the input face. name The property name. output aproperty The property. return FreeType error code. 0 means success. note This function works with BDF and PCF fonts. It returns an error otherwise. It also returns an error if the property is not in the font. A \u2018property\u2019 is a either key-value pair within the STARTPROPERTIES ... ENDPROPERTIES block of a BDF font or a key-value pair from the info->props array within a FontRec structure of a PCF font. Integer properties are always stored as \u2018signed\u2019 within PCF fonts; consequently, BDF_PROPERTY_TYPE_CARDINAL is a possible return value for BDF fonts only. In case of error, aproperty->type is always set to BDF_PROPERTY_TYPE_NONE .","title":"BDF and PCF Files"},{"location":"ft2-bdf_fonts.html#bdf-and-pcf-files","text":"","title":"BDF and PCF Files"},{"location":"ft2-bdf_fonts.html#synopsis","text":"This section contains the declaration of functions specific to BDF and PCF fonts.","title":"Synopsis"},{"location":"ft2-bdf_fonts.html#bdf_propertytype","text":"Defined in FT_BDF_H (freetype/ftbdf.h). typedef enum BDF_PropertyType_ { BDF_PROPERTY_TYPE_NONE = 0, BDF_PROPERTY_TYPE_ATOM = 1, BDF_PROPERTY_TYPE_INTEGER = 2, BDF_PROPERTY_TYPE_CARDINAL = 3 } BDF_PropertyType ; A list of BDF property types.","title":"BDF_PropertyType"},{"location":"ft2-bdf_fonts.html#bdf_property","text":"Defined in FT_BDF_H (freetype/ftbdf.h). typedef struct BDF_PropertyRec_* BDF_Property ; A handle to a BDF_PropertyRec structure to model a given BDF/PCF property.","title":"BDF_Property"},{"location":"ft2-bdf_fonts.html#bdf_propertyrec","text":"Defined in FT_BDF_H (freetype/ftbdf.h). typedef struct BDF_PropertyRec_ { BDF_PropertyType type; union { const char * atom; FT_Int32 integer; FT_UInt32 cardinal; } u; } BDF_PropertyRec ; This structure models a given BDF/PCF property.","title":"BDF_PropertyRec"},{"location":"ft2-bdf_fonts.html#ft_get_bdf_charset_id","text":"Defined in FT_BDF_H (freetype/ftbdf.h). FT_EXPORT( FT_Error ) FT_Get_BDF_Charset_ID ( FT_Face face, const char * *acharset_encoding, const char * *acharset_registry ); Retrieve a BDF font character set identity, according to the BDF specification.","title":"FT_Get_BDF_Charset_ID"},{"location":"ft2-bdf_fonts.html#ft_get_bdf_property","text":"Defined in FT_BDF_H (freetype/ftbdf.h). FT_EXPORT( FT_Error ) FT_Get_BDF_Property ( FT_Face face, const char * prop_name, BDF_PropertyRec *aproperty ); Retrieve a BDF property from a BDF or PCF font file.","title":"FT_Get_BDF_Property"},{"location":"ft2-bitmap_handling.html","text":"FreeType \u00bb Docs \u00bb Support API \u00bb Bitmap Handling Bitmap Handling \u00b6 Synopsis \u00b6 This section contains functions for handling FT_Bitmap objects, automatically adjusting the target's bitmap buffer size as needed. Note that none of the functions changes the bitmap's \u2018flow\u2019 (as indicated by the sign of the pitch field in FT_Bitmap ). To set the flow, assign an appropriate positive or negative value to the pitch field of the target FT_Bitmap object after calling FT_Bitmap_Init but before calling any of the other functions described here. FT_Bitmap_Init \u00b6 Defined in FT_BITMAP_H (freetype/ftbitmap.h). FT_EXPORT( void ) FT_Bitmap_Init ( FT_Bitmap *abitmap ); /* deprecated */ FT_EXPORT( void ) FT_Bitmap_New( FT_Bitmap *abitmap ); Initialize a pointer to an FT_Bitmap structure. inout abitmap A pointer to the bitmap structure. note A deprecated name for the same function is FT_Bitmap_New . FT_Bitmap_Copy \u00b6 Defined in FT_BITMAP_H (freetype/ftbitmap.h). FT_EXPORT( FT_Error ) FT_Bitmap_Copy ( FT_Library library, const FT_Bitmap *source, FT_Bitmap *target ); Copy a bitmap into another one. input library A handle to a library object. source A handle to the source bitmap. output target A handle to the target bitmap. return FreeType error code. 0 means success. note source->buffer and target->buffer must neither be equal nor overlap. FT_Bitmap_Embolden \u00b6 Defined in FT_BITMAP_H (freetype/ftbitmap.h). FT_EXPORT( FT_Error ) FT_Bitmap_Embolden ( FT_Library library, FT_Bitmap * bitmap, FT_Pos xStrength, FT_Pos yStrength ); Embolden a bitmap. The new bitmap will be about xStrength pixels wider and yStrength pixels higher. The left and bottom borders are kept unchanged. input library A handle to a library object. xStrength How strong the glyph is emboldened horizontally. Expressed in 26.6 pixel format. yStrength How strong the glyph is emboldened vertically. Expressed in 26.6 pixel format. inout bitmap A handle to the target bitmap. return FreeType error code. 0 means success. note The current implementation restricts xStrength to be less than or equal to 8 if bitmap is of pixel_mode FT_PIXEL_MODE_MONO . If you want to embolden the bitmap owned by a FT_GlyphSlotRec , you should call FT_GlyphSlot_Own_Bitmap on the slot first. Bitmaps in FT_PIXEL_MODE_GRAY2 and FT_PIXEL_MODE_GRAY @ format are converted to FT_PIXEL_MODE_GRAY format (i.e., 8bpp). FT_Bitmap_Convert \u00b6 Defined in FT_BITMAP_H (freetype/ftbitmap.h). FT_EXPORT( FT_Error ) FT_Bitmap_Convert ( FT_Library library, const FT_Bitmap *source, FT_Bitmap *target, FT_Int alignment ); Convert a bitmap object with depth 1bpp, 2bpp, 4bpp, 8bpp or 32bpp to a bitmap object with depth 8bpp, making the number of used bytes per line (a.k.a. the \u2018pitch\u2019) a multiple of alignment . input library A handle to a library object. source The source bitmap. alignment The pitch of the bitmap is a multiple of this argument. Common values are 1, 2, or 4. output target The target bitmap. return FreeType error code. 0 means success. note It is possible to call FT_Bitmap_Convert multiple times without calling FT_Bitmap_Done (the memory is simply reallocated). Use FT_Bitmap_Done to finally remove the bitmap object. The library argument is taken to have access to FreeType's memory handling functions. source->buffer and target->buffer must neither be equal nor overlap. FT_Bitmap_Blend \u00b6 Defined in FT_BITMAP_H (freetype/ftbitmap.h). FT_EXPORT( FT_Error ) FT_Bitmap_Blend ( FT_Library library, const FT_Bitmap * source, const FT_Vector source_offset, FT_Bitmap * target, FT_Vector *atarget_offset, FT_Color color ); Blend a bitmap onto another bitmap, using a given color. input library A handle to a library object. source The source bitmap, which can have any FT_Pixel_Mode format. source_offset The offset vector to the upper left corner of the source bitmap in 26.6 pixel format. It should represent an integer offset; the function will set the lowest six bits to zero to enforce that. color The color used to draw source onto target . inout target A handle to an FT_Bitmap object. It should be either initialized as empty with a call to FT_Bitmap_Init , or it should be of type FT_PIXEL_MODE_BGRA . atarget_offset The offset vector to the upper left corner of the target bitmap in 26.6 pixel format. It should represent an integer offset; the function will set the lowest six bits to zero to enforce that. return FreeType error code. 0 means success. note This function doesn't perform clipping. The bitmap in target gets allocated or reallocated as needed; the vector atarget_offset is updated accordingly. In case of allocation or reallocation, the bitmap's pitch is set to 4 * width . Both source and target must have the same bitmap flow (as indicated by the sign of the pitch field). source->buffer and target->buffer must neither be equal nor overlap. since 2.10 FT_GlyphSlot_Own_Bitmap \u00b6 Defined in FT_BITMAP_H (freetype/ftbitmap.h). FT_EXPORT( FT_Error ) FT_GlyphSlot_Own_Bitmap ( FT_GlyphSlot slot ); Make sure that a glyph slot owns slot->bitmap . input slot The glyph slot. return FreeType error code. 0 means success. note This function is to be used in combination with FT_Bitmap_Embolden . FT_Bitmap_Done \u00b6 Defined in FT_BITMAP_H (freetype/ftbitmap.h). FT_EXPORT( FT_Error ) FT_Bitmap_Done ( FT_Library library, FT_Bitmap *bitmap ); Destroy a bitmap object initialized with FT_Bitmap_Init . input library A handle to a library object. bitmap The bitmap object to be freed. return FreeType error code. 0 means success. note The library argument is taken to have access to FreeType's memory handling functions.","title":"Bitmap Handling"},{"location":"ft2-bitmap_handling.html#bitmap-handling","text":"","title":"Bitmap Handling"},{"location":"ft2-bitmap_handling.html#synopsis","text":"This section contains functions for handling FT_Bitmap objects, automatically adjusting the target's bitmap buffer size as needed. Note that none of the functions changes the bitmap's \u2018flow\u2019 (as indicated by the sign of the pitch field in FT_Bitmap ). To set the flow, assign an appropriate positive or negative value to the pitch field of the target FT_Bitmap object after calling FT_Bitmap_Init but before calling any of the other functions described here.","title":"Synopsis"},{"location":"ft2-bitmap_handling.html#ft_bitmap_init","text":"Defined in FT_BITMAP_H (freetype/ftbitmap.h). FT_EXPORT( void ) FT_Bitmap_Init ( FT_Bitmap *abitmap ); /* deprecated */ FT_EXPORT( void ) FT_Bitmap_New( FT_Bitmap *abitmap ); Initialize a pointer to an FT_Bitmap structure.","title":"FT_Bitmap_Init"},{"location":"ft2-bitmap_handling.html#ft_bitmap_copy","text":"Defined in FT_BITMAP_H (freetype/ftbitmap.h). FT_EXPORT( FT_Error ) FT_Bitmap_Copy ( FT_Library library, const FT_Bitmap *source, FT_Bitmap *target ); Copy a bitmap into another one.","title":"FT_Bitmap_Copy"},{"location":"ft2-bitmap_handling.html#ft_bitmap_embolden","text":"Defined in FT_BITMAP_H (freetype/ftbitmap.h). FT_EXPORT( FT_Error ) FT_Bitmap_Embolden ( FT_Library library, FT_Bitmap * bitmap, FT_Pos xStrength, FT_Pos yStrength ); Embolden a bitmap. The new bitmap will be about xStrength pixels wider and yStrength pixels higher. The left and bottom borders are kept unchanged.","title":"FT_Bitmap_Embolden"},{"location":"ft2-bitmap_handling.html#ft_bitmap_convert","text":"Defined in FT_BITMAP_H (freetype/ftbitmap.h). FT_EXPORT( FT_Error ) FT_Bitmap_Convert ( FT_Library library, const FT_Bitmap *source, FT_Bitmap *target, FT_Int alignment ); Convert a bitmap object with depth 1bpp, 2bpp, 4bpp, 8bpp or 32bpp to a bitmap object with depth 8bpp, making the number of used bytes per line (a.k.a. the \u2018pitch\u2019) a multiple of alignment .","title":"FT_Bitmap_Convert"},{"location":"ft2-bitmap_handling.html#ft_bitmap_blend","text":"Defined in FT_BITMAP_H (freetype/ftbitmap.h). FT_EXPORT( FT_Error ) FT_Bitmap_Blend ( FT_Library library, const FT_Bitmap * source, const FT_Vector source_offset, FT_Bitmap * target, FT_Vector *atarget_offset, FT_Color color ); Blend a bitmap onto another bitmap, using a given color.","title":"FT_Bitmap_Blend"},{"location":"ft2-bitmap_handling.html#ft_glyphslot_own_bitmap","text":"Defined in FT_BITMAP_H (freetype/ftbitmap.h). FT_EXPORT( FT_Error ) FT_GlyphSlot_Own_Bitmap ( FT_GlyphSlot slot ); Make sure that a glyph slot owns slot->bitmap .","title":"FT_GlyphSlot_Own_Bitmap"},{"location":"ft2-bitmap_handling.html#ft_bitmap_done","text":"Defined in FT_BITMAP_H (freetype/ftbitmap.h). FT_EXPORT( FT_Error ) FT_Bitmap_Done ( FT_Library library, FT_Bitmap *bitmap ); Destroy a bitmap object initialized with FT_Bitmap_Init .","title":"FT_Bitmap_Done"},{"location":"ft2-bzip2.html","text":"FreeType \u00bb Docs \u00bb Support API \u00bb BZIP2 Streams BZIP2 Streams \u00b6 Synopsis \u00b6 In certain builds of the library, bzip2 compression recognition is automatically handled when calling FT_New_Face or FT_Open_Face . This means that if no font driver is capable of handling the raw compressed file, the library will try to open a bzip2 compressed stream from it and re-open the face with it. The stream implementation is very basic and resets the decompression process each time seeking backwards is needed within the stream, which significantly undermines the performance. This section contains the declaration of Bzip2-specific functions. FT_Stream_OpenBzip2 \u00b6 Defined in FT_BZIP2_H (freetype/ftbzip2.h). FT_EXPORT( FT_Error ) FT_Stream_OpenBzip2 ( FT_Stream stream, FT_Stream source ); Open a new stream to parse bzip2-compressed font files. This is mainly used to support the compressed *.pcf.bz2 fonts that come with XFree86. input stream The target embedding stream. source The source stream. return FreeType error code. 0 means success. note The source stream must be opened before calling this function. Calling the internal function FT_Stream_Close on the new stream will not call FT_Stream_Close on the source stream. None of the stream objects will be released to the heap. This function may return FT_Err_Unimplemented_Feature if your build of FreeType was not compiled with bzip2 support.","title":"BZIP2 Streams"},{"location":"ft2-bzip2.html#bzip2-streams","text":"","title":"BZIP2 Streams"},{"location":"ft2-bzip2.html#synopsis","text":"In certain builds of the library, bzip2 compression recognition is automatically handled when calling FT_New_Face or FT_Open_Face . This means that if no font driver is capable of handling the raw compressed file, the library will try to open a bzip2 compressed stream from it and re-open the face with it. The stream implementation is very basic and resets the decompression process each time seeking backwards is needed within the stream, which significantly undermines the performance. This section contains the declaration of Bzip2-specific functions.","title":"Synopsis"},{"location":"ft2-bzip2.html#ft_stream_openbzip2","text":"Defined in FT_BZIP2_H (freetype/ftbzip2.h). FT_EXPORT( FT_Error ) FT_Stream_OpenBzip2 ( FT_Stream stream, FT_Stream source ); Open a new stream to parse bzip2-compressed font files. This is mainly used to support the compressed *.pcf.bz2 fonts that come with XFree86.","title":"FT_Stream_OpenBzip2"},{"location":"ft2-cache_subsystem.html","text":"FreeType \u00bb Docs \u00bb Cache Sub-System \u00bb Cache Sub-System Cache Sub-System \u00b6 Synopsis \u00b6 This section describes the FreeType 2 cache sub-system, which is used to limit the number of concurrently opened FT_Face and FT_Size objects, as well as caching information like character maps and glyph images while limiting their maximum memory usage. Note that all types and functions begin with the FTC_ prefix. The cache is highly portable and thus doesn't know anything about the fonts installed on your system, or how to access them. This implies the following scheme: First, available or installed font faces are uniquely identified by FTC_FaceID values, provided to the cache by the client. Note that the cache only stores and compares these values, and doesn't try to interpret them in any way. Second, the cache calls, only when needed, a client-provided function to convert an FTC_FaceID into a new FT_Face object. The latter is then completely managed by the cache, including its termination through FT_Done_Face . To monitor termination of face objects, the finalizer callback in the generic field of the FT_Face object can be used, which might also be used to store the FTC_FaceID of the face. Clients are free to map face IDs to anything else. The most simple usage is to associate them to a (pathname,face_index) pair that is used to call FT_New_Face . However, more complex schemes are also possible. Note that for the cache to work correctly, the face ID values must be persistent , which means that the contents they point to should not change at runtime, or that their value should not become invalid. If this is unavoidable (e.g., when a font is uninstalled at runtime), you should call FTC_Manager_RemoveFaceID as soon as possible, to let the cache get rid of any references to the old FTC_FaceID it may keep internally. Failure to do so will lead to incorrect behaviour or even crashes. To use the cache, start with calling FTC_Manager_New to create a new FTC_Manager object, which models a single cache instance. You can then look up FT_Face and FT_Size objects with FTC_Manager_LookupFace and FTC_Manager_LookupSize , respectively. If you want to use the charmap caching, call FTC_CMapCache_New , then later use FTC_CMapCache_Lookup to perform the equivalent of FT_Get_Char_Index , only much faster. If you want to use the FT_Glyph caching, call FTC_ImageCache , then later use FTC_ImageCache_Lookup to retrieve the corresponding FT_Glyph objects from the cache. If you need lots of small bitmaps, it is much more memory efficient to call FTC_SBitCache_New followed by FTC_SBitCache_Lookup . This returns FTC_SBitRec structures, which are used to store small bitmaps directly. (A small bitmap is one whose metrics and dimensions all fit into 8-bit integers). We hope to also provide a kerning cache in the near future. FTC_Manager \u00b6 Defined in FT_CACHE_H (freetype/ftcache.h). typedef struct FTC_ManagerRec_* FTC_Manager ; This object corresponds to one instance of the cache-subsystem. It is used to cache one or more FT_Face objects, along with corresponding FT_Size objects. The manager intentionally limits the total number of opened FT_Face and FT_Size objects to control memory usage. See the max_faces and max_sizes parameters of FTC_Manager_New . The manager is also used to cache \u2018nodes\u2019 of various types while limiting their total memory usage. All limitations are enforced by keeping lists of managed objects in most-recently-used order, and flushing old nodes to make room for new ones. FTC_FaceID \u00b6 Defined in FT_CACHE_H (freetype/ftcache.h). typedef FT_Pointer FTC_FaceID ; An opaque pointer type that is used to identity face objects. The contents of such objects is application-dependent. These pointers are typically used to point to a user-defined structure containing a font file path, and face index. note Never use NULL as a valid FTC_FaceID . Face IDs are passed by the client to the cache manager that calls, when needed, the FTC_Face_Requester to translate them into new FT_Face objects. If the content of a given face ID changes at runtime, or if the value becomes invalid (e.g., when uninstalling a font), you should immediately call FTC_Manager_RemoveFaceID before any other cache function. Failure to do so will result in incorrect behaviour or even memory leaks and crashes. FTC_Face_Requester \u00b6 Defined in FT_CACHE_H (freetype/ftcache.h). typedef FT_Error (* FTC_Face_Requester )( FTC_FaceID face_id, FT_Library library, FT_Pointer req_data, FT_Face * aface ); A callback function provided by client applications. It is used by the cache manager to translate a given FTC_FaceID into a new valid FT_Face object, on demand. input face_id The face ID to resolve. library A handle to a FreeType library object. req_data Application-provided request data (see note below). output aface A new FT_Face handle. return FreeType error code. 0 means success. note The third parameter req_data is the same as the one passed by the client when FTC_Manager_New is called. The face requester should not perform funny things on the returned face object, like creating a new FT_Size for it, or setting a transformation through FT_Set_Transform ! FTC_Manager_New \u00b6 Defined in FT_CACHE_H (freetype/ftcache.h). FT_EXPORT( FT_Error ) FTC_Manager_New ( FT_Library library, FT_UInt max_faces, FT_UInt max_sizes, FT_ULong max_bytes, FTC_Face_Requester requester, FT_Pointer req_data, FTC_Manager *amanager ); Create a new cache manager. input library The parent FreeType library handle to use. max_faces Maximum number of opened FT_Face objects managed by this cache instance. Use 0 for defaults. max_sizes Maximum number of opened FT_Size objects managed by this cache instance. Use 0 for defaults. max_bytes Maximum number of bytes to use for cached data nodes. Use 0 for defaults. Note that this value does not account for managed FT_Face and FT_Size objects. requester An application-provided callback used to translate face IDs into real FT_Face objects. req_data A generic pointer that is passed to the requester each time it is called (see FTC_Face_Requester ). output amanager A handle to a new manager object. 0 in case of failure. return FreeType error code. 0 means success. FTC_Manager_Reset \u00b6 Defined in FT_CACHE_H (freetype/ftcache.h). FT_EXPORT( void ) FTC_Manager_Reset ( FTC_Manager manager ); Empty a given cache manager. This simply gets rid of all the currently cached FT_Face and FT_Size objects within the manager. inout manager A handle to the manager. FTC_Manager_Done \u00b6 Defined in FT_CACHE_H (freetype/ftcache.h). FT_EXPORT( void ) FTC_Manager_Done ( FTC_Manager manager ); Destroy a given manager after emptying it. input manager A handle to the target cache manager object. FTC_Manager_LookupFace \u00b6 Defined in FT_CACHE_H (freetype/ftcache.h). FT_EXPORT( FT_Error ) FTC_Manager_LookupFace ( FTC_Manager manager, FTC_FaceID face_id, FT_Face *aface ); Retrieve the FT_Face object that corresponds to a given face ID through a cache manager. input manager A handle to the cache manager. face_id The ID of the face object. output aface A handle to the face object. return FreeType error code. 0 means success. note The returned FT_Face object is always owned by the manager. You should never try to discard it yourself. The FT_Face object doesn't necessarily have a current size object (i.e., face->size can be 0). If you need a specific \u2018font size\u2019, use FTC_Manager_LookupSize instead. Never change the face's transformation matrix (i.e., never call the FT_Set_Transform function) on a returned face! If you need to transform glyphs, do it yourself after glyph loading. When you perform a lookup, out-of-memory errors are detected within the lookup and force incremental flushes of the cache until enough memory is released for the lookup to succeed. If a lookup fails with FT_Err_Out_Of_Memory the cache has already been completely flushed, and still no memory was available for the operation. FTC_Manager_LookupSize \u00b6 Defined in FT_CACHE_H (freetype/ftcache.h). FT_EXPORT( FT_Error ) FTC_Manager_LookupSize ( FTC_Manager manager, FTC_Scaler scaler, FT_Size *asize ); Retrieve the FT_Size object that corresponds to a given FTC_ScalerRec pointer through a cache manager. input manager A handle to the cache manager. scaler A scaler handle. output asize A handle to the size object. return FreeType error code. 0 means success. note The returned FT_Size object is always owned by the manager. You should never try to discard it by yourself. You can access the parent FT_Face object simply as size->face if you need it. Note that this object is also owned by the manager. note When you perform a lookup, out-of-memory errors are detected within the lookup and force incremental flushes of the cache until enough memory is released for the lookup to succeed. If a lookup fails with FT_Err_Out_Of_Memory the cache has already been completely flushed, and still no memory is available for the operation. FTC_Manager_RemoveFaceID \u00b6 Defined in FT_CACHE_H (freetype/ftcache.h). FT_EXPORT( void ) FTC_Manager_RemoveFaceID ( FTC_Manager manager, FTC_FaceID face_id ); A special function used to indicate to the cache manager that a given FTC_FaceID is no longer valid, either because its content changed, or because it was deallocated or uninstalled. input manager The cache manager handle. face_id The FTC_FaceID to be removed. note This function flushes all nodes from the cache corresponding to this face_id , with the exception of nodes with a non-null reference count. Such nodes are however modified internally so as to never appear in later lookups with the same face_id value, and to be immediately destroyed when released by all their users. FTC_Node \u00b6 Defined in FT_CACHE_H (freetype/ftcache.h). typedef struct FTC_NodeRec_* FTC_Node ; An opaque handle to a cache node object. Each cache node is reference-counted. A node with a count of 0 might be flushed out of a full cache whenever a lookup request is performed. If you look up nodes, you have the ability to \u2018acquire\u2019 them, i.e., to increment their reference count. This will prevent the node from being flushed out of the cache until you explicitly \u2018release\u2019 it (see FTC_Node_Unref ). See also FTC_SBitCache_Lookup and FTC_ImageCache_Lookup . FTC_Node_Unref \u00b6 Defined in FT_CACHE_H (freetype/ftcache.h). FT_EXPORT( void ) FTC_Node_Unref ( FTC_Node node, FTC_Manager manager ); Decrement a cache node's internal reference count. When the count reaches 0, it is not destroyed but becomes eligible for subsequent cache flushes. input node The cache node handle. manager The cache manager handle. FTC_ImageCache \u00b6 Defined in FT_CACHE_H (freetype/ftcache.h). typedef struct FTC_ImageCacheRec_* FTC_ImageCache ; A handle to a glyph image cache object. They are designed to hold many distinct glyph images while not exceeding a certain memory threshold. FTC_ImageCache_New \u00b6 Defined in FT_CACHE_H (freetype/ftcache.h). FT_EXPORT( FT_Error ) FTC_ImageCache_New ( FTC_Manager manager, FTC_ImageCache *acache ); Create a new glyph image cache. input manager The parent manager for the image cache. output acache A handle to the new glyph image cache object. return FreeType error code. 0 means success. FTC_ImageCache_Lookup \u00b6 Defined in FT_CACHE_H (freetype/ftcache.h). FT_EXPORT( FT_Error ) FTC_ImageCache_Lookup ( FTC_ImageCache cache, FTC_ImageType type, FT_UInt gindex, FT_Glyph *aglyph, FTC_Node *anode ); Retrieve a given glyph image from a glyph image cache. input cache A handle to the source glyph image cache. type A pointer to a glyph image type descriptor. gindex The glyph index to retrieve. output aglyph The corresponding FT_Glyph object. 0 in case of failure. anode Used to return the address of the corresponding cache node after incrementing its reference count (see note below). return FreeType error code. 0 means success. note The returned glyph is owned and managed by the glyph image cache. Never try to transform or discard it manually! You can however create a copy with FT_Glyph_Copy and modify the new one. If anode is not NULL , it receives the address of the cache node containing the glyph image, after increasing its reference count. This ensures that the node (as well as the FT_Glyph ) will always be kept in the cache until you call FTC_Node_Unref to \u2018release\u2019 it. If anode is NULL , the cache node is left unchanged, which means that the FT_Glyph could be flushed out of the cache on the next call to one of the caching sub-system APIs. Don't assume that it is persistent! FTC_SBit \u00b6 Defined in FT_CACHE_H (freetype/ftcache.h). typedef struct FTC_SBitRec_* FTC_SBit ; A handle to a small bitmap descriptor. See the FTC_SBitRec structure for details. FTC_SBitCache \u00b6 Defined in FT_CACHE_H (freetype/ftcache.h). typedef struct FTC_SBitCacheRec_* FTC_SBitCache ; A handle to a small bitmap cache. These are special cache objects used to store small glyph bitmaps (and anti-aliased pixmaps) in a much more efficient way than the traditional glyph image cache implemented by FTC_ImageCache . FTC_SBitCache_New \u00b6 Defined in FT_CACHE_H (freetype/ftcache.h). FT_EXPORT( FT_Error ) FTC_SBitCache_New ( FTC_Manager manager, FTC_SBitCache *acache ); Create a new cache to store small glyph bitmaps. input manager A handle to the source cache manager. output acache A handle to the new sbit cache. NULL in case of error. return FreeType error code. 0 means success. FTC_SBitCache_Lookup \u00b6 Defined in FT_CACHE_H (freetype/ftcache.h). FT_EXPORT( FT_Error ) FTC_SBitCache_Lookup ( FTC_SBitCache cache, FTC_ImageType type, FT_UInt gindex, FTC_SBit *sbit, FTC_Node *anode ); Look up a given small glyph bitmap in a given sbit cache and \u2018lock\u2019 it to prevent its flushing from the cache until needed. input cache A handle to the source sbit cache. type A pointer to the glyph image type descriptor. gindex The glyph index. output sbit A handle to a small bitmap descriptor. anode Used to return the address of the corresponding cache node after incrementing its reference count (see note below). return FreeType error code. 0 means success. note The small bitmap descriptor and its bit buffer are owned by the cache and should never be freed by the application. They might as well disappear from memory on the next cache lookup, so don't treat them as persistent data. The descriptor's buffer field is set to 0 to indicate a missing glyph bitmap. If anode is not NULL , it receives the address of the cache node containing the bitmap, after increasing its reference count. This ensures that the node (as well as the image) will always be kept in the cache until you call FTC_Node_Unref to \u2018release\u2019 it. If anode is NULL , the cache node is left unchanged, which means that the bitmap could be flushed out of the cache on the next call to one of the caching sub-system APIs. Don't assume that it is persistent! FTC_CMapCache \u00b6 Defined in FT_CACHE_H (freetype/ftcache.h). typedef struct FTC_CMapCacheRec_* FTC_CMapCache ; An opaque handle used to model a charmap cache. This cache is to hold character codes -> glyph indices mappings. FTC_CMapCache_New \u00b6 Defined in FT_CACHE_H (freetype/ftcache.h). FT_EXPORT( FT_Error ) FTC_CMapCache_New ( FTC_Manager manager, FTC_CMapCache *acache ); Create a new charmap cache. input manager A handle to the cache manager. output acache A new cache handle. NULL in case of error. return FreeType error code. 0 means success. note Like all other caches, this one will be destroyed with the cache manager. FTC_CMapCache_Lookup \u00b6 Defined in FT_CACHE_H (freetype/ftcache.h). FT_EXPORT( FT_UInt ) FTC_CMapCache_Lookup ( FTC_CMapCache cache, FTC_FaceID face_id, FT_Int cmap_index, FT_UInt32 char_code ); Translate a character code into a glyph index, using the charmap cache. input cache A charmap cache handle. face_id The source face ID. cmap_index The index of the charmap in the source face. Any negative value means to use the cache FT_Face 's default charmap. char_code The character code (in the corresponding charmap). return Glyph index. 0 means \u2018no glyph\u2019. FTC_ScalerRec \u00b6 Defined in FT_CACHE_H (freetype/ftcache.h). typedef struct FTC_ScalerRec_ { FTC_FaceID face_id; FT_UInt width; FT_UInt height; FT_Int pixel; FT_UInt x_res; FT_UInt y_res; } FTC_ScalerRec ; A structure used to describe a given character size in either pixels or points to the cache manager. See FTC_Manager_LookupSize . fields face_id The source face ID. width The character width. height The character height. pixel A Boolean. If 1, the width and height fields are interpreted as integer pixel character sizes. Otherwise, they are expressed as 1/64th of points. x_res Only used when pixel is value 0 to indicate the horizontal resolution in dpi. y_res Only used when pixel is value 0 to indicate the vertical resolution in dpi. note This type is mainly used to retrieve FT_Size objects through the cache manager. FTC_Scaler \u00b6 Defined in FT_CACHE_H (freetype/ftcache.h). typedef struct FTC_ScalerRec_* FTC_Scaler ; A handle to an FTC_ScalerRec structure. FTC_ImageTypeRec \u00b6 Defined in FT_CACHE_H (freetype/ftcache.h). typedef struct FTC_ImageTypeRec_ { FTC_FaceID face_id; FT_UInt width; FT_UInt height; FT_Int32 flags; } FTC_ImageTypeRec ; A structure used to model the type of images in a glyph cache. fields face_id The face ID. width The width in pixels. height The height in pixels. flags The load flags, as in FT_Load_Glyph . FTC_ImageType \u00b6 Defined in FT_CACHE_H (freetype/ftcache.h). typedef struct FTC_ImageTypeRec_* FTC_ImageType ; A handle to an FTC_ImageTypeRec structure. FTC_ImageCache_LookupScaler \u00b6 Defined in FT_CACHE_H (freetype/ftcache.h). FT_EXPORT( FT_Error ) FTC_ImageCache_LookupScaler ( FTC_ImageCache cache, FTC_Scaler scaler, FT_ULong load_flags, FT_UInt gindex, FT_Glyph *aglyph, FTC_Node *anode ); A variant of FTC_ImageCache_Lookup that uses an FTC_ScalerRec to specify the face ID and its size. input cache A handle to the source glyph image cache. scaler A pointer to a scaler descriptor. load_flags The corresponding load flags. gindex The glyph index to retrieve. output aglyph The corresponding FT_Glyph object. 0 in case of failure. anode Used to return the address of the corresponding cache node after incrementing its reference count (see note below). return FreeType error code. 0 means success. note The returned glyph is owned and managed by the glyph image cache. Never try to transform or discard it manually! You can however create a copy with FT_Glyph_Copy and modify the new one. If anode is not NULL , it receives the address of the cache node containing the glyph image, after increasing its reference count. This ensures that the node (as well as the FT_Glyph ) will always be kept in the cache until you call FTC_Node_Unref to \u2018release\u2019 it. If anode is NULL , the cache node is left unchanged, which means that the FT_Glyph could be flushed out of the cache on the next call to one of the caching sub-system APIs. Don't assume that it is persistent! Calls to FT_Set_Char_Size and friends have no effect on cached glyphs; you should always use the FreeType cache API instead. FTC_SBitRec \u00b6 Defined in FT_CACHE_H (freetype/ftcache.h). typedef struct FTC_SBitRec_ { FT_Byte width; FT_Byte height; FT_Char left; FT_Char top; FT_Byte format; FT_Byte max_grays; FT_Short pitch; FT_Char xadvance; FT_Char yadvance; FT_Byte * buffer; } FTC_SBitRec ; A very compact structure used to describe a small glyph bitmap. fields width The bitmap width in pixels. height The bitmap height in pixels. left The horizontal distance from the pen position to the left bitmap border (a.k.a. \u2018left side bearing\u2019, or \u2018lsb\u2019). top The vertical distance from the pen position (on the baseline) to the upper bitmap border (a.k.a. \u2018top side bearing\u2019). The distance is positive for upwards y coordinates. format The format of the glyph bitmap (monochrome or gray). max_grays Maximum gray level value (in the range 1 to 255). pitch The number of bytes per bitmap line. May be positive or negative. xadvance The horizontal advance width in pixels. yadvance The vertical advance height in pixels. buffer A pointer to the bitmap pixels. FTC_SBitCache_LookupScaler \u00b6 Defined in FT_CACHE_H (freetype/ftcache.h). FT_EXPORT( FT_Error ) FTC_SBitCache_LookupScaler ( FTC_SBitCache cache, FTC_Scaler scaler, FT_ULong load_flags, FT_UInt gindex, FTC_SBit *sbit, FTC_Node *anode ); A variant of FTC_SBitCache_Lookup that uses an FTC_ScalerRec to specify the face ID and its size. input cache A handle to the source sbit cache. scaler A pointer to the scaler descriptor. load_flags The corresponding load flags. gindex The glyph index. output sbit A handle to a small bitmap descriptor. anode Used to return the address of the corresponding cache node after incrementing its reference count (see note below). return FreeType error code. 0 means success. note The small bitmap descriptor and its bit buffer are owned by the cache and should never be freed by the application. They might as well disappear from memory on the next cache lookup, so don't treat them as persistent data. The descriptor's buffer field is set to 0 to indicate a missing glyph bitmap. If anode is not NULL , it receives the address of the cache node containing the bitmap, after increasing its reference count. This ensures that the node (as well as the image) will always be kept in the cache until you call FTC_Node_Unref to \u2018release\u2019 it. If anode is NULL , the cache node is left unchanged, which means that the bitmap could be flushed out of the cache on the next call to one of the caching sub-system APIs. Don't assume that it is persistent!","title":"Cache Sub-System"},{"location":"ft2-cache_subsystem.html#cache-sub-system","text":"","title":"Cache Sub-System"},{"location":"ft2-cache_subsystem.html#synopsis","text":"This section describes the FreeType 2 cache sub-system, which is used to limit the number of concurrently opened FT_Face and FT_Size objects, as well as caching information like character maps and glyph images while limiting their maximum memory usage. Note that all types and functions begin with the FTC_ prefix. The cache is highly portable and thus doesn't know anything about the fonts installed on your system, or how to access them. This implies the following scheme: First, available or installed font faces are uniquely identified by FTC_FaceID values, provided to the cache by the client. Note that the cache only stores and compares these values, and doesn't try to interpret them in any way. Second, the cache calls, only when needed, a client-provided function to convert an FTC_FaceID into a new FT_Face object. The latter is then completely managed by the cache, including its termination through FT_Done_Face . To monitor termination of face objects, the finalizer callback in the generic field of the FT_Face object can be used, which might also be used to store the FTC_FaceID of the face. Clients are free to map face IDs to anything else. The most simple usage is to associate them to a (pathname,face_index) pair that is used to call FT_New_Face . However, more complex schemes are also possible. Note that for the cache to work correctly, the face ID values must be persistent , which means that the contents they point to should not change at runtime, or that their value should not become invalid. If this is unavoidable (e.g., when a font is uninstalled at runtime), you should call FTC_Manager_RemoveFaceID as soon as possible, to let the cache get rid of any references to the old FTC_FaceID it may keep internally. Failure to do so will lead to incorrect behaviour or even crashes. To use the cache, start with calling FTC_Manager_New to create a new FTC_Manager object, which models a single cache instance. You can then look up FT_Face and FT_Size objects with FTC_Manager_LookupFace and FTC_Manager_LookupSize , respectively. If you want to use the charmap caching, call FTC_CMapCache_New , then later use FTC_CMapCache_Lookup to perform the equivalent of FT_Get_Char_Index , only much faster. If you want to use the FT_Glyph caching, call FTC_ImageCache , then later use FTC_ImageCache_Lookup to retrieve the corresponding FT_Glyph objects from the cache. If you need lots of small bitmaps, it is much more memory efficient to call FTC_SBitCache_New followed by FTC_SBitCache_Lookup . This returns FTC_SBitRec structures, which are used to store small bitmaps directly. (A small bitmap is one whose metrics and dimensions all fit into 8-bit integers). We hope to also provide a kerning cache in the near future.","title":"Synopsis"},{"location":"ft2-cache_subsystem.html#ftc_manager","text":"Defined in FT_CACHE_H (freetype/ftcache.h). typedef struct FTC_ManagerRec_* FTC_Manager ; This object corresponds to one instance of the cache-subsystem. It is used to cache one or more FT_Face objects, along with corresponding FT_Size objects. The manager intentionally limits the total number of opened FT_Face and FT_Size objects to control memory usage. See the max_faces and max_sizes parameters of FTC_Manager_New . The manager is also used to cache \u2018nodes\u2019 of various types while limiting their total memory usage. All limitations are enforced by keeping lists of managed objects in most-recently-used order, and flushing old nodes to make room for new ones.","title":"FTC_Manager"},{"location":"ft2-cache_subsystem.html#ftc_faceid","text":"Defined in FT_CACHE_H (freetype/ftcache.h). typedef FT_Pointer FTC_FaceID ; An opaque pointer type that is used to identity face objects. The contents of such objects is application-dependent. These pointers are typically used to point to a user-defined structure containing a font file path, and face index.","title":"FTC_FaceID"},{"location":"ft2-cache_subsystem.html#ftc_face_requester","text":"Defined in FT_CACHE_H (freetype/ftcache.h). typedef FT_Error (* FTC_Face_Requester )( FTC_FaceID face_id, FT_Library library, FT_Pointer req_data, FT_Face * aface ); A callback function provided by client applications. It is used by the cache manager to translate a given FTC_FaceID into a new valid FT_Face object, on demand.","title":"FTC_Face_Requester"},{"location":"ft2-cache_subsystem.html#ftc_manager_new","text":"Defined in FT_CACHE_H (freetype/ftcache.h). FT_EXPORT( FT_Error ) FTC_Manager_New ( FT_Library library, FT_UInt max_faces, FT_UInt max_sizes, FT_ULong max_bytes, FTC_Face_Requester requester, FT_Pointer req_data, FTC_Manager *amanager ); Create a new cache manager.","title":"FTC_Manager_New"},{"location":"ft2-cache_subsystem.html#ftc_manager_reset","text":"Defined in FT_CACHE_H (freetype/ftcache.h). FT_EXPORT( void ) FTC_Manager_Reset ( FTC_Manager manager ); Empty a given cache manager. This simply gets rid of all the currently cached FT_Face and FT_Size objects within the manager.","title":"FTC_Manager_Reset"},{"location":"ft2-cache_subsystem.html#ftc_manager_done","text":"Defined in FT_CACHE_H (freetype/ftcache.h). FT_EXPORT( void ) FTC_Manager_Done ( FTC_Manager manager ); Destroy a given manager after emptying it.","title":"FTC_Manager_Done"},{"location":"ft2-cache_subsystem.html#ftc_manager_lookupface","text":"Defined in FT_CACHE_H (freetype/ftcache.h). FT_EXPORT( FT_Error ) FTC_Manager_LookupFace ( FTC_Manager manager, FTC_FaceID face_id, FT_Face *aface ); Retrieve the FT_Face object that corresponds to a given face ID through a cache manager.","title":"FTC_Manager_LookupFace"},{"location":"ft2-cache_subsystem.html#ftc_manager_lookupsize","text":"Defined in FT_CACHE_H (freetype/ftcache.h). FT_EXPORT( FT_Error ) FTC_Manager_LookupSize ( FTC_Manager manager, FTC_Scaler scaler, FT_Size *asize ); Retrieve the FT_Size object that corresponds to a given FTC_ScalerRec pointer through a cache manager.","title":"FTC_Manager_LookupSize"},{"location":"ft2-cache_subsystem.html#ftc_manager_removefaceid","text":"Defined in FT_CACHE_H (freetype/ftcache.h). FT_EXPORT( void ) FTC_Manager_RemoveFaceID ( FTC_Manager manager, FTC_FaceID face_id ); A special function used to indicate to the cache manager that a given FTC_FaceID is no longer valid, either because its content changed, or because it was deallocated or uninstalled.","title":"FTC_Manager_RemoveFaceID"},{"location":"ft2-cache_subsystem.html#ftc_node","text":"Defined in FT_CACHE_H (freetype/ftcache.h). typedef struct FTC_NodeRec_* FTC_Node ; An opaque handle to a cache node object. Each cache node is reference-counted. A node with a count of 0 might be flushed out of a full cache whenever a lookup request is performed. If you look up nodes, you have the ability to \u2018acquire\u2019 them, i.e., to increment their reference count. This will prevent the node from being flushed out of the cache until you explicitly \u2018release\u2019 it (see FTC_Node_Unref ). See also FTC_SBitCache_Lookup and FTC_ImageCache_Lookup .","title":"FTC_Node"},{"location":"ft2-cache_subsystem.html#ftc_node_unref","text":"Defined in FT_CACHE_H (freetype/ftcache.h). FT_EXPORT( void ) FTC_Node_Unref ( FTC_Node node, FTC_Manager manager ); Decrement a cache node's internal reference count. When the count reaches 0, it is not destroyed but becomes eligible for subsequent cache flushes.","title":"FTC_Node_Unref"},{"location":"ft2-cache_subsystem.html#ftc_imagecache","text":"Defined in FT_CACHE_H (freetype/ftcache.h). typedef struct FTC_ImageCacheRec_* FTC_ImageCache ; A handle to a glyph image cache object. They are designed to hold many distinct glyph images while not exceeding a certain memory threshold.","title":"FTC_ImageCache"},{"location":"ft2-cache_subsystem.html#ftc_imagecache_new","text":"Defined in FT_CACHE_H (freetype/ftcache.h). FT_EXPORT( FT_Error ) FTC_ImageCache_New ( FTC_Manager manager, FTC_ImageCache *acache ); Create a new glyph image cache.","title":"FTC_ImageCache_New"},{"location":"ft2-cache_subsystem.html#ftc_imagecache_lookup","text":"Defined in FT_CACHE_H (freetype/ftcache.h). FT_EXPORT( FT_Error ) FTC_ImageCache_Lookup ( FTC_ImageCache cache, FTC_ImageType type, FT_UInt gindex, FT_Glyph *aglyph, FTC_Node *anode ); Retrieve a given glyph image from a glyph image cache.","title":"FTC_ImageCache_Lookup"},{"location":"ft2-cache_subsystem.html#ftc_sbit","text":"Defined in FT_CACHE_H (freetype/ftcache.h). typedef struct FTC_SBitRec_* FTC_SBit ; A handle to a small bitmap descriptor. See the FTC_SBitRec structure for details.","title":"FTC_SBit"},{"location":"ft2-cache_subsystem.html#ftc_sbitcache","text":"Defined in FT_CACHE_H (freetype/ftcache.h). typedef struct FTC_SBitCacheRec_* FTC_SBitCache ; A handle to a small bitmap cache. These are special cache objects used to store small glyph bitmaps (and anti-aliased pixmaps) in a much more efficient way than the traditional glyph image cache implemented by FTC_ImageCache .","title":"FTC_SBitCache"},{"location":"ft2-cache_subsystem.html#ftc_sbitcache_new","text":"Defined in FT_CACHE_H (freetype/ftcache.h). FT_EXPORT( FT_Error ) FTC_SBitCache_New ( FTC_Manager manager, FTC_SBitCache *acache ); Create a new cache to store small glyph bitmaps.","title":"FTC_SBitCache_New"},{"location":"ft2-cache_subsystem.html#ftc_sbitcache_lookup","text":"Defined in FT_CACHE_H (freetype/ftcache.h). FT_EXPORT( FT_Error ) FTC_SBitCache_Lookup ( FTC_SBitCache cache, FTC_ImageType type, FT_UInt gindex, FTC_SBit *sbit, FTC_Node *anode ); Look up a given small glyph bitmap in a given sbit cache and \u2018lock\u2019 it to prevent its flushing from the cache until needed.","title":"FTC_SBitCache_Lookup"},{"location":"ft2-cache_subsystem.html#ftc_cmapcache","text":"Defined in FT_CACHE_H (freetype/ftcache.h). typedef struct FTC_CMapCacheRec_* FTC_CMapCache ; An opaque handle used to model a charmap cache. This cache is to hold character codes -> glyph indices mappings.","title":"FTC_CMapCache"},{"location":"ft2-cache_subsystem.html#ftc_cmapcache_new","text":"Defined in FT_CACHE_H (freetype/ftcache.h). FT_EXPORT( FT_Error ) FTC_CMapCache_New ( FTC_Manager manager, FTC_CMapCache *acache ); Create a new charmap cache.","title":"FTC_CMapCache_New"},{"location":"ft2-cache_subsystem.html#ftc_cmapcache_lookup","text":"Defined in FT_CACHE_H (freetype/ftcache.h). FT_EXPORT( FT_UInt ) FTC_CMapCache_Lookup ( FTC_CMapCache cache, FTC_FaceID face_id, FT_Int cmap_index, FT_UInt32 char_code ); Translate a character code into a glyph index, using the charmap cache.","title":"FTC_CMapCache_Lookup"},{"location":"ft2-cache_subsystem.html#ftc_scalerrec","text":"Defined in FT_CACHE_H (freetype/ftcache.h). typedef struct FTC_ScalerRec_ { FTC_FaceID face_id; FT_UInt width; FT_UInt height; FT_Int pixel; FT_UInt x_res; FT_UInt y_res; } FTC_ScalerRec ; A structure used to describe a given character size in either pixels or points to the cache manager. See FTC_Manager_LookupSize .","title":"FTC_ScalerRec"},{"location":"ft2-cache_subsystem.html#ftc_scaler","text":"Defined in FT_CACHE_H (freetype/ftcache.h). typedef struct FTC_ScalerRec_* FTC_Scaler ; A handle to an FTC_ScalerRec structure.","title":"FTC_Scaler"},{"location":"ft2-cache_subsystem.html#ftc_imagetyperec","text":"Defined in FT_CACHE_H (freetype/ftcache.h). typedef struct FTC_ImageTypeRec_ { FTC_FaceID face_id; FT_UInt width; FT_UInt height; FT_Int32 flags; } FTC_ImageTypeRec ; A structure used to model the type of images in a glyph cache.","title":"FTC_ImageTypeRec"},{"location":"ft2-cache_subsystem.html#ftc_imagetype","text":"Defined in FT_CACHE_H (freetype/ftcache.h). typedef struct FTC_ImageTypeRec_* FTC_ImageType ; A handle to an FTC_ImageTypeRec structure.","title":"FTC_ImageType"},{"location":"ft2-cache_subsystem.html#ftc_imagecache_lookupscaler","text":"Defined in FT_CACHE_H (freetype/ftcache.h). FT_EXPORT( FT_Error ) FTC_ImageCache_LookupScaler ( FTC_ImageCache cache, FTC_Scaler scaler, FT_ULong load_flags, FT_UInt gindex, FT_Glyph *aglyph, FTC_Node *anode ); A variant of FTC_ImageCache_Lookup that uses an FTC_ScalerRec to specify the face ID and its size.","title":"FTC_ImageCache_LookupScaler"},{"location":"ft2-cache_subsystem.html#ftc_sbitrec","text":"Defined in FT_CACHE_H (freetype/ftcache.h). typedef struct FTC_SBitRec_ { FT_Byte width; FT_Byte height; FT_Char left; FT_Char top; FT_Byte format; FT_Byte max_grays; FT_Short pitch; FT_Char xadvance; FT_Char yadvance; FT_Byte * buffer; } FTC_SBitRec ; A very compact structure used to describe a small glyph bitmap.","title":"FTC_SBitRec"},{"location":"ft2-cache_subsystem.html#ftc_sbitcache_lookupscaler","text":"Defined in FT_CACHE_H (freetype/ftcache.h). FT_EXPORT( FT_Error ) FTC_SBitCache_LookupScaler ( FTC_SBitCache cache, FTC_Scaler scaler, FT_ULong load_flags, FT_UInt gindex, FTC_SBit *sbit, FTC_Node *anode ); A variant of FTC_SBitCache_Lookup that uses an FTC_ScalerRec to specify the face ID and its size.","title":"FTC_SBitCache_LookupScaler"},{"location":"ft2-cff_driver.html","text":"FreeType \u00bb Docs \u00bb Controlling FreeType Modules \u00bb The CFF driver The CFF driver \u00b6 Synopsis \u00b6 While FreeType's CFF driver doesn't expose API functions by itself, it is possible to control its behaviour with FT_Property_Set and FT_Property_Get . The CFF driver's module name is \u2018cff\u2019. Available properties are hinting-engine , no-stem-darkening , darkening-parameters , and random-seed , as documented in the \u2018 Driver properties \u2019 section. Hinting and antialiasing principles of the new engine The rasterizer is positioning horizontal features (e.g., ascender height & x-height, or crossbars) on the pixel grid and minimizing the amount of antialiasing applied to them, while placing vertical features (vertical stems) on the pixel grid without hinting, thus representing the stem position and weight accurately. Sometimes the vertical stems may be only partially black. In this context, \u2018antialiasing\u2019 means that stems are not positioned exactly on pixel borders, causing a fuzzy appearance. There are two principles behind this approach. 1) No hinting in the horizontal direction: Unlike \u2018superhinted\u2019 TrueType, which changes glyph widths to accommodate regular inter-glyph spacing, Adobe's approach is \u2018faithful to the design\u2019 in representing both the glyph width and the inter-glyph spacing designed for the font. This makes the screen display as close as it can be to the result one would get with infinite resolution, while preserving what is considered the key characteristics of each glyph. Note that the distances between unhinted and grid-fitted positions at small sizes are comparable to kerning values and thus would be noticeable (and distracting) while reading if hinting were applied. One of the reasons to not hint horizontally is antialiasing for LCD screens: The pixel geometry of modern displays supplies three vertical subpixels as the eye moves horizontally across each visible pixel. On devices where we can be certain this characteristic is present a rasterizer can take advantage of the subpixels to add increments of weight. In Western writing systems this turns out to be the more critical direction anyway; the weights and spacing of vertical stems (see above) are central to Armenian, Cyrillic, Greek, and Latin type designs. Even when the rasterizer uses greyscale antialiasing instead of color (a necessary compromise when one doesn't know the screen characteristics), the unhinted vertical features preserve the design's weight and spacing much better than aliased type would. 2) Alignment in the vertical direction: Weights and spacing along the y axis are less critical; what is much more important is the visual alignment of related features (like cap-height and x-height). The sense of alignment for these is enhanced by the sharpness of grid-fit edges, while the cruder vertical resolution (full pixels instead of \u2153 pixels) is less of a problem. On the technical side, horizontal alignment zones for ascender, x-height, and other important height values (traditionally called \u2018blue zones\u2019) as defined in the font are positioned independently, each being rounded to the nearest pixel edge, taking care of overshoot suppression at small sizes, stem darkening, and scaling. Hstems (this is, hint values defined in the font to help align horizontal features) that fall within a blue zone are said to be \u2018captured\u2019 and are aligned to that zone. Uncaptured stems are moved in one of four ways, top edge up or down, bottom edge up or down. Unless there are conflicting hstems, the smallest movement is taken to minimize distortion.","title":"The CFF driver"},{"location":"ft2-cff_driver.html#the-cff-driver","text":"","title":"The CFF driver"},{"location":"ft2-cff_driver.html#synopsis","text":"While FreeType's CFF driver doesn't expose API functions by itself, it is possible to control its behaviour with FT_Property_Set and FT_Property_Get . The CFF driver's module name is \u2018cff\u2019. Available properties are hinting-engine , no-stem-darkening , darkening-parameters , and random-seed , as documented in the \u2018 Driver properties \u2019 section. Hinting and antialiasing principles of the new engine The rasterizer is positioning horizontal features (e.g., ascender height & x-height, or crossbars) on the pixel grid and minimizing the amount of antialiasing applied to them, while placing vertical features (vertical stems) on the pixel grid without hinting, thus representing the stem position and weight accurately. Sometimes the vertical stems may be only partially black. In this context, \u2018antialiasing\u2019 means that stems are not positioned exactly on pixel borders, causing a fuzzy appearance. There are two principles behind this approach. 1) No hinting in the horizontal direction: Unlike \u2018superhinted\u2019 TrueType, which changes glyph widths to accommodate regular inter-glyph spacing, Adobe's approach is \u2018faithful to the design\u2019 in representing both the glyph width and the inter-glyph spacing designed for the font. This makes the screen display as close as it can be to the result one would get with infinite resolution, while preserving what is considered the key characteristics of each glyph. Note that the distances between unhinted and grid-fitted positions at small sizes are comparable to kerning values and thus would be noticeable (and distracting) while reading if hinting were applied. One of the reasons to not hint horizontally is antialiasing for LCD screens: The pixel geometry of modern displays supplies three vertical subpixels as the eye moves horizontally across each visible pixel. On devices where we can be certain this characteristic is present a rasterizer can take advantage of the subpixels to add increments of weight. In Western writing systems this turns out to be the more critical direction anyway; the weights and spacing of vertical stems (see above) are central to Armenian, Cyrillic, Greek, and Latin type designs. Even when the rasterizer uses greyscale antialiasing instead of color (a necessary compromise when one doesn't know the screen characteristics), the unhinted vertical features preserve the design's weight and spacing much better than aliased type would. 2) Alignment in the vertical direction: Weights and spacing along the y axis are less critical; what is much more important is the visual alignment of related features (like cap-height and x-height). The sense of alignment for these is enhanced by the sharpness of grid-fit edges, while the cruder vertical resolution (full pixels instead of \u2153 pixels) is less of a problem. On the technical side, horizontal alignment zones for ascender, x-height, and other important height values (traditionally called \u2018blue zones\u2019) as defined in the font are positioned independently, each being rounded to the nearest pixel edge, taking care of overshoot suppression at small sizes, stem darkening, and scaling. Hstems (this is, hint values defined in the font to help align horizontal features) that fall within a blue zone are said to be \u2018captured\u2019 and are aligned to that zone. Uncaptured stems are moved in one of four ways, top edge up or down, bottom edge up or down. Unless there are conflicting hstems, the smallest movement is taken to minimize distortion.","title":"Synopsis"},{"location":"ft2-cid_fonts.html","text":"FreeType \u00bb Docs \u00bb Format-Specific API \u00bb CID Fonts CID Fonts \u00b6 Synopsis \u00b6 This section contains the declaration of CID-keyed font-specific functions. FT_Get_CID_Registry_Ordering_Supplement \u00b6 Defined in FT_CID_H (freetype/ftcid.h). FT_EXPORT( FT_Error ) FT_Get_CID_Registry_Ordering_Supplement ( FT_Face face, const char * *registry, const char * *ordering, FT_Int *supplement ); Retrieve the Registry/Ordering/Supplement triple (also known as the \"R/O/S\") from a CID-keyed font. input face A handle to the input face. output registry The registry, as a C string, owned by the face. ordering The ordering, as a C string, owned by the face. supplement The supplement. return FreeType error code. 0 means success. note This function only works with CID faces, returning an error otherwise. since 2.3.6 FT_Get_CID_Is_Internally_CID_Keyed \u00b6 Defined in FT_CID_H (freetype/ftcid.h). FT_EXPORT( FT_Error ) FT_Get_CID_Is_Internally_CID_Keyed ( FT_Face face, FT_Bool *is_cid ); Retrieve the type of the input face, CID keyed or not. In contrast to the FT_IS_CID_KEYED macro this function returns successfully also for CID-keyed fonts in an SFNT wrapper. input face A handle to the input face. output is_cid The type of the face as an FT_Bool . return FreeType error code. 0 means success. note This function only works with CID faces and OpenType fonts, returning an error otherwise. since 2.3.9 FT_Get_CID_From_Glyph_Index \u00b6 Defined in FT_CID_H (freetype/ftcid.h). FT_EXPORT( FT_Error ) FT_Get_CID_From_Glyph_Index ( FT_Face face, FT_UInt glyph_index, FT_UInt *cid ); Retrieve the CID of the input glyph index. input face A handle to the input face. glyph_index The input glyph index. output cid The CID as an FT_UInt . return FreeType error code. 0 means success. note This function only works with CID faces and OpenType fonts, returning an error otherwise. since 2.3.9","title":"CID Fonts"},{"location":"ft2-cid_fonts.html#cid-fonts","text":"","title":"CID Fonts"},{"location":"ft2-cid_fonts.html#synopsis","text":"This section contains the declaration of CID-keyed font-specific functions.","title":"Synopsis"},{"location":"ft2-cid_fonts.html#ft_get_cid_registry_ordering_supplement","text":"Defined in FT_CID_H (freetype/ftcid.h). FT_EXPORT( FT_Error ) FT_Get_CID_Registry_Ordering_Supplement ( FT_Face face, const char * *registry, const char * *ordering, FT_Int *supplement ); Retrieve the Registry/Ordering/Supplement triple (also known as the \"R/O/S\") from a CID-keyed font.","title":"FT_Get_CID_Registry_Ordering_Supplement"},{"location":"ft2-cid_fonts.html#ft_get_cid_is_internally_cid_keyed","text":"Defined in FT_CID_H (freetype/ftcid.h). FT_EXPORT( FT_Error ) FT_Get_CID_Is_Internally_CID_Keyed ( FT_Face face, FT_Bool *is_cid ); Retrieve the type of the input face, CID keyed or not. In contrast to the FT_IS_CID_KEYED macro this function returns successfully also for CID-keyed fonts in an SFNT wrapper.","title":"FT_Get_CID_Is_Internally_CID_Keyed"},{"location":"ft2-cid_fonts.html#ft_get_cid_from_glyph_index","text":"Defined in FT_CID_H (freetype/ftcid.h). FT_EXPORT( FT_Error ) FT_Get_CID_From_Glyph_Index ( FT_Face face, FT_UInt glyph_index, FT_UInt *cid ); Retrieve the CID of the input glyph index.","title":"FT_Get_CID_From_Glyph_Index"},{"location":"ft2-color_management.html","text":"FreeType \u00bb Docs \u00bb Core API \u00bb Glyph Color Management Glyph Color Management \u00b6 Synopsis \u00b6 The functions described here allow access and manipulation of color palette entries in OpenType's \u2018CPAL\u2019 tables. FT_Color \u00b6 Defined in FT_COLOR_H (freetype/ftcolor.h). typedef struct FT_Color_ { FT_Byte blue; FT_Byte green; FT_Byte red; FT_Byte alpha; } FT_Color ; This structure models a BGRA color value of a \u2018CPAL\u2019 palette entry. The used color space is sRGB; the colors are not pre-multiplied, and alpha values must be explicitly set. fields blue Blue value. green Green value. red Red value. alpha Alpha value, giving the red, green, and blue color's opacity. since 2.10 FT_PALETTE_XXX \u00b6 Defined in FT_COLOR_H (freetype/ftcolor.h). # define FT_PALETTE_FOR_LIGHT_BACKGROUND 0x01 # define FT_PALETTE_FOR_DARK_BACKGROUND 0x02 A list of bit field constants used in the palette_flags array of the FT_Palette_Data structure to indicate for which background a palette with a given index is usable. values FT_PALETTE_FOR_LIGHT_BACKGROUND The palette is appropriate to use when displaying the font on a light background such as white. FT_PALETTE_FOR_DARK_BACKGROUND The palette is appropriate to use when displaying the font on a dark background such as black. since 2.10 FT_Palette_Data \u00b6 Defined in FT_COLOR_H (freetype/ftcolor.h). typedef struct FT_Palette_Data_ { FT_UShort num_palettes; const FT_UShort * palette_name_ids; const FT_UShort * palette_flags; FT_UShort num_palette_entries; const FT_UShort * palette_entry_name_ids; } FT_Palette_Data ; This structure holds the data of the \u2018CPAL\u2019 table. fields num_palettes The number of palettes. palette_name_ids An optional read-only array of palette name IDs with num_palettes elements, corresponding to entries like \u2018dark\u2019 or \u2018light\u2019 in the font's \u2018name\u2019 table. An empty name ID in the \u2018CPAL\u2019 table gets represented as value 0xFFFF. NULL if the font's \u2018CPAL\u2019 table doesn't contain appropriate data. palette_flags An optional read-only array of palette flags with num_palettes elements. Possible values are an ORed combination of FT_PALETTE_FOR_LIGHT_BACKGROUND and FT_PALETTE_FOR_DARK_BACKGROUND . NULL if the font's \u2018CPAL\u2019 table doesn't contain appropriate data. num_palette_entries The number of entries in a single palette. All palettes have the same size. palette_entry_name_ids An optional read-only array of palette entry name IDs with num_palette_entries . In each palette, entries with the same index have the same function. For example, index 0 might correspond to string \u2018outline\u2019 in the font's \u2018name\u2019 table to indicate that this palette entry is used for outlines, index 1 might correspond to \u2018fill\u2019 to indicate the filling color palette entry, etc. An empty entry name ID in the \u2018CPAL\u2019 table gets represented as value 0xFFFF. NULL if the font's \u2018CPAL\u2019 table doesn't contain appropriate data. note Use function FT_Get_Sfnt_Name to map name IDs and entry name IDs to name strings. Use function FT_Palette_Select to get the colors associated with a palette entry. since 2.10 FT_Palette_Data_Get \u00b6 Defined in FT_COLOR_H (freetype/ftcolor.h). FT_EXPORT( FT_Error ) FT_Palette_Data_Get ( FT_Face face, FT_Palette_Data *apalette ); Retrieve the face's color palette data. input face The source face handle. output apalette A pointer to an FT_Palette_Data structure. return FreeType error code. 0 means success. note All arrays in the returned FT_Palette_Data structure are read-only. This function always returns an error if the config macro TT_CONFIG_OPTION_COLOR_LAYERS is not defined in ftoption.h . since 2.10 FT_Palette_Select \u00b6 Defined in FT_COLOR_H (freetype/ftcolor.h). FT_EXPORT( FT_Error ) FT_Palette_Select ( FT_Face face, FT_UShort palette_index, FT_Color * *apalette ); This function has two purposes. (1) It activates a palette for rendering color glyphs, and (2) it retrieves all (unmodified) color entries of this palette. This function returns a read-write array, which means that a calling application can modify the palette entries on demand. A corollary of (2) is that calling the function, then modifying some values, then calling the function again with the same arguments resets all color entries to the original \u2018CPAL\u2019 values; all user modifications are lost. input face The source face handle. palette_index The palette index. output apalette An array of color entries for a palette with index palette_index , having num_palette_entries elements (as found in the FT_Palette_Data structure). If apalette is set to NULL , no array gets returned (and no color entries can be modified). In case the font doesn't support color palettes, NULL is returned. return FreeType error code. 0 means success. note The array pointed to by apalette_entries is owned and managed by FreeType. This function always returns an error if the config macro TT_CONFIG_OPTION_COLOR_LAYERS is not defined in ftoption.h . since 2.10 FT_Palette_Set_Foreground_Color \u00b6 Defined in FT_COLOR_H (freetype/ftcolor.h). FT_EXPORT( FT_Error ) FT_Palette_Set_Foreground_Color ( FT_Face face, FT_Color foreground_color ); \u2018COLR\u2019 uses palette index 0xFFFF to indicate a \u2018text foreground color\u2019. This function sets this value. input face The source face handle. foreground_color An FT_Color structure to define the text foreground color. return FreeType error code. 0 means success. note If this function isn't called, the text foreground color is set to white opaque (BGRA value 0xFFFFFFFF) if FT_PALETTE_FOR_DARK_BACKGROUND is present for the current palette, and black opaque (BGRA value 0x000000FF) otherwise, including the case that no palette types are available in the \u2018CPAL\u2019 table. This function always returns an error if the config macro TT_CONFIG_OPTION_COLOR_LAYERS is not defined in ftoption.h . since 2.10","title":"Glyph Color Management"},{"location":"ft2-color_management.html#glyph-color-management","text":"","title":"Glyph Color Management"},{"location":"ft2-color_management.html#synopsis","text":"The functions described here allow access and manipulation of color palette entries in OpenType's \u2018CPAL\u2019 tables.","title":"Synopsis"},{"location":"ft2-color_management.html#ft_color","text":"Defined in FT_COLOR_H (freetype/ftcolor.h). typedef struct FT_Color_ { FT_Byte blue; FT_Byte green; FT_Byte red; FT_Byte alpha; } FT_Color ; This structure models a BGRA color value of a \u2018CPAL\u2019 palette entry. The used color space is sRGB; the colors are not pre-multiplied, and alpha values must be explicitly set.","title":"FT_Color"},{"location":"ft2-color_management.html#ft_palette_xxx","text":"Defined in FT_COLOR_H (freetype/ftcolor.h). # define FT_PALETTE_FOR_LIGHT_BACKGROUND 0x01 # define FT_PALETTE_FOR_DARK_BACKGROUND 0x02 A list of bit field constants used in the palette_flags array of the FT_Palette_Data structure to indicate for which background a palette with a given index is usable.","title":"FT_PALETTE_XXX"},{"location":"ft2-color_management.html#ft_palette_data","text":"Defined in FT_COLOR_H (freetype/ftcolor.h). typedef struct FT_Palette_Data_ { FT_UShort num_palettes; const FT_UShort * palette_name_ids; const FT_UShort * palette_flags; FT_UShort num_palette_entries; const FT_UShort * palette_entry_name_ids; } FT_Palette_Data ; This structure holds the data of the \u2018CPAL\u2019 table.","title":"FT_Palette_Data"},{"location":"ft2-color_management.html#ft_palette_data_get","text":"Defined in FT_COLOR_H (freetype/ftcolor.h). FT_EXPORT( FT_Error ) FT_Palette_Data_Get ( FT_Face face, FT_Palette_Data *apalette ); Retrieve the face's color palette data.","title":"FT_Palette_Data_Get"},{"location":"ft2-color_management.html#ft_palette_select","text":"Defined in FT_COLOR_H (freetype/ftcolor.h). FT_EXPORT( FT_Error ) FT_Palette_Select ( FT_Face face, FT_UShort palette_index, FT_Color * *apalette ); This function has two purposes. (1) It activates a palette for rendering color glyphs, and (2) it retrieves all (unmodified) color entries of this palette. This function returns a read-write array, which means that a calling application can modify the palette entries on demand. A corollary of (2) is that calling the function, then modifying some values, then calling the function again with the same arguments resets all color entries to the original \u2018CPAL\u2019 values; all user modifications are lost.","title":"FT_Palette_Select"},{"location":"ft2-color_management.html#ft_palette_set_foreground_color","text":"Defined in FT_COLOR_H (freetype/ftcolor.h). FT_EXPORT( FT_Error ) FT_Palette_Set_Foreground_Color ( FT_Face face, FT_Color foreground_color ); \u2018COLR\u2019 uses palette index 0xFFFF to indicate a \u2018text foreground color\u2019. This function sets this value.","title":"FT_Palette_Set_Foreground_Color"},{"location":"ft2-computations.html","text":"FreeType \u00bb Docs \u00bb Support API \u00bb Computations Computations \u00b6 Synopsis \u00b6 This section contains various functions used to perform computations on 16.16 fixed-float numbers or 2d vectors. Attention : Most arithmetic functions take FT_Long as arguments. For historical reasons, FreeType was designed under the assumption that FT_Long is a 32-bit integer; results can thus be undefined if the arguments don't fit into 32 bits. FT_MulDiv \u00b6 Defined in FT_FREETYPE_H (freetype/freetype.h). FT_EXPORT( FT_Long ) FT_MulDiv ( FT_Long a, FT_Long b, FT_Long c ); Compute (a*b)/c with maximum accuracy, using a 64-bit intermediate integer whenever necessary. This function isn't necessarily as fast as some processor-specific operations, but is at least completely portable. input a The first multiplier. b The second multiplier. c The divisor. return The result of (a*b)/c . This function never traps when trying to divide by zero; it simply returns \u2018MaxInt\u2019 or \u2018MinInt\u2019 depending on the signs of a and b . FT_MulFix \u00b6 Defined in FT_FREETYPE_H (freetype/freetype.h). FT_EXPORT( FT_Long ) FT_MulFix ( FT_Long a, FT_Long b ); Compute (a*b)/0x10000 with maximum accuracy. Its main use is to multiply a given value by a 16.16 fixed-point factor. input a The first multiplier. b The second multiplier. Use a 16.16 factor here whenever possible (see note below). return The result of (a*b)/0x10000 . note This function has been optimized for the case where the absolute value of a is less than 2048, and b is a 16.16 scaling factor. As this happens mainly when scaling from notional units to fractional pixels in FreeType, it resulted in noticeable speed improvements between versions 2.x and 1.x. As a conclusion, always try to place a 16.16 factor as the second argument of this function; this can make a great difference. FT_DivFix \u00b6 Defined in FT_FREETYPE_H (freetype/freetype.h). FT_EXPORT( FT_Long ) FT_DivFix ( FT_Long a, FT_Long b ); Compute (a*0x10000)/b with maximum accuracy. Its main use is to divide a given value by a 16.16 fixed-point factor. input a The numerator. b The denominator. Use a 16.16 factor here. return The result of (a*0x10000)/b . FT_RoundFix \u00b6 Defined in FT_FREETYPE_H (freetype/freetype.h). FT_EXPORT( FT_Fixed ) FT_RoundFix ( FT_Fixed a ); Round a 16.16 fixed number. input a The number to be rounded. return a rounded to the nearest 16.16 fixed integer, halfway cases away from zero. note The function uses wrap-around arithmetic. FT_CeilFix \u00b6 Defined in FT_FREETYPE_H (freetype/freetype.h). FT_EXPORT( FT_Fixed ) FT_CeilFix ( FT_Fixed a ); Compute the smallest following integer of a 16.16 fixed number. input a The number for which the ceiling function is to be computed. return a rounded towards plus infinity. note The function uses wrap-around arithmetic. FT_FloorFix \u00b6 Defined in FT_FREETYPE_H (freetype/freetype.h). FT_EXPORT( FT_Fixed ) FT_FloorFix ( FT_Fixed a ); Compute the largest previous integer of a 16.16 fixed number. input a The number for which the floor function is to be computed. return a rounded towards minus infinity. FT_Vector_Transform \u00b6 Defined in FT_FREETYPE_H (freetype/freetype.h). FT_EXPORT( void ) FT_Vector_Transform ( FT_Vector * vector, const FT_Matrix * matrix ); Transform a single vector through a 2x2 matrix. inout vector The target vector to transform. input matrix A pointer to the source 2x2 matrix. note The result is undefined if either vector or matrix is invalid. FT_Matrix_Multiply \u00b6 Defined in FT_GLYPH_H (freetype/ftglyph.h). FT_EXPORT( void ) FT_Matrix_Multiply ( const FT_Matrix * a, FT_Matrix * b ); Perform the matrix operation b = a*b . input a A pointer to matrix a . inout b A pointer to matrix b . note The result is undefined if either a or b is zero. Since the function uses wrap-around arithmetic, results become meaningless if the arguments are very large. FT_Matrix_Invert \u00b6 Defined in FT_GLYPH_H (freetype/ftglyph.h). FT_EXPORT( FT_Error ) FT_Matrix_Invert ( FT_Matrix * matrix ); Invert a 2x2 matrix. Return an error if it can't be inverted. inout matrix A pointer to the target matrix. Remains untouched in case of error. return FreeType error code. 0 means success. FT_Angle \u00b6 Defined in FT_TRIGONOMETRY_H (freetype/fttrigon.h). typedef FT_Fixed FT_Angle ; This type is used to model angle values in FreeType. Note that the angle is a 16.16 fixed-point value expressed in degrees. FT_ANGLE_PI \u00b6 Defined in FT_TRIGONOMETRY_H (freetype/fttrigon.h). # define FT_ANGLE_PI ( 180L << 16 ) The angle pi expressed in FT_Angle units. FT_ANGLE_2PI \u00b6 Defined in FT_TRIGONOMETRY_H (freetype/fttrigon.h). # define FT_ANGLE_2PI ( FT_ANGLE_PI * 2 ) The angle 2*pi expressed in FT_Angle units. FT_ANGLE_PI2 \u00b6 Defined in FT_TRIGONOMETRY_H (freetype/fttrigon.h). # define FT_ANGLE_PI2 ( FT_ANGLE_PI / 2 ) The angle pi/2 expressed in FT_Angle units. FT_ANGLE_PI4 \u00b6 Defined in FT_TRIGONOMETRY_H (freetype/fttrigon.h). # define FT_ANGLE_PI4 ( FT_ANGLE_PI / 4 ) The angle pi/4 expressed in FT_Angle units. FT_Sin \u00b6 Defined in FT_TRIGONOMETRY_H (freetype/fttrigon.h). FT_EXPORT( FT_Fixed ) FT_Sin ( FT_Angle angle ); Return the sinus of a given angle in fixed-point format. input angle The input angle. return The sinus value. note If you need both the sinus and cosinus for a given angle, use the function FT_Vector_Unit . FT_Cos \u00b6 Defined in FT_TRIGONOMETRY_H (freetype/fttrigon.h). FT_EXPORT( FT_Fixed ) FT_Cos ( FT_Angle angle ); Return the cosinus of a given angle in fixed-point format. input angle The input angle. return The cosinus value. note If you need both the sinus and cosinus for a given angle, use the function FT_Vector_Unit . FT_Tan \u00b6 Defined in FT_TRIGONOMETRY_H (freetype/fttrigon.h). FT_EXPORT( FT_Fixed ) FT_Tan ( FT_Angle angle ); Return the tangent of a given angle in fixed-point format. input angle The input angle. return The tangent value. FT_Atan2 \u00b6 Defined in FT_TRIGONOMETRY_H (freetype/fttrigon.h). FT_EXPORT( FT_Angle ) FT_Atan2 ( FT_Fixed x, FT_Fixed y ); Return the arc-tangent corresponding to a given vector (x,y) in the 2d plane. input x The horizontal vector coordinate. y The vertical vector coordinate. return The arc-tangent value (i.e. angle). FT_Angle_Diff \u00b6 Defined in FT_TRIGONOMETRY_H (freetype/fttrigon.h). FT_EXPORT( FT_Angle ) FT_Angle_Diff ( FT_Angle angle1, FT_Angle angle2 ); Return the difference between two angles. The result is always constrained to the ]-PI..PI] interval. input angle1 First angle. angle2 Second angle. return Constrained value of angle2-angle1 . FT_Vector_Unit \u00b6 Defined in FT_TRIGONOMETRY_H (freetype/fttrigon.h). FT_EXPORT( void ) FT_Vector_Unit ( FT_Vector * vec, FT_Angle angle ); Return the unit vector corresponding to a given angle. After the call, the value of vec.x will be cos(angle) , and the value of vec.y will be sin(angle) . This function is useful to retrieve both the sinus and cosinus of a given angle quickly. output vec The address of target vector. input angle The input angle. FT_Vector_Rotate \u00b6 Defined in FT_TRIGONOMETRY_H (freetype/fttrigon.h). FT_EXPORT( void ) FT_Vector_Rotate ( FT_Vector * vec, FT_Angle angle ); Rotate a vector by a given angle. inout vec The address of target vector. input angle The input angle. FT_Vector_Length \u00b6 Defined in FT_TRIGONOMETRY_H (freetype/fttrigon.h). FT_EXPORT( FT_Fixed ) FT_Vector_Length ( FT_Vector * vec ); Return the length of a given vector. input vec The address of target vector. return The vector length, expressed in the same units that the original vector coordinates. FT_Vector_Polarize \u00b6 Defined in FT_TRIGONOMETRY_H (freetype/fttrigon.h). FT_EXPORT( void ) FT_Vector_Polarize ( FT_Vector * vec, FT_Fixed *length, FT_Angle *angle ); Compute both the length and angle of a given vector. input vec The address of source vector. output length The vector length. angle The vector angle. FT_Vector_From_Polar \u00b6 Defined in FT_TRIGONOMETRY_H (freetype/fttrigon.h). FT_EXPORT( void ) FT_Vector_From_Polar ( FT_Vector * vec, FT_Fixed length, FT_Angle angle ); Compute vector coordinates from a length and angle. output vec The address of source vector. input length The vector length. angle The vector angle.","title":"Computations"},{"location":"ft2-computations.html#computations","text":"","title":"Computations"},{"location":"ft2-computations.html#synopsis","text":"This section contains various functions used to perform computations on 16.16 fixed-float numbers or 2d vectors. Attention : Most arithmetic functions take FT_Long as arguments. For historical reasons, FreeType was designed under the assumption that FT_Long is a 32-bit integer; results can thus be undefined if the arguments don't fit into 32 bits.","title":"Synopsis"},{"location":"ft2-computations.html#ft_muldiv","text":"Defined in FT_FREETYPE_H (freetype/freetype.h). FT_EXPORT( FT_Long ) FT_MulDiv ( FT_Long a, FT_Long b, FT_Long c ); Compute (a*b)/c with maximum accuracy, using a 64-bit intermediate integer whenever necessary. This function isn't necessarily as fast as some processor-specific operations, but is at least completely portable.","title":"FT_MulDiv"},{"location":"ft2-computations.html#ft_mulfix","text":"Defined in FT_FREETYPE_H (freetype/freetype.h). FT_EXPORT( FT_Long ) FT_MulFix ( FT_Long a, FT_Long b ); Compute (a*b)/0x10000 with maximum accuracy. Its main use is to multiply a given value by a 16.16 fixed-point factor.","title":"FT_MulFix"},{"location":"ft2-computations.html#ft_divfix","text":"Defined in FT_FREETYPE_H (freetype/freetype.h). FT_EXPORT( FT_Long ) FT_DivFix ( FT_Long a, FT_Long b ); Compute (a*0x10000)/b with maximum accuracy. Its main use is to divide a given value by a 16.16 fixed-point factor.","title":"FT_DivFix"},{"location":"ft2-computations.html#ft_roundfix","text":"Defined in FT_FREETYPE_H (freetype/freetype.h). FT_EXPORT( FT_Fixed ) FT_RoundFix ( FT_Fixed a ); Round a 16.16 fixed number.","title":"FT_RoundFix"},{"location":"ft2-computations.html#ft_ceilfix","text":"Defined in FT_FREETYPE_H (freetype/freetype.h). FT_EXPORT( FT_Fixed ) FT_CeilFix ( FT_Fixed a ); Compute the smallest following integer of a 16.16 fixed number.","title":"FT_CeilFix"},{"location":"ft2-computations.html#ft_floorfix","text":"Defined in FT_FREETYPE_H (freetype/freetype.h). FT_EXPORT( FT_Fixed ) FT_FloorFix ( FT_Fixed a ); Compute the largest previous integer of a 16.16 fixed number.","title":"FT_FloorFix"},{"location":"ft2-computations.html#ft_vector_transform","text":"Defined in FT_FREETYPE_H (freetype/freetype.h). FT_EXPORT( void ) FT_Vector_Transform ( FT_Vector * vector, const FT_Matrix * matrix ); Transform a single vector through a 2x2 matrix.","title":"FT_Vector_Transform"},{"location":"ft2-computations.html#ft_matrix_multiply","text":"Defined in FT_GLYPH_H (freetype/ftglyph.h). FT_EXPORT( void ) FT_Matrix_Multiply ( const FT_Matrix * a, FT_Matrix * b ); Perform the matrix operation b = a*b .","title":"FT_Matrix_Multiply"},{"location":"ft2-computations.html#ft_matrix_invert","text":"Defined in FT_GLYPH_H (freetype/ftglyph.h). FT_EXPORT( FT_Error ) FT_Matrix_Invert ( FT_Matrix * matrix ); Invert a 2x2 matrix. Return an error if it can't be inverted.","title":"FT_Matrix_Invert"},{"location":"ft2-computations.html#ft_angle","text":"Defined in FT_TRIGONOMETRY_H (freetype/fttrigon.h). typedef FT_Fixed FT_Angle ; This type is used to model angle values in FreeType. Note that the angle is a 16.16 fixed-point value expressed in degrees.","title":"FT_Angle"},{"location":"ft2-computations.html#ft_angle_pi","text":"Defined in FT_TRIGONOMETRY_H (freetype/fttrigon.h). # define FT_ANGLE_PI ( 180L << 16 ) The angle pi expressed in FT_Angle units.","title":"FT_ANGLE_PI"},{"location":"ft2-computations.html#ft_angle_2pi","text":"Defined in FT_TRIGONOMETRY_H (freetype/fttrigon.h). # define FT_ANGLE_2PI ( FT_ANGLE_PI * 2 ) The angle 2*pi expressed in FT_Angle units.","title":"FT_ANGLE_2PI"},{"location":"ft2-computations.html#ft_angle_pi2","text":"Defined in FT_TRIGONOMETRY_H (freetype/fttrigon.h). # define FT_ANGLE_PI2 ( FT_ANGLE_PI / 2 ) The angle pi/2 expressed in FT_Angle units.","title":"FT_ANGLE_PI2"},{"location":"ft2-computations.html#ft_angle_pi4","text":"Defined in FT_TRIGONOMETRY_H (freetype/fttrigon.h). # define FT_ANGLE_PI4 ( FT_ANGLE_PI / 4 ) The angle pi/4 expressed in FT_Angle units.","title":"FT_ANGLE_PI4"},{"location":"ft2-computations.html#ft_sin","text":"Defined in FT_TRIGONOMETRY_H (freetype/fttrigon.h). FT_EXPORT( FT_Fixed ) FT_Sin ( FT_Angle angle ); Return the sinus of a given angle in fixed-point format.","title":"FT_Sin"},{"location":"ft2-computations.html#ft_cos","text":"Defined in FT_TRIGONOMETRY_H (freetype/fttrigon.h). FT_EXPORT( FT_Fixed ) FT_Cos ( FT_Angle angle ); Return the cosinus of a given angle in fixed-point format.","title":"FT_Cos"},{"location":"ft2-computations.html#ft_tan","text":"Defined in FT_TRIGONOMETRY_H (freetype/fttrigon.h). FT_EXPORT( FT_Fixed ) FT_Tan ( FT_Angle angle ); Return the tangent of a given angle in fixed-point format.","title":"FT_Tan"},{"location":"ft2-computations.html#ft_atan2","text":"Defined in FT_TRIGONOMETRY_H (freetype/fttrigon.h). FT_EXPORT( FT_Angle ) FT_Atan2 ( FT_Fixed x, FT_Fixed y ); Return the arc-tangent corresponding to a given vector (x,y) in the 2d plane.","title":"FT_Atan2"},{"location":"ft2-computations.html#ft_angle_diff","text":"Defined in FT_TRIGONOMETRY_H (freetype/fttrigon.h). FT_EXPORT( FT_Angle ) FT_Angle_Diff ( FT_Angle angle1, FT_Angle angle2 ); Return the difference between two angles. The result is always constrained to the ]-PI..PI] interval.","title":"FT_Angle_Diff"},{"location":"ft2-computations.html#ft_vector_unit","text":"Defined in FT_TRIGONOMETRY_H (freetype/fttrigon.h). FT_EXPORT( void ) FT_Vector_Unit ( FT_Vector * vec, FT_Angle angle ); Return the unit vector corresponding to a given angle. After the call, the value of vec.x will be cos(angle) , and the value of vec.y will be sin(angle) . This function is useful to retrieve both the sinus and cosinus of a given angle quickly.","title":"FT_Vector_Unit"},{"location":"ft2-computations.html#ft_vector_rotate","text":"Defined in FT_TRIGONOMETRY_H (freetype/fttrigon.h). FT_EXPORT( void ) FT_Vector_Rotate ( FT_Vector * vec, FT_Angle angle ); Rotate a vector by a given angle.","title":"FT_Vector_Rotate"},{"location":"ft2-computations.html#ft_vector_length","text":"Defined in FT_TRIGONOMETRY_H (freetype/fttrigon.h). FT_EXPORT( FT_Fixed ) FT_Vector_Length ( FT_Vector * vec ); Return the length of a given vector.","title":"FT_Vector_Length"},{"location":"ft2-computations.html#ft_vector_polarize","text":"Defined in FT_TRIGONOMETRY_H (freetype/fttrigon.h). FT_EXPORT( void ) FT_Vector_Polarize ( FT_Vector * vec, FT_Fixed *length, FT_Angle *angle ); Compute both the length and angle of a given vector.","title":"FT_Vector_Polarize"},{"location":"ft2-computations.html#ft_vector_from_polar","text":"Defined in FT_TRIGONOMETRY_H (freetype/fttrigon.h). FT_EXPORT( void ) FT_Vector_From_Polar ( FT_Vector * vec, FT_Fixed length, FT_Angle angle ); Compute vector coordinates from a length and angle.","title":"FT_Vector_From_Polar"},{"location":"ft2-error_code_values.html","text":"FreeType \u00bb Docs \u00bb Error Codes \u00bb Error Code Values Error Code Values \u00b6 Synopsis \u00b6 The list below is taken verbatim from the file fterrdef.h (loaded automatically by including FT_FREETYPE_H ). The first argument of the FT_ERROR_DEF_ macro is the error label; by default, the prefix FT_Err_ gets added so that you get error names like FT_Err_Cannot_Open_Resource . The second argument is the error code, and the last argument an error string, which is not used by FreeType. Within your application you should only use error names and never its numeric values! The latter might (and actually do) change in forthcoming FreeType versions. Macro FT_NOERRORDEF_ defines FT_Err_Ok , which is always zero. See the \u2018Error Enumerations\u2019 subsection how to automatically generate a list of error strings. FT_Err_XXX \u00b6 /* generic errors */ FT_NOERRORDEF_( Ok, 0x00, \"no error\" ) FT_ERRORDEF_( Cannot_Open_Resource, 0x01, \"cannot open resource\" ) FT_ERRORDEF_( Unknown_File_Format, 0x02, \"unknown file format\" ) FT_ERRORDEF_( Invalid_File_Format, 0x03, \"broken file\" ) FT_ERRORDEF_( Invalid_Version, 0x04, \"invalid FreeType version\" ) FT_ERRORDEF_( Lower_Module_Version, 0x05, \"module version is too low\" ) FT_ERRORDEF_( Invalid_Argument, 0x06, \"invalid argument\" ) FT_ERRORDEF_( Unimplemented_Feature, 0x07, \"unimplemented feature\" ) FT_ERRORDEF_( Invalid_Table, 0x08, \"broken table\" ) FT_ERRORDEF_( Invalid_Offset, 0x09, \"broken offset within table\" ) FT_ERRORDEF_( Array_Too_Large, 0x0A, \"array allocation size too large\" ) FT_ERRORDEF_( Missing_Module, 0x0B, \"missing module\" ) FT_ERRORDEF_( Missing_Property, 0x0C, \"missing property\" ) /* glyph/character errors */ FT_ERRORDEF_( Invalid_Glyph_Index, 0x10, \"invalid glyph index\" ) FT_ERRORDEF_( Invalid_Character_Code, 0x11, \"invalid character code\" ) FT_ERRORDEF_( Invalid_Glyph_Format, 0x12, \"unsupported glyph image format\" ) FT_ERRORDEF_( Cannot_Render_Glyph, 0x13, \"cannot render this glyph format\" ) FT_ERRORDEF_( Invalid_Outline, 0x14, \"invalid outline\" ) FT_ERRORDEF_( Invalid_Composite, 0x15, \"invalid composite glyph\" ) FT_ERRORDEF_( Too_Many_Hints, 0x16, \"too many hints\" ) FT_ERRORDEF_( Invalid_Pixel_Size, 0x17, \"invalid pixel size\" ) /* handle errors */ FT_ERRORDEF_( Invalid_Handle, 0x20, \"invalid object handle\" ) FT_ERRORDEF_( Invalid_Library_Handle, 0x21, \"invalid library handle\" ) FT_ERRORDEF_( Invalid_Driver_Handle, 0x22, \"invalid module handle\" ) FT_ERRORDEF_( Invalid_Face_Handle, 0x23, \"invalid face handle\" ) FT_ERRORDEF_( Invalid_Size_Handle, 0x24, \"invalid size handle\" ) FT_ERRORDEF_( Invalid_Slot_Handle, 0x25, \"invalid glyph slot handle\" ) FT_ERRORDEF_( Invalid_CharMap_Handle, 0x26, \"invalid charmap handle\" ) FT_ERRORDEF_( Invalid_Cache_Handle, 0x27, \"invalid cache manager handle\" ) FT_ERRORDEF_( Invalid_Stream_Handle, 0x28, \"invalid stream handle\" ) /* driver errors */ FT_ERRORDEF_( Too_Many_Drivers, 0x30, \"too many modules\" ) FT_ERRORDEF_( Too_Many_Extensions, 0x31, \"too many extensions\" ) /* memory errors */ FT_ERRORDEF_( Out_Of_Memory, 0x40, \"out of memory\" ) FT_ERRORDEF_( Unlisted_Object, 0x41, \"unlisted object\" ) /* stream errors */ FT_ERRORDEF_( Cannot_Open_Stream, 0x51, \"cannot open stream\" ) FT_ERRORDEF_( Invalid_Stream_Seek, 0x52, \"invalid stream seek\" ) FT_ERRORDEF_( Invalid_Stream_Skip, 0x53, \"invalid stream skip\" ) FT_ERRORDEF_( Invalid_Stream_Read, 0x54, \"invalid stream read\" ) FT_ERRORDEF_( Invalid_Stream_Operation, 0x55, \"invalid stream operation\" ) FT_ERRORDEF_( Invalid_Frame_Operation, 0x56, \"invalid frame operation\" ) FT_ERRORDEF_( Nested_Frame_Access, 0x57, \"nested frame access\" ) FT_ERRORDEF_( Invalid_Frame_Read, 0x58, \"invalid frame read\" ) /* raster errors */ FT_ERRORDEF_( Raster_Uninitialized, 0x60, \"raster uninitialized\" ) FT_ERRORDEF_( Raster_Corrupted, 0x61, \"raster corrupted\" ) FT_ERRORDEF_( Raster_Overflow, 0x62, \"raster overflow\" ) FT_ERRORDEF_( Raster_Negative_Height, 0x63, \"negative height while rastering\" ) /* cache errors */ FT_ERRORDEF_( Too_Many_Caches, 0x70, \"too many registered caches\" ) /* TrueType and SFNT errors */ FT_ERRORDEF_( Invalid_Opcode, 0x80, \"invalid opcode\" ) FT_ERRORDEF_( Too_Few_Arguments, 0x81, \"too few arguments\" ) FT_ERRORDEF_( Stack_Overflow, 0x82, \"stack overflow\" ) FT_ERRORDEF_( Code_Overflow, 0x83, \"code overflow\" ) FT_ERRORDEF_( Bad_Argument, 0x84, \"bad argument\" ) FT_ERRORDEF_( Divide_By_Zero, 0x85, \"division by zero\" ) FT_ERRORDEF_( Invalid_Reference, 0x86, \"invalid reference\" ) FT_ERRORDEF_( Debug_OpCode, 0x87, \"found debug opcode\" ) FT_ERRORDEF_( ENDF_In_Exec_Stream, 0x88, \"found ENDF opcode in execution stream\" ) FT_ERRORDEF_( Nested_DEFS, 0x89, \"nested DEFS\" ) FT_ERRORDEF_( Invalid_CodeRange, 0x8A, \"invalid code range\" ) FT_ERRORDEF_( Execution_Too_Long, 0x8B, \"execution context too long \" ) FT_ERRORDEF_( Too_Many_Function_Defs, 0x8C, \"too many function definitions\" ) FT_ERRORDEF_( Too_Many_Instruction_Defs, 0x8D, \"too many instruction definitions\" ) FT_ERRORDEF_( Table_Missing, 0x8E, \"SFNT font table missing\" ) FT_ERRORDEF_( Horiz_Header_Missing, 0x8F, \"horizontal header (hhea) table missing\" ) FT_ERRORDEF_( Locations_Missing, 0x90, \"locations (loca) table missing\" ) FT_ERRORDEF_( Name_Table_Missing, 0x91, \"name table missing\" ) FT_ERRORDEF_( CMap_Table_Missing, 0x92, \"character map (cmap) table missing\" ) FT_ERRORDEF_( Hmtx_Table_Missing, 0x93, \"horizontal metrics (hmtx) table missing\" ) FT_ERRORDEF_( Post_Table_Missing, 0x94, \"PostScript (post) table missing\" ) FT_ERRORDEF_( Invalid_Horiz_Metrics, 0x95, \"invalid horizontal metrics\" ) FT_ERRORDEF_( Invalid_CharMap_Format, 0x96, \"invalid character map (cmap) format\" ) FT_ERRORDEF_( Invalid_PPem, 0x97, \"invalid ppem value\" ) FT_ERRORDEF_( Invalid_Vert_Metrics, 0x98, \"invalid vertical metrics\" ) FT_ERRORDEF_( Could_Not_Find_Context, 0x99, \"could not find context\" ) FT_ERRORDEF_( Invalid_Post_Table_Format, 0x9A, \"invalid PostScript (post) table format\" ) FT_ERRORDEF_( Invalid_Post_Table, 0x9B, \"invalid PostScript (post) table\" ) FT_ERRORDEF_( DEF_In_Glyf_Bytecode, 0x9C, \"found FDEF or IDEF opcode in glyf bytecode\" ) FT_ERRORDEF_( Missing_Bitmap, 0x9D, \"missing bitmap in strike\" ) /* CFF, CID, and Type 1 errors */ FT_ERRORDEF_( Syntax_Error, 0xA0, \"opcode syntax error\" ) FT_ERRORDEF_( Stack_Underflow, 0xA1, \"argument stack underflow\" ) FT_ERRORDEF_( Ignore, 0xA2, \"ignore\" ) FT_ERRORDEF_( No_Unicode_Glyph_Name, 0xA3, \"no Unicode glyph name found\" ) FT_ERRORDEF_( Glyph_Too_Big, 0xA4, \"glyph too big for hinting\" ) /* BDF errors */ FT_ERRORDEF_( Missing_Startfont_Field, 0xB0, \"`STARTFONT' field missing\" ) FT_ERRORDEF_( Missing_Font_Field, 0xB1, \"`FONT' field missing\" ) FT_ERRORDEF_( Missing_Size_Field, 0xB2, \"`SIZE' field missing\" ) FT_ERRORDEF_( Missing_Fontboundingbox_Field, 0xB3, \"`FONTBOUNDINGBOX' field missing\" ) FT_ERRORDEF_( Missing_Chars_Field, 0xB4, \"`CHARS' field missing\" ) FT_ERRORDEF_( Missing_Startchar_Field, 0xB5, \"`STARTCHAR' field missing\" ) FT_ERRORDEF_( Missing_Encoding_Field, 0xB6, \"`ENCODING' field missing\" ) FT_ERRORDEF_( Missing_Bbx_Field, 0xB7, \"`BBX' field missing\" ) FT_ERRORDEF_( Bbx_Too_Big, 0xB8, \"`BBX' too big\" ) FT_ERRORDEF_( Corrupted_Font_Header, 0xB9, \"Font header corrupted or missing fields\" ) FT_ERRORDEF_( Corrupted_Font_Glyphs, 0xBA, \"Font glyphs corrupted or missing fields\" )","title":"Error Code Values"},{"location":"ft2-error_code_values.html#error-code-values","text":"","title":"Error Code Values"},{"location":"ft2-error_code_values.html#synopsis","text":"The list below is taken verbatim from the file fterrdef.h (loaded automatically by including FT_FREETYPE_H ). The first argument of the FT_ERROR_DEF_ macro is the error label; by default, the prefix FT_Err_ gets added so that you get error names like FT_Err_Cannot_Open_Resource . The second argument is the error code, and the last argument an error string, which is not used by FreeType. Within your application you should only use error names and never its numeric values! The latter might (and actually do) change in forthcoming FreeType versions. Macro FT_NOERRORDEF_ defines FT_Err_Ok , which is always zero. See the \u2018Error Enumerations\u2019 subsection how to automatically generate a list of error strings.","title":"Synopsis"},{"location":"ft2-error_code_values.html#ft_err_xxx","text":"/* generic errors */ FT_NOERRORDEF_( Ok, 0x00, \"no error\" ) FT_ERRORDEF_( Cannot_Open_Resource, 0x01, \"cannot open resource\" ) FT_ERRORDEF_( Unknown_File_Format, 0x02, \"unknown file format\" ) FT_ERRORDEF_( Invalid_File_Format, 0x03, \"broken file\" ) FT_ERRORDEF_( Invalid_Version, 0x04, \"invalid FreeType version\" ) FT_ERRORDEF_( Lower_Module_Version, 0x05, \"module version is too low\" ) FT_ERRORDEF_( Invalid_Argument, 0x06, \"invalid argument\" ) FT_ERRORDEF_( Unimplemented_Feature, 0x07, \"unimplemented feature\" ) FT_ERRORDEF_( Invalid_Table, 0x08, \"broken table\" ) FT_ERRORDEF_( Invalid_Offset, 0x09, \"broken offset within table\" ) FT_ERRORDEF_( Array_Too_Large, 0x0A, \"array allocation size too large\" ) FT_ERRORDEF_( Missing_Module, 0x0B, \"missing module\" ) FT_ERRORDEF_( Missing_Property, 0x0C, \"missing property\" ) /* glyph/character errors */ FT_ERRORDEF_( Invalid_Glyph_Index, 0x10, \"invalid glyph index\" ) FT_ERRORDEF_( Invalid_Character_Code, 0x11, \"invalid character code\" ) FT_ERRORDEF_( Invalid_Glyph_Format, 0x12, \"unsupported glyph image format\" ) FT_ERRORDEF_( Cannot_Render_Glyph, 0x13, \"cannot render this glyph format\" ) FT_ERRORDEF_( Invalid_Outline, 0x14, \"invalid outline\" ) FT_ERRORDEF_( Invalid_Composite, 0x15, \"invalid composite glyph\" ) FT_ERRORDEF_( Too_Many_Hints, 0x16, \"too many hints\" ) FT_ERRORDEF_( Invalid_Pixel_Size, 0x17, \"invalid pixel size\" ) /* handle errors */ FT_ERRORDEF_( Invalid_Handle, 0x20, \"invalid object handle\" ) FT_ERRORDEF_( Invalid_Library_Handle, 0x21, \"invalid library handle\" ) FT_ERRORDEF_( Invalid_Driver_Handle, 0x22, \"invalid module handle\" ) FT_ERRORDEF_( Invalid_Face_Handle, 0x23, \"invalid face handle\" ) FT_ERRORDEF_( Invalid_Size_Handle, 0x24, \"invalid size handle\" ) FT_ERRORDEF_( Invalid_Slot_Handle, 0x25, \"invalid glyph slot handle\" ) FT_ERRORDEF_( Invalid_CharMap_Handle, 0x26, \"invalid charmap handle\" ) FT_ERRORDEF_( Invalid_Cache_Handle, 0x27, \"invalid cache manager handle\" ) FT_ERRORDEF_( Invalid_Stream_Handle, 0x28, \"invalid stream handle\" ) /* driver errors */ FT_ERRORDEF_( Too_Many_Drivers, 0x30, \"too many modules\" ) FT_ERRORDEF_( Too_Many_Extensions, 0x31, \"too many extensions\" ) /* memory errors */ FT_ERRORDEF_( Out_Of_Memory, 0x40, \"out of memory\" ) FT_ERRORDEF_( Unlisted_Object, 0x41, \"unlisted object\" ) /* stream errors */ FT_ERRORDEF_( Cannot_Open_Stream, 0x51, \"cannot open stream\" ) FT_ERRORDEF_( Invalid_Stream_Seek, 0x52, \"invalid stream seek\" ) FT_ERRORDEF_( Invalid_Stream_Skip, 0x53, \"invalid stream skip\" ) FT_ERRORDEF_( Invalid_Stream_Read, 0x54, \"invalid stream read\" ) FT_ERRORDEF_( Invalid_Stream_Operation, 0x55, \"invalid stream operation\" ) FT_ERRORDEF_( Invalid_Frame_Operation, 0x56, \"invalid frame operation\" ) FT_ERRORDEF_( Nested_Frame_Access, 0x57, \"nested frame access\" ) FT_ERRORDEF_( Invalid_Frame_Read, 0x58, \"invalid frame read\" ) /* raster errors */ FT_ERRORDEF_( Raster_Uninitialized, 0x60, \"raster uninitialized\" ) FT_ERRORDEF_( Raster_Corrupted, 0x61, \"raster corrupted\" ) FT_ERRORDEF_( Raster_Overflow, 0x62, \"raster overflow\" ) FT_ERRORDEF_( Raster_Negative_Height, 0x63, \"negative height while rastering\" ) /* cache errors */ FT_ERRORDEF_( Too_Many_Caches, 0x70, \"too many registered caches\" ) /* TrueType and SFNT errors */ FT_ERRORDEF_( Invalid_Opcode, 0x80, \"invalid opcode\" ) FT_ERRORDEF_( Too_Few_Arguments, 0x81, \"too few arguments\" ) FT_ERRORDEF_( Stack_Overflow, 0x82, \"stack overflow\" ) FT_ERRORDEF_( Code_Overflow, 0x83, \"code overflow\" ) FT_ERRORDEF_( Bad_Argument, 0x84, \"bad argument\" ) FT_ERRORDEF_( Divide_By_Zero, 0x85, \"division by zero\" ) FT_ERRORDEF_( Invalid_Reference, 0x86, \"invalid reference\" ) FT_ERRORDEF_( Debug_OpCode, 0x87, \"found debug opcode\" ) FT_ERRORDEF_( ENDF_In_Exec_Stream, 0x88, \"found ENDF opcode in execution stream\" ) FT_ERRORDEF_( Nested_DEFS, 0x89, \"nested DEFS\" ) FT_ERRORDEF_( Invalid_CodeRange, 0x8A, \"invalid code range\" ) FT_ERRORDEF_( Execution_Too_Long, 0x8B, \"execution context too long \" ) FT_ERRORDEF_( Too_Many_Function_Defs, 0x8C, \"too many function definitions\" ) FT_ERRORDEF_( Too_Many_Instruction_Defs, 0x8D, \"too many instruction definitions\" ) FT_ERRORDEF_( Table_Missing, 0x8E, \"SFNT font table missing\" ) FT_ERRORDEF_( Horiz_Header_Missing, 0x8F, \"horizontal header (hhea) table missing\" ) FT_ERRORDEF_( Locations_Missing, 0x90, \"locations (loca) table missing\" ) FT_ERRORDEF_( Name_Table_Missing, 0x91, \"name table missing\" ) FT_ERRORDEF_( CMap_Table_Missing, 0x92, \"character map (cmap) table missing\" ) FT_ERRORDEF_( Hmtx_Table_Missing, 0x93, \"horizontal metrics (hmtx) table missing\" ) FT_ERRORDEF_( Post_Table_Missing, 0x94, \"PostScript (post) table missing\" ) FT_ERRORDEF_( Invalid_Horiz_Metrics, 0x95, \"invalid horizontal metrics\" ) FT_ERRORDEF_( Invalid_CharMap_Format, 0x96, \"invalid character map (cmap) format\" ) FT_ERRORDEF_( Invalid_PPem, 0x97, \"invalid ppem value\" ) FT_ERRORDEF_( Invalid_Vert_Metrics, 0x98, \"invalid vertical metrics\" ) FT_ERRORDEF_( Could_Not_Find_Context, 0x99, \"could not find context\" ) FT_ERRORDEF_( Invalid_Post_Table_Format, 0x9A, \"invalid PostScript (post) table format\" ) FT_ERRORDEF_( Invalid_Post_Table, 0x9B, \"invalid PostScript (post) table\" ) FT_ERRORDEF_( DEF_In_Glyf_Bytecode, 0x9C, \"found FDEF or IDEF opcode in glyf bytecode\" ) FT_ERRORDEF_( Missing_Bitmap, 0x9D, \"missing bitmap in strike\" ) /* CFF, CID, and Type 1 errors */ FT_ERRORDEF_( Syntax_Error, 0xA0, \"opcode syntax error\" ) FT_ERRORDEF_( Stack_Underflow, 0xA1, \"argument stack underflow\" ) FT_ERRORDEF_( Ignore, 0xA2, \"ignore\" ) FT_ERRORDEF_( No_Unicode_Glyph_Name, 0xA3, \"no Unicode glyph name found\" ) FT_ERRORDEF_( Glyph_Too_Big, 0xA4, \"glyph too big for hinting\" ) /* BDF errors */ FT_ERRORDEF_( Missing_Startfont_Field, 0xB0, \"`STARTFONT' field missing\" ) FT_ERRORDEF_( Missing_Font_Field, 0xB1, \"`FONT' field missing\" ) FT_ERRORDEF_( Missing_Size_Field, 0xB2, \"`SIZE' field missing\" ) FT_ERRORDEF_( Missing_Fontboundingbox_Field, 0xB3, \"`FONTBOUNDINGBOX' field missing\" ) FT_ERRORDEF_( Missing_Chars_Field, 0xB4, \"`CHARS' field missing\" ) FT_ERRORDEF_( Missing_Startchar_Field, 0xB5, \"`STARTCHAR' field missing\" ) FT_ERRORDEF_( Missing_Encoding_Field, 0xB6, \"`ENCODING' field missing\" ) FT_ERRORDEF_( Missing_Bbx_Field, 0xB7, \"`BBX' field missing\" ) FT_ERRORDEF_( Bbx_Too_Big, 0xB8, \"`BBX' too big\" ) FT_ERRORDEF_( Corrupted_Font_Header, 0xB9, \"Font header corrupted or missing fields\" ) FT_ERRORDEF_( Corrupted_Font_Glyphs, 0xBA, \"Font glyphs corrupted or missing fields\" )","title":"FT_Err_XXX"},{"location":"ft2-error_enumerations.html","text":"FreeType \u00bb Docs \u00bb Error Codes \u00bb Error Enumerations Error Enumerations \u00b6 Synopsis \u00b6 The header file fterrors.h (which is automatically included by freetype.h defines the handling of FreeType's enumeration constants. It can also be used to generate error message strings with a small macro trick explained below. Error Formats The configuration macro FT_CONFIG_OPTION_USE_MODULE_ERRORS can be defined in ftoption.h in order to make the higher byte indicate the module where the error has happened (this is not compatible with standard builds of FreeType 2, however). See the file ftmoderr.h for more details. Error Message Strings Error definitions are set up with special macros that allow client applications to build a table of error message strings. The strings are not included in a normal build of FreeType 2 to save space (most client applications do not use them). To do so, you have to define the following macros before including this file. FT_ERROR_START_LIST This macro is called before anything else to define the start of the error list. It is followed by several FT_ERROR_DEF calls. FT_ERROR_DEF( e, v, s ) This macro is called to define one single error. \u2018e\u2019 is the error code identifier (e.g., Invalid_Argument ), \u2018v\u2019 is the error's numerical value, and \u2018s\u2019 is the corresponding error string. FT_ERROR_END_LIST This macro ends the list. Additionally, you have to undefine FTERRORS_H_ before #including this file. Here is a simple example. #undef FTERRORS_H_ #define FT_ERRORDEF( e, v, s ) { e, s }, #define FT_ERROR_START_LIST { #define FT_ERROR_END_LIST { 0, NULL } }; const struct { int err_code; const char* err_msg; } ft_errors[] = #include <freetype/fterrors.h> An alternative to using an array is a switch statement. #undef FTERRORS_H_ #define FT_ERROR_START_LIST switch ( error_code ) { #define FT_ERRORDEF( e, v, s ) case v: return s; #define FT_ERROR_END_LIST } If you use FT_CONFIG_OPTION_USE_MODULE_ERRORS , error_code should be replaced with FT_ERROR_BASE(error_code) in the last example. FT_Error_String \u00b6 Defined in FT_ERRORS_H (freetype/fterrors.h). FT_EXPORT( const char * ) FT_Error_String ( FT_Error error_code ); FT_END_HEADER # endif /* FT_ERR_PROTOS_DEFINED */ # endif /* FT_INCLUDE_ERR_PROTOS */ # endif /* !(FTERRORS_H_ && __FTERRORS_H__) */ /* END */ Retrieve the description of a valid FreeType error code. input error_code A valid FreeType error code. return A C string or NULL , if any error occurred. note FreeType has to be compiled with FT_CONFIG_OPTION_ERROR_STRINGS or FT_DEBUG_LEVEL_ERROR to get meaningful descriptions. \u2018error_string\u2019 will be NULL otherwise. Module identification will be ignored: strcmp ( FT_Error_String ( FT_Err_Unknown_File_Format ), FT_Error_String ( BDF_Err_Unknown_File_Format ) ) == 0 ;","title":"Error Enumerations"},{"location":"ft2-error_enumerations.html#error-enumerations","text":"","title":"Error Enumerations"},{"location":"ft2-error_enumerations.html#synopsis","text":"The header file fterrors.h (which is automatically included by freetype.h defines the handling of FreeType's enumeration constants. It can also be used to generate error message strings with a small macro trick explained below. Error Formats The configuration macro FT_CONFIG_OPTION_USE_MODULE_ERRORS can be defined in ftoption.h in order to make the higher byte indicate the module where the error has happened (this is not compatible with standard builds of FreeType 2, however). See the file ftmoderr.h for more details. Error Message Strings Error definitions are set up with special macros that allow client applications to build a table of error message strings. The strings are not included in a normal build of FreeType 2 to save space (most client applications do not use them). To do so, you have to define the following macros before including this file. FT_ERROR_START_LIST This macro is called before anything else to define the start of the error list. It is followed by several FT_ERROR_DEF calls. FT_ERROR_DEF( e, v, s ) This macro is called to define one single error. \u2018e\u2019 is the error code identifier (e.g., Invalid_Argument ), \u2018v\u2019 is the error's numerical value, and \u2018s\u2019 is the corresponding error string. FT_ERROR_END_LIST This macro ends the list. Additionally, you have to undefine FTERRORS_H_ before #including this file. Here is a simple example. #undef FTERRORS_H_ #define FT_ERRORDEF( e, v, s ) { e, s }, #define FT_ERROR_START_LIST { #define FT_ERROR_END_LIST { 0, NULL } }; const struct { int err_code; const char* err_msg; } ft_errors[] = #include <freetype/fterrors.h> An alternative to using an array is a switch statement. #undef FTERRORS_H_ #define FT_ERROR_START_LIST switch ( error_code ) { #define FT_ERRORDEF( e, v, s ) case v: return s; #define FT_ERROR_END_LIST } If you use FT_CONFIG_OPTION_USE_MODULE_ERRORS , error_code should be replaced with FT_ERROR_BASE(error_code) in the last example.","title":"Synopsis"},{"location":"ft2-error_enumerations.html#ft_error_string","text":"Defined in FT_ERRORS_H (freetype/fterrors.h). FT_EXPORT( const char * ) FT_Error_String ( FT_Error error_code ); FT_END_HEADER # endif /* FT_ERR_PROTOS_DEFINED */ # endif /* FT_INCLUDE_ERR_PROTOS */ # endif /* !(FTERRORS_H_ && __FTERRORS_H__) */ /* END */ Retrieve the description of a valid FreeType error code.","title":"FT_Error_String"},{"location":"ft2-font_formats.html","text":"FreeType \u00bb Docs \u00bb Format-Specific API \u00bb Font Formats Font Formats \u00b6 Synopsis \u00b6 The single function in this section can be used to get the font format. Note that this information is not needed normally; however, there are special cases (like in PDF devices) where it is important to differentiate, in spite of FreeType's uniform API. FT_Get_Font_Format \u00b6 Defined in FT_FONT_FORMATS_H (freetype/ftfntfmt.h). FT_EXPORT( const char * ) FT_Get_Font_Format ( FT_Face face ); /* deprecated */ FT_EXPORT( const char * ) FT_Get_X11_Font_Format( FT_Face face ); Return a string describing the format of a given face. Possible values are \u2018TrueType\u2019, \u2018Type 1\u2019, \u2018BDF\u2019, \u2018PCF\u2019, \u2018Type 42\u2019, \u2018CID Type 1\u2019, \u2018CFF\u2019, \u2018PFR\u2019, and \u2018Windows FNT\u2019. The return value is suitable to be used as an X11 FONT_PROPERTY. input face Input face handle. return Font format string. NULL in case of error. note A deprecated name for the same function is FT_Get_X11_Font_Format .","title":"Font Formats"},{"location":"ft2-font_formats.html#font-formats","text":"","title":"Font Formats"},{"location":"ft2-font_formats.html#synopsis","text":"The single function in this section can be used to get the font format. Note that this information is not needed normally; however, there are special cases (like in PDF devices) where it is important to differentiate, in spite of FreeType's uniform API.","title":"Synopsis"},{"location":"ft2-font_formats.html#ft_get_font_format","text":"Defined in FT_FONT_FORMATS_H (freetype/ftfntfmt.h). FT_EXPORT( const char * ) FT_Get_Font_Format ( FT_Face face ); /* deprecated */ FT_EXPORT( const char * ) FT_Get_X11_Font_Format( FT_Face face ); Return a string describing the format of a given face. Possible values are \u2018TrueType\u2019, \u2018Type 1\u2019, \u2018BDF\u2019, \u2018PCF\u2019, \u2018Type 42\u2019, \u2018CID Type 1\u2019, \u2018CFF\u2019, \u2018PFR\u2019, and \u2018Windows FNT\u2019. The return value is suitable to be used as an X11 FONT_PROPERTY.","title":"FT_Get_Font_Format"},{"location":"ft2-gasp_table.html","text":"FreeType \u00bb Docs \u00bb Format-Specific API \u00bb Gasp Table Gasp Table \u00b6 Synopsis \u00b6 The function FT_Get_Gasp can be used to query a TrueType or OpenType font for specific entries in its \u2018gasp\u2019 table, if any. This is mainly useful when implementing native TrueType hinting with the bytecode interpreter to duplicate the Windows text rendering results. FT_GASP_XXX \u00b6 Defined in FT_GASP_H (freetype/ftgasp.h). # define FT_GASP_NO_TABLE -1 # define FT_GASP_DO_GRIDFIT 0x01 # define FT_GASP_DO_GRAY 0x02 # define FT_GASP_SYMMETRIC_GRIDFIT 0x04 # define FT_GASP_SYMMETRIC_SMOOTHING 0x08 A list of values and/or bit-flags returned by the FT_Get_Gasp function. values FT_GASP_NO_TABLE This special value means that there is no GASP table in this face. It is up to the client to decide what to do. FT_GASP_DO_GRIDFIT Grid-fitting and hinting should be performed at the specified ppem. This really means TrueType bytecode interpretation. If this bit is not set, no hinting gets applied. FT_GASP_DO_GRAY Anti-aliased rendering should be performed at the specified ppem. If not set, do monochrome rendering. FT_GASP_SYMMETRIC_SMOOTHING If set, smoothing along multiple axes must be used with ClearType. FT_GASP_SYMMETRIC_GRIDFIT Grid-fitting must be used with ClearType's symmetric smoothing. note The bit-flags FT_GASP_DO_GRIDFIT and FT_GASP_DO_GRAY are to be used for standard font rasterization only. Independently of that, FT_GASP_SYMMETRIC_SMOOTHING and FT_GASP_SYMMETRIC_GRIDFIT are to be used if ClearType is enabled (and FT_GASP_DO_GRIDFIT and FT_GASP_DO_GRAY are consequently ignored). \u2018ClearType\u2019 is Microsoft's implementation of LCD rendering, partly protected by patents. since 2.3.0 FT_Get_Gasp \u00b6 Defined in FT_GASP_H (freetype/ftgasp.h). FT_EXPORT( FT_Int ) FT_Get_Gasp ( FT_Face face, FT_UInt ppem ); For a TrueType or OpenType font file, return the rasterizer behaviour flags from the font's \u2018gasp\u2019 table corresponding to a given character pixel size. input face The source face handle. ppem The vertical character pixel size. return Bit flags (see FT_GASP_XXX ), or FT_GASP_NO_TABLE if there is no \u2018gasp\u2019 table in the face. note If you want to use the MM functionality of OpenType variation fonts (i.e., using FT_Set_Var_Design_Coordinates and friends), call this function after setting an instance since the return values can change. since 2.3.0","title":"Gasp Table"},{"location":"ft2-gasp_table.html#gasp-table","text":"","title":"Gasp Table"},{"location":"ft2-gasp_table.html#synopsis","text":"The function FT_Get_Gasp can be used to query a TrueType or OpenType font for specific entries in its \u2018gasp\u2019 table, if any. This is mainly useful when implementing native TrueType hinting with the bytecode interpreter to duplicate the Windows text rendering results.","title":"Synopsis"},{"location":"ft2-gasp_table.html#ft_gasp_xxx","text":"Defined in FT_GASP_H (freetype/ftgasp.h). # define FT_GASP_NO_TABLE -1 # define FT_GASP_DO_GRIDFIT 0x01 # define FT_GASP_DO_GRAY 0x02 # define FT_GASP_SYMMETRIC_GRIDFIT 0x04 # define FT_GASP_SYMMETRIC_SMOOTHING 0x08 A list of values and/or bit-flags returned by the FT_Get_Gasp function.","title":"FT_GASP_XXX"},{"location":"ft2-gasp_table.html#ft_get_gasp","text":"Defined in FT_GASP_H (freetype/ftgasp.h). FT_EXPORT( FT_Int ) FT_Get_Gasp ( FT_Face face, FT_UInt ppem ); For a TrueType or OpenType font file, return the rasterizer behaviour flags from the font's \u2018gasp\u2019 table corresponding to a given character pixel size.","title":"FT_Get_Gasp"},{"location":"ft2-glyph_management.html","text":"FreeType \u00bb Docs \u00bb Core API \u00bb Glyph Management Glyph Management \u00b6 Synopsis \u00b6 This section contains definitions used to manage glyph data through generic FT_Glyph objects. Each of them can contain a bitmap, a vector outline, or even images in other formats. These objects are detached from FT_Face , contrary to FT_GlyphSlot . FT_Glyph \u00b6 Defined in FT_GLYPH_H (freetype/ftglyph.h). typedef struct FT_GlyphRec_* FT_Glyph ; Handle to an object used to model generic glyph images. It is a pointer to the FT_GlyphRec structure and can contain a glyph bitmap or pointer. note Glyph objects are not owned by the library. You must thus release them manually (through FT_Done_Glyph ) before calling FT_Done_FreeType . FT_GlyphRec \u00b6 Defined in FT_GLYPH_H (freetype/ftglyph.h). typedef struct FT_GlyphRec_ { FT_Library library; const FT_Glyph_Class* clazz; FT_Glyph_Format format; FT_Vector advance; } FT_GlyphRec ; The root glyph structure contains a given glyph image plus its advance width in 16.16 fixed-point format. fields library A handle to the FreeType library object. clazz A pointer to the glyph's class. Private. format The format of the glyph's image. advance A 16.16 vector that gives the glyph's advance width. FT_BitmapGlyph \u00b6 Defined in FT_GLYPH_H (freetype/ftglyph.h). typedef struct FT_BitmapGlyphRec_* FT_BitmapGlyph ; A handle to an object used to model a bitmap glyph image. This is a sub-class of FT_Glyph , and a pointer to FT_BitmapGlyphRec . FT_BitmapGlyphRec \u00b6 Defined in FT_GLYPH_H (freetype/ftglyph.h). typedef struct FT_BitmapGlyphRec_ { FT_GlyphRec root; FT_Int left; FT_Int top; FT_Bitmap bitmap; } FT_BitmapGlyphRec ; A structure used for bitmap glyph images. This really is a \u2018sub-class\u2019 of FT_GlyphRec . fields root The root FT_Glyph fields. left The left-side bearing, i.e., the horizontal distance from the current pen position to the left border of the glyph bitmap. top The top-side bearing, i.e., the vertical distance from the current pen position to the top border of the glyph bitmap. This distance is positive for upwards y! bitmap A descriptor for the bitmap. note You can typecast an FT_Glyph to FT_BitmapGlyph if you have glyph->format == FT_GLYPH_FORMAT_BITMAP . This lets you access the bitmap's contents easily. The corresponding pixel buffer is always owned by FT_BitmapGlyph and is thus created and destroyed with it. FT_OutlineGlyph \u00b6 Defined in FT_GLYPH_H (freetype/ftglyph.h). typedef struct FT_OutlineGlyphRec_* FT_OutlineGlyph ; A handle to an object used to model an outline glyph image. This is a sub-class of FT_Glyph , and a pointer to FT_OutlineGlyphRec . FT_OutlineGlyphRec \u00b6 Defined in FT_GLYPH_H (freetype/ftglyph.h). typedef struct FT_OutlineGlyphRec_ { FT_GlyphRec root; FT_Outline outline; } FT_OutlineGlyphRec ; A structure used for outline (vectorial) glyph images. This really is a \u2018sub-class\u2019 of FT_GlyphRec . fields root The root FT_Glyph fields. outline A descriptor for the outline. note You can typecast an FT_Glyph to FT_OutlineGlyph if you have glyph->format == FT_GLYPH_FORMAT_OUTLINE . This lets you access the outline's content easily. As the outline is extracted from a glyph slot, its coordinates are expressed normally in 26.6 pixels, unless the flag FT_LOAD_NO_SCALE was used in FT_Load_Glyph or FT_Load_Char . The outline's tables are always owned by the object and are destroyed with it. FT_New_Glyph \u00b6 Defined in FT_GLYPH_H (freetype/ftglyph.h). FT_EXPORT( FT_Error ) FT_New_Glyph ( FT_Library library, FT_Glyph_Format format, FT_Glyph *aglyph ); A function used to create a new empty glyph image. Note that the created FT_Glyph object must be released with FT_Done_Glyph . input library A handle to the FreeType library object. format The format of the glyph's image. output aglyph A handle to the glyph object. return FreeType error code. 0 means success. since 2.10 FT_Get_Glyph \u00b6 Defined in FT_GLYPH_H (freetype/ftglyph.h). FT_EXPORT( FT_Error ) FT_Get_Glyph ( FT_GlyphSlot slot, FT_Glyph *aglyph ); A function used to extract a glyph image from a slot. Note that the created FT_Glyph object must be released with FT_Done_Glyph . input slot A handle to the source glyph slot. output aglyph A handle to the glyph object. return FreeType error code. 0 means success. note Because *aglyph->advance.x and *aglyph->advance.y are 16.16 fixed-point numbers, slot->advance.x and slot->advance.y (which are in 26.6 fixed-point format) must be in the range ]-32768;32768[. FT_Glyph_Copy \u00b6 Defined in FT_GLYPH_H (freetype/ftglyph.h). FT_EXPORT( FT_Error ) FT_Glyph_Copy ( FT_Glyph source, FT_Glyph *target ); A function used to copy a glyph image. Note that the created FT_Glyph object must be released with FT_Done_Glyph . input source A handle to the source glyph object. output target A handle to the target glyph object. 0 in case of error. return FreeType error code. 0 means success. FT_Glyph_Transform \u00b6 Defined in FT_GLYPH_H (freetype/ftglyph.h). FT_EXPORT( FT_Error ) FT_Glyph_Transform ( FT_Glyph glyph, FT_Matrix * matrix, FT_Vector * delta ); Transform a glyph image if its format is scalable. inout glyph A handle to the target glyph object. input matrix A pointer to a 2x2 matrix to apply. delta A pointer to a 2d vector to apply. Coordinates are expressed in 1/64th of a pixel. return FreeType error code (if not 0, the glyph format is not scalable). note The 2x2 transformation matrix is also applied to the glyph's advance vector. FT_Glyph_BBox_Mode \u00b6 Defined in FT_GLYPH_H (freetype/ftglyph.h). typedef enum FT_Glyph_BBox_Mode_ { FT_GLYPH_BBOX_UNSCALED = 0, FT_GLYPH_BBOX_SUBPIXELS = 0, FT_GLYPH_BBOX_GRIDFIT = 1, FT_GLYPH_BBOX_TRUNCATE = 2, FT_GLYPH_BBOX_PIXELS = 3 } FT_Glyph_BBox_Mode ; /* these constants are deprecated; use the corresponding */ /* ` FT_Glyph_BBox_Mode ` values instead */ # define ft_glyph_bbox_unscaled FT_GLYPH_BBOX_UNSCALED # define ft_glyph_bbox_subpixels FT_GLYPH_BBOX_SUBPIXELS # define ft_glyph_bbox_gridfit FT_GLYPH_BBOX_GRIDFIT # define ft_glyph_bbox_truncate FT_GLYPH_BBOX_TRUNCATE # define ft_glyph_bbox_pixels FT_GLYPH_BBOX_PIXELS The mode how the values of FT_Glyph_Get_CBox are returned. values FT_GLYPH_BBOX_UNSCALED Return unscaled font units. FT_GLYPH_BBOX_SUBPIXELS Return unfitted 26.6 coordinates. FT_GLYPH_BBOX_GRIDFIT Return grid-fitted 26.6 coordinates. FT_GLYPH_BBOX_TRUNCATE Return coordinates in integer pixels. FT_GLYPH_BBOX_PIXELS Return grid-fitted pixel coordinates. FT_Glyph_Get_CBox \u00b6 Defined in FT_GLYPH_H (freetype/ftglyph.h). FT_EXPORT( void ) FT_Glyph_Get_CBox ( FT_Glyph glyph, FT_UInt bbox_mode, FT_BBox *acbox ); Return a glyph's \u2018control box\u2019. The control box encloses all the outline's points, including Bezier control points. Though it coincides with the exact bounding box for most glyphs, it can be slightly larger in some situations (like when rotating an outline that contains Bezier outside arcs). Computing the control box is very fast, while getting the bounding box can take much more time as it needs to walk over all segments and arcs in the outline. To get the latter, you can use the \u2018ftbbox\u2019 component, which is dedicated to this single task. input glyph A handle to the source glyph object. mode The mode that indicates how to interpret the returned bounding box values. output acbox The glyph coordinate bounding box. Coordinates are expressed in 1/64th of pixels if it is grid-fitted. note Coordinates are relative to the glyph origin, using the y upwards convention. If the glyph has been loaded with FT_LOAD_NO_SCALE , bbox_mode must be set to FT_GLYPH_BBOX_UNSCALED to get unscaled font units in 26.6 pixel format. The value FT_GLYPH_BBOX_SUBPIXELS is another name for this constant. If the font is tricky and the glyph has been loaded with FT_LOAD_NO_SCALE , the resulting CBox is meaningless. To get reasonable values for the CBox it is necessary to load the glyph at a large ppem value (so that the hinting instructions can properly shift and scale the subglyphs), then extracting the CBox, which can be eventually converted back to font units. Note that the maximum coordinates are exclusive, which means that one can compute the width and height of the glyph image (be it in integer or 26.6 pixels) as: width = bbox.xMax - bbox.xMin; height = bbox.yMax - bbox.yMin; Note also that for 26.6 coordinates, if bbox_mode is set to FT_GLYPH_BBOX_GRIDFIT , the coordinates will also be grid-fitted, which corresponds to: bbox.xMin = FLOOR(bbox.xMin); bbox.yMin = FLOOR(bbox.yMin); bbox.xMax = CEILING(bbox.xMax); bbox.yMax = CEILING(bbox.yMax); To get the bbox in pixel coordinates, set bbox_mode to FT_GLYPH_BBOX_TRUNCATE . To get the bbox in grid-fitted pixel coordinates, set bbox_mode to FT_GLYPH_BBOX_PIXELS . FT_Glyph_To_Bitmap \u00b6 Defined in FT_GLYPH_H (freetype/ftglyph.h). FT_EXPORT( FT_Error ) FT_Glyph_To_Bitmap ( FT_Glyph * the_glyph, FT_Render_Mode render_mode, FT_Vector * origin, FT_Bool destroy ); Convert a given glyph object to a bitmap glyph object. inout the_glyph A pointer to a handle to the target glyph. input render_mode An enumeration that describes how the data is rendered. origin A pointer to a vector used to translate the glyph image before rendering. Can be 0 (if no translation). The origin is expressed in 26.6 pixels. destroy A boolean that indicates that the original glyph image should be destroyed by this function. It is never destroyed in case of error. return FreeType error code. 0 means success. note This function does nothing if the glyph format isn't scalable. The glyph image is translated with the origin vector before rendering. The first parameter is a pointer to an FT_Glyph handle, that will be replaced by this function (with newly allocated data). Typically, you would use (omitting error handling): FT_Glyph glyph; FT_BitmapGlyph glyph_bitmap; // load glyph error = FT_Load_Char( face, glyph_index, FT_LOAD_DEFAULT ); // extract glyph image error = FT_Get_Glyph( face->glyph, &glyph ); // convert to a bitmap (default render mode + destroying old) if ( glyph->format != FT_GLYPH_FORMAT_BITMAP ) { error = FT_Glyph_To_Bitmap( &glyph, FT_RENDER_MODE_NORMAL, 0, 1 ); if ( error ) // `glyph' unchanged ... } // access bitmap content by typecasting glyph_bitmap = (FT_BitmapGlyph)glyph; // do funny stuff with it, like blitting/drawing ... // discard glyph image (bitmap or not) FT_Done_Glyph( glyph ); Here is another example, again without error handling: FT_Glyph glyphs[MAX_GLYPHS] ... for ( idx = 0; i < MAX_GLYPHS; i++ ) error = FT_Load_Glyph( face, idx, FT_LOAD_DEFAULT ) || FT_Get_Glyph ( face->glyph, &glyphs[idx] ); ... for ( idx = 0; i < MAX_GLYPHS; i++ ) { FT_Glyph bitmap = glyphs[idx]; ... // after this call, `bitmap' no longer points into // the `glyphs' array (and the old value isn't destroyed) FT_Glyph_To_Bitmap( &bitmap, FT_RENDER_MODE_MONO, 0, 0 ); ... FT_Done_Glyph( bitmap ); } ... for ( idx = 0; i < MAX_GLYPHS; i++ ) FT_Done_Glyph( glyphs[idx] ); FT_Done_Glyph \u00b6 Defined in FT_GLYPH_H (freetype/ftglyph.h). FT_EXPORT( void ) FT_Done_Glyph ( FT_Glyph glyph ); Destroy a given glyph. input glyph A handle to the target glyph object.","title":"Glyph Management"},{"location":"ft2-glyph_management.html#glyph-management","text":"","title":"Glyph Management"},{"location":"ft2-glyph_management.html#synopsis","text":"This section contains definitions used to manage glyph data through generic FT_Glyph objects. Each of them can contain a bitmap, a vector outline, or even images in other formats. These objects are detached from FT_Face , contrary to FT_GlyphSlot .","title":"Synopsis"},{"location":"ft2-glyph_management.html#ft_glyph","text":"Defined in FT_GLYPH_H (freetype/ftglyph.h). typedef struct FT_GlyphRec_* FT_Glyph ; Handle to an object used to model generic glyph images. It is a pointer to the FT_GlyphRec structure and can contain a glyph bitmap or pointer.","title":"FT_Glyph"},{"location":"ft2-glyph_management.html#ft_glyphrec","text":"Defined in FT_GLYPH_H (freetype/ftglyph.h). typedef struct FT_GlyphRec_ { FT_Library library; const FT_Glyph_Class* clazz; FT_Glyph_Format format; FT_Vector advance; } FT_GlyphRec ; The root glyph structure contains a given glyph image plus its advance width in 16.16 fixed-point format.","title":"FT_GlyphRec"},{"location":"ft2-glyph_management.html#ft_bitmapglyph","text":"Defined in FT_GLYPH_H (freetype/ftglyph.h). typedef struct FT_BitmapGlyphRec_* FT_BitmapGlyph ; A handle to an object used to model a bitmap glyph image. This is a sub-class of FT_Glyph , and a pointer to FT_BitmapGlyphRec .","title":"FT_BitmapGlyph"},{"location":"ft2-glyph_management.html#ft_bitmapglyphrec","text":"Defined in FT_GLYPH_H (freetype/ftglyph.h). typedef struct FT_BitmapGlyphRec_ { FT_GlyphRec root; FT_Int left; FT_Int top; FT_Bitmap bitmap; } FT_BitmapGlyphRec ; A structure used for bitmap glyph images. This really is a \u2018sub-class\u2019 of FT_GlyphRec .","title":"FT_BitmapGlyphRec"},{"location":"ft2-glyph_management.html#ft_outlineglyph","text":"Defined in FT_GLYPH_H (freetype/ftglyph.h). typedef struct FT_OutlineGlyphRec_* FT_OutlineGlyph ; A handle to an object used to model an outline glyph image. This is a sub-class of FT_Glyph , and a pointer to FT_OutlineGlyphRec .","title":"FT_OutlineGlyph"},{"location":"ft2-glyph_management.html#ft_outlineglyphrec","text":"Defined in FT_GLYPH_H (freetype/ftglyph.h). typedef struct FT_OutlineGlyphRec_ { FT_GlyphRec root; FT_Outline outline; } FT_OutlineGlyphRec ; A structure used for outline (vectorial) glyph images. This really is a \u2018sub-class\u2019 of FT_GlyphRec .","title":"FT_OutlineGlyphRec"},{"location":"ft2-glyph_management.html#ft_new_glyph","text":"Defined in FT_GLYPH_H (freetype/ftglyph.h). FT_EXPORT( FT_Error ) FT_New_Glyph ( FT_Library library, FT_Glyph_Format format, FT_Glyph *aglyph ); A function used to create a new empty glyph image. Note that the created FT_Glyph object must be released with FT_Done_Glyph .","title":"FT_New_Glyph"},{"location":"ft2-glyph_management.html#ft_get_glyph","text":"Defined in FT_GLYPH_H (freetype/ftglyph.h). FT_EXPORT( FT_Error ) FT_Get_Glyph ( FT_GlyphSlot slot, FT_Glyph *aglyph ); A function used to extract a glyph image from a slot. Note that the created FT_Glyph object must be released with FT_Done_Glyph .","title":"FT_Get_Glyph"},{"location":"ft2-glyph_management.html#ft_glyph_copy","text":"Defined in FT_GLYPH_H (freetype/ftglyph.h). FT_EXPORT( FT_Error ) FT_Glyph_Copy ( FT_Glyph source, FT_Glyph *target ); A function used to copy a glyph image. Note that the created FT_Glyph object must be released with FT_Done_Glyph .","title":"FT_Glyph_Copy"},{"location":"ft2-glyph_management.html#ft_glyph_transform","text":"Defined in FT_GLYPH_H (freetype/ftglyph.h). FT_EXPORT( FT_Error ) FT_Glyph_Transform ( FT_Glyph glyph, FT_Matrix * matrix, FT_Vector * delta ); Transform a glyph image if its format is scalable.","title":"FT_Glyph_Transform"},{"location":"ft2-glyph_management.html#ft_glyph_bbox_mode","text":"Defined in FT_GLYPH_H (freetype/ftglyph.h). typedef enum FT_Glyph_BBox_Mode_ { FT_GLYPH_BBOX_UNSCALED = 0, FT_GLYPH_BBOX_SUBPIXELS = 0, FT_GLYPH_BBOX_GRIDFIT = 1, FT_GLYPH_BBOX_TRUNCATE = 2, FT_GLYPH_BBOX_PIXELS = 3 } FT_Glyph_BBox_Mode ; /* these constants are deprecated; use the corresponding */ /* ` FT_Glyph_BBox_Mode ` values instead */ # define ft_glyph_bbox_unscaled FT_GLYPH_BBOX_UNSCALED # define ft_glyph_bbox_subpixels FT_GLYPH_BBOX_SUBPIXELS # define ft_glyph_bbox_gridfit FT_GLYPH_BBOX_GRIDFIT # define ft_glyph_bbox_truncate FT_GLYPH_BBOX_TRUNCATE # define ft_glyph_bbox_pixels FT_GLYPH_BBOX_PIXELS The mode how the values of FT_Glyph_Get_CBox are returned.","title":"FT_Glyph_BBox_Mode"},{"location":"ft2-glyph_management.html#ft_glyph_get_cbox","text":"Defined in FT_GLYPH_H (freetype/ftglyph.h). FT_EXPORT( void ) FT_Glyph_Get_CBox ( FT_Glyph glyph, FT_UInt bbox_mode, FT_BBox *acbox ); Return a glyph's \u2018control box\u2019. The control box encloses all the outline's points, including Bezier control points. Though it coincides with the exact bounding box for most glyphs, it can be slightly larger in some situations (like when rotating an outline that contains Bezier outside arcs). Computing the control box is very fast, while getting the bounding box can take much more time as it needs to walk over all segments and arcs in the outline. To get the latter, you can use the \u2018ftbbox\u2019 component, which is dedicated to this single task.","title":"FT_Glyph_Get_CBox"},{"location":"ft2-glyph_management.html#ft_glyph_to_bitmap","text":"Defined in FT_GLYPH_H (freetype/ftglyph.h). FT_EXPORT( FT_Error ) FT_Glyph_To_Bitmap ( FT_Glyph * the_glyph, FT_Render_Mode render_mode, FT_Vector * origin, FT_Bool destroy ); Convert a given glyph object to a bitmap glyph object.","title":"FT_Glyph_To_Bitmap"},{"location":"ft2-glyph_management.html#ft_done_glyph","text":"Defined in FT_GLYPH_H (freetype/ftglyph.h). FT_EXPORT( void ) FT_Done_Glyph ( FT_Glyph glyph ); Destroy a given glyph.","title":"FT_Done_Glyph"},{"location":"ft2-glyph_stroker.html","text":"FreeType \u00bb Docs \u00bb Support API \u00bb Glyph Stroker Glyph Stroker \u00b6 Synopsis \u00b6 This component generates stroked outlines of a given vectorial glyph. It also allows you to retrieve the \u2018outside\u2019 and/or the \u2018inside\u2019 borders of the stroke. This can be useful to generate \u2018bordered\u2019 glyph, i.e., glyphs displayed with a colored (and anti-aliased) border around their shape. FT_Stroker \u00b6 Defined in FT_STROKER_H (freetype/ftstroke.h). typedef struct FT_StrokerRec_* FT_Stroker ; Opaque handle to a path stroker object. FT_Stroker_LineJoin \u00b6 Defined in FT_STROKER_H (freetype/ftstroke.h). typedef enum FT_Stroker_LineJoin_ { FT_STROKER_LINEJOIN_ROUND = 0, FT_STROKER_LINEJOIN_BEVEL = 1, FT_STROKER_LINEJOIN_MITER_VARIABLE = 2, FT_STROKER_LINEJOIN_MITER = FT_STROKER_LINEJOIN_MITER_VARIABLE , FT_STROKER_LINEJOIN_MITER_FIXED = 3 } FT_Stroker_LineJoin ; These values determine how two joining lines are rendered in a stroker. values FT_STROKER_LINEJOIN_ROUND Used to render rounded line joins. Circular arcs are used to join two lines smoothly. FT_STROKER_LINEJOIN_BEVEL Used to render beveled line joins. The outer corner of the joined lines is filled by enclosing the triangular region of the corner with a straight line between the outer corners of each stroke. FT_STROKER_LINEJOIN_MITER_FIXED Used to render mitered line joins, with fixed bevels if the miter limit is exceeded. The outer edges of the strokes for the two segments are extended until they meet at an angle. A bevel join (see above) is used if the segments meet at too sharp an angle and the outer edges meet beyond a distance corresponding to the meter limit. This prevents long spikes being created. FT_STROKER_LINEJOIN_MITER_FIXED generates a miter line join as used in PostScript and PDF. FT_STROKER_LINEJOIN_MITER_VARIABLE FT_STROKER_LINEJOIN_MITER Used to render mitered line joins, with variable bevels if the miter limit is exceeded. The intersection of the strokes is clipped perpendicularly to the bisector, at a distance corresponding to the miter limit. This prevents long spikes being created. FT_STROKER_LINEJOIN_MITER_VARIABLE generates a mitered line join as used in XPS. FT_STROKER_LINEJOIN_MITER is an alias for FT_STROKER_LINEJOIN_MITER_VARIABLE , retained for backward compatibility. FT_Stroker_LineCap \u00b6 Defined in FT_STROKER_H (freetype/ftstroke.h). typedef enum FT_Stroker_LineCap_ { FT_STROKER_LINECAP_BUTT = 0, FT_STROKER_LINECAP_ROUND , FT_STROKER_LINECAP_SQUARE } FT_Stroker_LineCap ; These values determine how the end of opened sub-paths are rendered in a stroke. values FT_STROKER_LINECAP_BUTT The end of lines is rendered as a full stop on the last point itself. FT_STROKER_LINECAP_ROUND The end of lines is rendered as a half-circle around the last point. FT_STROKER_LINECAP_SQUARE The end of lines is rendered as a square around the last point. FT_StrokerBorder \u00b6 Defined in FT_STROKER_H (freetype/ftstroke.h). typedef enum FT_StrokerBorder_ { FT_STROKER_BORDER_LEFT = 0, FT_STROKER_BORDER_RIGHT } FT_StrokerBorder ; These values are used to select a given stroke border in FT_Stroker_GetBorderCounts and FT_Stroker_ExportBorder . values FT_STROKER_BORDER_LEFT Select the left border, relative to the drawing direction. FT_STROKER_BORDER_RIGHT Select the right border, relative to the drawing direction. note Applications are generally interested in the \u2018inside\u2019 and \u2018outside\u2019 borders. However, there is no direct mapping between these and the \u2018left\u2019 and \u2018right\u2019 ones, since this really depends on the glyph's drawing orientation, which varies between font formats. You can however use FT_Outline_GetInsideBorder and FT_Outline_GetOutsideBorder to get these. FT_Outline_GetInsideBorder \u00b6 Defined in FT_STROKER_H (freetype/ftstroke.h). FT_EXPORT( FT_StrokerBorder ) FT_Outline_GetInsideBorder ( FT_Outline * outline ); Retrieve the FT_StrokerBorder value corresponding to the \u2018inside\u2019 borders of a given outline. input outline The source outline handle. return The border index. FT_STROKER_BORDER_RIGHT for empty or invalid outlines. FT_Outline_GetOutsideBorder \u00b6 Defined in FT_STROKER_H (freetype/ftstroke.h). FT_EXPORT( FT_StrokerBorder ) FT_Outline_GetOutsideBorder ( FT_Outline * outline ); Retrieve the FT_StrokerBorder value corresponding to the \u2018outside\u2019 borders of a given outline. input outline The source outline handle. return The border index. FT_STROKER_BORDER_LEFT for empty or invalid outlines. FT_Glyph_Stroke \u00b6 Defined in FT_STROKER_H (freetype/ftstroke.h). FT_EXPORT( FT_Error ) FT_Glyph_Stroke ( FT_Glyph *pglyph, FT_Stroker stroker, FT_Bool destroy ); Stroke a given outline glyph object with a given stroker. inout pglyph Source glyph handle on input, new glyph handle on output. input stroker A stroker handle. destroy A Boolean. If 1, the source glyph object is destroyed on success. return FreeType error code. 0 means success. note The source glyph is untouched in case of error. Adding stroke may yield a significantly wider and taller glyph depending on how large of a radius was used to stroke the glyph. You may need to manually adjust horizontal and vertical advance amounts to account for this added size. FT_Glyph_StrokeBorder \u00b6 Defined in FT_STROKER_H (freetype/ftstroke.h). FT_EXPORT( FT_Error ) FT_Glyph_StrokeBorder ( FT_Glyph *pglyph, FT_Stroker stroker, FT_Bool inside, FT_Bool destroy ); Stroke a given outline glyph object with a given stroker, but only return either its inside or outside border. inout pglyph Source glyph handle on input, new glyph handle on output. input stroker A stroker handle. inside A Boolean. If 1, return the inside border, otherwise the outside border. destroy A Boolean. If 1, the source glyph object is destroyed on success. return FreeType error code. 0 means success. note The source glyph is untouched in case of error. Adding stroke may yield a significantly wider and taller glyph depending on how large of a radius was used to stroke the glyph. You may need to manually adjust horizontal and vertical advance amounts to account for this added size. FT_Stroker_New \u00b6 Defined in FT_STROKER_H (freetype/ftstroke.h). FT_EXPORT( FT_Error ) FT_Stroker_New ( FT_Library library, FT_Stroker *astroker ); Create a new stroker object. input library FreeType library handle. output astroker A new stroker object handle. NULL in case of error. return FreeType error code. 0 means success. FT_Stroker_Set \u00b6 Defined in FT_STROKER_H (freetype/ftstroke.h). FT_EXPORT( void ) FT_Stroker_Set ( FT_Stroker stroker, FT_Fixed radius, FT_Stroker_LineCap line_cap, FT_Stroker_LineJoin line_join, FT_Fixed miter_limit ); Reset a stroker object's attributes. input stroker The target stroker handle. radius The border radius. line_cap The line cap style. line_join The line join style. miter_limit The maximum reciprocal sine of half-angle at the miter join, expressed as 16.16 fixed point value. note The radius is expressed in the same units as the outline coordinates. The miter_limit multiplied by the radius gives the maximum size of a miter spike, at which it is clipped for FT_STROKER_LINEJOIN_MITER_VARIABLE or replaced with a bevel join for FT_STROKER_LINEJOIN_MITER_FIXED . This function calls FT_Stroker_Rewind automatically. FT_Stroker_Rewind \u00b6 Defined in FT_STROKER_H (freetype/ftstroke.h). FT_EXPORT( void ) FT_Stroker_Rewind ( FT_Stroker stroker ); Reset a stroker object without changing its attributes. You should call this function before beginning a new series of calls to FT_Stroker_BeginSubPath or FT_Stroker_EndSubPath . input stroker The target stroker handle. FT_Stroker_ParseOutline \u00b6 Defined in FT_STROKER_H (freetype/ftstroke.h). FT_EXPORT( FT_Error ) FT_Stroker_ParseOutline ( FT_Stroker stroker, FT_Outline * outline, FT_Bool opened ); A convenience function used to parse a whole outline with the stroker. The resulting outline(s) can be retrieved later by functions like FT_Stroker_GetCounts and FT_Stroker_Export . input stroker The target stroker handle. outline The source outline. opened A boolean. If 1, the outline is treated as an open path instead of a closed one. return FreeType error code. 0 means success. note If opened is 0 (the default), the outline is treated as a closed path, and the stroker generates two distinct \u2018border\u2019 outlines. If opened is 1, the outline is processed as an open path, and the stroker generates a single \u2018stroke\u2019 outline. This function calls FT_Stroker_Rewind automatically. FT_Stroker_Done \u00b6 Defined in FT_STROKER_H (freetype/ftstroke.h). FT_EXPORT( void ) FT_Stroker_Done ( FT_Stroker stroker ); Destroy a stroker object. input stroker A stroker handle. Can be NULL . FT_Stroker_BeginSubPath \u00b6 Defined in FT_STROKER_H (freetype/ftstroke.h). FT_EXPORT( FT_Error ) FT_Stroker_BeginSubPath ( FT_Stroker stroker, FT_Vector * to, FT_Bool open ); Start a new sub-path in the stroker. input stroker The target stroker handle. to A pointer to the start vector. open A boolean. If 1, the sub-path is treated as an open one. return FreeType error code. 0 means success. note This function is useful when you need to stroke a path that is not stored as an FT_Outline object. FT_Stroker_EndSubPath \u00b6 Defined in FT_STROKER_H (freetype/ftstroke.h). FT_EXPORT( FT_Error ) FT_Stroker_EndSubPath ( FT_Stroker stroker ); Close the current sub-path in the stroker. input stroker The target stroker handle. return FreeType error code. 0 means success. note You should call this function after FT_Stroker_BeginSubPath . If the subpath was not \u2018opened\u2019, this function \u2018draws\u2019 a single line segment to the start position when needed. FT_Stroker_LineTo \u00b6 Defined in FT_STROKER_H (freetype/ftstroke.h). FT_EXPORT( FT_Error ) FT_Stroker_LineTo ( FT_Stroker stroker, FT_Vector * to ); \u2018Draw\u2019 a single line segment in the stroker's current sub-path, from the last position. input stroker The target stroker handle. to A pointer to the destination point. return FreeType error code. 0 means success. note You should call this function between FT_Stroker_BeginSubPath and FT_Stroker_EndSubPath . FT_Stroker_ConicTo \u00b6 Defined in FT_STROKER_H (freetype/ftstroke.h). FT_EXPORT( FT_Error ) FT_Stroker_ConicTo ( FT_Stroker stroker, FT_Vector * control, FT_Vector * to ); \u2018Draw\u2019 a single quadratic Bezier in the stroker's current sub-path, from the last position. input stroker The target stroker handle. control A pointer to a Bezier control point. to A pointer to the destination point. return FreeType error code. 0 means success. note You should call this function between FT_Stroker_BeginSubPath and FT_Stroker_EndSubPath . FT_Stroker_CubicTo \u00b6 Defined in FT_STROKER_H (freetype/ftstroke.h). FT_EXPORT( FT_Error ) FT_Stroker_CubicTo ( FT_Stroker stroker, FT_Vector * control1, FT_Vector * control2, FT_Vector * to ); \u2018Draw\u2019 a single cubic Bezier in the stroker's current sub-path, from the last position. input stroker The target stroker handle. control1 A pointer to the first Bezier control point. control2 A pointer to second Bezier control point. to A pointer to the destination point. return FreeType error code. 0 means success. note You should call this function between FT_Stroker_BeginSubPath and FT_Stroker_EndSubPath . FT_Stroker_GetBorderCounts \u00b6 Defined in FT_STROKER_H (freetype/ftstroke.h). FT_EXPORT( FT_Error ) FT_Stroker_GetBorderCounts ( FT_Stroker stroker, FT_StrokerBorder border, FT_UInt *anum_points, FT_UInt *anum_contours ); Call this function once you have finished parsing your paths with the stroker. It returns the number of points and contours necessary to export one of the \u2018border\u2019 or \u2018stroke\u2019 outlines generated by the stroker. input stroker The target stroker handle. border The border index. output anum_points The number of points. anum_contours The number of contours. return FreeType error code. 0 means success. note When an outline, or a sub-path, is \u2018closed\u2019, the stroker generates two independent \u2018border\u2019 outlines, named \u2018left\u2019 and \u2018right\u2019. When the outline, or a sub-path, is \u2018opened\u2019, the stroker merges the \u2018border\u2019 outlines with caps. The \u2018left\u2019 border receives all points, while the \u2018right\u2019 border becomes empty. Use the function FT_Stroker_GetCounts instead if you want to retrieve the counts associated to both borders. FT_Stroker_ExportBorder \u00b6 Defined in FT_STROKER_H (freetype/ftstroke.h). FT_EXPORT( void ) FT_Stroker_ExportBorder ( FT_Stroker stroker, FT_StrokerBorder border, FT_Outline * outline ); Call this function after FT_Stroker_GetBorderCounts to export the corresponding border to your own FT_Outline structure. Note that this function appends the border points and contours to your outline, but does not try to resize its arrays. input stroker The target stroker handle. border The border index. outline The target outline handle. note Always call this function after FT_Stroker_GetBorderCounts to get sure that there is enough room in your FT_Outline object to receive all new data. When an outline, or a sub-path, is \u2018closed\u2019, the stroker generates two independent \u2018border\u2019 outlines, named \u2018left\u2019 and \u2018right\u2019. When the outline, or a sub-path, is \u2018opened\u2019, the stroker merges the \u2018border\u2019 outlines with caps. The \u2018left\u2019 border receives all points, while the \u2018right\u2019 border becomes empty. Use the function FT_Stroker_Export instead if you want to retrieve all borders at once. FT_Stroker_GetCounts \u00b6 Defined in FT_STROKER_H (freetype/ftstroke.h). FT_EXPORT( FT_Error ) FT_Stroker_GetCounts ( FT_Stroker stroker, FT_UInt *anum_points, FT_UInt *anum_contours ); Call this function once you have finished parsing your paths with the stroker. It returns the number of points and contours necessary to export all points/borders from the stroked outline/path. input stroker The target stroker handle. output anum_points The number of points. anum_contours The number of contours. return FreeType error code. 0 means success. FT_Stroker_Export \u00b6 Defined in FT_STROKER_H (freetype/ftstroke.h). FT_EXPORT( void ) FT_Stroker_Export ( FT_Stroker stroker, FT_Outline * outline ); Call this function after FT_Stroker_GetBorderCounts to export all borders to your own FT_Outline structure. Note that this function appends the border points and contours to your outline, but does not try to resize its arrays. input stroker The target stroker handle. outline The target outline handle.","title":"Glyph Stroker"},{"location":"ft2-glyph_stroker.html#glyph-stroker","text":"","title":"Glyph Stroker"},{"location":"ft2-glyph_stroker.html#synopsis","text":"This component generates stroked outlines of a given vectorial glyph. It also allows you to retrieve the \u2018outside\u2019 and/or the \u2018inside\u2019 borders of the stroke. This can be useful to generate \u2018bordered\u2019 glyph, i.e., glyphs displayed with a colored (and anti-aliased) border around their shape.","title":"Synopsis"},{"location":"ft2-glyph_stroker.html#ft_stroker","text":"Defined in FT_STROKER_H (freetype/ftstroke.h). typedef struct FT_StrokerRec_* FT_Stroker ; Opaque handle to a path stroker object.","title":"FT_Stroker"},{"location":"ft2-glyph_stroker.html#ft_stroker_linejoin","text":"Defined in FT_STROKER_H (freetype/ftstroke.h). typedef enum FT_Stroker_LineJoin_ { FT_STROKER_LINEJOIN_ROUND = 0, FT_STROKER_LINEJOIN_BEVEL = 1, FT_STROKER_LINEJOIN_MITER_VARIABLE = 2, FT_STROKER_LINEJOIN_MITER = FT_STROKER_LINEJOIN_MITER_VARIABLE , FT_STROKER_LINEJOIN_MITER_FIXED = 3 } FT_Stroker_LineJoin ; These values determine how two joining lines are rendered in a stroker.","title":"FT_Stroker_LineJoin"},{"location":"ft2-glyph_stroker.html#ft_stroker_linecap","text":"Defined in FT_STROKER_H (freetype/ftstroke.h). typedef enum FT_Stroker_LineCap_ { FT_STROKER_LINECAP_BUTT = 0, FT_STROKER_LINECAP_ROUND , FT_STROKER_LINECAP_SQUARE } FT_Stroker_LineCap ; These values determine how the end of opened sub-paths are rendered in a stroke.","title":"FT_Stroker_LineCap"},{"location":"ft2-glyph_stroker.html#ft_strokerborder","text":"Defined in FT_STROKER_H (freetype/ftstroke.h). typedef enum FT_StrokerBorder_ { FT_STROKER_BORDER_LEFT = 0, FT_STROKER_BORDER_RIGHT } FT_StrokerBorder ; These values are used to select a given stroke border in FT_Stroker_GetBorderCounts and FT_Stroker_ExportBorder .","title":"FT_StrokerBorder"},{"location":"ft2-glyph_stroker.html#ft_outline_getinsideborder","text":"Defined in FT_STROKER_H (freetype/ftstroke.h). FT_EXPORT( FT_StrokerBorder ) FT_Outline_GetInsideBorder ( FT_Outline * outline ); Retrieve the FT_StrokerBorder value corresponding to the \u2018inside\u2019 borders of a given outline.","title":"FT_Outline_GetInsideBorder"},{"location":"ft2-glyph_stroker.html#ft_outline_getoutsideborder","text":"Defined in FT_STROKER_H (freetype/ftstroke.h). FT_EXPORT( FT_StrokerBorder ) FT_Outline_GetOutsideBorder ( FT_Outline * outline ); Retrieve the FT_StrokerBorder value corresponding to the \u2018outside\u2019 borders of a given outline.","title":"FT_Outline_GetOutsideBorder"},{"location":"ft2-glyph_stroker.html#ft_glyph_stroke","text":"Defined in FT_STROKER_H (freetype/ftstroke.h). FT_EXPORT( FT_Error ) FT_Glyph_Stroke ( FT_Glyph *pglyph, FT_Stroker stroker, FT_Bool destroy ); Stroke a given outline glyph object with a given stroker.","title":"FT_Glyph_Stroke"},{"location":"ft2-glyph_stroker.html#ft_glyph_strokeborder","text":"Defined in FT_STROKER_H (freetype/ftstroke.h). FT_EXPORT( FT_Error ) FT_Glyph_StrokeBorder ( FT_Glyph *pglyph, FT_Stroker stroker, FT_Bool inside, FT_Bool destroy ); Stroke a given outline glyph object with a given stroker, but only return either its inside or outside border.","title":"FT_Glyph_StrokeBorder"},{"location":"ft2-glyph_stroker.html#ft_stroker_new","text":"Defined in FT_STROKER_H (freetype/ftstroke.h). FT_EXPORT( FT_Error ) FT_Stroker_New ( FT_Library library, FT_Stroker *astroker ); Create a new stroker object.","title":"FT_Stroker_New"},{"location":"ft2-glyph_stroker.html#ft_stroker_set","text":"Defined in FT_STROKER_H (freetype/ftstroke.h). FT_EXPORT( void ) FT_Stroker_Set ( FT_Stroker stroker, FT_Fixed radius, FT_Stroker_LineCap line_cap, FT_Stroker_LineJoin line_join, FT_Fixed miter_limit ); Reset a stroker object's attributes.","title":"FT_Stroker_Set"},{"location":"ft2-glyph_stroker.html#ft_stroker_rewind","text":"Defined in FT_STROKER_H (freetype/ftstroke.h). FT_EXPORT( void ) FT_Stroker_Rewind ( FT_Stroker stroker ); Reset a stroker object without changing its attributes. You should call this function before beginning a new series of calls to FT_Stroker_BeginSubPath or FT_Stroker_EndSubPath .","title":"FT_Stroker_Rewind"},{"location":"ft2-glyph_stroker.html#ft_stroker_parseoutline","text":"Defined in FT_STROKER_H (freetype/ftstroke.h). FT_EXPORT( FT_Error ) FT_Stroker_ParseOutline ( FT_Stroker stroker, FT_Outline * outline, FT_Bool opened ); A convenience function used to parse a whole outline with the stroker. The resulting outline(s) can be retrieved later by functions like FT_Stroker_GetCounts and FT_Stroker_Export .","title":"FT_Stroker_ParseOutline"},{"location":"ft2-glyph_stroker.html#ft_stroker_done","text":"Defined in FT_STROKER_H (freetype/ftstroke.h). FT_EXPORT( void ) FT_Stroker_Done ( FT_Stroker stroker ); Destroy a stroker object.","title":"FT_Stroker_Done"},{"location":"ft2-glyph_stroker.html#ft_stroker_beginsubpath","text":"Defined in FT_STROKER_H (freetype/ftstroke.h). FT_EXPORT( FT_Error ) FT_Stroker_BeginSubPath ( FT_Stroker stroker, FT_Vector * to, FT_Bool open ); Start a new sub-path in the stroker.","title":"FT_Stroker_BeginSubPath"},{"location":"ft2-glyph_stroker.html#ft_stroker_endsubpath","text":"Defined in FT_STROKER_H (freetype/ftstroke.h). FT_EXPORT( FT_Error ) FT_Stroker_EndSubPath ( FT_Stroker stroker ); Close the current sub-path in the stroker.","title":"FT_Stroker_EndSubPath"},{"location":"ft2-glyph_stroker.html#ft_stroker_lineto","text":"Defined in FT_STROKER_H (freetype/ftstroke.h). FT_EXPORT( FT_Error ) FT_Stroker_LineTo ( FT_Stroker stroker, FT_Vector * to ); \u2018Draw\u2019 a single line segment in the stroker's current sub-path, from the last position.","title":"FT_Stroker_LineTo"},{"location":"ft2-glyph_stroker.html#ft_stroker_conicto","text":"Defined in FT_STROKER_H (freetype/ftstroke.h). FT_EXPORT( FT_Error ) FT_Stroker_ConicTo ( FT_Stroker stroker, FT_Vector * control, FT_Vector * to ); \u2018Draw\u2019 a single quadratic Bezier in the stroker's current sub-path, from the last position.","title":"FT_Stroker_ConicTo"},{"location":"ft2-glyph_stroker.html#ft_stroker_cubicto","text":"Defined in FT_STROKER_H (freetype/ftstroke.h). FT_EXPORT( FT_Error ) FT_Stroker_CubicTo ( FT_Stroker stroker, FT_Vector * control1, FT_Vector * control2, FT_Vector * to ); \u2018Draw\u2019 a single cubic Bezier in the stroker's current sub-path, from the last position.","title":"FT_Stroker_CubicTo"},{"location":"ft2-glyph_stroker.html#ft_stroker_getbordercounts","text":"Defined in FT_STROKER_H (freetype/ftstroke.h). FT_EXPORT( FT_Error ) FT_Stroker_GetBorderCounts ( FT_Stroker stroker, FT_StrokerBorder border, FT_UInt *anum_points, FT_UInt *anum_contours ); Call this function once you have finished parsing your paths with the stroker. It returns the number of points and contours necessary to export one of the \u2018border\u2019 or \u2018stroke\u2019 outlines generated by the stroker.","title":"FT_Stroker_GetBorderCounts"},{"location":"ft2-glyph_stroker.html#ft_stroker_exportborder","text":"Defined in FT_STROKER_H (freetype/ftstroke.h). FT_EXPORT( void ) FT_Stroker_ExportBorder ( FT_Stroker stroker, FT_StrokerBorder border, FT_Outline * outline ); Call this function after FT_Stroker_GetBorderCounts to export the corresponding border to your own FT_Outline structure. Note that this function appends the border points and contours to your outline, but does not try to resize its arrays.","title":"FT_Stroker_ExportBorder"},{"location":"ft2-glyph_stroker.html#ft_stroker_getcounts","text":"Defined in FT_STROKER_H (freetype/ftstroke.h). FT_EXPORT( FT_Error ) FT_Stroker_GetCounts ( FT_Stroker stroker, FT_UInt *anum_points, FT_UInt *anum_contours ); Call this function once you have finished parsing your paths with the stroker. It returns the number of points and contours necessary to export all points/borders from the stroked outline/path.","title":"FT_Stroker_GetCounts"},{"location":"ft2-glyph_stroker.html#ft_stroker_export","text":"Defined in FT_STROKER_H (freetype/ftstroke.h). FT_EXPORT( void ) FT_Stroker_Export ( FT_Stroker stroker, FT_Outline * outline ); Call this function after FT_Stroker_GetBorderCounts to export all borders to your own FT_Outline structure. Note that this function appends the border points and contours to your outline, but does not try to resize its arrays.","title":"FT_Stroker_Export"},{"location":"ft2-glyph_variants.html","text":"FreeType \u00bb Docs \u00bb Core API \u00bb Unicode Variation Sequences Unicode Variation Sequences \u00b6 Synopsis \u00b6 Many characters, especially for CJK scripts, have variant forms. They are a sort of grey area somewhere between being totally irrelevant and semantically distinct; for this reason, the Unicode consortium decided to introduce Variation Sequences (VS), consisting of a Unicode base character and a variation selector instead of further extending the already huge number of characters. Unicode maintains two different sets, namely \u2018Standardized Variation Sequences\u2019 and registered \u2018Ideographic Variation Sequences\u2019 (IVS), collected in the \u2018Ideographic Variation Database\u2019 (IVD). https://unicode.org/Public/UCD/latest/ucd/StandardizedVariants.txt https://unicode.org/reports/tr37/ https://unicode.org/ivd/ To date (January 2017), the character with the most ideographic variations is U+9089, having 32 such IVS. Three Mongolian Variation Selectors have the values U+180B-U+180D; 256 generic Variation Selectors are encoded in the ranges U+FE00-U+FE0F and U+E0100-U+E01EF. IVS currently use Variation Selectors from the range U+E0100-U+E01EF only. A VS consists of the base character value followed by a single Variation Selector. For example, to get the first variation of U+9089, you have to write the character sequence U+9089 U+E0100 . Adobe and MS decided to support both standardized and ideographic VS with a new cmap subtable (format 14). It is an odd subtable because it is not a mapping of input code points to glyphs, but contains lists of all variations supported by the font. A variation may be either \u2018default\u2019 or \u2018non-default\u2019 for a given font. A default variation is the one you will get for that code point if you look it up in the standard Unicode cmap. A non-default variation is a different glyph. FT_Face_GetCharVariantIndex \u00b6 Defined in FT_FREETYPE_H (freetype/freetype.h). FT_EXPORT( FT_UInt ) FT_Face_GetCharVariantIndex ( FT_Face face, FT_ULong charcode, FT_ULong variantSelector ); Return the glyph index of a given character code as modified by the variation selector. input face A handle to the source face object. charcode The character code point in Unicode. variantSelector The Unicode code point of the variation selector. return The glyph index. 0 means either \u2018undefined character code\u2019, or \u2018undefined selector code\u2019, or \u2018no variation selector cmap subtable\u2019, or \u2018current CharMap is not Unicode\u2019. note If you use FreeType to manipulate the contents of font files directly, be aware that the glyph index returned by this function doesn't always correspond to the internal indices used within the file. This is done to ensure that value 0 always corresponds to the \u2018missing glyph\u2019. This function is only meaningful if a) the font has a variation selector cmap sub table, and b) the current charmap has a Unicode encoding. since 2.3.6 FT_Face_GetCharVariantIsDefault \u00b6 Defined in FT_FREETYPE_H (freetype/freetype.h). FT_EXPORT( FT_Int ) FT_Face_GetCharVariantIsDefault ( FT_Face face, FT_ULong charcode, FT_ULong variantSelector ); Check whether this variation of this Unicode character is the one to be found in the charmap. input face A handle to the source face object. charcode The character codepoint in Unicode. variantSelector The Unicode codepoint of the variation selector. return 1 if found in the standard (Unicode) cmap, 0 if found in the variation selector cmap, or -1 if it is not a variation. note This function is only meaningful if the font has a variation selector cmap subtable. since 2.3.6 FT_Face_GetVariantSelectors \u00b6 Defined in FT_FREETYPE_H (freetype/freetype.h). FT_EXPORT( FT_UInt32 * ) FT_Face_GetVariantSelectors ( FT_Face face ); Return a zero-terminated list of Unicode variation selectors found in the font. input face A handle to the source face object. return A pointer to an array of selector code points, or NULL if there is no valid variation selector cmap subtable. note The last item in the array is 0; the array is owned by the FT_Face object but can be overwritten or released on the next call to a FreeType function. since 2.3.6 FT_Face_GetVariantsOfChar \u00b6 Defined in FT_FREETYPE_H (freetype/freetype.h). FT_EXPORT( FT_UInt32 * ) FT_Face_GetVariantsOfChar ( FT_Face face, FT_ULong charcode ); Return a zero-terminated list of Unicode variation selectors found for the specified character code. input face A handle to the source face object. charcode The character codepoint in Unicode. return A pointer to an array of variation selector code points that are active for the given character, or NULL if the corresponding list is empty. note The last item in the array is 0; the array is owned by the FT_Face object but can be overwritten or released on the next call to a FreeType function. since 2.3.6 FT_Face_GetCharsOfVariant \u00b6 Defined in FT_FREETYPE_H (freetype/freetype.h). FT_EXPORT( FT_UInt32 * ) FT_Face_GetCharsOfVariant ( FT_Face face, FT_ULong variantSelector ); Return a zero-terminated list of Unicode character codes found for the specified variation selector. input face A handle to the source face object. variantSelector The variation selector code point in Unicode. return A list of all the code points that are specified by this selector (both default and non-default codes are returned) or NULL if there is no valid cmap or the variation selector is invalid. note The last item in the array is 0; the array is owned by the FT_Face object but can be overwritten or released on the next call to a FreeType function. since 2.3.6","title":"Unicode Variation Sequences"},{"location":"ft2-glyph_variants.html#unicode-variation-sequences","text":"","title":"Unicode Variation Sequences"},{"location":"ft2-glyph_variants.html#synopsis","text":"Many characters, especially for CJK scripts, have variant forms. They are a sort of grey area somewhere between being totally irrelevant and semantically distinct; for this reason, the Unicode consortium decided to introduce Variation Sequences (VS), consisting of a Unicode base character and a variation selector instead of further extending the already huge number of characters. Unicode maintains two different sets, namely \u2018Standardized Variation Sequences\u2019 and registered \u2018Ideographic Variation Sequences\u2019 (IVS), collected in the \u2018Ideographic Variation Database\u2019 (IVD). https://unicode.org/Public/UCD/latest/ucd/StandardizedVariants.txt https://unicode.org/reports/tr37/ https://unicode.org/ivd/ To date (January 2017), the character with the most ideographic variations is U+9089, having 32 such IVS. Three Mongolian Variation Selectors have the values U+180B-U+180D; 256 generic Variation Selectors are encoded in the ranges U+FE00-U+FE0F and U+E0100-U+E01EF. IVS currently use Variation Selectors from the range U+E0100-U+E01EF only. A VS consists of the base character value followed by a single Variation Selector. For example, to get the first variation of U+9089, you have to write the character sequence U+9089 U+E0100 . Adobe and MS decided to support both standardized and ideographic VS with a new cmap subtable (format 14). It is an odd subtable because it is not a mapping of input code points to glyphs, but contains lists of all variations supported by the font. A variation may be either \u2018default\u2019 or \u2018non-default\u2019 for a given font. A default variation is the one you will get for that code point if you look it up in the standard Unicode cmap. A non-default variation is a different glyph.","title":"Synopsis"},{"location":"ft2-glyph_variants.html#ft_face_getcharvariantindex","text":"Defined in FT_FREETYPE_H (freetype/freetype.h). FT_EXPORT( FT_UInt ) FT_Face_GetCharVariantIndex ( FT_Face face, FT_ULong charcode, FT_ULong variantSelector ); Return the glyph index of a given character code as modified by the variation selector.","title":"FT_Face_GetCharVariantIndex"},{"location":"ft2-glyph_variants.html#ft_face_getcharvariantisdefault","text":"Defined in FT_FREETYPE_H (freetype/freetype.h). FT_EXPORT( FT_Int ) FT_Face_GetCharVariantIsDefault ( FT_Face face, FT_ULong charcode, FT_ULong variantSelector ); Check whether this variation of this Unicode character is the one to be found in the charmap.","title":"FT_Face_GetCharVariantIsDefault"},{"location":"ft2-glyph_variants.html#ft_face_getvariantselectors","text":"Defined in FT_FREETYPE_H (freetype/freetype.h). FT_EXPORT( FT_UInt32 * ) FT_Face_GetVariantSelectors ( FT_Face face ); Return a zero-terminated list of Unicode variation selectors found in the font.","title":"FT_Face_GetVariantSelectors"},{"location":"ft2-glyph_variants.html#ft_face_getvariantsofchar","text":"Defined in FT_FREETYPE_H (freetype/freetype.h). FT_EXPORT( FT_UInt32 * ) FT_Face_GetVariantsOfChar ( FT_Face face, FT_ULong charcode ); Return a zero-terminated list of Unicode variation selectors found for the specified character code.","title":"FT_Face_GetVariantsOfChar"},{"location":"ft2-glyph_variants.html#ft_face_getcharsofvariant","text":"Defined in FT_FREETYPE_H (freetype/freetype.h). FT_EXPORT( FT_UInt32 * ) FT_Face_GetCharsOfVariant ( FT_Face face, FT_ULong variantSelector ); Return a zero-terminated list of Unicode character codes found for the specified variation selector.","title":"FT_Face_GetCharsOfVariant"},{"location":"ft2-gx_validation.html","text":"FreeType \u00bb Docs \u00bb Miscellaneous \u00bb TrueTypeGX/AAT Validation TrueTypeGX/AAT Validation \u00b6 Synopsis \u00b6 This section contains the declaration of functions to validate some TrueTypeGX tables (feat, mort, morx, bsln, just, kern, opbd, trak, prop, lcar). FT_TrueTypeGX_Validate \u00b6 Defined in FT_GX_VALIDATE_H (freetype/ftgxval.h). FT_EXPORT( FT_Error ) FT_TrueTypeGX_Validate ( FT_Face face, FT_UInt validation_flags, FT_Bytes tables[ FT_VALIDATE_GX_LENGTH ], FT_UInt table_length ); Validate various TrueTypeGX tables to assure that all offsets and indices are valid. The idea is that a higher-level library that actually does the text layout can access those tables without error checking (which can be quite time consuming). input face A handle to the input face. validation_flags A bit field that specifies the tables to be validated. See FT_VALIDATE_GXXXX for possible values. table_length The size of the tables array. Normally, FT_VALIDATE_GX_LENGTH should be passed. output tables The array where all validated sfnt tables are stored. The array itself must be allocated by a client. return FreeType error code. 0 means success. note This function only works with TrueTypeGX fonts, returning an error otherwise. After use, the application should deallocate the buffers pointed to by each tables element, by calling FT_TrueTypeGX_Free . A NULL value indicates that the table either doesn't exist in the font, the application hasn't asked for validation, or the validator doesn't have the ability to validate the sfnt table. FT_TrueTypeGX_Free \u00b6 Defined in FT_GX_VALIDATE_H (freetype/ftgxval.h). FT_EXPORT( void ) FT_TrueTypeGX_Free ( FT_Face face, FT_Bytes table ); Free the buffer allocated by TrueTypeGX validator. input face A handle to the input face. table The pointer to the buffer allocated by FT_TrueTypeGX_Validate . note This function must be used to free the buffer allocated by FT_TrueTypeGX_Validate only. FT_ClassicKern_Validate \u00b6 Defined in FT_GX_VALIDATE_H (freetype/ftgxval.h). FT_EXPORT( FT_Error ) FT_ClassicKern_Validate ( FT_Face face, FT_UInt validation_flags, FT_Bytes *ckern_table ); Validate classic (16-bit format) kern table to assure that the offsets and indices are valid. The idea is that a higher-level library that actually does the text layout can access those tables without error checking (which can be quite time consuming). The \u2018kern\u2019 table validator in FT_TrueTypeGX_Validate deals with both the new 32-bit format and the classic 16-bit format, while FT_ClassicKern_Validate only supports the classic 16-bit format. input face A handle to the input face. validation_flags A bit field that specifies the dialect to be validated. See FT_VALIDATE_CKERNXXX for possible values. output ckern_table A pointer to the kern table. return FreeType error code. 0 means success. note After use, the application should deallocate the buffers pointed to by ckern_table , by calling FT_ClassicKern_Free . A NULL value indicates that the table doesn't exist in the font. FT_ClassicKern_Free \u00b6 Defined in FT_GX_VALIDATE_H (freetype/ftgxval.h). FT_EXPORT( void ) FT_ClassicKern_Free ( FT_Face face, FT_Bytes table ); Free the buffer allocated by classic Kern validator. input face A handle to the input face. table The pointer to the buffer that is allocated by FT_ClassicKern_Validate . note This function must be used to free the buffer allocated by FT_ClassicKern_Validate only. FT_VALIDATE_GX_LENGTH \u00b6 Defined in FT_GX_VALIDATE_H (freetype/ftgxval.h). # define FT_VALIDATE_GX_LENGTH ( FT_VALIDATE_GX_LAST_INDEX + 1 ) The number of tables checked in this module. Use it as a parameter for the table-length argument of function FT_TrueTypeGX_Validate . FT_VALIDATE_GXXXX \u00b6 Defined in FT_GX_VALIDATE_H (freetype/ftgxval.h). # define FT_VALIDATE_feat FT_VALIDATE_GX_BITFIELD( feat ) # define FT_VALIDATE_mort FT_VALIDATE_GX_BITFIELD( mort ) # define FT_VALIDATE_morx FT_VALIDATE_GX_BITFIELD( morx ) # define FT_VALIDATE_bsln FT_VALIDATE_GX_BITFIELD( bsln ) # define FT_VALIDATE_just FT_VALIDATE_GX_BITFIELD( just ) # define FT_VALIDATE_kern FT_VALIDATE_GX_BITFIELD( kern ) # define FT_VALIDATE_opbd FT_VALIDATE_GX_BITFIELD( opbd ) # define FT_VALIDATE_trak FT_VALIDATE_GX_BITFIELD( trak ) # define FT_VALIDATE_prop FT_VALIDATE_GX_BITFIELD( prop ) # define FT_VALIDATE_lcar FT_VALIDATE_GX_BITFIELD( lcar ) # define FT_VALIDATE_GX ( FT_VALIDATE_feat | \\ FT_VALIDATE_mort | \\ FT_VALIDATE_morx | \\ FT_VALIDATE_bsln | \\ FT_VALIDATE_just | \\ FT_VALIDATE_kern | \\ FT_VALIDATE_opbd | \\ FT_VALIDATE_trak | \\ FT_VALIDATE_prop | \\ FT_VALIDATE_lcar ) A list of bit-field constants used with FT_TrueTypeGX_Validate to indicate which TrueTypeGX/AAT Type tables should be validated. values FT_VALIDATE_feat Validate \u2018feat\u2019 table. FT_VALIDATE_mort Validate \u2018mort\u2019 table. FT_VALIDATE_morx Validate \u2018morx\u2019 table. FT_VALIDATE_bsln Validate \u2018bsln\u2019 table. FT_VALIDATE_just Validate \u2018just\u2019 table. FT_VALIDATE_kern Validate \u2018kern\u2019 table. FT_VALIDATE_opbd Validate \u2018opbd\u2019 table. FT_VALIDATE_trak Validate \u2018trak\u2019 table. FT_VALIDATE_prop Validate \u2018prop\u2019 table. FT_VALIDATE_lcar Validate \u2018lcar\u2019 table. FT_VALIDATE_GX Validate all TrueTypeGX tables (feat, mort, morx, bsln, just, kern, opbd, trak, prop and lcar). FT_VALIDATE_CKERNXXX \u00b6 Defined in FT_GX_VALIDATE_H (freetype/ftgxval.h). # define FT_VALIDATE_MS ( FT_VALIDATE_GX_START << 0 ) # define FT_VALIDATE_APPLE ( FT_VALIDATE_GX_START << 1 ) # define FT_VALIDATE_CKERN ( FT_VALIDATE_MS | FT_VALIDATE_APPLE ) A list of bit-field constants used with FT_ClassicKern_Validate to indicate the classic kern dialect or dialects. If the selected type doesn't fit, FT_ClassicKern_Validate regards the table as invalid. values FT_VALIDATE_MS Handle the \u2018kern\u2019 table as a classic Microsoft kern table. FT_VALIDATE_APPLE Handle the \u2018kern\u2019 table as a classic Apple kern table. FT_VALIDATE_CKERN Handle the \u2018kern\u2019 as either classic Apple or Microsoft kern table.","title":"TrueTypeGX/AAT Validation"},{"location":"ft2-gx_validation.html#truetypegxaat-validation","text":"","title":"TrueTypeGX/AAT Validation"},{"location":"ft2-gx_validation.html#synopsis","text":"This section contains the declaration of functions to validate some TrueTypeGX tables (feat, mort, morx, bsln, just, kern, opbd, trak, prop, lcar).","title":"Synopsis"},{"location":"ft2-gx_validation.html#ft_truetypegx_validate","text":"Defined in FT_GX_VALIDATE_H (freetype/ftgxval.h). FT_EXPORT( FT_Error ) FT_TrueTypeGX_Validate ( FT_Face face, FT_UInt validation_flags, FT_Bytes tables[ FT_VALIDATE_GX_LENGTH ], FT_UInt table_length ); Validate various TrueTypeGX tables to assure that all offsets and indices are valid. The idea is that a higher-level library that actually does the text layout can access those tables without error checking (which can be quite time consuming).","title":"FT_TrueTypeGX_Validate"},{"location":"ft2-gx_validation.html#ft_truetypegx_free","text":"Defined in FT_GX_VALIDATE_H (freetype/ftgxval.h). FT_EXPORT( void ) FT_TrueTypeGX_Free ( FT_Face face, FT_Bytes table ); Free the buffer allocated by TrueTypeGX validator.","title":"FT_TrueTypeGX_Free"},{"location":"ft2-gx_validation.html#ft_classickern_validate","text":"Defined in FT_GX_VALIDATE_H (freetype/ftgxval.h). FT_EXPORT( FT_Error ) FT_ClassicKern_Validate ( FT_Face face, FT_UInt validation_flags, FT_Bytes *ckern_table ); Validate classic (16-bit format) kern table to assure that the offsets and indices are valid. The idea is that a higher-level library that actually does the text layout can access those tables without error checking (which can be quite time consuming). The \u2018kern\u2019 table validator in FT_TrueTypeGX_Validate deals with both the new 32-bit format and the classic 16-bit format, while FT_ClassicKern_Validate only supports the classic 16-bit format.","title":"FT_ClassicKern_Validate"},{"location":"ft2-gx_validation.html#ft_classickern_free","text":"Defined in FT_GX_VALIDATE_H (freetype/ftgxval.h). FT_EXPORT( void ) FT_ClassicKern_Free ( FT_Face face, FT_Bytes table ); Free the buffer allocated by classic Kern validator.","title":"FT_ClassicKern_Free"},{"location":"ft2-gx_validation.html#ft_validate_gx_length","text":"Defined in FT_GX_VALIDATE_H (freetype/ftgxval.h). # define FT_VALIDATE_GX_LENGTH ( FT_VALIDATE_GX_LAST_INDEX + 1 ) The number of tables checked in this module. Use it as a parameter for the table-length argument of function FT_TrueTypeGX_Validate .","title":"FT_VALIDATE_GX_LENGTH"},{"location":"ft2-gx_validation.html#ft_validate_gxxxx","text":"Defined in FT_GX_VALIDATE_H (freetype/ftgxval.h). # define FT_VALIDATE_feat FT_VALIDATE_GX_BITFIELD( feat ) # define FT_VALIDATE_mort FT_VALIDATE_GX_BITFIELD( mort ) # define FT_VALIDATE_morx FT_VALIDATE_GX_BITFIELD( morx ) # define FT_VALIDATE_bsln FT_VALIDATE_GX_BITFIELD( bsln ) # define FT_VALIDATE_just FT_VALIDATE_GX_BITFIELD( just ) # define FT_VALIDATE_kern FT_VALIDATE_GX_BITFIELD( kern ) # define FT_VALIDATE_opbd FT_VALIDATE_GX_BITFIELD( opbd ) # define FT_VALIDATE_trak FT_VALIDATE_GX_BITFIELD( trak ) # define FT_VALIDATE_prop FT_VALIDATE_GX_BITFIELD( prop ) # define FT_VALIDATE_lcar FT_VALIDATE_GX_BITFIELD( lcar ) # define FT_VALIDATE_GX ( FT_VALIDATE_feat | \\ FT_VALIDATE_mort | \\ FT_VALIDATE_morx | \\ FT_VALIDATE_bsln | \\ FT_VALIDATE_just | \\ FT_VALIDATE_kern | \\ FT_VALIDATE_opbd | \\ FT_VALIDATE_trak | \\ FT_VALIDATE_prop | \\ FT_VALIDATE_lcar ) A list of bit-field constants used with FT_TrueTypeGX_Validate to indicate which TrueTypeGX/AAT Type tables should be validated.","title":"FT_VALIDATE_GXXXX"},{"location":"ft2-gx_validation.html#ft_validate_ckernxxx","text":"Defined in FT_GX_VALIDATE_H (freetype/ftgxval.h). # define FT_VALIDATE_MS ( FT_VALIDATE_GX_START << 0 ) # define FT_VALIDATE_APPLE ( FT_VALIDATE_GX_START << 1 ) # define FT_VALIDATE_CKERN ( FT_VALIDATE_MS | FT_VALIDATE_APPLE ) A list of bit-field constants used with FT_ClassicKern_Validate to indicate the classic kern dialect or dialects. If the selected type doesn't fit, FT_ClassicKern_Validate regards the table as invalid.","title":"FT_VALIDATE_CKERNXXX"},{"location":"ft2-gzip.html","text":"FreeType \u00bb Docs \u00bb Support API \u00bb GZIP Streams GZIP Streams \u00b6 Synopsis \u00b6 In certain builds of the library, gzip compression recognition is automatically handled when calling FT_New_Face or FT_Open_Face . This means that if no font driver is capable of handling the raw compressed file, the library will try to open a gzipped stream from it and re-open the face with it. The stream implementation is very basic and resets the decompression process each time seeking backwards is needed within the stream, which significantly undermines the performance. This section contains the declaration of Gzip-specific functions. FT_Stream_OpenGzip \u00b6 Defined in FT_GZIP_H (freetype/ftgzip.h). FT_EXPORT( FT_Error ) FT_Stream_OpenGzip ( FT_Stream stream, FT_Stream source ); Open a new stream to parse gzip-compressed font files. This is mainly used to support the compressed *.pcf.gz fonts that come with XFree86. input stream The target embedding stream. source The source stream. return FreeType error code. 0 means success. note The source stream must be opened before calling this function. Calling the internal function FT_Stream_Close on the new stream will not call FT_Stream_Close on the source stream. None of the stream objects will be released to the heap. This function may return FT_Err_Unimplemented_Feature if your build of FreeType was not compiled with zlib support. FT_Gzip_Uncompress \u00b6 Defined in FT_GZIP_H (freetype/ftgzip.h). FT_EXPORT( FT_Error ) FT_Gzip_Uncompress ( FT_Memory memory, FT_Byte * output, FT_ULong * output_len, const FT_Byte * input, FT_ULong input_len ); Decompress a zipped input buffer into an output buffer. This function is modeled after zlib's uncompress function. input memory A FreeType memory handle. input The input buffer. input_len The length of the input buffer. output output The output buffer. inout output_len Before calling the function, this is the total size of the output buffer, which must be large enough to hold the entire uncompressed data (so the size of the uncompressed data must be known in advance). After calling the function, output_len is the size of the used data in output . return FreeType error code. 0 means success. note This function may return FT_Err_Unimplemented_Feature if your build of FreeType was not compiled with zlib support. since 2.5.1","title":"GZIP Streams"},{"location":"ft2-gzip.html#gzip-streams","text":"","title":"GZIP Streams"},{"location":"ft2-gzip.html#synopsis","text":"In certain builds of the library, gzip compression recognition is automatically handled when calling FT_New_Face or FT_Open_Face . This means that if no font driver is capable of handling the raw compressed file, the library will try to open a gzipped stream from it and re-open the face with it. The stream implementation is very basic and resets the decompression process each time seeking backwards is needed within the stream, which significantly undermines the performance. This section contains the declaration of Gzip-specific functions.","title":"Synopsis"},{"location":"ft2-gzip.html#ft_stream_opengzip","text":"Defined in FT_GZIP_H (freetype/ftgzip.h). FT_EXPORT( FT_Error ) FT_Stream_OpenGzip ( FT_Stream stream, FT_Stream source ); Open a new stream to parse gzip-compressed font files. This is mainly used to support the compressed *.pcf.gz fonts that come with XFree86.","title":"FT_Stream_OpenGzip"},{"location":"ft2-gzip.html#ft_gzip_uncompress","text":"Defined in FT_GZIP_H (freetype/ftgzip.h). FT_EXPORT( FT_Error ) FT_Gzip_Uncompress ( FT_Memory memory, FT_Byte * output, FT_ULong * output_len, const FT_Byte * input, FT_ULong input_len ); Decompress a zipped input buffer into an output buffer. This function is modeled after zlib's uncompress function.","title":"FT_Gzip_Uncompress"},{"location":"ft2-header_file_macros.html","text":"FreeType \u00bb Docs \u00bb Core API \u00bb Header File Macros Header File Macros \u00b6 Synopsis \u00b6 In addition to the normal scheme of including header files like #include <freetype/freetype.h> #include <freetype/ftmm.h> #include <freetype/ftglyph.h> it is possible to used named macros instead. They can be used directly in #include statements as in #include FT_FREETYPE_H #include FT_MULTIPLE_MASTERS_H #include FT_GLYPH_H These macros were introduced to overcome the infamous 8.3 naming rule required by DOS (and FT_MULTIPLE_MASTERS_H is a lot more meaningful than ftmm.h ). FT_CONFIG_CONFIG_H \u00b6 # ifndef FT_CONFIG_CONFIG_H # define FT_CONFIG_CONFIG_H <freetype/config/ftconfig.h> # endif A macro used in #include statements to name the file containing FreeType 2 configuration data. FT_CONFIG_STANDARD_LIBRARY_H \u00b6 # ifndef FT_CONFIG_STANDARD_LIBRARY_H # define FT_CONFIG_STANDARD_LIBRARY_H <freetype/config/ftstdlib.h> # endif A macro used in #include statements to name the file containing FreeType 2 interface to the standard C library functions. FT_CONFIG_OPTIONS_H \u00b6 # ifndef FT_CONFIG_OPTIONS_H # define FT_CONFIG_OPTIONS_H <freetype/config/ftoption.h> # endif A macro used in #include statements to name the file containing FreeType 2 project-specific configuration options. FT_CONFIG_MODULES_H \u00b6 # ifndef FT_CONFIG_MODULES_H # define FT_CONFIG_MODULES_H <freetype/config/ftmodule.h> # endif A macro used in #include statements to name the file containing the list of FreeType 2 modules that are statically linked to new library instances in FT_Init_FreeType . FT_FREETYPE_H \u00b6 # define FT_FREETYPE_H <freetype/freetype.h> A macro used in #include statements to name the file containing the base FreeType 2 API. FT_ERRORS_H \u00b6 # define FT_ERRORS_H <freetype/fterrors.h> A macro used in #include statements to name the file containing the list of FreeType 2 error codes (and messages). It is included by FT_FREETYPE_H . FT_MODULE_ERRORS_H \u00b6 # define FT_MODULE_ERRORS_H <freetype/ftmoderr.h> A macro used in #include statements to name the file containing the list of FreeType 2 module error offsets (and messages). FT_SYSTEM_H \u00b6 # define FT_SYSTEM_H <freetype/ftsystem.h> A macro used in #include statements to name the file containing the FreeType 2 interface to low-level operations (i.e., memory management and stream i/o). It is included by FT_FREETYPE_H . FT_IMAGE_H \u00b6 # define FT_IMAGE_H <freetype/ftimage.h> A macro used in #include statements to name the file containing type definitions related to glyph images (i.e., bitmaps, outlines, scan-converter parameters). It is included by FT_FREETYPE_H . FT_TYPES_H \u00b6 # define FT_TYPES_H <freetype/fttypes.h> A macro used in #include statements to name the file containing the basic data types defined by FreeType 2. It is included by FT_FREETYPE_H . FT_LIST_H \u00b6 # define FT_LIST_H <freetype/ftlist.h> A macro used in #include statements to name the file containing the list management API of FreeType 2. (Most applications will never need to include this file.) FT_OUTLINE_H \u00b6 # define FT_OUTLINE_H <freetype/ftoutln.h> A macro used in #include statements to name the file containing the scalable outline management API of FreeType 2. FT_SIZES_H \u00b6 # define FT_SIZES_H <freetype/ftsizes.h> A macro used in #include statements to name the file containing the API which manages multiple FT_Size objects per face. FT_MODULE_H \u00b6 # define FT_MODULE_H <freetype/ftmodapi.h> A macro used in #include statements to name the file containing the module management API of FreeType 2. FT_RENDER_H \u00b6 # define FT_RENDER_H <freetype/ftrender.h> A macro used in #include statements to name the file containing the renderer module management API of FreeType 2. FT_DRIVER_H \u00b6 # define FT_DRIVER_H <freetype/ftdriver.h> A macro used in #include statements to name the file containing structures and macros related to the driver modules. FT_AUTOHINTER_H \u00b6 # define FT_AUTOHINTER_H FT_DRIVER_H A macro used in #include statements to name the file containing structures and macros related to the auto-hinting module. Deprecated since version 2.9; use FT_DRIVER_H instead. FT_CFF_DRIVER_H \u00b6 # define FT_CFF_DRIVER_H FT_DRIVER_H A macro used in #include statements to name the file containing structures and macros related to the CFF driver module. Deprecated since version 2.9; use FT_DRIVER_H instead. FT_TRUETYPE_DRIVER_H \u00b6 # define FT_TRUETYPE_DRIVER_H FT_DRIVER_H A macro used in #include statements to name the file containing structures and macros related to the TrueType driver module. Deprecated since version 2.9; use FT_DRIVER_H instead. FT_PCF_DRIVER_H \u00b6 # define FT_PCF_DRIVER_H FT_DRIVER_H A macro used in #include statements to name the file containing structures and macros related to the PCF driver module. Deprecated since version 2.9; use FT_DRIVER_H instead. FT_TYPE1_TABLES_H \u00b6 # define FT_TYPE1_TABLES_H <freetype/t1tables.h> A macro used in #include statements to name the file containing the types and API specific to the Type 1 format. FT_TRUETYPE_IDS_H \u00b6 # define FT_TRUETYPE_IDS_H <freetype/ttnameid.h> A macro used in #include statements to name the file containing the enumeration values which identify name strings, languages, encodings, etc. This file really contains a large set of constant macro definitions, taken from the TrueType and OpenType specifications. FT_TRUETYPE_TABLES_H \u00b6 # define FT_TRUETYPE_TABLES_H <freetype/tttables.h> A macro used in #include statements to name the file containing the types and API specific to the TrueType (as well as OpenType) format. FT_TRUETYPE_TAGS_H \u00b6 # define FT_TRUETYPE_TAGS_H <freetype/tttags.h> A macro used in #include statements to name the file containing the definitions of TrueType four-byte \u2018tags\u2019 which identify blocks in SFNT-based font formats (i.e., TrueType and OpenType). FT_BDF_H \u00b6 # define FT_BDF_H <freetype/ftbdf.h> A macro used in #include statements to name the file containing the definitions of an API which accesses BDF-specific strings from a face. FT_CID_H \u00b6 # define FT_CID_H <freetype/ftcid.h> A macro used in #include statements to name the file containing the definitions of an API which access CID font information from a face. FT_GZIP_H \u00b6 # define FT_GZIP_H <freetype/ftgzip.h> A macro used in #include statements to name the file containing the definitions of an API which supports gzip-compressed files. FT_LZW_H \u00b6 # define FT_LZW_H <freetype/ftlzw.h> A macro used in #include statements to name the file containing the definitions of an API which supports LZW-compressed files. FT_BZIP2_H \u00b6 # define FT_BZIP2_H <freetype/ftbzip2.h> A macro used in #include statements to name the file containing the definitions of an API which supports bzip2-compressed files. FT_WINFONTS_H \u00b6 # define FT_WINFONTS_H <freetype/ftwinfnt.h> A macro used in #include statements to name the file containing the definitions of an API which supports Windows FNT files. FT_GLYPH_H \u00b6 # define FT_GLYPH_H <freetype/ftglyph.h> A macro used in #include statements to name the file containing the API of the optional glyph management component. FT_BITMAP_H \u00b6 # define FT_BITMAP_H <freetype/ftbitmap.h> A macro used in #include statements to name the file containing the API of the optional bitmap conversion component. FT_BBOX_H \u00b6 # define FT_BBOX_H <freetype/ftbbox.h> A macro used in #include statements to name the file containing the API of the optional exact bounding box computation routines. FT_CACHE_H \u00b6 # define FT_CACHE_H <freetype/ftcache.h> A macro used in #include statements to name the file containing the API of the optional FreeType 2 cache sub-system. FT_MAC_H \u00b6 # define FT_MAC_H <freetype/ftmac.h> A macro used in #include statements to name the file containing the Macintosh-specific FreeType 2 API. The latter is used to access fonts embedded in resource forks. This header file must be explicitly included by client applications compiled on the Mac (note that the base API still works though). FT_MULTIPLE_MASTERS_H \u00b6 # define FT_MULTIPLE_MASTERS_H <freetype/ftmm.h> A macro used in #include statements to name the file containing the optional multiple-masters management API of FreeType 2. FT_SFNT_NAMES_H \u00b6 # define FT_SFNT_NAMES_H <freetype/ftsnames.h> A macro used in #include statements to name the file containing the optional FreeType 2 API which accesses embedded \u2018name\u2019 strings in SFNT-based font formats (i.e., TrueType and OpenType). FT_OPENTYPE_VALIDATE_H \u00b6 # define FT_OPENTYPE_VALIDATE_H <freetype/ftotval.h> A macro used in #include statements to name the file containing the optional FreeType 2 API which validates OpenType tables (\u2018BASE\u2019, \u2018GDEF\u2019, \u2018GPOS\u2019, \u2018GSUB\u2019, \u2018JSTF\u2019). FT_GX_VALIDATE_H \u00b6 # define FT_GX_VALIDATE_H <freetype/ftgxval.h> A macro used in #include statements to name the file containing the optional FreeType 2 API which validates TrueTypeGX/AAT tables (\u2018feat\u2019, \u2018mort\u2019, \u2018morx\u2019, \u2018bsln\u2019, \u2018just\u2019, \u2018kern\u2019, \u2018opbd\u2019, \u2018trak\u2019, \u2018prop\u2019). FT_PFR_H \u00b6 # define FT_PFR_H <freetype/ftpfr.h> A macro used in #include statements to name the file containing the FreeType 2 API which accesses PFR-specific data. FT_STROKER_H \u00b6 # define FT_STROKER_H <freetype/ftstroke.h> A macro used in #include statements to name the file containing the FreeType 2 API which provides functions to stroke outline paths. FT_SYNTHESIS_H \u00b6 # define FT_SYNTHESIS_H <freetype/ftsynth.h> A macro used in #include statements to name the file containing the FreeType 2 API which performs artificial obliquing and emboldening. FT_FONT_FORMATS_H \u00b6 # define FT_FONT_FORMATS_H <freetype/ftfntfmt.h> /* deprecated */ # define FT_XFREE86_H FT_FONT_FORMATS_H A macro used in #include statements to name the file containing the FreeType 2 API which provides functions specific to font formats. FT_TRIGONOMETRY_H \u00b6 # define FT_TRIGONOMETRY_H <freetype/fttrigon.h> A macro used in #include statements to name the file containing the FreeType 2 API which performs trigonometric computations (e.g., cosines and arc tangents). FT_LCD_FILTER_H \u00b6 # define FT_LCD_FILTER_H <freetype/ftlcdfil.h> A macro used in #include statements to name the file containing the FreeType 2 API which performs color filtering for subpixel rendering. FT_INCREMENTAL_H \u00b6 # define FT_INCREMENTAL_H <freetype/ftincrem.h> A macro used in #include statements to name the file containing the FreeType 2 API which performs incremental glyph loading. FT_GASP_H \u00b6 # define FT_GASP_H <freetype/ftgasp.h> A macro used in #include statements to name the file containing the FreeType 2 API which returns entries from the TrueType GASP table. FT_ADVANCES_H \u00b6 # define FT_ADVANCES_H <freetype/ftadvanc.h> A macro used in #include statements to name the file containing the FreeType 2 API which returns individual and ranged glyph advances. FT_COLOR_H \u00b6 # define FT_COLOR_H <freetype/ftcolor.h> A macro used in #include statements to name the file containing the FreeType 2 API which handles the OpenType \u2018CPAL\u2019 table.","title":"Header File Macros"},{"location":"ft2-header_file_macros.html#header-file-macros","text":"","title":"Header File Macros"},{"location":"ft2-header_file_macros.html#synopsis","text":"In addition to the normal scheme of including header files like #include <freetype/freetype.h> #include <freetype/ftmm.h> #include <freetype/ftglyph.h> it is possible to used named macros instead. They can be used directly in #include statements as in #include FT_FREETYPE_H #include FT_MULTIPLE_MASTERS_H #include FT_GLYPH_H These macros were introduced to overcome the infamous 8.3 naming rule required by DOS (and FT_MULTIPLE_MASTERS_H is a lot more meaningful than ftmm.h ).","title":"Synopsis"},{"location":"ft2-header_file_macros.html#ft_config_config_h","text":"# ifndef FT_CONFIG_CONFIG_H # define FT_CONFIG_CONFIG_H <freetype/config/ftconfig.h> # endif A macro used in #include statements to name the file containing FreeType 2 configuration data.","title":"FT_CONFIG_CONFIG_H"},{"location":"ft2-header_file_macros.html#ft_config_standard_library_h","text":"# ifndef FT_CONFIG_STANDARD_LIBRARY_H # define FT_CONFIG_STANDARD_LIBRARY_H <freetype/config/ftstdlib.h> # endif A macro used in #include statements to name the file containing FreeType 2 interface to the standard C library functions.","title":"FT_CONFIG_STANDARD_LIBRARY_H"},{"location":"ft2-header_file_macros.html#ft_config_options_h","text":"# ifndef FT_CONFIG_OPTIONS_H # define FT_CONFIG_OPTIONS_H <freetype/config/ftoption.h> # endif A macro used in #include statements to name the file containing FreeType 2 project-specific configuration options.","title":"FT_CONFIG_OPTIONS_H"},{"location":"ft2-header_file_macros.html#ft_config_modules_h","text":"# ifndef FT_CONFIG_MODULES_H # define FT_CONFIG_MODULES_H <freetype/config/ftmodule.h> # endif A macro used in #include statements to name the file containing the list of FreeType 2 modules that are statically linked to new library instances in FT_Init_FreeType .","title":"FT_CONFIG_MODULES_H"},{"location":"ft2-header_file_macros.html#ft_freetype_h","text":"# define FT_FREETYPE_H <freetype/freetype.h> A macro used in #include statements to name the file containing the base FreeType 2 API.","title":"FT_FREETYPE_H"},{"location":"ft2-header_file_macros.html#ft_errors_h","text":"# define FT_ERRORS_H <freetype/fterrors.h> A macro used in #include statements to name the file containing the list of FreeType 2 error codes (and messages). It is included by FT_FREETYPE_H .","title":"FT_ERRORS_H"},{"location":"ft2-header_file_macros.html#ft_module_errors_h","text":"# define FT_MODULE_ERRORS_H <freetype/ftmoderr.h> A macro used in #include statements to name the file containing the list of FreeType 2 module error offsets (and messages).","title":"FT_MODULE_ERRORS_H"},{"location":"ft2-header_file_macros.html#ft_system_h","text":"# define FT_SYSTEM_H <freetype/ftsystem.h> A macro used in #include statements to name the file containing the FreeType 2 interface to low-level operations (i.e., memory management and stream i/o). It is included by FT_FREETYPE_H .","title":"FT_SYSTEM_H"},{"location":"ft2-header_file_macros.html#ft_image_h","text":"# define FT_IMAGE_H <freetype/ftimage.h> A macro used in #include statements to name the file containing type definitions related to glyph images (i.e., bitmaps, outlines, scan-converter parameters). It is included by FT_FREETYPE_H .","title":"FT_IMAGE_H"},{"location":"ft2-header_file_macros.html#ft_types_h","text":"# define FT_TYPES_H <freetype/fttypes.h> A macro used in #include statements to name the file containing the basic data types defined by FreeType 2. It is included by FT_FREETYPE_H .","title":"FT_TYPES_H"},{"location":"ft2-header_file_macros.html#ft_list_h","text":"# define FT_LIST_H <freetype/ftlist.h> A macro used in #include statements to name the file containing the list management API of FreeType 2. (Most applications will never need to include this file.)","title":"FT_LIST_H"},{"location":"ft2-header_file_macros.html#ft_outline_h","text":"# define FT_OUTLINE_H <freetype/ftoutln.h> A macro used in #include statements to name the file containing the scalable outline management API of FreeType 2.","title":"FT_OUTLINE_H"},{"location":"ft2-header_file_macros.html#ft_sizes_h","text":"# define FT_SIZES_H <freetype/ftsizes.h> A macro used in #include statements to name the file containing the API which manages multiple FT_Size objects per face.","title":"FT_SIZES_H"},{"location":"ft2-header_file_macros.html#ft_module_h","text":"# define FT_MODULE_H <freetype/ftmodapi.h> A macro used in #include statements to name the file containing the module management API of FreeType 2.","title":"FT_MODULE_H"},{"location":"ft2-header_file_macros.html#ft_render_h","text":"# define FT_RENDER_H <freetype/ftrender.h> A macro used in #include statements to name the file containing the renderer module management API of FreeType 2.","title":"FT_RENDER_H"},{"location":"ft2-header_file_macros.html#ft_driver_h","text":"# define FT_DRIVER_H <freetype/ftdriver.h> A macro used in #include statements to name the file containing structures and macros related to the driver modules.","title":"FT_DRIVER_H"},{"location":"ft2-header_file_macros.html#ft_autohinter_h","text":"# define FT_AUTOHINTER_H FT_DRIVER_H A macro used in #include statements to name the file containing structures and macros related to the auto-hinting module. Deprecated since version 2.9; use FT_DRIVER_H instead.","title":"FT_AUTOHINTER_H"},{"location":"ft2-header_file_macros.html#ft_cff_driver_h","text":"# define FT_CFF_DRIVER_H FT_DRIVER_H A macro used in #include statements to name the file containing structures and macros related to the CFF driver module. Deprecated since version 2.9; use FT_DRIVER_H instead.","title":"FT_CFF_DRIVER_H"},{"location":"ft2-header_file_macros.html#ft_truetype_driver_h","text":"# define FT_TRUETYPE_DRIVER_H FT_DRIVER_H A macro used in #include statements to name the file containing structures and macros related to the TrueType driver module. Deprecated since version 2.9; use FT_DRIVER_H instead.","title":"FT_TRUETYPE_DRIVER_H"},{"location":"ft2-header_file_macros.html#ft_pcf_driver_h","text":"# define FT_PCF_DRIVER_H FT_DRIVER_H A macro used in #include statements to name the file containing structures and macros related to the PCF driver module. Deprecated since version 2.9; use FT_DRIVER_H instead.","title":"FT_PCF_DRIVER_H"},{"location":"ft2-header_file_macros.html#ft_type1_tables_h","text":"# define FT_TYPE1_TABLES_H <freetype/t1tables.h> A macro used in #include statements to name the file containing the types and API specific to the Type 1 format.","title":"FT_TYPE1_TABLES_H"},{"location":"ft2-header_file_macros.html#ft_truetype_ids_h","text":"# define FT_TRUETYPE_IDS_H <freetype/ttnameid.h> A macro used in #include statements to name the file containing the enumeration values which identify name strings, languages, encodings, etc. This file really contains a large set of constant macro definitions, taken from the TrueType and OpenType specifications.","title":"FT_TRUETYPE_IDS_H"},{"location":"ft2-header_file_macros.html#ft_truetype_tables_h","text":"# define FT_TRUETYPE_TABLES_H <freetype/tttables.h> A macro used in #include statements to name the file containing the types and API specific to the TrueType (as well as OpenType) format.","title":"FT_TRUETYPE_TABLES_H"},{"location":"ft2-header_file_macros.html#ft_truetype_tags_h","text":"# define FT_TRUETYPE_TAGS_H <freetype/tttags.h> A macro used in #include statements to name the file containing the definitions of TrueType four-byte \u2018tags\u2019 which identify blocks in SFNT-based font formats (i.e., TrueType and OpenType).","title":"FT_TRUETYPE_TAGS_H"},{"location":"ft2-header_file_macros.html#ft_bdf_h","text":"# define FT_BDF_H <freetype/ftbdf.h> A macro used in #include statements to name the file containing the definitions of an API which accesses BDF-specific strings from a face.","title":"FT_BDF_H"},{"location":"ft2-header_file_macros.html#ft_cid_h","text":"# define FT_CID_H <freetype/ftcid.h> A macro used in #include statements to name the file containing the definitions of an API which access CID font information from a face.","title":"FT_CID_H"},{"location":"ft2-header_file_macros.html#ft_gzip_h","text":"# define FT_GZIP_H <freetype/ftgzip.h> A macro used in #include statements to name the file containing the definitions of an API which supports gzip-compressed files.","title":"FT_GZIP_H"},{"location":"ft2-header_file_macros.html#ft_lzw_h","text":"# define FT_LZW_H <freetype/ftlzw.h> A macro used in #include statements to name the file containing the definitions of an API which supports LZW-compressed files.","title":"FT_LZW_H"},{"location":"ft2-header_file_macros.html#ft_bzip2_h","text":"# define FT_BZIP2_H <freetype/ftbzip2.h> A macro used in #include statements to name the file containing the definitions of an API which supports bzip2-compressed files.","title":"FT_BZIP2_H"},{"location":"ft2-header_file_macros.html#ft_winfonts_h","text":"# define FT_WINFONTS_H <freetype/ftwinfnt.h> A macro used in #include statements to name the file containing the definitions of an API which supports Windows FNT files.","title":"FT_WINFONTS_H"},{"location":"ft2-header_file_macros.html#ft_glyph_h","text":"# define FT_GLYPH_H <freetype/ftglyph.h> A macro used in #include statements to name the file containing the API of the optional glyph management component.","title":"FT_GLYPH_H"},{"location":"ft2-header_file_macros.html#ft_bitmap_h","text":"# define FT_BITMAP_H <freetype/ftbitmap.h> A macro used in #include statements to name the file containing the API of the optional bitmap conversion component.","title":"FT_BITMAP_H"},{"location":"ft2-header_file_macros.html#ft_bbox_h","text":"# define FT_BBOX_H <freetype/ftbbox.h> A macro used in #include statements to name the file containing the API of the optional exact bounding box computation routines.","title":"FT_BBOX_H"},{"location":"ft2-header_file_macros.html#ft_cache_h","text":"# define FT_CACHE_H <freetype/ftcache.h> A macro used in #include statements to name the file containing the API of the optional FreeType 2 cache sub-system.","title":"FT_CACHE_H"},{"location":"ft2-header_file_macros.html#ft_mac_h","text":"# define FT_MAC_H <freetype/ftmac.h> A macro used in #include statements to name the file containing the Macintosh-specific FreeType 2 API. The latter is used to access fonts embedded in resource forks. This header file must be explicitly included by client applications compiled on the Mac (note that the base API still works though).","title":"FT_MAC_H"},{"location":"ft2-header_file_macros.html#ft_multiple_masters_h","text":"# define FT_MULTIPLE_MASTERS_H <freetype/ftmm.h> A macro used in #include statements to name the file containing the optional multiple-masters management API of FreeType 2.","title":"FT_MULTIPLE_MASTERS_H"},{"location":"ft2-header_file_macros.html#ft_sfnt_names_h","text":"# define FT_SFNT_NAMES_H <freetype/ftsnames.h> A macro used in #include statements to name the file containing the optional FreeType 2 API which accesses embedded \u2018name\u2019 strings in SFNT-based font formats (i.e., TrueType and OpenType).","title":"FT_SFNT_NAMES_H"},{"location":"ft2-header_file_macros.html#ft_opentype_validate_h","text":"# define FT_OPENTYPE_VALIDATE_H <freetype/ftotval.h> A macro used in #include statements to name the file containing the optional FreeType 2 API which validates OpenType tables (\u2018BASE\u2019, \u2018GDEF\u2019, \u2018GPOS\u2019, \u2018GSUB\u2019, \u2018JSTF\u2019).","title":"FT_OPENTYPE_VALIDATE_H"},{"location":"ft2-header_file_macros.html#ft_gx_validate_h","text":"# define FT_GX_VALIDATE_H <freetype/ftgxval.h> A macro used in #include statements to name the file containing the optional FreeType 2 API which validates TrueTypeGX/AAT tables (\u2018feat\u2019, \u2018mort\u2019, \u2018morx\u2019, \u2018bsln\u2019, \u2018just\u2019, \u2018kern\u2019, \u2018opbd\u2019, \u2018trak\u2019, \u2018prop\u2019).","title":"FT_GX_VALIDATE_H"},{"location":"ft2-header_file_macros.html#ft_pfr_h","text":"# define FT_PFR_H <freetype/ftpfr.h> A macro used in #include statements to name the file containing the FreeType 2 API which accesses PFR-specific data.","title":"FT_PFR_H"},{"location":"ft2-header_file_macros.html#ft_stroker_h","text":"# define FT_STROKER_H <freetype/ftstroke.h> A macro used in #include statements to name the file containing the FreeType 2 API which provides functions to stroke outline paths.","title":"FT_STROKER_H"},{"location":"ft2-header_file_macros.html#ft_synthesis_h","text":"# define FT_SYNTHESIS_H <freetype/ftsynth.h> A macro used in #include statements to name the file containing the FreeType 2 API which performs artificial obliquing and emboldening.","title":"FT_SYNTHESIS_H"},{"location":"ft2-header_file_macros.html#ft_font_formats_h","text":"# define FT_FONT_FORMATS_H <freetype/ftfntfmt.h> /* deprecated */ # define FT_XFREE86_H FT_FONT_FORMATS_H A macro used in #include statements to name the file containing the FreeType 2 API which provides functions specific to font formats.","title":"FT_FONT_FORMATS_H"},{"location":"ft2-header_file_macros.html#ft_trigonometry_h","text":"# define FT_TRIGONOMETRY_H <freetype/fttrigon.h> A macro used in #include statements to name the file containing the FreeType 2 API which performs trigonometric computations (e.g., cosines and arc tangents).","title":"FT_TRIGONOMETRY_H"},{"location":"ft2-header_file_macros.html#ft_lcd_filter_h","text":"# define FT_LCD_FILTER_H <freetype/ftlcdfil.h> A macro used in #include statements to name the file containing the FreeType 2 API which performs color filtering for subpixel rendering.","title":"FT_LCD_FILTER_H"},{"location":"ft2-header_file_macros.html#ft_incremental_h","text":"# define FT_INCREMENTAL_H <freetype/ftincrem.h> A macro used in #include statements to name the file containing the FreeType 2 API which performs incremental glyph loading.","title":"FT_INCREMENTAL_H"},{"location":"ft2-header_file_macros.html#ft_gasp_h","text":"# define FT_GASP_H <freetype/ftgasp.h> A macro used in #include statements to name the file containing the FreeType 2 API which returns entries from the TrueType GASP table.","title":"FT_GASP_H"},{"location":"ft2-header_file_macros.html#ft_advances_h","text":"# define FT_ADVANCES_H <freetype/ftadvanc.h> A macro used in #include statements to name the file containing the FreeType 2 API which returns individual and ranged glyph advances.","title":"FT_ADVANCES_H"},{"location":"ft2-header_file_macros.html#ft_color_h","text":"# define FT_COLOR_H <freetype/ftcolor.h> A macro used in #include statements to name the file containing the FreeType 2 API which handles the OpenType \u2018CPAL\u2019 table.","title":"FT_COLOR_H"},{"location":"ft2-header_inclusion.html","text":"FreeType \u00bb Docs \u00bb General Remarks \u00bb FreeType's header inclusion scheme FreeType's header inclusion scheme \u00b6 Synopsis \u00b6 To be as flexible as possible (and for historical reasons), you must load file ft2build.h first before other header files, for example #include <ft2build.h> #include <freetype/freetype.h> #include <freetype/ftoutln.h>","title":"FreeType's header inclusion scheme"},{"location":"ft2-header_inclusion.html#freetypes-header-inclusion-scheme","text":"","title":"FreeType's header inclusion scheme"},{"location":"ft2-header_inclusion.html#synopsis","text":"To be as flexible as possible (and for historical reasons), you must load file ft2build.h first before other header files, for example #include <ft2build.h> #include <freetype/freetype.h> #include <freetype/ftoutln.h>","title":"Synopsis"},{"location":"ft2-incremental.html","text":"FreeType \u00bb Docs \u00bb Miscellaneous \u00bb Incremental Loading Incremental Loading \u00b6 Synopsis \u00b6 This section contains various functions used to perform so-called \u2018incremental\u2019 glyph loading. This is a mode where all glyphs loaded from a given FT_Face are provided by the client application. Apart from that, all other tables are loaded normally from the font file. This mode is useful when FreeType is used within another engine, e.g., a PostScript Imaging Processor. To enable this mode, you must use FT_Open_Face , passing an FT_Parameter with the FT_PARAM_TAG_INCREMENTAL tag and an FT_Incremental_Interface value. See the comments for FT_Incremental_InterfaceRec for an example. FT_Incremental \u00b6 Defined in FT_INCREMENTAL_H (freetype/ftincrem.h). typedef struct FT_IncrementalRec_* FT_Incremental ; An opaque type describing a user-provided object used to implement \u2018incremental\u2019 glyph loading within FreeType. This is used to support embedded fonts in certain environments (e.g., PostScript interpreters), where the glyph data isn't in the font file, or must be overridden by different values. note It is up to client applications to create and implement FT_Incremental objects, as long as they provide implementations for the methods FT_Incremental_GetGlyphDataFunc , FT_Incremental_FreeGlyphDataFunc and FT_Incremental_GetGlyphMetricsFunc . See the description of FT_Incremental_InterfaceRec to understand how to use incremental objects with FreeType. FT_Incremental_MetricsRec \u00b6 Defined in FT_INCREMENTAL_H (freetype/ftincrem.h). typedef struct FT_Incremental_MetricsRec_ { FT_Long bearing_x; FT_Long bearing_y; FT_Long advance; FT_Long advance_v; /* since 2.3.12 */ } FT_Incremental_MetricsRec ; A small structure used to contain the basic glyph metrics returned by the FT_Incremental_GetGlyphMetricsFunc method. fields bearing_x Left bearing, in font units. bearing_y Top bearing, in font units. advance Horizontal component of glyph advance, in font units. advance_v Vertical component of glyph advance, in font units. note These correspond to horizontal or vertical metrics depending on the value of the vertical argument to the function FT_Incremental_GetGlyphMetricsFunc . FT_Incremental_Metrics \u00b6 Defined in FT_INCREMENTAL_H (freetype/ftincrem.h). typedef struct FT_Incremental_MetricsRec_* FT_Incremental_Metrics ; A handle to an FT_Incremental_MetricsRec structure. FT_Incremental_GetGlyphDataFunc \u00b6 Defined in FT_INCREMENTAL_H (freetype/ftincrem.h). typedef FT_Error (* FT_Incremental_GetGlyphDataFunc )( FT_Incremental incremental, FT_UInt glyph_index, FT_Data * adata ); A function called by FreeType to access a given glyph's data bytes during FT_Load_Glyph or FT_Load_Char if incremental loading is enabled. Note that the format of the glyph's data bytes depends on the font file format. For TrueType, it must correspond to the raw bytes within the \u2018glyf\u2019 table. For PostScript formats, it must correspond to the unencrypted charstring bytes, without any lenIV header. It is undefined for any other format. input incremental Handle to an opaque FT_Incremental handle provided by the client application. glyph_index Index of relevant glyph. output adata A structure describing the returned glyph data bytes (which will be accessed as a read-only byte block). return FreeType error code. 0 means success. note If this function returns successfully the method FT_Incremental_FreeGlyphDataFunc will be called later to release the data bytes. Nested calls to FT_Incremental_GetGlyphDataFunc can happen for compound glyphs. FT_Incremental_FreeGlyphDataFunc \u00b6 Defined in FT_INCREMENTAL_H (freetype/ftincrem.h). typedef void (* FT_Incremental_FreeGlyphDataFunc )( FT_Incremental incremental, FT_Data * data ); A function used to release the glyph data bytes returned by a successful call to FT_Incremental_GetGlyphDataFunc . input incremental A handle to an opaque FT_Incremental handle provided by the client application. data A structure describing the glyph data bytes (which will be accessed as a read-only byte block). FT_Incremental_GetGlyphMetricsFunc \u00b6 Defined in FT_INCREMENTAL_H (freetype/ftincrem.h). typedef FT_Error (* FT_Incremental_GetGlyphMetricsFunc ) ( FT_Incremental incremental, FT_UInt glyph_index, FT_Bool vertical, FT_Incremental_MetricsRec *ametrics ); A function used to retrieve the basic metrics of a given glyph index before accessing its data. This is necessary because, in certain formats like TrueType, the metrics are stored in a different place from the glyph images proper. input incremental A handle to an opaque FT_Incremental handle provided by the client application. glyph_index Index of relevant glyph. vertical If true, return vertical metrics. ametrics This parameter is used for both input and output. The original glyph metrics, if any, in font units. If metrics are not available all the values must be set to zero. output ametrics The replacement glyph metrics in font units. FT_Incremental_FuncsRec \u00b6 Defined in FT_INCREMENTAL_H (freetype/ftincrem.h). typedef struct FT_Incremental_FuncsRec_ { FT_Incremental_GetGlyphDataFunc get_glyph_data; FT_Incremental_FreeGlyphDataFunc free_glyph_data; FT_Incremental_GetGlyphMetricsFunc get_glyph_metrics; } FT_Incremental_FuncsRec ; A table of functions for accessing fonts that load data incrementally. Used in FT_Incremental_InterfaceRec . fields get_glyph_data The function to get glyph data. Must not be null. free_glyph_data The function to release glyph data. Must not be null. get_glyph_metrics The function to get glyph metrics. May be null if the font does not provide overriding glyph metrics. FT_Incremental_InterfaceRec \u00b6 Defined in FT_INCREMENTAL_H (freetype/ftincrem.h). typedef struct FT_Incremental_InterfaceRec_ { const FT_Incremental_FuncsRec * funcs; FT_Incremental object; } FT_Incremental_InterfaceRec ; A structure to be used with FT_Open_Face to indicate that the user wants to support incremental glyph loading. You should use it with FT_PARAM_TAG_INCREMENTAL as in the following example: FT_Incremental_InterfaceRec inc_int; FT_Parameter parameter; FT_Open_Args open_args; // set up incremental descriptor inc_int.funcs = my_funcs; inc_int.object = my_object; // set up optional parameter parameter.tag = FT_PARAM_TAG_INCREMENTAL; parameter.data = &inc_int; // set up FT_Open_Args structure open_args.flags = FT_OPEN_PATHNAME | FT_OPEN_PARAMS; open_args.pathname = my_font_pathname; open_args.num_params = 1; open_args.params = &parameter; // we use one optional argument // open the font error = FT_Open_Face( library, &open_args, index, &face ); ... FT_Incremental_Interface \u00b6 Defined in FT_INCREMENTAL_H (freetype/ftincrem.h). typedef FT_Incremental_InterfaceRec * FT_Incremental_Interface ; A pointer to an FT_Incremental_InterfaceRec structure.","title":"Incremental Loading"},{"location":"ft2-incremental.html#incremental-loading","text":"","title":"Incremental Loading"},{"location":"ft2-incremental.html#synopsis","text":"This section contains various functions used to perform so-called \u2018incremental\u2019 glyph loading. This is a mode where all glyphs loaded from a given FT_Face are provided by the client application. Apart from that, all other tables are loaded normally from the font file. This mode is useful when FreeType is used within another engine, e.g., a PostScript Imaging Processor. To enable this mode, you must use FT_Open_Face , passing an FT_Parameter with the FT_PARAM_TAG_INCREMENTAL tag and an FT_Incremental_Interface value. See the comments for FT_Incremental_InterfaceRec for an example.","title":"Synopsis"},{"location":"ft2-incremental.html#ft_incremental","text":"Defined in FT_INCREMENTAL_H (freetype/ftincrem.h). typedef struct FT_IncrementalRec_* FT_Incremental ; An opaque type describing a user-provided object used to implement \u2018incremental\u2019 glyph loading within FreeType. This is used to support embedded fonts in certain environments (e.g., PostScript interpreters), where the glyph data isn't in the font file, or must be overridden by different values.","title":"FT_Incremental"},{"location":"ft2-incremental.html#ft_incremental_metricsrec","text":"Defined in FT_INCREMENTAL_H (freetype/ftincrem.h). typedef struct FT_Incremental_MetricsRec_ { FT_Long bearing_x; FT_Long bearing_y; FT_Long advance; FT_Long advance_v; /* since 2.3.12 */ } FT_Incremental_MetricsRec ; A small structure used to contain the basic glyph metrics returned by the FT_Incremental_GetGlyphMetricsFunc method.","title":"FT_Incremental_MetricsRec"},{"location":"ft2-incremental.html#ft_incremental_metrics","text":"Defined in FT_INCREMENTAL_H (freetype/ftincrem.h). typedef struct FT_Incremental_MetricsRec_* FT_Incremental_Metrics ; A handle to an FT_Incremental_MetricsRec structure.","title":"FT_Incremental_Metrics"},{"location":"ft2-incremental.html#ft_incremental_getglyphdatafunc","text":"Defined in FT_INCREMENTAL_H (freetype/ftincrem.h). typedef FT_Error (* FT_Incremental_GetGlyphDataFunc )( FT_Incremental incremental, FT_UInt glyph_index, FT_Data * adata ); A function called by FreeType to access a given glyph's data bytes during FT_Load_Glyph or FT_Load_Char if incremental loading is enabled. Note that the format of the glyph's data bytes depends on the font file format. For TrueType, it must correspond to the raw bytes within the \u2018glyf\u2019 table. For PostScript formats, it must correspond to the unencrypted charstring bytes, without any lenIV header. It is undefined for any other format.","title":"FT_Incremental_GetGlyphDataFunc"},{"location":"ft2-incremental.html#ft_incremental_freeglyphdatafunc","text":"Defined in FT_INCREMENTAL_H (freetype/ftincrem.h). typedef void (* FT_Incremental_FreeGlyphDataFunc )( FT_Incremental incremental, FT_Data * data ); A function used to release the glyph data bytes returned by a successful call to FT_Incremental_GetGlyphDataFunc .","title":"FT_Incremental_FreeGlyphDataFunc"},{"location":"ft2-incremental.html#ft_incremental_getglyphmetricsfunc","text":"Defined in FT_INCREMENTAL_H (freetype/ftincrem.h). typedef FT_Error (* FT_Incremental_GetGlyphMetricsFunc ) ( FT_Incremental incremental, FT_UInt glyph_index, FT_Bool vertical, FT_Incremental_MetricsRec *ametrics ); A function used to retrieve the basic metrics of a given glyph index before accessing its data. This is necessary because, in certain formats like TrueType, the metrics are stored in a different place from the glyph images proper.","title":"FT_Incremental_GetGlyphMetricsFunc"},{"location":"ft2-incremental.html#ft_incremental_funcsrec","text":"Defined in FT_INCREMENTAL_H (freetype/ftincrem.h). typedef struct FT_Incremental_FuncsRec_ { FT_Incremental_GetGlyphDataFunc get_glyph_data; FT_Incremental_FreeGlyphDataFunc free_glyph_data; FT_Incremental_GetGlyphMetricsFunc get_glyph_metrics; } FT_Incremental_FuncsRec ; A table of functions for accessing fonts that load data incrementally. Used in FT_Incremental_InterfaceRec .","title":"FT_Incremental_FuncsRec"},{"location":"ft2-incremental.html#ft_incremental_interfacerec","text":"Defined in FT_INCREMENTAL_H (freetype/ftincrem.h). typedef struct FT_Incremental_InterfaceRec_ { const FT_Incremental_FuncsRec * funcs; FT_Incremental object; } FT_Incremental_InterfaceRec ; A structure to be used with FT_Open_Face to indicate that the user wants to support incremental glyph loading. You should use it with FT_PARAM_TAG_INCREMENTAL as in the following example: FT_Incremental_InterfaceRec inc_int; FT_Parameter parameter; FT_Open_Args open_args; // set up incremental descriptor inc_int.funcs = my_funcs; inc_int.object = my_object; // set up optional parameter parameter.tag = FT_PARAM_TAG_INCREMENTAL; parameter.data = &inc_int; // set up FT_Open_Args structure open_args.flags = FT_OPEN_PATHNAME | FT_OPEN_PARAMS; open_args.pathname = my_font_pathname; open_args.num_params = 1; open_args.params = &parameter; // we use one optional argument // open the font error = FT_Open_Face( library, &open_args, index, &face ); ...","title":"FT_Incremental_InterfaceRec"},{"location":"ft2-incremental.html#ft_incremental_interface","text":"Defined in FT_INCREMENTAL_H (freetype/ftincrem.h). typedef FT_Incremental_InterfaceRec * FT_Incremental_Interface ; A pointer to an FT_Incremental_InterfaceRec structure.","title":"FT_Incremental_Interface"},{"location":"ft2-index.html","text":"FreeType \u00bb Docs \u00bb Global Index FreeType-2.10.4 API Reference \u00b6 B \u00b6 BDF_Property BDF_PROPERTY_TYPE_ATOM BDF_PROPERTY_TYPE_CARDINAL BDF_PROPERTY_TYPE_INTEGER BDF_PROPERTY_TYPE_NONE BDF_PropertyRec BDF_PropertyType C \u00b6 CID_FaceDict CID_FaceDictRec CID_FaceInfo CID_FaceInfoRec CID_FontDict CID_Info D \u00b6 darkening-parameters default-script F \u00b6 fallback-script FREETYPE_MAJOR FREETYPE_MINOR FREETYPE_PATCH FREETYPE_XXX FT_Activate_Size FT_Add_Default_Modules FT_Add_Module FT_ADVANCE_FLAG_FAST_ONLY FT_ADVANCES_H FT_Alloc_Func FT_Angle FT_ANGLE_2PI FT_Angle_Diff FT_ANGLE_PI FT_ANGLE_PI2 FT_ANGLE_PI4 FT_Atan2 FT_Attach_File FT_Attach_Stream FT_AUTOHINTER_H FT_AUTOHINTER_SCRIPT_CJK FT_AUTOHINTER_SCRIPT_INDIC FT_AUTOHINTER_SCRIPT_LATIN FT_AUTOHINTER_SCRIPT_NONE FT_AUTOHINTER_SCRIPT_XXX FT_BBox FT_BBOX_H FT_BDF_H FT_Bitmap FT_Bitmap_Blend FT_Bitmap_Convert FT_Bitmap_Copy FT_Bitmap_Done FT_Bitmap_Embolden FT_BITMAP_H FT_Bitmap_Init FT_Bitmap_Size FT_BitmapGlyph FT_BitmapGlyphRec FT_Bool FT_Byte FT_Bytes FT_BZIP2_H FT_CACHE_H FT_CeilFix FT_CFF_DRIVER_H FT_Char FT_CharMap FT_CharMapRec FT_CID_H FT_ClassicKern_Free FT_ClassicKern_Validate FT_Color FT_COLOR_H FT_CONFIG_CONFIG_H FT_CONFIG_MODULES_H FT_CONFIG_OPTIONS_H FT_CONFIG_STANDARD_LIBRARY_H FT_Cos FT_Data FT_DEBUG_HOOK_TRUETYPE FT_DEBUG_HOOK_XXX FT_DebugHook_Func FT_DivFix FT_Done_Face FT_Done_FreeType FT_Done_Glyph FT_Done_Library FT_Done_MM_Var FT_Done_Size FT_Driver FT_DRIVER_H FT_ENC_TAG FT_Encoding FT_ENCODING_ADOBE_CUSTOM FT_ENCODING_ADOBE_EXPERT FT_ENCODING_ADOBE_LATIN_1 FT_ENCODING_ADOBE_STANDARD FT_ENCODING_APPLE_ROMAN FT_ENCODING_BIG5 FT_ENCODING_JOHAB FT_ENCODING_MS_BIG5 FT_ENCODING_MS_GB2312 FT_ENCODING_MS_JOHAB FT_ENCODING_MS_SJIS FT_ENCODING_MS_SYMBOL FT_ENCODING_MS_WANSUNG FT_ENCODING_NONE FT_ENCODING_OLD_LATIN_2 FT_ENCODING_PRC FT_ENCODING_SJIS FT_ENCODING_UNICODE FT_ENCODING_WANSUNG FT_Err_XXX FT_Error FT_Error_String FT_ERRORS_H FT_F26Dot6 FT_F2Dot14 FT_Face FT_Face_CheckTrueTypePatents FT_FACE_FLAG_CID_KEYED FT_FACE_FLAG_COLOR FT_FACE_FLAG_EXTERNAL_STREAM FT_FACE_FLAG_FAST_GLYPHS FT_FACE_FLAG_FIXED_SIZES FT_FACE_FLAG_FIXED_WIDTH FT_FACE_FLAG_GLYPH_NAMES FT_FACE_FLAG_HINTER FT_FACE_FLAG_HORIZONTAL FT_FACE_FLAG_KERNING FT_FACE_FLAG_MULTIPLE_MASTERS FT_FACE_FLAG_SCALABLE FT_FACE_FLAG_SFNT FT_FACE_FLAG_TRICKY FT_FACE_FLAG_VARIATION FT_FACE_FLAG_VERTICAL FT_FACE_FLAG_XXX FT_Face_GetCharsOfVariant FT_Face_GetCharVariantIndex FT_Face_GetCharVariantIsDefault FT_Face_GetVariantSelectors FT_Face_GetVariantsOfChar FT_Face_Internal FT_Face_Properties FT_Face_SetUnpatentedHinting FT_FaceRec FT_Fixed FT_FloorFix FT_FONT_FORMATS_H FT_Free_Func FT_FREETYPE_H FT_FSTYPE_BITMAP_EMBEDDING_ONLY FT_FSTYPE_EDITABLE_EMBEDDING FT_FSTYPE_INSTALLABLE_EMBEDDING FT_FSTYPE_NO_SUBSETTING FT_FSTYPE_PREVIEW_AND_PRINT_EMBEDDING FT_FSTYPE_RESTRICTED_LICENSE_EMBEDDING FT_FSTYPE_XXX FT_FWord FT_GASP_DO_GRAY FT_GASP_DO_GRIDFIT FT_GASP_H FT_GASP_NO_TABLE FT_GASP_SYMMETRIC_GRIDFIT FT_GASP_SYMMETRIC_SMOOTHING FT_GASP_XXX FT_Generic FT_Generic_Finalizer FT_Get_Advance FT_Get_Advances FT_Get_BDF_Charset_ID FT_Get_BDF_Property FT_Get_Char_Index FT_Get_Charmap_Index FT_Get_CID_From_Glyph_Index FT_Get_CID_Is_Internally_CID_Keyed FT_Get_CID_Registry_Ordering_Supplement FT_Get_CMap_Format FT_Get_CMap_Language_ID FT_Get_Color_Glyph_Layer FT_Get_First_Char FT_Get_Font_Format FT_Get_FSType_Flags FT_Get_Gasp FT_Get_Glyph FT_Get_Glyph_Name FT_Get_Kerning FT_Get_MM_Blend_Coordinates FT_Get_MM_Var FT_Get_MM_WeightVector FT_Get_Module FT_Get_Multi_Master FT_Get_Name_Index FT_Get_Next_Char FT_Get_PFR_Advance FT_Get_PFR_Kerning FT_Get_PFR_Metrics FT_Get_Postscript_Name FT_Get_PS_Font_Info FT_Get_PS_Font_Private FT_Get_PS_Font_Value FT_Get_Renderer FT_Get_Sfnt_LangTag FT_Get_Sfnt_Name FT_Get_Sfnt_Name_Count FT_Get_Sfnt_Table FT_Get_SubGlyph_Info FT_Get_Track_Kerning FT_Get_TrueType_Engine_Type FT_Get_Var_Axis_Flags FT_Get_Var_Blend_Coordinates FT_Get_Var_Design_Coordinates FT_Get_WinFNT_Header FT_GetFile_From_Mac_ATS_Name FT_GetFile_From_Mac_Name FT_GetFilePath_From_Mac_ATS_Name FT_Glyph FT_GLYPH_BBOX_GRIDFIT FT_Glyph_BBox_Mode FT_GLYPH_BBOX_PIXELS FT_GLYPH_BBOX_SUBPIXELS FT_GLYPH_BBOX_TRUNCATE FT_GLYPH_BBOX_UNSCALED FT_Glyph_Copy FT_Glyph_Format FT_GLYPH_FORMAT_BITMAP FT_GLYPH_FORMAT_COMPOSITE FT_GLYPH_FORMAT_NONE FT_GLYPH_FORMAT_OUTLINE FT_GLYPH_FORMAT_PLOTTER FT_Glyph_Get_CBox FT_GLYPH_H FT_Glyph_Metrics FT_Glyph_Stroke FT_Glyph_StrokeBorder FT_Glyph_To_Bitmap FT_Glyph_Transform FT_GlyphRec FT_GlyphSlot FT_GlyphSlot_Own_Bitmap FT_GlyphSlotRec FT_GX_VALIDATE_H FT_GZIP_H FT_Gzip_Uncompress FT_HAS_COLOR FT_HAS_FAST_GLYPHS FT_HAS_FIXED_SIZES FT_HAS_GLYPH_NAMES FT_HAS_HORIZONTAL FT_HAS_KERNING FT_HAS_MULTIPLE_MASTERS FT_Has_PS_Glyph_Names FT_HAS_VERTICAL FT_HINTING_ADOBE FT_HINTING_FREETYPE FT_HINTING_XXX FT_IMAGE_H FT_IMAGE_TAG FT_Incremental FT_Incremental_FreeGlyphDataFunc FT_Incremental_FuncsRec FT_Incremental_GetGlyphDataFunc FT_Incremental_GetGlyphMetricsFunc FT_INCREMENTAL_H FT_Incremental_Interface FT_Incremental_InterfaceRec FT_Incremental_Metrics FT_Incremental_MetricsRec FT_Init_FreeType FT_Int FT_Int16 FT_Int32 FT_Int64 FT_IS_CID_KEYED FT_IS_FIXED_WIDTH FT_IS_NAMED_INSTANCE FT_IS_SCALABLE FT_IS_SFNT FT_IS_TRICKY FT_IS_VARIATION FT_KERNING_DEFAULT FT_Kerning_Mode FT_KERNING_UNFITTED FT_KERNING_UNSCALED FT_LayerIterator FT_LCD_FILTER_DEFAULT FT_LCD_FILTER_H FT_LCD_FILTER_LEGACY FT_LCD_FILTER_LEGACY1 FT_LCD_FILTER_LIGHT FT_LCD_FILTER_NONE FT_LcdFilter FT_LcdFiveTapFilter FT_Library FT_Library_SetLcdFilter FT_Library_SetLcdFilterWeights FT_Library_SetLcdGeometry FT_Library_Version FT_List FT_List_Add FT_List_Destructor FT_List_Finalize FT_List_Find FT_LIST_H FT_List_Insert FT_List_Iterate FT_List_Iterator FT_List_Remove FT_List_Up FT_ListNode FT_ListNodeRec FT_ListRec FT_LOAD_BITMAP_METRICS_ONLY FT_Load_Char FT_LOAD_COLOR FT_LOAD_COMPUTE_METRICS FT_LOAD_CROP_BITMAP FT_LOAD_DEFAULT FT_LOAD_FORCE_AUTOHINT FT_Load_Glyph FT_LOAD_IGNORE_GLOBAL_ADVANCE_WIDTH FT_LOAD_IGNORE_TRANSFORM FT_LOAD_LINEAR_DESIGN FT_LOAD_MONOCHROME FT_LOAD_NO_AUTOHINT FT_LOAD_NO_BITMAP FT_LOAD_NO_HINTING FT_LOAD_NO_RECURSE FT_LOAD_NO_SCALE FT_LOAD_PEDANTIC FT_LOAD_RENDER FT_Load_Sfnt_Table FT_LOAD_TARGET_LCD FT_LOAD_TARGET_LCD_V FT_LOAD_TARGET_LIGHT FT_LOAD_TARGET_MODE FT_LOAD_TARGET_MONO FT_LOAD_TARGET_NORMAL FT_LOAD_TARGET_XXX FT_LOAD_VERTICAL_LAYOUT FT_LOAD_XXX FT_Long FT_LZW_H FT_MAC_H FT_MAKE_TAG FT_Matrix FT_Matrix_Invert FT_Matrix_Multiply FT_Memory FT_MemoryRec FT_MM_Axis FT_MM_Var FT_Module FT_Module_Class FT_Module_Constructor FT_Module_Destructor FT_MODULE_ERRORS_H FT_MODULE_H FT_Module_Requester FT_MulDiv FT_MulFix FT_Multi_Master FT_MULTIPLE_MASTERS_H FT_New_Face FT_New_Face_From_FOND FT_New_Face_From_FSRef FT_New_Face_From_FSSpec FT_New_Glyph FT_New_Library FT_New_Memory_Face FT_New_Size FT_Offset FT_Open_Args FT_OPEN_DRIVER FT_Open_Face FT_OPEN_MEMORY FT_OPEN_PARAMS FT_OPEN_PATHNAME FT_OPEN_STREAM FT_OPEN_XXX FT_OpenType_Free FT_OpenType_Validate FT_OPENTYPE_VALIDATE_H FT_Orientation FT_ORIENTATION_FILL_LEFT FT_ORIENTATION_FILL_RIGHT FT_ORIENTATION_NONE FT_ORIENTATION_POSTSCRIPT FT_ORIENTATION_TRUETYPE FT_Outline FT_Outline_Check FT_Outline_ConicToFunc FT_Outline_Copy FT_Outline_CubicToFunc FT_Outline_Decompose FT_Outline_Done FT_Outline_Embolden FT_Outline_EmboldenXY FT_OUTLINE_EVEN_ODD_FILL FT_Outline_Funcs FT_Outline_Get_BBox FT_Outline_Get_Bitmap FT_Outline_Get_CBox FT_Outline_Get_Orientation FT_Outline_GetInsideBorder FT_Outline_GetOutsideBorder FT_OUTLINE_H FT_OUTLINE_HIGH_PRECISION FT_OUTLINE_IGNORE_DROPOUTS FT_OUTLINE_INCLUDE_STUBS FT_Outline_LineToFunc FT_Outline_MoveToFunc FT_Outline_New FT_OUTLINE_NONE FT_OUTLINE_OVERLAP FT_OUTLINE_OWNER FT_Outline_Render FT_Outline_Reverse FT_OUTLINE_REVERSE_FILL FT_OUTLINE_SINGLE_PASS FT_OUTLINE_SMART_DROPOUTS FT_Outline_Transform FT_Outline_Translate FT_OUTLINE_XXX FT_OutlineGlyph FT_OutlineGlyphRec FT_Palette_Data FT_Palette_Data_Get FT_PALETTE_FOR_DARK_BACKGROUND FT_PALETTE_FOR_LIGHT_BACKGROUND FT_Palette_Select FT_Palette_Set_Foreground_Color FT_PALETTE_XXX FT_PARAM_TAG_IGNORE_TYPOGRAPHIC_FAMILY FT_PARAM_TAG_IGNORE_TYPOGRAPHIC_SUBFAMILY FT_PARAM_TAG_INCREMENTAL FT_PARAM_TAG_LCD_FILTER_WEIGHTS FT_PARAM_TAG_RANDOM_SEED FT_PARAM_TAG_STEM_DARKENING FT_PARAM_TAG_UNPATENTED_HINTING FT_Parameter FT_PCF_DRIVER_H FT_PFR_H FT_Pixel_Mode FT_PIXEL_MODE_BGRA FT_PIXEL_MODE_GRAY FT_PIXEL_MODE_GRAY2 FT_PIXEL_MODE_GRAY4 FT_PIXEL_MODE_LCD FT_PIXEL_MODE_LCD_V FT_PIXEL_MODE_MONO FT_PIXEL_MODE_NONE FT_Pointer FT_Pos FT_Prop_GlyphToScriptMap FT_Prop_IncreaseXHeight FT_Property_Get FT_Property_Set FT_PtrDist FT_Raster FT_Raster_BitSet_Func FT_Raster_BitTest_Func FT_Raster_DoneFunc FT_RASTER_FLAG_AA FT_RASTER_FLAG_CLIP FT_RASTER_FLAG_DEFAULT FT_RASTER_FLAG_DIRECT FT_RASTER_FLAG_XXX FT_Raster_Funcs FT_Raster_NewFunc FT_Raster_Params FT_Raster_RenderFunc FT_Raster_ResetFunc FT_Raster_SetModeFunc FT_Realloc_Func FT_Reference_Face FT_Reference_Library FT_Remove_Module FT_Render_Glyph FT_RENDER_H FT_Render_Mode FT_RENDER_MODE_LCD FT_RENDER_MODE_LCD_V FT_RENDER_MODE_LIGHT FT_RENDER_MODE_MONO FT_RENDER_MODE_NORMAL FT_Renderer FT_Renderer_Class FT_Request_Size FT_RoundFix FT_Select_Charmap FT_Select_Size FT_Set_Char_Size FT_Set_Charmap FT_Set_Debug_Hook FT_Set_Default_Properties FT_Set_MM_Blend_Coordinates FT_Set_MM_Design_Coordinates FT_Set_MM_WeightVector FT_Set_Named_Instance FT_Set_Pixel_Sizes FT_Set_Renderer FT_Set_Transform FT_Set_Var_Blend_Coordinates FT_Set_Var_Design_Coordinates FT_SFNT_HEAD FT_SFNT_HHEA FT_SFNT_MAXP FT_SFNT_NAMES_H FT_SFNT_OS2 FT_SFNT_PCLT FT_SFNT_POST FT_Sfnt_Table_Info FT_Sfnt_Tag FT_SFNT_VHEA FT_SfntLangTag FT_SfntName FT_Short FT_Sin FT_Size FT_Size_Internal FT_Size_Metrics FT_Size_Request FT_Size_Request_Type FT_SIZE_REQUEST_TYPE_BBOX FT_SIZE_REQUEST_TYPE_CELL FT_SIZE_REQUEST_TYPE_NOMINAL FT_SIZE_REQUEST_TYPE_REAL_DIM FT_SIZE_REQUEST_TYPE_SCALES FT_Size_RequestRec FT_SizeRec FT_SIZES_H FT_Slot_Internal FT_Span FT_SpanFunc FT_Stream FT_Stream_CloseFunc FT_Stream_IoFunc FT_Stream_OpenBzip2 FT_Stream_OpenGzip FT_Stream_OpenLZW FT_StreamDesc FT_StreamRec FT_String FT_Stroker FT_Stroker_BeginSubPath FT_STROKER_BORDER_LEFT FT_STROKER_BORDER_RIGHT FT_Stroker_ConicTo FT_Stroker_CubicTo FT_Stroker_Done FT_Stroker_EndSubPath FT_Stroker_Export FT_Stroker_ExportBorder FT_Stroker_GetBorderCounts FT_Stroker_GetCounts FT_STROKER_H FT_Stroker_LineCap FT_STROKER_LINECAP_BUTT FT_STROKER_LINECAP_ROUND FT_STROKER_LINECAP_SQUARE FT_Stroker_LineJoin FT_STROKER_LINEJOIN_BEVEL FT_STROKER_LINEJOIN_MITER FT_STROKER_LINEJOIN_MITER_FIXED FT_STROKER_LINEJOIN_MITER_VARIABLE FT_STROKER_LINEJOIN_ROUND FT_Stroker_LineTo FT_Stroker_New FT_Stroker_ParseOutline FT_Stroker_Rewind FT_Stroker_Set FT_StrokerBorder FT_STYLE_FLAG_BOLD FT_STYLE_FLAG_ITALIC FT_STYLE_FLAG_XXX FT_SubGlyph FT_SUBGLYPH_FLAG_2X2 FT_SUBGLYPH_FLAG_ARGS_ARE_WORDS FT_SUBGLYPH_FLAG_ARGS_ARE_XY_VALUES FT_SUBGLYPH_FLAG_ROUND_XY_TO_GRID FT_SUBGLYPH_FLAG_SCALE FT_SUBGLYPH_FLAG_USE_MY_METRICS FT_SUBGLYPH_FLAG_XXX FT_SUBGLYPH_FLAG_XY_SCALE FT_SYNTHESIS_H FT_SYSTEM_H FT_Tag FT_Tan FT_TRIGONOMETRY_H FT_TRUETYPE_DRIVER_H FT_TRUETYPE_ENGINE_TYPE_NONE FT_TRUETYPE_ENGINE_TYPE_PATENTED FT_TRUETYPE_ENGINE_TYPE_UNPATENTED FT_TRUETYPE_IDS_H FT_TRUETYPE_TABLES_H FT_TRUETYPE_TAGS_H FT_TrueTypeEngineType FT_TrueTypeGX_Free FT_TrueTypeGX_Validate FT_TYPE1_TABLES_H FT_TYPES_H FT_UFWord FT_UInt FT_UInt16 FT_UInt32 FT_UInt64 FT_ULong FT_UnitVector FT_UShort FT_VALIDATE_APPLE FT_VALIDATE_BASE FT_VALIDATE_bsln FT_VALIDATE_CKERN FT_VALIDATE_CKERNXXX FT_VALIDATE_feat FT_VALIDATE_GDEF FT_VALIDATE_GPOS FT_VALIDATE_GSUB FT_VALIDATE_GX FT_VALIDATE_GX_LENGTH FT_VALIDATE_GXXXX FT_VALIDATE_JSTF FT_VALIDATE_just FT_VALIDATE_kern FT_VALIDATE_lcar FT_VALIDATE_MATH FT_VALIDATE_mort FT_VALIDATE_morx FT_VALIDATE_MS FT_VALIDATE_opbd FT_VALIDATE_OT FT_VALIDATE_OTXXX FT_VALIDATE_prop FT_VALIDATE_trak FT_Var_Axis FT_VAR_AXIS_FLAG_HIDDEN FT_VAR_AXIS_FLAG_XXX FT_Var_Named_Style FT_Vector FT_Vector_From_Polar FT_Vector_Length FT_Vector_Polarize FT_Vector_Rotate FT_Vector_Transform FT_Vector_Unit FT_WinFNT_Header FT_WinFNT_HeaderRec FT_WinFNT_ID_CP1250 FT_WinFNT_ID_CP1251 FT_WinFNT_ID_CP1252 FT_WinFNT_ID_CP1253 FT_WinFNT_ID_CP1254 FT_WinFNT_ID_CP1255 FT_WinFNT_ID_CP1256 FT_WinFNT_ID_CP1257 FT_WinFNT_ID_CP1258 FT_WinFNT_ID_CP1361 FT_WinFNT_ID_CP874 FT_WinFNT_ID_CP932 FT_WinFNT_ID_CP936 FT_WinFNT_ID_CP949 FT_WinFNT_ID_CP950 FT_WinFNT_ID_DEFAULT FT_WinFNT_ID_MAC FT_WinFNT_ID_OEM FT_WinFNT_ID_SYMBOL FT_WinFNT_ID_XXX FT_WINFONTS_H FTC_CMapCache FTC_CMapCache_Lookup FTC_CMapCache_New FTC_Face_Requester FTC_FaceID FTC_ImageCache FTC_ImageCache_Lookup FTC_ImageCache_LookupScaler FTC_ImageCache_New FTC_ImageType FTC_ImageTypeRec FTC_Manager FTC_Manager_Done FTC_Manager_LookupFace FTC_Manager_LookupSize FTC_Manager_New FTC_Manager_RemoveFaceID FTC_Manager_Reset FTC_Node FTC_Node_Unref FTC_SBit FTC_SBitCache FTC_SBitCache_Lookup FTC_SBitCache_LookupScaler FTC_SBitCache_New FTC_SBitRec FTC_Scaler FTC_ScalerRec G \u00b6 glyph-to-script-map H \u00b6 hinting-engine I \u00b6 increase-x-height interpreter-version N \u00b6 no-long-family-names no-stem-darkening P \u00b6 PS_DICT_BLUE_FUZZ PS_DICT_BLUE_SCALE PS_DICT_BLUE_SHIFT PS_DICT_BLUE_VALUE PS_DICT_CHAR_STRING PS_DICT_CHAR_STRING_KEY PS_DICT_ENCODING_ENTRY PS_DICT_ENCODING_TYPE PS_DICT_FAMILY_BLUE PS_DICT_FAMILY_NAME PS_DICT_FAMILY_OTHER_BLUE PS_DICT_FONT_BBOX PS_DICT_FONT_MATRIX PS_DICT_FONT_NAME PS_DICT_FONT_TYPE PS_DICT_FORCE_BOLD PS_DICT_FS_TYPE PS_DICT_FULL_NAME PS_DICT_IS_FIXED_PITCH PS_DICT_ITALIC_ANGLE PS_Dict_Keys PS_DICT_LANGUAGE_GROUP PS_DICT_LEN_IV PS_DICT_MIN_FEATURE PS_DICT_NOTICE PS_DICT_NUM_BLUE_VALUES PS_DICT_NUM_CHAR_STRINGS PS_DICT_NUM_FAMILY_BLUES PS_DICT_NUM_FAMILY_OTHER_BLUES PS_DICT_NUM_OTHER_BLUES PS_DICT_NUM_STEM_SNAP_H PS_DICT_NUM_STEM_SNAP_V PS_DICT_NUM_SUBRS PS_DICT_OTHER_BLUE PS_DICT_PAINT_TYPE PS_DICT_PASSWORD PS_DICT_RND_STEM_UP PS_DICT_STD_HW PS_DICT_STD_VW PS_DICT_STEM_SNAP_H PS_DICT_STEM_SNAP_V PS_DICT_SUBR PS_DICT_UNDERLINE_POSITION PS_DICT_UNDERLINE_THICKNESS PS_DICT_UNIQUE_ID PS_DICT_VERSION PS_DICT_WEIGHT PS_FontInfo PS_FontInfoRec PS_Private PS_PrivateRec R \u00b6 random-seed T \u00b6 T1_BLEND_BLUE_SCALE T1_BLEND_BLUE_SHIFT T1_BLEND_BLUE_VALUES T1_BLEND_FAMILY_BLUES T1_BLEND_FAMILY_OTHER_BLUES T1_Blend_Flags T1_BLEND_FORCE_BOLD T1_BLEND_ITALIC_ANGLE T1_BLEND_OTHER_BLUES T1_BLEND_STANDARD_HEIGHT T1_BLEND_STANDARD_WIDTH T1_BLEND_STEM_SNAP_HEIGHTS T1_BLEND_STEM_SNAP_WIDTHS T1_BLEND_UNDERLINE_POSITION T1_BLEND_UNDERLINE_THICKNESS T1_ENCODING_TYPE_ARRAY T1_ENCODING_TYPE_EXPERT T1_ENCODING_TYPE_ISOLATIN1 T1_ENCODING_TYPE_NONE T1_ENCODING_TYPE_STANDARD T1_EncodingType T1_FontInfo T1_Private TT_ADOBE_ID_CUSTOM TT_ADOBE_ID_EXPERT TT_ADOBE_ID_LATIN_1 TT_ADOBE_ID_STANDARD TT_ADOBE_ID_XXX TT_APPLE_ID_DEFAULT TT_APPLE_ID_FULL_UNICODE TT_APPLE_ID_ISO_10646 TT_APPLE_ID_UNICODE_1_1 TT_APPLE_ID_UNICODE_2_0 TT_APPLE_ID_UNICODE_32 TT_APPLE_ID_VARIANT_SELECTOR TT_APPLE_ID_XXX TT_Header TT_HoriHeader TT_INTERPRETER_VERSION_35 TT_INTERPRETER_VERSION_38 TT_INTERPRETER_VERSION_40 TT_INTERPRETER_VERSION_XXX TT_ISO_ID_10646 TT_ISO_ID_7BIT_ASCII TT_ISO_ID_8859_1 TT_ISO_ID_XXX TT_MAC_ID_XXX TT_MAC_LANGID_XXX TT_MaxProfile TT_MS_ID_BIG_5 TT_MS_ID_JOHAB TT_MS_ID_PRC TT_MS_ID_SJIS TT_MS_ID_SYMBOL_CS TT_MS_ID_UCS_4 TT_MS_ID_UNICODE_CS TT_MS_ID_WANSUNG TT_MS_ID_XXX TT_MS_LANGID_XXX TT_NAME_ID_XXX TT_OS2 TT_PCLT TT_PLATFORM_ADOBE TT_PLATFORM_APPLE_UNICODE TT_PLATFORM_CUSTOM TT_PLATFORM_ISO TT_PLATFORM_MACINTOSH TT_PLATFORM_MICROSOFT TT_PLATFORM_XXX TT_Postscript TT_UCR_XXX TT_VertHeader W \u00b6 warping generated on Tue Oct 20 05:14:52 2020 UTC","title":"Index"},{"location":"ft2-index.html#freetype-2104-api-reference","text":"","title":"FreeType-2.10.4 API Reference"},{"location":"ft2-index.html#b","text":"BDF_Property BDF_PROPERTY_TYPE_ATOM BDF_PROPERTY_TYPE_CARDINAL BDF_PROPERTY_TYPE_INTEGER BDF_PROPERTY_TYPE_NONE BDF_PropertyRec BDF_PropertyType","title":"B"},{"location":"ft2-index.html#c","text":"CID_FaceDict CID_FaceDictRec CID_FaceInfo CID_FaceInfoRec CID_FontDict CID_Info","title":"C"},{"location":"ft2-index.html#d","text":"darkening-parameters default-script","title":"D"},{"location":"ft2-index.html#f","text":"fallback-script FREETYPE_MAJOR FREETYPE_MINOR FREETYPE_PATCH FREETYPE_XXX FT_Activate_Size FT_Add_Default_Modules FT_Add_Module FT_ADVANCE_FLAG_FAST_ONLY FT_ADVANCES_H FT_Alloc_Func FT_Angle FT_ANGLE_2PI FT_Angle_Diff FT_ANGLE_PI FT_ANGLE_PI2 FT_ANGLE_PI4 FT_Atan2 FT_Attach_File FT_Attach_Stream FT_AUTOHINTER_H FT_AUTOHINTER_SCRIPT_CJK FT_AUTOHINTER_SCRIPT_INDIC FT_AUTOHINTER_SCRIPT_LATIN FT_AUTOHINTER_SCRIPT_NONE FT_AUTOHINTER_SCRIPT_XXX FT_BBox FT_BBOX_H FT_BDF_H FT_Bitmap FT_Bitmap_Blend FT_Bitmap_Convert FT_Bitmap_Copy FT_Bitmap_Done FT_Bitmap_Embolden FT_BITMAP_H FT_Bitmap_Init FT_Bitmap_Size FT_BitmapGlyph FT_BitmapGlyphRec FT_Bool FT_Byte FT_Bytes FT_BZIP2_H FT_CACHE_H FT_CeilFix FT_CFF_DRIVER_H FT_Char FT_CharMap FT_CharMapRec FT_CID_H FT_ClassicKern_Free FT_ClassicKern_Validate FT_Color FT_COLOR_H FT_CONFIG_CONFIG_H FT_CONFIG_MODULES_H FT_CONFIG_OPTIONS_H FT_CONFIG_STANDARD_LIBRARY_H FT_Cos FT_Data FT_DEBUG_HOOK_TRUETYPE FT_DEBUG_HOOK_XXX FT_DebugHook_Func FT_DivFix FT_Done_Face FT_Done_FreeType FT_Done_Glyph FT_Done_Library FT_Done_MM_Var FT_Done_Size FT_Driver FT_DRIVER_H FT_ENC_TAG FT_Encoding FT_ENCODING_ADOBE_CUSTOM FT_ENCODING_ADOBE_EXPERT FT_ENCODING_ADOBE_LATIN_1 FT_ENCODING_ADOBE_STANDARD FT_ENCODING_APPLE_ROMAN FT_ENCODING_BIG5 FT_ENCODING_JOHAB FT_ENCODING_MS_BIG5 FT_ENCODING_MS_GB2312 FT_ENCODING_MS_JOHAB FT_ENCODING_MS_SJIS FT_ENCODING_MS_SYMBOL FT_ENCODING_MS_WANSUNG FT_ENCODING_NONE FT_ENCODING_OLD_LATIN_2 FT_ENCODING_PRC FT_ENCODING_SJIS FT_ENCODING_UNICODE FT_ENCODING_WANSUNG FT_Err_XXX FT_Error FT_Error_String FT_ERRORS_H FT_F26Dot6 FT_F2Dot14 FT_Face FT_Face_CheckTrueTypePatents FT_FACE_FLAG_CID_KEYED FT_FACE_FLAG_COLOR FT_FACE_FLAG_EXTERNAL_STREAM FT_FACE_FLAG_FAST_GLYPHS FT_FACE_FLAG_FIXED_SIZES FT_FACE_FLAG_FIXED_WIDTH FT_FACE_FLAG_GLYPH_NAMES FT_FACE_FLAG_HINTER FT_FACE_FLAG_HORIZONTAL FT_FACE_FLAG_KERNING FT_FACE_FLAG_MULTIPLE_MASTERS FT_FACE_FLAG_SCALABLE FT_FACE_FLAG_SFNT FT_FACE_FLAG_TRICKY FT_FACE_FLAG_VARIATION FT_FACE_FLAG_VERTICAL FT_FACE_FLAG_XXX FT_Face_GetCharsOfVariant FT_Face_GetCharVariantIndex FT_Face_GetCharVariantIsDefault FT_Face_GetVariantSelectors FT_Face_GetVariantsOfChar FT_Face_Internal FT_Face_Properties FT_Face_SetUnpatentedHinting FT_FaceRec FT_Fixed FT_FloorFix FT_FONT_FORMATS_H FT_Free_Func FT_FREETYPE_H FT_FSTYPE_BITMAP_EMBEDDING_ONLY FT_FSTYPE_EDITABLE_EMBEDDING FT_FSTYPE_INSTALLABLE_EMBEDDING FT_FSTYPE_NO_SUBSETTING FT_FSTYPE_PREVIEW_AND_PRINT_EMBEDDING FT_FSTYPE_RESTRICTED_LICENSE_EMBEDDING FT_FSTYPE_XXX FT_FWord FT_GASP_DO_GRAY FT_GASP_DO_GRIDFIT FT_GASP_H FT_GASP_NO_TABLE FT_GASP_SYMMETRIC_GRIDFIT FT_GASP_SYMMETRIC_SMOOTHING FT_GASP_XXX FT_Generic FT_Generic_Finalizer FT_Get_Advance FT_Get_Advances FT_Get_BDF_Charset_ID FT_Get_BDF_Property FT_Get_Char_Index FT_Get_Charmap_Index FT_Get_CID_From_Glyph_Index FT_Get_CID_Is_Internally_CID_Keyed FT_Get_CID_Registry_Ordering_Supplement FT_Get_CMap_Format FT_Get_CMap_Language_ID FT_Get_Color_Glyph_Layer FT_Get_First_Char FT_Get_Font_Format FT_Get_FSType_Flags FT_Get_Gasp FT_Get_Glyph FT_Get_Glyph_Name FT_Get_Kerning FT_Get_MM_Blend_Coordinates FT_Get_MM_Var FT_Get_MM_WeightVector FT_Get_Module FT_Get_Multi_Master FT_Get_Name_Index FT_Get_Next_Char FT_Get_PFR_Advance FT_Get_PFR_Kerning FT_Get_PFR_Metrics FT_Get_Postscript_Name FT_Get_PS_Font_Info FT_Get_PS_Font_Private FT_Get_PS_Font_Value FT_Get_Renderer FT_Get_Sfnt_LangTag FT_Get_Sfnt_Name FT_Get_Sfnt_Name_Count FT_Get_Sfnt_Table FT_Get_SubGlyph_Info FT_Get_Track_Kerning FT_Get_TrueType_Engine_Type FT_Get_Var_Axis_Flags FT_Get_Var_Blend_Coordinates FT_Get_Var_Design_Coordinates FT_Get_WinFNT_Header FT_GetFile_From_Mac_ATS_Name FT_GetFile_From_Mac_Name FT_GetFilePath_From_Mac_ATS_Name FT_Glyph FT_GLYPH_BBOX_GRIDFIT FT_Glyph_BBox_Mode FT_GLYPH_BBOX_PIXELS FT_GLYPH_BBOX_SUBPIXELS FT_GLYPH_BBOX_TRUNCATE FT_GLYPH_BBOX_UNSCALED FT_Glyph_Copy FT_Glyph_Format FT_GLYPH_FORMAT_BITMAP FT_GLYPH_FORMAT_COMPOSITE FT_GLYPH_FORMAT_NONE FT_GLYPH_FORMAT_OUTLINE FT_GLYPH_FORMAT_PLOTTER FT_Glyph_Get_CBox FT_GLYPH_H FT_Glyph_Metrics FT_Glyph_Stroke FT_Glyph_StrokeBorder FT_Glyph_To_Bitmap FT_Glyph_Transform FT_GlyphRec FT_GlyphSlot FT_GlyphSlot_Own_Bitmap FT_GlyphSlotRec FT_GX_VALIDATE_H FT_GZIP_H FT_Gzip_Uncompress FT_HAS_COLOR FT_HAS_FAST_GLYPHS FT_HAS_FIXED_SIZES FT_HAS_GLYPH_NAMES FT_HAS_HORIZONTAL FT_HAS_KERNING FT_HAS_MULTIPLE_MASTERS FT_Has_PS_Glyph_Names FT_HAS_VERTICAL FT_HINTING_ADOBE FT_HINTING_FREETYPE FT_HINTING_XXX FT_IMAGE_H FT_IMAGE_TAG FT_Incremental FT_Incremental_FreeGlyphDataFunc FT_Incremental_FuncsRec FT_Incremental_GetGlyphDataFunc FT_Incremental_GetGlyphMetricsFunc FT_INCREMENTAL_H FT_Incremental_Interface FT_Incremental_InterfaceRec FT_Incremental_Metrics FT_Incremental_MetricsRec FT_Init_FreeType FT_Int FT_Int16 FT_Int32 FT_Int64 FT_IS_CID_KEYED FT_IS_FIXED_WIDTH FT_IS_NAMED_INSTANCE FT_IS_SCALABLE FT_IS_SFNT FT_IS_TRICKY FT_IS_VARIATION FT_KERNING_DEFAULT FT_Kerning_Mode FT_KERNING_UNFITTED FT_KERNING_UNSCALED FT_LayerIterator FT_LCD_FILTER_DEFAULT FT_LCD_FILTER_H FT_LCD_FILTER_LEGACY FT_LCD_FILTER_LEGACY1 FT_LCD_FILTER_LIGHT FT_LCD_FILTER_NONE FT_LcdFilter FT_LcdFiveTapFilter FT_Library FT_Library_SetLcdFilter FT_Library_SetLcdFilterWeights FT_Library_SetLcdGeometry FT_Library_Version FT_List FT_List_Add FT_List_Destructor FT_List_Finalize FT_List_Find FT_LIST_H FT_List_Insert FT_List_Iterate FT_List_Iterator FT_List_Remove FT_List_Up FT_ListNode FT_ListNodeRec FT_ListRec FT_LOAD_BITMAP_METRICS_ONLY FT_Load_Char FT_LOAD_COLOR FT_LOAD_COMPUTE_METRICS FT_LOAD_CROP_BITMAP FT_LOAD_DEFAULT FT_LOAD_FORCE_AUTOHINT FT_Load_Glyph FT_LOAD_IGNORE_GLOBAL_ADVANCE_WIDTH FT_LOAD_IGNORE_TRANSFORM FT_LOAD_LINEAR_DESIGN FT_LOAD_MONOCHROME FT_LOAD_NO_AUTOHINT FT_LOAD_NO_BITMAP FT_LOAD_NO_HINTING FT_LOAD_NO_RECURSE FT_LOAD_NO_SCALE FT_LOAD_PEDANTIC FT_LOAD_RENDER FT_Load_Sfnt_Table FT_LOAD_TARGET_LCD FT_LOAD_TARGET_LCD_V FT_LOAD_TARGET_LIGHT FT_LOAD_TARGET_MODE FT_LOAD_TARGET_MONO FT_LOAD_TARGET_NORMAL FT_LOAD_TARGET_XXX FT_LOAD_VERTICAL_LAYOUT FT_LOAD_XXX FT_Long FT_LZW_H FT_MAC_H FT_MAKE_TAG FT_Matrix FT_Matrix_Invert FT_Matrix_Multiply FT_Memory FT_MemoryRec FT_MM_Axis FT_MM_Var FT_Module FT_Module_Class FT_Module_Constructor FT_Module_Destructor FT_MODULE_ERRORS_H FT_MODULE_H FT_Module_Requester FT_MulDiv FT_MulFix FT_Multi_Master FT_MULTIPLE_MASTERS_H FT_New_Face FT_New_Face_From_FOND FT_New_Face_From_FSRef FT_New_Face_From_FSSpec FT_New_Glyph FT_New_Library FT_New_Memory_Face FT_New_Size FT_Offset FT_Open_Args FT_OPEN_DRIVER FT_Open_Face FT_OPEN_MEMORY FT_OPEN_PARAMS FT_OPEN_PATHNAME FT_OPEN_STREAM FT_OPEN_XXX FT_OpenType_Free FT_OpenType_Validate FT_OPENTYPE_VALIDATE_H FT_Orientation FT_ORIENTATION_FILL_LEFT FT_ORIENTATION_FILL_RIGHT FT_ORIENTATION_NONE FT_ORIENTATION_POSTSCRIPT FT_ORIENTATION_TRUETYPE FT_Outline FT_Outline_Check FT_Outline_ConicToFunc FT_Outline_Copy FT_Outline_CubicToFunc FT_Outline_Decompose FT_Outline_Done FT_Outline_Embolden FT_Outline_EmboldenXY FT_OUTLINE_EVEN_ODD_FILL FT_Outline_Funcs FT_Outline_Get_BBox FT_Outline_Get_Bitmap FT_Outline_Get_CBox FT_Outline_Get_Orientation FT_Outline_GetInsideBorder FT_Outline_GetOutsideBorder FT_OUTLINE_H FT_OUTLINE_HIGH_PRECISION FT_OUTLINE_IGNORE_DROPOUTS FT_OUTLINE_INCLUDE_STUBS FT_Outline_LineToFunc FT_Outline_MoveToFunc FT_Outline_New FT_OUTLINE_NONE FT_OUTLINE_OVERLAP FT_OUTLINE_OWNER FT_Outline_Render FT_Outline_Reverse FT_OUTLINE_REVERSE_FILL FT_OUTLINE_SINGLE_PASS FT_OUTLINE_SMART_DROPOUTS FT_Outline_Transform FT_Outline_Translate FT_OUTLINE_XXX FT_OutlineGlyph FT_OutlineGlyphRec FT_Palette_Data FT_Palette_Data_Get FT_PALETTE_FOR_DARK_BACKGROUND FT_PALETTE_FOR_LIGHT_BACKGROUND FT_Palette_Select FT_Palette_Set_Foreground_Color FT_PALETTE_XXX FT_PARAM_TAG_IGNORE_TYPOGRAPHIC_FAMILY FT_PARAM_TAG_IGNORE_TYPOGRAPHIC_SUBFAMILY FT_PARAM_TAG_INCREMENTAL FT_PARAM_TAG_LCD_FILTER_WEIGHTS FT_PARAM_TAG_RANDOM_SEED FT_PARAM_TAG_STEM_DARKENING FT_PARAM_TAG_UNPATENTED_HINTING FT_Parameter FT_PCF_DRIVER_H FT_PFR_H FT_Pixel_Mode FT_PIXEL_MODE_BGRA FT_PIXEL_MODE_GRAY FT_PIXEL_MODE_GRAY2 FT_PIXEL_MODE_GRAY4 FT_PIXEL_MODE_LCD FT_PIXEL_MODE_LCD_V FT_PIXEL_MODE_MONO FT_PIXEL_MODE_NONE FT_Pointer FT_Pos FT_Prop_GlyphToScriptMap FT_Prop_IncreaseXHeight FT_Property_Get FT_Property_Set FT_PtrDist FT_Raster FT_Raster_BitSet_Func FT_Raster_BitTest_Func FT_Raster_DoneFunc FT_RASTER_FLAG_AA FT_RASTER_FLAG_CLIP FT_RASTER_FLAG_DEFAULT FT_RASTER_FLAG_DIRECT FT_RASTER_FLAG_XXX FT_Raster_Funcs FT_Raster_NewFunc FT_Raster_Params FT_Raster_RenderFunc FT_Raster_ResetFunc FT_Raster_SetModeFunc FT_Realloc_Func FT_Reference_Face FT_Reference_Library FT_Remove_Module FT_Render_Glyph FT_RENDER_H FT_Render_Mode FT_RENDER_MODE_LCD FT_RENDER_MODE_LCD_V FT_RENDER_MODE_LIGHT FT_RENDER_MODE_MONO FT_RENDER_MODE_NORMAL FT_Renderer FT_Renderer_Class FT_Request_Size FT_RoundFix FT_Select_Charmap FT_Select_Size FT_Set_Char_Size FT_Set_Charmap FT_Set_Debug_Hook FT_Set_Default_Properties FT_Set_MM_Blend_Coordinates FT_Set_MM_Design_Coordinates FT_Set_MM_WeightVector FT_Set_Named_Instance FT_Set_Pixel_Sizes FT_Set_Renderer FT_Set_Transform FT_Set_Var_Blend_Coordinates FT_Set_Var_Design_Coordinates FT_SFNT_HEAD FT_SFNT_HHEA FT_SFNT_MAXP FT_SFNT_NAMES_H FT_SFNT_OS2 FT_SFNT_PCLT FT_SFNT_POST FT_Sfnt_Table_Info FT_Sfnt_Tag FT_SFNT_VHEA FT_SfntLangTag FT_SfntName FT_Short FT_Sin FT_Size FT_Size_Internal FT_Size_Metrics FT_Size_Request FT_Size_Request_Type FT_SIZE_REQUEST_TYPE_BBOX FT_SIZE_REQUEST_TYPE_CELL FT_SIZE_REQUEST_TYPE_NOMINAL FT_SIZE_REQUEST_TYPE_REAL_DIM FT_SIZE_REQUEST_TYPE_SCALES FT_Size_RequestRec FT_SizeRec FT_SIZES_H FT_Slot_Internal FT_Span FT_SpanFunc FT_Stream FT_Stream_CloseFunc FT_Stream_IoFunc FT_Stream_OpenBzip2 FT_Stream_OpenGzip FT_Stream_OpenLZW FT_StreamDesc FT_StreamRec FT_String FT_Stroker FT_Stroker_BeginSubPath FT_STROKER_BORDER_LEFT FT_STROKER_BORDER_RIGHT FT_Stroker_ConicTo FT_Stroker_CubicTo FT_Stroker_Done FT_Stroker_EndSubPath FT_Stroker_Export FT_Stroker_ExportBorder FT_Stroker_GetBorderCounts FT_Stroker_GetCounts FT_STROKER_H FT_Stroker_LineCap FT_STROKER_LINECAP_BUTT FT_STROKER_LINECAP_ROUND FT_STROKER_LINECAP_SQUARE FT_Stroker_LineJoin FT_STROKER_LINEJOIN_BEVEL FT_STROKER_LINEJOIN_MITER FT_STROKER_LINEJOIN_MITER_FIXED FT_STROKER_LINEJOIN_MITER_VARIABLE FT_STROKER_LINEJOIN_ROUND FT_Stroker_LineTo FT_Stroker_New FT_Stroker_ParseOutline FT_Stroker_Rewind FT_Stroker_Set FT_StrokerBorder FT_STYLE_FLAG_BOLD FT_STYLE_FLAG_ITALIC FT_STYLE_FLAG_XXX FT_SubGlyph FT_SUBGLYPH_FLAG_2X2 FT_SUBGLYPH_FLAG_ARGS_ARE_WORDS FT_SUBGLYPH_FLAG_ARGS_ARE_XY_VALUES FT_SUBGLYPH_FLAG_ROUND_XY_TO_GRID FT_SUBGLYPH_FLAG_SCALE FT_SUBGLYPH_FLAG_USE_MY_METRICS FT_SUBGLYPH_FLAG_XXX FT_SUBGLYPH_FLAG_XY_SCALE FT_SYNTHESIS_H FT_SYSTEM_H FT_Tag FT_Tan FT_TRIGONOMETRY_H FT_TRUETYPE_DRIVER_H FT_TRUETYPE_ENGINE_TYPE_NONE FT_TRUETYPE_ENGINE_TYPE_PATENTED FT_TRUETYPE_ENGINE_TYPE_UNPATENTED FT_TRUETYPE_IDS_H FT_TRUETYPE_TABLES_H FT_TRUETYPE_TAGS_H FT_TrueTypeEngineType FT_TrueTypeGX_Free FT_TrueTypeGX_Validate FT_TYPE1_TABLES_H FT_TYPES_H FT_UFWord FT_UInt FT_UInt16 FT_UInt32 FT_UInt64 FT_ULong FT_UnitVector FT_UShort FT_VALIDATE_APPLE FT_VALIDATE_BASE FT_VALIDATE_bsln FT_VALIDATE_CKERN FT_VALIDATE_CKERNXXX FT_VALIDATE_feat FT_VALIDATE_GDEF FT_VALIDATE_GPOS FT_VALIDATE_GSUB FT_VALIDATE_GX FT_VALIDATE_GX_LENGTH FT_VALIDATE_GXXXX FT_VALIDATE_JSTF FT_VALIDATE_just FT_VALIDATE_kern FT_VALIDATE_lcar FT_VALIDATE_MATH FT_VALIDATE_mort FT_VALIDATE_morx FT_VALIDATE_MS FT_VALIDATE_opbd FT_VALIDATE_OT FT_VALIDATE_OTXXX FT_VALIDATE_prop FT_VALIDATE_trak FT_Var_Axis FT_VAR_AXIS_FLAG_HIDDEN FT_VAR_AXIS_FLAG_XXX FT_Var_Named_Style FT_Vector FT_Vector_From_Polar FT_Vector_Length FT_Vector_Polarize FT_Vector_Rotate FT_Vector_Transform FT_Vector_Unit FT_WinFNT_Header FT_WinFNT_HeaderRec FT_WinFNT_ID_CP1250 FT_WinFNT_ID_CP1251 FT_WinFNT_ID_CP1252 FT_WinFNT_ID_CP1253 FT_WinFNT_ID_CP1254 FT_WinFNT_ID_CP1255 FT_WinFNT_ID_CP1256 FT_WinFNT_ID_CP1257 FT_WinFNT_ID_CP1258 FT_WinFNT_ID_CP1361 FT_WinFNT_ID_CP874 FT_WinFNT_ID_CP932 FT_WinFNT_ID_CP936 FT_WinFNT_ID_CP949 FT_WinFNT_ID_CP950 FT_WinFNT_ID_DEFAULT FT_WinFNT_ID_MAC FT_WinFNT_ID_OEM FT_WinFNT_ID_SYMBOL FT_WinFNT_ID_XXX FT_WINFONTS_H FTC_CMapCache FTC_CMapCache_Lookup FTC_CMapCache_New FTC_Face_Requester FTC_FaceID FTC_ImageCache FTC_ImageCache_Lookup FTC_ImageCache_LookupScaler FTC_ImageCache_New FTC_ImageType FTC_ImageTypeRec FTC_Manager FTC_Manager_Done FTC_Manager_LookupFace FTC_Manager_LookupSize FTC_Manager_New FTC_Manager_RemoveFaceID FTC_Manager_Reset FTC_Node FTC_Node_Unref FTC_SBit FTC_SBitCache FTC_SBitCache_Lookup FTC_SBitCache_LookupScaler FTC_SBitCache_New FTC_SBitRec FTC_Scaler FTC_ScalerRec","title":"F"},{"location":"ft2-index.html#g","text":"glyph-to-script-map","title":"G"},{"location":"ft2-index.html#h","text":"hinting-engine","title":"H"},{"location":"ft2-index.html#i","text":"increase-x-height interpreter-version","title":"I"},{"location":"ft2-index.html#n","text":"no-long-family-names no-stem-darkening","title":"N"},{"location":"ft2-index.html#p","text":"PS_DICT_BLUE_FUZZ PS_DICT_BLUE_SCALE PS_DICT_BLUE_SHIFT PS_DICT_BLUE_VALUE PS_DICT_CHAR_STRING PS_DICT_CHAR_STRING_KEY PS_DICT_ENCODING_ENTRY PS_DICT_ENCODING_TYPE PS_DICT_FAMILY_BLUE PS_DICT_FAMILY_NAME PS_DICT_FAMILY_OTHER_BLUE PS_DICT_FONT_BBOX PS_DICT_FONT_MATRIX PS_DICT_FONT_NAME PS_DICT_FONT_TYPE PS_DICT_FORCE_BOLD PS_DICT_FS_TYPE PS_DICT_FULL_NAME PS_DICT_IS_FIXED_PITCH PS_DICT_ITALIC_ANGLE PS_Dict_Keys PS_DICT_LANGUAGE_GROUP PS_DICT_LEN_IV PS_DICT_MIN_FEATURE PS_DICT_NOTICE PS_DICT_NUM_BLUE_VALUES PS_DICT_NUM_CHAR_STRINGS PS_DICT_NUM_FAMILY_BLUES PS_DICT_NUM_FAMILY_OTHER_BLUES PS_DICT_NUM_OTHER_BLUES PS_DICT_NUM_STEM_SNAP_H PS_DICT_NUM_STEM_SNAP_V PS_DICT_NUM_SUBRS PS_DICT_OTHER_BLUE PS_DICT_PAINT_TYPE PS_DICT_PASSWORD PS_DICT_RND_STEM_UP PS_DICT_STD_HW PS_DICT_STD_VW PS_DICT_STEM_SNAP_H PS_DICT_STEM_SNAP_V PS_DICT_SUBR PS_DICT_UNDERLINE_POSITION PS_DICT_UNDERLINE_THICKNESS PS_DICT_UNIQUE_ID PS_DICT_VERSION PS_DICT_WEIGHT PS_FontInfo PS_FontInfoRec PS_Private PS_PrivateRec","title":"P"},{"location":"ft2-index.html#r","text":"random-seed","title":"R"},{"location":"ft2-index.html#t","text":"T1_BLEND_BLUE_SCALE T1_BLEND_BLUE_SHIFT T1_BLEND_BLUE_VALUES T1_BLEND_FAMILY_BLUES T1_BLEND_FAMILY_OTHER_BLUES T1_Blend_Flags T1_BLEND_FORCE_BOLD T1_BLEND_ITALIC_ANGLE T1_BLEND_OTHER_BLUES T1_BLEND_STANDARD_HEIGHT T1_BLEND_STANDARD_WIDTH T1_BLEND_STEM_SNAP_HEIGHTS T1_BLEND_STEM_SNAP_WIDTHS T1_BLEND_UNDERLINE_POSITION T1_BLEND_UNDERLINE_THICKNESS T1_ENCODING_TYPE_ARRAY T1_ENCODING_TYPE_EXPERT T1_ENCODING_TYPE_ISOLATIN1 T1_ENCODING_TYPE_NONE T1_ENCODING_TYPE_STANDARD T1_EncodingType T1_FontInfo T1_Private TT_ADOBE_ID_CUSTOM TT_ADOBE_ID_EXPERT TT_ADOBE_ID_LATIN_1 TT_ADOBE_ID_STANDARD TT_ADOBE_ID_XXX TT_APPLE_ID_DEFAULT TT_APPLE_ID_FULL_UNICODE TT_APPLE_ID_ISO_10646 TT_APPLE_ID_UNICODE_1_1 TT_APPLE_ID_UNICODE_2_0 TT_APPLE_ID_UNICODE_32 TT_APPLE_ID_VARIANT_SELECTOR TT_APPLE_ID_XXX TT_Header TT_HoriHeader TT_INTERPRETER_VERSION_35 TT_INTERPRETER_VERSION_38 TT_INTERPRETER_VERSION_40 TT_INTERPRETER_VERSION_XXX TT_ISO_ID_10646 TT_ISO_ID_7BIT_ASCII TT_ISO_ID_8859_1 TT_ISO_ID_XXX TT_MAC_ID_XXX TT_MAC_LANGID_XXX TT_MaxProfile TT_MS_ID_BIG_5 TT_MS_ID_JOHAB TT_MS_ID_PRC TT_MS_ID_SJIS TT_MS_ID_SYMBOL_CS TT_MS_ID_UCS_4 TT_MS_ID_UNICODE_CS TT_MS_ID_WANSUNG TT_MS_ID_XXX TT_MS_LANGID_XXX TT_NAME_ID_XXX TT_OS2 TT_PCLT TT_PLATFORM_ADOBE TT_PLATFORM_APPLE_UNICODE TT_PLATFORM_CUSTOM TT_PLATFORM_ISO TT_PLATFORM_MACINTOSH TT_PLATFORM_MICROSOFT TT_PLATFORM_XXX TT_Postscript TT_UCR_XXX TT_VertHeader","title":"T"},{"location":"ft2-index.html#w","text":"warping generated on Tue Oct 20 05:14:52 2020 UTC","title":"W"},{"location":"ft2-layer_management.html","text":"FreeType \u00bb Docs \u00bb Core API \u00bb Glyph Layer Management Glyph Layer Management \u00b6 Synopsis \u00b6 The functions described here allow access of colored glyph layer data in OpenType's \u2018COLR\u2019 tables. FT_LayerIterator \u00b6 Defined in FT_FREETYPE_H (freetype/freetype.h). typedef struct FT_LayerIterator_ { FT_UInt num_layers; FT_UInt layer; FT_Byte * p; } FT_LayerIterator ; This iterator object is needed for FT_Get_Color_Glyph_Layer . fields num_layers The number of glyph layers for the requested glyph index. Will be set by FT_Get_Color_Glyph_Layer . layer The current layer. Will be set by FT_Get_Color_Glyph_Layer . p An opaque pointer into \u2018COLR\u2019 table data. The caller must set this to NULL before the first call of FT_Get_Color_Glyph_Layer . FT_Get_Color_Glyph_Layer \u00b6 Defined in FT_FREETYPE_H (freetype/freetype.h). FT_EXPORT( FT_Bool ) FT_Get_Color_Glyph_Layer ( FT_Face face, FT_UInt base_glyph, FT_UInt *aglyph_index, FT_UInt *acolor_index, FT_LayerIterator * iterator ); This is an interface to the \u2018COLR\u2019 table in OpenType fonts to iteratively retrieve the colored glyph layers associated with the current glyph slot. https://docs.microsoft.com/en-us/typography/opentype/spec/colr The glyph layer data for a given glyph index, if present, provides an alternative, multi-color glyph representation: Instead of rendering the outline or bitmap with the given glyph index, glyphs with the indices and colors returned by this function are rendered layer by layer. The returned elements are ordered in the z direction from bottom to top; the 'n'th element should be rendered with the associated palette color and blended on top of the already rendered layers (elements 0, 1, ..., n-1). input face A handle to the parent face object. base_glyph The glyph index the colored glyph layers are associated with. inout iterator An FT_LayerIterator object. For the first call you should set iterator->p to NULL . For all following calls, simply use the same object again. output aglyph_index The glyph index of the current layer. acolor_index The color index into the font face's color palette of the current layer. The value 0xFFFF is special; it doesn't reference a palette entry but indicates that the text foreground color should be used instead (to be set up by the application outside of FreeType). The color palette can be retrieved with FT_Palette_Select . return Value 1 if everything is OK. If there are no more layers (or if there are no layers at all), value 0 gets returned. In case of an error, value 0 is returned also. note This function is necessary if you want to handle glyph layers by yourself. In particular, functions that operate with FT_GlyphRec objects (like FT_Get_Glyph or FT_Glyph_To_Bitmap ) don't have access to this information. Note that FT_Render_Glyph is able to handle colored glyph layers automatically if the FT_LOAD_COLOR flag is passed to a previous call to FT_Load_Glyph . [This is an experimental feature.] example FT_Color* palette; FT_LayerIterator iterator; FT_Bool have_layers; FT_UInt layer_glyph_index; FT_UInt layer_color_index; error = FT_Palette_Select( face, palette_index, &palette ); if ( error ) palette = NULL; iterator.p = NULL; have_layers = FT_Get_Color_Glyph_Layer( face, glyph_index, &layer_glyph_index, &layer_color_index, &iterator ); if ( palette && have_layers ) { do { FT_Color layer_color; if ( layer_color_index == 0xFFFF ) layer_color = text_foreground_color; else layer_color = palette[layer_color_index]; // Load and render glyph `layer_glyph_index', then // blend resulting pixmap (using color `layer_color') // with previously created pixmaps. } while ( FT_Get_Color_Glyph_Layer( face, glyph_index, &layer_glyph_index, &layer_color_index, &iterator ) ); }","title":"Glyph Layer Management"},{"location":"ft2-layer_management.html#glyph-layer-management","text":"","title":"Glyph Layer Management"},{"location":"ft2-layer_management.html#synopsis","text":"The functions described here allow access of colored glyph layer data in OpenType's \u2018COLR\u2019 tables.","title":"Synopsis"},{"location":"ft2-layer_management.html#ft_layeriterator","text":"Defined in FT_FREETYPE_H (freetype/freetype.h). typedef struct FT_LayerIterator_ { FT_UInt num_layers; FT_UInt layer; FT_Byte * p; } FT_LayerIterator ; This iterator object is needed for FT_Get_Color_Glyph_Layer .","title":"FT_LayerIterator"},{"location":"ft2-layer_management.html#ft_get_color_glyph_layer","text":"Defined in FT_FREETYPE_H (freetype/freetype.h). FT_EXPORT( FT_Bool ) FT_Get_Color_Glyph_Layer ( FT_Face face, FT_UInt base_glyph, FT_UInt *aglyph_index, FT_UInt *acolor_index, FT_LayerIterator * iterator ); This is an interface to the \u2018COLR\u2019 table in OpenType fonts to iteratively retrieve the colored glyph layers associated with the current glyph slot. https://docs.microsoft.com/en-us/typography/opentype/spec/colr The glyph layer data for a given glyph index, if present, provides an alternative, multi-color glyph representation: Instead of rendering the outline or bitmap with the given glyph index, glyphs with the indices and colors returned by this function are rendered layer by layer. The returned elements are ordered in the z direction from bottom to top; the 'n'th element should be rendered with the associated palette color and blended on top of the already rendered layers (elements 0, 1, ..., n-1).","title":"FT_Get_Color_Glyph_Layer"},{"location":"ft2-lcd_rendering.html","text":"FreeType \u00bb Docs \u00bb Controlling FreeType Modules \u00bb Subpixel Rendering Subpixel Rendering \u00b6 Synopsis \u00b6 FreeType provides two alternative subpixel rendering technologies. Should you define FT_CONFIG_OPTION_SUBPIXEL_RENDERING in your ftoption.h file, this enables ClearType-style rendering. Otherwise, Harmony LCD rendering is enabled. These technologies are controlled differently and API described below, although always available, performs its function when appropriate method is enabled and does nothing otherwise. ClearType-style LCD rendering exploits the color-striped structure of LCD pixels, increasing the available resolution in the direction of the stripe (usually horizontal RGB) by a factor of 3. Using the subpixels coverages unfiltered can create severe color fringes especially when rendering thin features. Indeed, to produce black-on-white text, the nearby color subpixels must be dimmed equally. A good 5-tap FIR filter should be applied to subpixel coverages regardless of pixel boundaries and should have these properties: It should be symmetrical, like { a, b, c, b, a }, to avoid any shifts in appearance. It should be color-balanced, meaning a + b = c, to reduce color fringes by distributing the computed coverage for one subpixel to all subpixels equally. It should be normalized, meaning 2a + 2b + c = 1.0 to maintain overall brightness. Boxy 3-tap filter {0, \u2153, \u2153, \u2153, 0} is sharper but is less forgiving of non-ideal gamma curves of a screen (and viewing angles), beveled filters are fuzzier but more tolerant. Use the FT_Library_SetLcdFilter or FT_Library_SetLcdFilterWeights API to specify a low-pass filter, which is then applied to subpixel-rendered bitmaps generated through FT_Render_Glyph . Harmony LCD rendering is suitable to panels with any regular subpixel structure, not just monitors with 3 color striped subpixels, as long as the color subpixels have fixed positions relative to the pixel center. In this case, each color channel is then rendered separately after shifting the outline opposite to the subpixel shift so that the coverage maps are aligned. This method is immune to color fringes because the shifts do not change integral coverage. The subpixel geometry must be specified by xy-coordinates for each subpixel. By convention they may come in the RGB order: {{-\u2153, 0}, {0, 0}, {\u2153, 0}} for standard RGB striped panel or {{-\u2159, \u00bc}, {-\u2159, -\u00bc}, {\u2153, 0}} for a certain PenTile panel. Use the FT_Library_SetLcdGeometry API to specify subpixel positions. If one follows the RGB order convention, the same order applies to the resulting FT_PIXEL_MODE_LCD and FT_PIXEL_MODE_LCD_V bitmaps. Note, however, that the coordinate frame for the latter must be rotated clockwise. Harmony with default LCD geometry is equivalent to ClearType with light filter. As a result of ClearType filtering or Harmony rendering, the dimensions of LCD bitmaps can be either wider or taller than the dimensions of the corresponding outline with regard to the pixel grid. For example, for FT_RENDER_MODE_LCD , the filter adds 2 subpixels to the left, and 2 subpixels to the right. The bitmap offset values are adjusted accordingly, so clients shouldn't need to modify their layout and glyph positioning code when enabling the filter. The ClearType and Harmony rendering is applicable to glyph bitmaps rendered through FT_Render_Glyph , FT_Load_Glyph , FT_Load_Char , and FT_Glyph_To_Bitmap , when FT_RENDER_MODE_LCD or FT_RENDER_MODE_LCD_V is specified. This API does not control FT_Outline_Render and FT_Outline_Get_Bitmap . The described algorithms can completely remove color artefacts when combined with gamma-corrected alpha blending in linear space. Each of the 3 alpha values (subpixels) must by independently used to blend one color channel. That is, red alpha blends the red channel of the text color with the red channel of the background pixel. FT_LcdFilter \u00b6 Defined in FT_LCD_FILTER_H (freetype/ftlcdfil.h). typedef enum FT_LcdFilter_ { FT_LCD_FILTER_NONE = 0, FT_LCD_FILTER_DEFAULT = 1, FT_LCD_FILTER_LIGHT = 2, FT_LCD_FILTER_LEGACY1 = 3, FT_LCD_FILTER_LEGACY = 16, FT_LCD_FILTER_MAX /* do not remove */ } FT_LcdFilter ; A list of values to identify various types of LCD filters. values FT_LCD_FILTER_NONE Do not perform filtering. When used with subpixel rendering, this results in sometimes severe color fringes. FT_LCD_FILTER_DEFAULT This is a beveled, normalized, and color-balanced five-tap filter with weights of [0x08 0x4D 0x56 0x4D 0x08] in 1/256th units. FT_LCD_FILTER_LIGHT this is a boxy, normalized, and color-balanced three-tap filter with weights of [0x00 0x55 0x56 0x55 0x00] in 1/256th units. FT_LCD_FILTER_LEGACY FT_LCD_FILTER_LEGACY1 This filter corresponds to the original libXft color filter. It provides high contrast output but can exhibit really bad color fringes if glyphs are not extremely well hinted to the pixel grid. This filter is only provided for comparison purposes, and might be disabled or stay unsupported in the future. The second value is provided for compatibility with FontConfig, which historically used different enumeration, sometimes incorrectly forwarded to FreeType. since 2.3.0 ( FT_LCD_FILTER_LEGACY1 since 2.6.2) FT_Library_SetLcdFilter \u00b6 Defined in FT_LCD_FILTER_H (freetype/ftlcdfil.h). FT_EXPORT( FT_Error ) FT_Library_SetLcdFilter ( FT_Library library, FT_LcdFilter filter ); This function is used to change filter applied to LCD decimated bitmaps, like the ones used when calling FT_Render_Glyph with FT_RENDER_MODE_LCD or FT_RENDER_MODE_LCD_V . input library A handle to the target library instance. filter The filter type. You can use FT_LCD_FILTER_NONE here to disable this feature, or FT_LCD_FILTER_DEFAULT to use a default filter that should work well on most LCD screens. return FreeType error code. 0 means success. note Since 2.10.3 the LCD filtering is enabled with FT_LCD_FILTER_DEFAULT . It is no longer necessary to call this function explicitly except to choose a different filter or disable filtering altogether with FT_LCD_FILTER_NONE . This function does nothing but returns FT_Err_Unimplemented_Feature if the configuration macro FT_CONFIG_OPTION_SUBPIXEL_RENDERING is not defined in your build of the library. since 2.3.0 FT_Library_SetLcdFilterWeights \u00b6 Defined in FT_LCD_FILTER_H (freetype/ftlcdfil.h). FT_EXPORT( FT_Error ) FT_Library_SetLcdFilterWeights ( FT_Library library, unsigned char *weights ); This function can be used to enable LCD filter with custom weights, instead of using presets in FT_Library_SetLcdFilter . input library A handle to the target library instance. weights A pointer to an array; the function copies the first five bytes and uses them to specify the filter weights in 1/256th units. return FreeType error code. 0 means success. note This function does nothing but returns FT_Err_Unimplemented_Feature if the configuration macro FT_CONFIG_OPTION_SUBPIXEL_RENDERING is not defined in your build of the library. LCD filter weights can also be set per face using FT_Face_Properties with FT_PARAM_TAG_LCD_FILTER_WEIGHTS . since 2.4.0 FT_LcdFiveTapFilter \u00b6 Defined in FT_LCD_FILTER_H (freetype/ftlcdfil.h). # define FT_LCD_FILTER_FIVE_TAPS 5 typedef FT_Byte FT_LcdFiveTapFilter [FT_LCD_FILTER_FIVE_TAPS]; A typedef for passing the five LCD filter weights to FT_Face_Properties within an FT_Parameter structure. since 2.8 FT_Library_SetLcdGeometry \u00b6 Defined in FT_LCD_FILTER_H (freetype/ftlcdfil.h). FT_EXPORT( FT_Error ) FT_Library_SetLcdGeometry ( FT_Library library, FT_Vector sub[3] ); This function can be used to modify default positions of color subpixels, which controls Harmony LCD rendering. input library A handle to the target library instance. sub A pointer to an array of 3 vectors in 26.6 fractional pixel format; the function modifies the default values, see the note below. return FreeType error code. 0 means success. note Subpixel geometry examples: {{-21, 0}, {0, 0}, {21, 0}} is the default, corresponding to 3 color stripes shifted by a third of a pixel. This could be an RGB panel. {{21, 0}, {0, 0}, {-21, 0}} looks the same as the default but can specify a BGR panel instead, while keeping the bitmap in the same RGB888 format. {{0, 21}, {0, 0}, {0, -21}} is the vertical RGB, but the bitmap stays RGB888 as a result. {{-11, 16}, {-11, -16}, {22, 0}} is a certain PenTile arrangement. This function does nothing and returns FT_Err_Unimplemented_Feature in the context of ClearType-style subpixel rendering when FT_CONFIG_OPTION_SUBPIXEL_RENDERING is defined in your build of the library. since 2.10.0","title":"Subpixel Rendering"},{"location":"ft2-lcd_rendering.html#subpixel-rendering","text":"","title":"Subpixel Rendering"},{"location":"ft2-lcd_rendering.html#synopsis","text":"FreeType provides two alternative subpixel rendering technologies. Should you define FT_CONFIG_OPTION_SUBPIXEL_RENDERING in your ftoption.h file, this enables ClearType-style rendering. Otherwise, Harmony LCD rendering is enabled. These technologies are controlled differently and API described below, although always available, performs its function when appropriate method is enabled and does nothing otherwise. ClearType-style LCD rendering exploits the color-striped structure of LCD pixels, increasing the available resolution in the direction of the stripe (usually horizontal RGB) by a factor of 3. Using the subpixels coverages unfiltered can create severe color fringes especially when rendering thin features. Indeed, to produce black-on-white text, the nearby color subpixels must be dimmed equally. A good 5-tap FIR filter should be applied to subpixel coverages regardless of pixel boundaries and should have these properties: It should be symmetrical, like { a, b, c, b, a }, to avoid any shifts in appearance. It should be color-balanced, meaning a + b = c, to reduce color fringes by distributing the computed coverage for one subpixel to all subpixels equally. It should be normalized, meaning 2a + 2b + c = 1.0 to maintain overall brightness. Boxy 3-tap filter {0, \u2153, \u2153, \u2153, 0} is sharper but is less forgiving of non-ideal gamma curves of a screen (and viewing angles), beveled filters are fuzzier but more tolerant. Use the FT_Library_SetLcdFilter or FT_Library_SetLcdFilterWeights API to specify a low-pass filter, which is then applied to subpixel-rendered bitmaps generated through FT_Render_Glyph . Harmony LCD rendering is suitable to panels with any regular subpixel structure, not just monitors with 3 color striped subpixels, as long as the color subpixels have fixed positions relative to the pixel center. In this case, each color channel is then rendered separately after shifting the outline opposite to the subpixel shift so that the coverage maps are aligned. This method is immune to color fringes because the shifts do not change integral coverage. The subpixel geometry must be specified by xy-coordinates for each subpixel. By convention they may come in the RGB order: {{-\u2153, 0}, {0, 0}, {\u2153, 0}} for standard RGB striped panel or {{-\u2159, \u00bc}, {-\u2159, -\u00bc}, {\u2153, 0}} for a certain PenTile panel. Use the FT_Library_SetLcdGeometry API to specify subpixel positions. If one follows the RGB order convention, the same order applies to the resulting FT_PIXEL_MODE_LCD and FT_PIXEL_MODE_LCD_V bitmaps. Note, however, that the coordinate frame for the latter must be rotated clockwise. Harmony with default LCD geometry is equivalent to ClearType with light filter. As a result of ClearType filtering or Harmony rendering, the dimensions of LCD bitmaps can be either wider or taller than the dimensions of the corresponding outline with regard to the pixel grid. For example, for FT_RENDER_MODE_LCD , the filter adds 2 subpixels to the left, and 2 subpixels to the right. The bitmap offset values are adjusted accordingly, so clients shouldn't need to modify their layout and glyph positioning code when enabling the filter. The ClearType and Harmony rendering is applicable to glyph bitmaps rendered through FT_Render_Glyph , FT_Load_Glyph , FT_Load_Char , and FT_Glyph_To_Bitmap , when FT_RENDER_MODE_LCD or FT_RENDER_MODE_LCD_V is specified. This API does not control FT_Outline_Render and FT_Outline_Get_Bitmap . The described algorithms can completely remove color artefacts when combined with gamma-corrected alpha blending in linear space. Each of the 3 alpha values (subpixels) must by independently used to blend one color channel. That is, red alpha blends the red channel of the text color with the red channel of the background pixel.","title":"Synopsis"},{"location":"ft2-lcd_rendering.html#ft_lcdfilter","text":"Defined in FT_LCD_FILTER_H (freetype/ftlcdfil.h). typedef enum FT_LcdFilter_ { FT_LCD_FILTER_NONE = 0, FT_LCD_FILTER_DEFAULT = 1, FT_LCD_FILTER_LIGHT = 2, FT_LCD_FILTER_LEGACY1 = 3, FT_LCD_FILTER_LEGACY = 16, FT_LCD_FILTER_MAX /* do not remove */ } FT_LcdFilter ; A list of values to identify various types of LCD filters.","title":"FT_LcdFilter"},{"location":"ft2-lcd_rendering.html#ft_library_setlcdfilter","text":"Defined in FT_LCD_FILTER_H (freetype/ftlcdfil.h). FT_EXPORT( FT_Error ) FT_Library_SetLcdFilter ( FT_Library library, FT_LcdFilter filter ); This function is used to change filter applied to LCD decimated bitmaps, like the ones used when calling FT_Render_Glyph with FT_RENDER_MODE_LCD or FT_RENDER_MODE_LCD_V .","title":"FT_Library_SetLcdFilter"},{"location":"ft2-lcd_rendering.html#ft_library_setlcdfilterweights","text":"Defined in FT_LCD_FILTER_H (freetype/ftlcdfil.h). FT_EXPORT( FT_Error ) FT_Library_SetLcdFilterWeights ( FT_Library library, unsigned char *weights ); This function can be used to enable LCD filter with custom weights, instead of using presets in FT_Library_SetLcdFilter .","title":"FT_Library_SetLcdFilterWeights"},{"location":"ft2-lcd_rendering.html#ft_lcdfivetapfilter","text":"Defined in FT_LCD_FILTER_H (freetype/ftlcdfil.h). # define FT_LCD_FILTER_FIVE_TAPS 5 typedef FT_Byte FT_LcdFiveTapFilter [FT_LCD_FILTER_FIVE_TAPS]; A typedef for passing the five LCD filter weights to FT_Face_Properties within an FT_Parameter structure.","title":"FT_LcdFiveTapFilter"},{"location":"ft2-lcd_rendering.html#ft_library_setlcdgeometry","text":"Defined in FT_LCD_FILTER_H (freetype/ftlcdfil.h). FT_EXPORT( FT_Error ) FT_Library_SetLcdGeometry ( FT_Library library, FT_Vector sub[3] ); This function can be used to modify default positions of color subpixels, which controls Harmony LCD rendering.","title":"FT_Library_SetLcdGeometry"},{"location":"ft2-list_processing.html","text":"FreeType \u00bb Docs \u00bb Support API \u00bb List Processing List Processing \u00b6 Synopsis \u00b6 This section contains various definitions related to list processing using doubly-linked nodes. FT_List \u00b6 Defined in FT_TYPES_H (freetype/fttypes.h). typedef struct FT_ListRec_* FT_List ; A handle to a list record (see FT_ListRec ). FT_ListNode \u00b6 Defined in FT_TYPES_H (freetype/fttypes.h). typedef struct FT_ListNodeRec_* FT_ListNode ; Many elements and objects in FreeType are listed through an FT_List record (see FT_ListRec ). As its name suggests, an FT_ListNode is a handle to a single list element. FT_ListRec \u00b6 Defined in FT_TYPES_H (freetype/fttypes.h). typedef struct FT_ListRec_ { FT_ListNode head; FT_ListNode tail; } FT_ListRec ; A structure used to hold a simple doubly-linked list. These are used in many parts of FreeType. fields head The head (first element) of doubly-linked list. tail The tail (last element) of doubly-linked list. FT_ListNodeRec \u00b6 Defined in FT_TYPES_H (freetype/fttypes.h). typedef struct FT_ListNodeRec_ { FT_ListNode prev; FT_ListNode next; void * data; } FT_ListNodeRec ; A structure used to hold a single list element. fields prev The previous element in the list. NULL if first. next The next element in the list. NULL if last. data A typeless pointer to the listed object. FT_List_Add \u00b6 Defined in FT_LIST_H (freetype/ftlist.h). FT_EXPORT( void ) FT_List_Add ( FT_List list, FT_ListNode node ); Append an element to the end of a list. inout list A pointer to the parent list. node The node to append. FT_List_Insert \u00b6 Defined in FT_LIST_H (freetype/ftlist.h). FT_EXPORT( void ) FT_List_Insert ( FT_List list, FT_ListNode node ); Insert an element at the head of a list. inout list A pointer to parent list. node The node to insert. FT_List_Find \u00b6 Defined in FT_LIST_H (freetype/ftlist.h). FT_EXPORT( FT_ListNode ) FT_List_Find ( FT_List list, void * data ); Find the list node for a given listed object. input list A pointer to the parent list. data The address of the listed object. return List node. NULL if it wasn't found. FT_List_Remove \u00b6 Defined in FT_LIST_H (freetype/ftlist.h). FT_EXPORT( void ) FT_List_Remove ( FT_List list, FT_ListNode node ); Remove a node from a list. This function doesn't check whether the node is in the list! input node The node to remove. inout list A pointer to the parent list. FT_List_Up \u00b6 Defined in FT_LIST_H (freetype/ftlist.h). FT_EXPORT( void ) FT_List_Up ( FT_List list, FT_ListNode node ); Move a node to the head/top of a list. Used to maintain LRU lists. inout list A pointer to the parent list. node The node to move. FT_List_Iterate \u00b6 Defined in FT_LIST_H (freetype/ftlist.h). FT_EXPORT( FT_Error ) FT_List_Iterate ( FT_List list, FT_List_Iterator iterator, void * user ); Parse a list and calls a given iterator function on each element. Note that parsing is stopped as soon as one of the iterator calls returns a non-zero value. input list A handle to the list. iterator An iterator function, called on each node of the list. user A user-supplied field that is passed as the second argument to the iterator. return The result (a FreeType error code) of the last iterator call. FT_List_Iterator \u00b6 Defined in FT_LIST_H (freetype/ftlist.h). typedef FT_Error (* FT_List_Iterator )( FT_ListNode node, void * user ); An FT_List iterator function that is called during a list parse by FT_List_Iterate . input node The current iteration list node. user A typeless pointer passed to FT_List_Iterate . Can be used to point to the iteration's state. FT_List_Finalize \u00b6 Defined in FT_LIST_H (freetype/ftlist.h). FT_EXPORT( void ) FT_List_Finalize ( FT_List list, FT_List_Destructor destroy, FT_Memory memory, void * user ); Destroy all elements in the list as well as the list itself. input list A handle to the list. destroy A list destructor that will be applied to each element of the list. Set this to NULL if not needed. memory The current memory object that handles deallocation. user A user-supplied field that is passed as the last argument to the destructor. note This function expects that all nodes added by FT_List_Add or FT_List_Insert have been dynamically allocated. FT_List_Destructor \u00b6 Defined in FT_LIST_H (freetype/ftlist.h). typedef void (* FT_List_Destructor )( FT_Memory memory, void * data, void * user ); An FT_List iterator function that is called during a list finalization by FT_List_Finalize to destroy all elements in a given list. input system The current system object. data The current object to destroy. user A typeless pointer passed to FT_List_Iterate . It can be used to point to the iteration's state.","title":"List Processing"},{"location":"ft2-list_processing.html#list-processing","text":"","title":"List Processing"},{"location":"ft2-list_processing.html#synopsis","text":"This section contains various definitions related to list processing using doubly-linked nodes.","title":"Synopsis"},{"location":"ft2-list_processing.html#ft_list","text":"Defined in FT_TYPES_H (freetype/fttypes.h). typedef struct FT_ListRec_* FT_List ; A handle to a list record (see FT_ListRec ).","title":"FT_List"},{"location":"ft2-list_processing.html#ft_listnode","text":"Defined in FT_TYPES_H (freetype/fttypes.h). typedef struct FT_ListNodeRec_* FT_ListNode ; Many elements and objects in FreeType are listed through an FT_List record (see FT_ListRec ). As its name suggests, an FT_ListNode is a handle to a single list element.","title":"FT_ListNode"},{"location":"ft2-list_processing.html#ft_listrec","text":"Defined in FT_TYPES_H (freetype/fttypes.h). typedef struct FT_ListRec_ { FT_ListNode head; FT_ListNode tail; } FT_ListRec ; A structure used to hold a simple doubly-linked list. These are used in many parts of FreeType.","title":"FT_ListRec"},{"location":"ft2-list_processing.html#ft_listnoderec","text":"Defined in FT_TYPES_H (freetype/fttypes.h). typedef struct FT_ListNodeRec_ { FT_ListNode prev; FT_ListNode next; void * data; } FT_ListNodeRec ; A structure used to hold a single list element.","title":"FT_ListNodeRec"},{"location":"ft2-list_processing.html#ft_list_add","text":"Defined in FT_LIST_H (freetype/ftlist.h). FT_EXPORT( void ) FT_List_Add ( FT_List list, FT_ListNode node ); Append an element to the end of a list.","title":"FT_List_Add"},{"location":"ft2-list_processing.html#ft_list_insert","text":"Defined in FT_LIST_H (freetype/ftlist.h). FT_EXPORT( void ) FT_List_Insert ( FT_List list, FT_ListNode node ); Insert an element at the head of a list.","title":"FT_List_Insert"},{"location":"ft2-list_processing.html#ft_list_find","text":"Defined in FT_LIST_H (freetype/ftlist.h). FT_EXPORT( FT_ListNode ) FT_List_Find ( FT_List list, void * data ); Find the list node for a given listed object.","title":"FT_List_Find"},{"location":"ft2-list_processing.html#ft_list_remove","text":"Defined in FT_LIST_H (freetype/ftlist.h). FT_EXPORT( void ) FT_List_Remove ( FT_List list, FT_ListNode node ); Remove a node from a list. This function doesn't check whether the node is in the list!","title":"FT_List_Remove"},{"location":"ft2-list_processing.html#ft_list_up","text":"Defined in FT_LIST_H (freetype/ftlist.h). FT_EXPORT( void ) FT_List_Up ( FT_List list, FT_ListNode node ); Move a node to the head/top of a list. Used to maintain LRU lists.","title":"FT_List_Up"},{"location":"ft2-list_processing.html#ft_list_iterate","text":"Defined in FT_LIST_H (freetype/ftlist.h). FT_EXPORT( FT_Error ) FT_List_Iterate ( FT_List list, FT_List_Iterator iterator, void * user ); Parse a list and calls a given iterator function on each element. Note that parsing is stopped as soon as one of the iterator calls returns a non-zero value.","title":"FT_List_Iterate"},{"location":"ft2-list_processing.html#ft_list_iterator","text":"Defined in FT_LIST_H (freetype/ftlist.h). typedef FT_Error (* FT_List_Iterator )( FT_ListNode node, void * user ); An FT_List iterator function that is called during a list parse by FT_List_Iterate .","title":"FT_List_Iterator"},{"location":"ft2-list_processing.html#ft_list_finalize","text":"Defined in FT_LIST_H (freetype/ftlist.h). FT_EXPORT( void ) FT_List_Finalize ( FT_List list, FT_List_Destructor destroy, FT_Memory memory, void * user ); Destroy all elements in the list as well as the list itself.","title":"FT_List_Finalize"},{"location":"ft2-list_processing.html#ft_list_destructor","text":"Defined in FT_LIST_H (freetype/ftlist.h). typedef void (* FT_List_Destructor )( FT_Memory memory, void * data, void * user ); An FT_List iterator function that is called during a list finalization by FT_List_Finalize to destroy all elements in a given list.","title":"FT_List_Destructor"},{"location":"ft2-lzw.html","text":"FreeType \u00bb Docs \u00bb Support API \u00bb LZW Streams LZW Streams \u00b6 Synopsis \u00b6 In certain builds of the library, LZW compression recognition is automatically handled when calling FT_New_Face or FT_Open_Face . This means that if no font driver is capable of handling the raw compressed file, the library will try to open a LZW stream from it and re-open the face with it. The stream implementation is very basic and resets the decompression process each time seeking backwards is needed within the stream, which significantly undermines the performance. This section contains the declaration of LZW-specific functions. FT_Stream_OpenLZW \u00b6 Defined in FT_LZW_H (freetype/ftlzw.h). FT_EXPORT( FT_Error ) FT_Stream_OpenLZW ( FT_Stream stream, FT_Stream source ); Open a new stream to parse LZW-compressed font files. This is mainly used to support the compressed *.pcf.Z fonts that come with XFree86. input stream The target embedding stream. source The source stream. return FreeType error code. 0 means success. note The source stream must be opened before calling this function. Calling the internal function FT_Stream_Close on the new stream will not call FT_Stream_Close on the source stream. None of the stream objects will be released to the heap. This function may return FT_Err_Unimplemented_Feature if your build of FreeType was not compiled with LZW support.","title":"LZW Streams"},{"location":"ft2-lzw.html#lzw-streams","text":"","title":"LZW Streams"},{"location":"ft2-lzw.html#synopsis","text":"In certain builds of the library, LZW compression recognition is automatically handled when calling FT_New_Face or FT_Open_Face . This means that if no font driver is capable of handling the raw compressed file, the library will try to open a LZW stream from it and re-open the face with it. The stream implementation is very basic and resets the decompression process each time seeking backwards is needed within the stream, which significantly undermines the performance. This section contains the declaration of LZW-specific functions.","title":"Synopsis"},{"location":"ft2-lzw.html#ft_stream_openlzw","text":"Defined in FT_LZW_H (freetype/ftlzw.h). FT_EXPORT( FT_Error ) FT_Stream_OpenLZW ( FT_Stream stream, FT_Stream source ); Open a new stream to parse LZW-compressed font files. This is mainly used to support the compressed *.pcf.Z fonts that come with XFree86.","title":"FT_Stream_OpenLZW"},{"location":"ft2-mac_specific.html","text":"FreeType \u00bb Docs \u00bb Core API \u00bb Mac Specific Interface Mac Specific Interface \u00b6 Synopsis \u00b6 The following definitions are only available if FreeType is compiled on a Macintosh. FT_New_Face_From_FOND \u00b6 Defined in FT_MAC_H (freetype/ftmac.h). FT_EXPORT( FT_Error ) FT_New_Face_From_FOND ( FT_Library library, Handle fond, FT_Long face_index, FT_Face *aface ) FT_DEPRECATED_ATTRIBUTE; Create a new face object from a FOND resource. inout library A handle to the library resource. input fond A FOND resource. face_index Only supported for the -1 \u2018sanity check\u2019 special case. output aface A handle to a new face object. return FreeType error code. 0 means success. example This function can be used to create FT_Face objects from fonts that are installed in the system as follows. fond = GetResource( 'FOND', fontName ); error = FT_New_Face_From_FOND( library, fond, 0, &face ); FT_GetFile_From_Mac_Name \u00b6 Defined in FT_MAC_H (freetype/ftmac.h). FT_EXPORT( FT_Error ) FT_GetFile_From_Mac_Name ( const char * fontName, FSSpec* pathSpec, FT_Long * face_index ) FT_DEPRECATED_ATTRIBUTE; Return an FSSpec for the disk file containing the named font. input fontName Mac OS name of the font (e.g., Times New Roman Bold). output pathSpec FSSpec to the file. For passing to FT_New_Face_From_FSSpec . face_index Index of the face. For passing to FT_New_Face_From_FSSpec . return FreeType error code. 0 means success. FT_GetFile_From_Mac_ATS_Name \u00b6 Defined in FT_MAC_H (freetype/ftmac.h). FT_EXPORT( FT_Error ) FT_GetFile_From_Mac_ATS_Name ( const char * fontName, FSSpec* pathSpec, FT_Long * face_index ) FT_DEPRECATED_ATTRIBUTE; Return an FSSpec for the disk file containing the named font. input fontName Mac OS name of the font in ATS framework. output pathSpec FSSpec to the file. For passing to FT_New_Face_From_FSSpec . face_index Index of the face. For passing to FT_New_Face_From_FSSpec . return FreeType error code. 0 means success. FT_GetFilePath_From_Mac_ATS_Name \u00b6 Defined in FT_MAC_H (freetype/ftmac.h). FT_EXPORT( FT_Error ) FT_GetFilePath_From_Mac_ATS_Name ( const char * fontName, UInt8* path, UInt32 maxPathSize, FT_Long * face_index ) FT_DEPRECATED_ATTRIBUTE; Return a pathname of the disk file and face index for given font name that is handled by ATS framework. input fontName Mac OS name of the font in ATS framework. output path Buffer to store pathname of the file. For passing to FT_New_Face . The client must allocate this buffer before calling this function. maxPathSize Lengths of the buffer path that client allocated. face_index Index of the face. For passing to FT_New_Face . return FreeType error code. 0 means success. FT_New_Face_From_FSSpec \u00b6 Defined in FT_MAC_H (freetype/ftmac.h). FT_EXPORT( FT_Error ) FT_New_Face_From_FSSpec ( FT_Library library, const FSSpec *spec, FT_Long face_index, FT_Face *aface ) FT_DEPRECATED_ATTRIBUTE; Create a new face object from a given resource and typeface index using an FSSpec to the font file. inout library A handle to the library resource. input spec FSSpec to the font file. face_index The index of the face within the resource. The first face has index 0. output aface A handle to a new face object. return FreeType error code. 0 means success. note FT_New_Face_From_FSSpec is identical to FT_New_Face except it accepts an FSSpec instead of a path. FT_New_Face_From_FSRef \u00b6 Defined in FT_MAC_H (freetype/ftmac.h). FT_EXPORT( FT_Error ) FT_New_Face_From_FSRef ( FT_Library library, const FSRef *ref, FT_Long face_index, FT_Face *aface ) FT_DEPRECATED_ATTRIBUTE; Create a new face object from a given resource and typeface index using an FSRef to the font file. inout library A handle to the library resource. input spec FSRef to the font file. face_index The index of the face within the resource. The first face has index 0. output aface A handle to a new face object. return FreeType error code. 0 means success. note FT_New_Face_From_FSRef is identical to FT_New_Face except it accepts an FSRef instead of a path.","title":"Mac Specific Interface"},{"location":"ft2-mac_specific.html#mac-specific-interface","text":"","title":"Mac Specific Interface"},{"location":"ft2-mac_specific.html#synopsis","text":"The following definitions are only available if FreeType is compiled on a Macintosh.","title":"Synopsis"},{"location":"ft2-mac_specific.html#ft_new_face_from_fond","text":"Defined in FT_MAC_H (freetype/ftmac.h). FT_EXPORT( FT_Error ) FT_New_Face_From_FOND ( FT_Library library, Handle fond, FT_Long face_index, FT_Face *aface ) FT_DEPRECATED_ATTRIBUTE; Create a new face object from a FOND resource.","title":"FT_New_Face_From_FOND"},{"location":"ft2-mac_specific.html#ft_getfile_from_mac_name","text":"Defined in FT_MAC_H (freetype/ftmac.h). FT_EXPORT( FT_Error ) FT_GetFile_From_Mac_Name ( const char * fontName, FSSpec* pathSpec, FT_Long * face_index ) FT_DEPRECATED_ATTRIBUTE; Return an FSSpec for the disk file containing the named font.","title":"FT_GetFile_From_Mac_Name"},{"location":"ft2-mac_specific.html#ft_getfile_from_mac_ats_name","text":"Defined in FT_MAC_H (freetype/ftmac.h). FT_EXPORT( FT_Error ) FT_GetFile_From_Mac_ATS_Name ( const char * fontName, FSSpec* pathSpec, FT_Long * face_index ) FT_DEPRECATED_ATTRIBUTE; Return an FSSpec for the disk file containing the named font.","title":"FT_GetFile_From_Mac_ATS_Name"},{"location":"ft2-mac_specific.html#ft_getfilepath_from_mac_ats_name","text":"Defined in FT_MAC_H (freetype/ftmac.h). FT_EXPORT( FT_Error ) FT_GetFilePath_From_Mac_ATS_Name ( const char * fontName, UInt8* path, UInt32 maxPathSize, FT_Long * face_index ) FT_DEPRECATED_ATTRIBUTE; Return a pathname of the disk file and face index for given font name that is handled by ATS framework.","title":"FT_GetFilePath_From_Mac_ATS_Name"},{"location":"ft2-mac_specific.html#ft_new_face_from_fsspec","text":"Defined in FT_MAC_H (freetype/ftmac.h). FT_EXPORT( FT_Error ) FT_New_Face_From_FSSpec ( FT_Library library, const FSSpec *spec, FT_Long face_index, FT_Face *aface ) FT_DEPRECATED_ATTRIBUTE; Create a new face object from a given resource and typeface index using an FSSpec to the font file.","title":"FT_New_Face_From_FSSpec"},{"location":"ft2-mac_specific.html#ft_new_face_from_fsref","text":"Defined in FT_MAC_H (freetype/ftmac.h). FT_EXPORT( FT_Error ) FT_New_Face_From_FSRef ( FT_Library library, const FSRef *ref, FT_Long face_index, FT_Face *aface ) FT_DEPRECATED_ATTRIBUTE; Create a new face object from a given resource and typeface index using an FSRef to the font file.","title":"FT_New_Face_From_FSRef"},{"location":"ft2-module_management.html","text":"FreeType \u00bb Docs \u00bb Support API \u00bb Module Management Module Management \u00b6 Synopsis \u00b6 The definitions below are used to manage modules within FreeType. Modules can be added, upgraded, and removed at runtime. Additionally, some module properties can be controlled also. Here is a list of possible values of the module_name field in the FT_Module_Class structure. autofitter bdf cff gxvalid otvalid pcf pfr psaux pshinter psnames raster1 sfnt smooth truetype type1 type42 t1cid winfonts Note that the FreeType Cache sub-system is not a FreeType module. FT_Module \u00b6 Defined in FT_FREETYPE_H (freetype/freetype.h). typedef struct FT_ModuleRec_* FT_Module ; A handle to a given FreeType module object. A module can be a font driver, a renderer, or anything else that provides services to the former. FT_Module_Constructor \u00b6 Defined in FT_MODULE_H (freetype/ftmodapi.h). typedef FT_Error (* FT_Module_Constructor )( FT_Module module ); A function used to initialize (not create) a new module object. input module The module to initialize. FT_Module_Destructor \u00b6 Defined in FT_MODULE_H (freetype/ftmodapi.h). typedef void (* FT_Module_Destructor )( FT_Module module ); A function used to finalize (not destroy) a given module object. input module The module to finalize. FT_Module_Requester \u00b6 Defined in FT_MODULE_H (freetype/ftmodapi.h). typedef FT_Module_Interface (* FT_Module_Requester )( FT_Module module, const char * name ); A function used to query a given module for a specific interface. input module The module to be searched. name The name of the interface in the module. FT_Module_Class \u00b6 Defined in FT_MODULE_H (freetype/ftmodapi.h). typedef struct FT_Module_Class_ { FT_ULong module_flags; FT_Long module_size; const FT_String * module_name; FT_Fixed module_version; FT_Fixed module_requires; const void * module_interface; FT_Module_Constructor module_init; FT_Module_Destructor module_done; FT_Module_Requester get_interface; } FT_Module_Class ; The module class descriptor. While being a public structure necessary for FreeType's module bookkeeping, most of the fields are essentially internal, not to be used directly by an application. fields module_flags Bit flags describing the module. module_size The size of one module object/instance in bytes. module_name The name of the module. module_version The version, as a 16.16 fixed number (major.minor). module_requires The version of FreeType this module requires, as a 16.16 fixed number (major.minor). Starts at version 2.0, i.e., 0x20000. module_interface A typeless pointer to a structure (which varies between different modules) that holds the module's interface functions. This is essentially what get_interface returns. module_init The initializing function. module_done The finalizing function. get_interface The interface requesting function. FT_Add_Module \u00b6 Defined in FT_MODULE_H (freetype/ftmodapi.h). FT_EXPORT( FT_Error ) FT_Add_Module ( FT_Library library, const FT_Module_Class * clazz ); Add a new module to a given library instance. inout library A handle to the library object. input clazz A pointer to class descriptor for the module. return FreeType error code. 0 means success. note An error will be returned if a module already exists by that name, or if the module requires a version of FreeType that is too great. FT_Get_Module \u00b6 Defined in FT_MODULE_H (freetype/ftmodapi.h). FT_EXPORT( FT_Module ) FT_Get_Module ( FT_Library library, const char * module_name ); Find a module by its name. input library A handle to the library object. module_name The module's name (as an ASCII string). return A module handle. 0 if none was found. note FreeType's internal modules aren't documented very well, and you should look up the source code for details. FT_Remove_Module \u00b6 Defined in FT_MODULE_H (freetype/ftmodapi.h). FT_EXPORT( FT_Error ) FT_Remove_Module ( FT_Library library, FT_Module module ); Remove a given module from a library instance. inout library A handle to a library object. input module A handle to a module object. return FreeType error code. 0 means success. note The module object is destroyed by the function in case of success. FT_Add_Default_Modules \u00b6 Defined in FT_MODULE_H (freetype/ftmodapi.h). FT_EXPORT( void ) FT_Add_Default_Modules ( FT_Library library ); Add the set of default drivers to a given library object. This is only useful when you create a library object with FT_New_Library (usually to plug a custom memory manager). inout library A handle to a new library object. FT_Property_Set \u00b6 Defined in FT_MODULE_H (freetype/ftmodapi.h). FT_EXPORT( FT_Error ) FT_Property_Set ( FT_Library library, const FT_String * module_name, const FT_String * property_name, const void * value ); Set a property for a given module. input library A handle to the library the module is part of. module_name The module name. property_name The property name. Properties are described in section \u2018 Driver properties \u2019. Note that only a few modules have properties. value A generic pointer to a variable or structure that gives the new value of the property. The exact definition of value is dependent on the property; see section \u2018 Driver properties \u2019. return FreeType error code. 0 means success. note If module_name isn't a valid module name, or property_name doesn't specify a valid property, or if value doesn't represent a valid value for the given property, an error is returned. The following example sets property \u2018bar\u2019 (a simple integer) in module \u2018foo\u2019 to value 1. FT_UInt bar; bar = 1; FT_Property_Set( library, \"foo\", \"bar\", &bar ); Note that the FreeType Cache sub-system doesn't recognize module property changes. To avoid glyph lookup confusion within the cache you should call FTC_Manager_Reset to completely flush the cache if a module property gets changed after FTC_Manager_New has been called. It is not possible to set properties of the FreeType Cache sub-system itself with FT_Property_Set; use ?FTC_Property_Set? instead. since 2.4.11 FT_Property_Get \u00b6 Defined in FT_MODULE_H (freetype/ftmodapi.h). FT_EXPORT( FT_Error ) FT_Property_Get ( FT_Library library, const FT_String * module_name, const FT_String * property_name, void * value ); Get a module's property value. input library A handle to the library the module is part of. module_name The module name. property_name The property name. Properties are described in section \u2018 Driver properties \u2019. inout value A generic pointer to a variable or structure that gives the value of the property. The exact definition of value is dependent on the property; see section \u2018 Driver properties \u2019. return FreeType error code. 0 means success. note If module_name isn't a valid module name, or property_name doesn't specify a valid property, or if value doesn't represent a valid value for the given property, an error is returned. The following example gets property \u2018baz\u2019 (a range) in module \u2018foo\u2019. typedef range_ { FT_Int32 min; FT_Int32 max; } range; range baz; FT_Property_Get( library, \"foo\", \"baz\", &baz ); It is not possible to retrieve properties of the FreeType Cache sub-system with FT_Property_Get; use ?FTC_Property_Get? instead. since 2.4.11 FT_Set_Default_Properties \u00b6 Defined in FT_MODULE_H (freetype/ftmodapi.h). FT_EXPORT( void ) FT_Set_Default_Properties ( FT_Library library ); If compilation option FT_CONFIG_OPTION_ENVIRONMENT_PROPERTIES is set, this function reads the FREETYPE_PROPERTIES environment variable to control driver properties. See section \u2018 Driver properties \u2019 for more. If the compilation option is not set, this function does nothing. FREETYPE_PROPERTIES has the following syntax form (broken here into multiple lines for better readability). <optional whitespace> <module-name1> ':' <property-name1> '=' <property-value1> <whitespace> <module-name2> ':' <property-name2> '=' <property-value2> ... Example: FREETYPE_PROPERTIES=truetype:interpreter-version=35 \\ cff:no-stem-darkening=0 \\ autofitter:warping=1 inout library A handle to a new library object. since 2.8 FT_New_Library \u00b6 Defined in FT_MODULE_H (freetype/ftmodapi.h). FT_EXPORT( FT_Error ) FT_New_Library ( FT_Memory memory, FT_Library *alibrary ); This function is used to create a new FreeType library instance from a given memory object. It is thus possible to use libraries with distinct memory allocators within the same program. Note, however, that the used FT_Memory structure is expected to remain valid for the life of the FT_Library object. Normally, you would call this function (followed by a call to FT_Add_Default_Modules or a series of calls to FT_Add_Module , and a call to FT_Set_Default_Properties ) instead of FT_Init_FreeType to initialize the FreeType library. Don't use FT_Done_FreeType but FT_Done_Library to destroy a library instance. input memory A handle to the original memory object. output alibrary A pointer to handle of a new library object. return FreeType error code. 0 means success. note See the discussion of reference counters in the description of FT_Reference_Library . FT_Done_Library \u00b6 Defined in FT_MODULE_H (freetype/ftmodapi.h). FT_EXPORT( FT_Error ) FT_Done_Library ( FT_Library library ); Discard a given library object. This closes all drivers and discards all resource objects. input library A handle to the target library. return FreeType error code. 0 means success. note See the discussion of reference counters in the description of FT_Reference_Library . FT_Reference_Library \u00b6 Defined in FT_MODULE_H (freetype/ftmodapi.h). FT_EXPORT( FT_Error ) FT_Reference_Library ( FT_Library library ); A counter gets initialized to 1 at the time an FT_Library structure is created. This function increments the counter. FT_Done_Library then only destroys a library if the counter is 1, otherwise it simply decrements the counter. This function helps in managing life-cycles of structures that reference FT_Library objects. input library A handle to a target library object. return FreeType error code. 0 means success. since 2.4.2 FT_Renderer \u00b6 Defined in FT_FREETYPE_H (freetype/freetype.h). typedef struct FT_RendererRec_* FT_Renderer ; A handle to a given FreeType renderer. A renderer is a module in charge of converting a glyph's outline image to a bitmap. It supports a single glyph image format, and one or more target surface depths. FT_Renderer_Class \u00b6 Defined in FT_RENDER_H (freetype/ftrender.h). typedef struct FT_Renderer_Class_ { FT_Module_Class root; FT_Glyph_Format glyph_format; FT_Renderer_RenderFunc render_glyph; FT_Renderer_TransformFunc transform_glyph; FT_Renderer_GetCBoxFunc get_glyph_cbox; FT_Renderer_SetModeFunc set_mode; FT_Raster_Funcs * raster_class; } FT_Renderer_Class ; The renderer module class descriptor. fields root The root FT_Module_Class fields. glyph_format The glyph image format this renderer handles. render_glyph A method used to render the image that is in a given glyph slot into a bitmap. transform_glyph A method used to transform the image that is in a given glyph slot. get_glyph_cbox A method used to access the glyph's cbox. set_mode A method used to pass additional parameters. raster_class For FT_GLYPH_FORMAT_OUTLINE renderers only. This is a pointer to its raster's class. FT_Get_Renderer \u00b6 Defined in FT_RENDER_H (freetype/ftrender.h). FT_EXPORT( FT_Renderer ) FT_Get_Renderer ( FT_Library library, FT_Glyph_Format format ); Retrieve the current renderer for a given glyph format. input library A handle to the library object. format The glyph format. return A renderer handle. 0 if none found. note An error will be returned if a module already exists by that name, or if the module requires a version of FreeType that is too great. To add a new renderer, simply use FT_Add_Module . To retrieve a renderer by its name, use FT_Get_Module . FT_Set_Renderer \u00b6 Defined in FT_RENDER_H (freetype/ftrender.h). FT_EXPORT( FT_Error ) FT_Set_Renderer ( FT_Library library, FT_Renderer renderer, FT_UInt num_params, FT_Parameter * parameters ); Set the current renderer to use, and set additional mode. inout library A handle to the library object. input renderer A handle to the renderer object. num_params The number of additional parameters. parameters Additional parameters. return FreeType error code. 0 means success. note In case of success, the renderer will be used to convert glyph images in the renderer's known format into bitmaps. This doesn't change the current renderer for other formats. Currently, no FreeType renderer module uses parameters ; you should thus always pass NULL as the value. FT_Set_Debug_Hook \u00b6 Defined in FT_MODULE_H (freetype/ftmodapi.h). FT_EXPORT( void ) FT_Set_Debug_Hook ( FT_Library library, FT_UInt hook_index, FT_DebugHook_Func debug_hook ); Set a debug hook function for debugging the interpreter of a font format. While this is a public API function, an application needs access to FreeType's internal header files to do something useful. Have a look at the source code of the ttdebug FreeType demo program for an example of its usage. inout library A handle to the library object. input hook_index The index of the debug hook. You should use defined enumeration macros like FT_DEBUG_HOOK_TRUETYPE . debug_hook The function used to debug the interpreter. note Currently, four debug hook slots are available, but only one (for the TrueType interpreter) is defined. FT_Driver \u00b6 Defined in FT_FREETYPE_H (freetype/freetype.h). typedef struct FT_DriverRec_* FT_Driver ; A handle to a given FreeType font driver object. A font driver is a module capable of creating faces from font files. FT_DebugHook_Func \u00b6 Defined in FT_MODULE_H (freetype/ftmodapi.h). typedef FT_Error (* FT_DebugHook_Func )( void * arg ); A drop-in replacement (or rather a wrapper) for the bytecode or charstring interpreter's main loop function. Its job is essentially to activate debug mode to enforce single-stepping, to call the main loop function to interpret the next opcode, and to show the changed context to the user. An example for such a main loop function is TT_RunIns (declared in FreeType's internal header file src/truetype/ttinterp.h ). Have a look at the source code of the ttdebug FreeType demo program for an example of a drop-in replacement. inout arg A typeless pointer, to be cast to the main loop function's data structure (which depends on the font module). For TrueType fonts it is bytecode interpreter's execution context, TT_ExecContext , which is declared in FreeType's internal header file tttypes.h . FT_DEBUG_HOOK_XXX \u00b6 Defined in FT_MODULE_H (freetype/ftmodapi.h). # define FT_DEBUG_HOOK_TRUETYPE 0 A list of named debug hook indices. values FT_DEBUG_HOOK_TRUETYPE This hook index identifies the TrueType bytecode debugger.","title":"Module Management"},{"location":"ft2-module_management.html#module-management","text":"","title":"Module Management"},{"location":"ft2-module_management.html#synopsis","text":"The definitions below are used to manage modules within FreeType. Modules can be added, upgraded, and removed at runtime. Additionally, some module properties can be controlled also. Here is a list of possible values of the module_name field in the FT_Module_Class structure. autofitter bdf cff gxvalid otvalid pcf pfr psaux pshinter psnames raster1 sfnt smooth truetype type1 type42 t1cid winfonts Note that the FreeType Cache sub-system is not a FreeType module.","title":"Synopsis"},{"location":"ft2-module_management.html#ft_module","text":"Defined in FT_FREETYPE_H (freetype/freetype.h). typedef struct FT_ModuleRec_* FT_Module ; A handle to a given FreeType module object. A module can be a font driver, a renderer, or anything else that provides services to the former.","title":"FT_Module"},{"location":"ft2-module_management.html#ft_module_constructor","text":"Defined in FT_MODULE_H (freetype/ftmodapi.h). typedef FT_Error (* FT_Module_Constructor )( FT_Module module ); A function used to initialize (not create) a new module object.","title":"FT_Module_Constructor"},{"location":"ft2-module_management.html#ft_module_destructor","text":"Defined in FT_MODULE_H (freetype/ftmodapi.h). typedef void (* FT_Module_Destructor )( FT_Module module ); A function used to finalize (not destroy) a given module object.","title":"FT_Module_Destructor"},{"location":"ft2-module_management.html#ft_module_requester","text":"Defined in FT_MODULE_H (freetype/ftmodapi.h). typedef FT_Module_Interface (* FT_Module_Requester )( FT_Module module, const char * name ); A function used to query a given module for a specific interface.","title":"FT_Module_Requester"},{"location":"ft2-module_management.html#ft_module_class","text":"Defined in FT_MODULE_H (freetype/ftmodapi.h). typedef struct FT_Module_Class_ { FT_ULong module_flags; FT_Long module_size; const FT_String * module_name; FT_Fixed module_version; FT_Fixed module_requires; const void * module_interface; FT_Module_Constructor module_init; FT_Module_Destructor module_done; FT_Module_Requester get_interface; } FT_Module_Class ; The module class descriptor. While being a public structure necessary for FreeType's module bookkeeping, most of the fields are essentially internal, not to be used directly by an application.","title":"FT_Module_Class"},{"location":"ft2-module_management.html#ft_add_module","text":"Defined in FT_MODULE_H (freetype/ftmodapi.h). FT_EXPORT( FT_Error ) FT_Add_Module ( FT_Library library, const FT_Module_Class * clazz ); Add a new module to a given library instance.","title":"FT_Add_Module"},{"location":"ft2-module_management.html#ft_get_module","text":"Defined in FT_MODULE_H (freetype/ftmodapi.h). FT_EXPORT( FT_Module ) FT_Get_Module ( FT_Library library, const char * module_name ); Find a module by its name.","title":"FT_Get_Module"},{"location":"ft2-module_management.html#ft_remove_module","text":"Defined in FT_MODULE_H (freetype/ftmodapi.h). FT_EXPORT( FT_Error ) FT_Remove_Module ( FT_Library library, FT_Module module ); Remove a given module from a library instance.","title":"FT_Remove_Module"},{"location":"ft2-module_management.html#ft_add_default_modules","text":"Defined in FT_MODULE_H (freetype/ftmodapi.h). FT_EXPORT( void ) FT_Add_Default_Modules ( FT_Library library ); Add the set of default drivers to a given library object. This is only useful when you create a library object with FT_New_Library (usually to plug a custom memory manager).","title":"FT_Add_Default_Modules"},{"location":"ft2-module_management.html#ft_property_set","text":"Defined in FT_MODULE_H (freetype/ftmodapi.h). FT_EXPORT( FT_Error ) FT_Property_Set ( FT_Library library, const FT_String * module_name, const FT_String * property_name, const void * value ); Set a property for a given module.","title":"FT_Property_Set"},{"location":"ft2-module_management.html#ft_property_get","text":"Defined in FT_MODULE_H (freetype/ftmodapi.h). FT_EXPORT( FT_Error ) FT_Property_Get ( FT_Library library, const FT_String * module_name, const FT_String * property_name, void * value ); Get a module's property value.","title":"FT_Property_Get"},{"location":"ft2-module_management.html#ft_set_default_properties","text":"Defined in FT_MODULE_H (freetype/ftmodapi.h). FT_EXPORT( void ) FT_Set_Default_Properties ( FT_Library library ); If compilation option FT_CONFIG_OPTION_ENVIRONMENT_PROPERTIES is set, this function reads the FREETYPE_PROPERTIES environment variable to control driver properties. See section \u2018 Driver properties \u2019 for more. If the compilation option is not set, this function does nothing. FREETYPE_PROPERTIES has the following syntax form (broken here into multiple lines for better readability). <optional whitespace> <module-name1> ':' <property-name1> '=' <property-value1> <whitespace> <module-name2> ':' <property-name2> '=' <property-value2> ... Example: FREETYPE_PROPERTIES=truetype:interpreter-version=35 \\ cff:no-stem-darkening=0 \\ autofitter:warping=1","title":"FT_Set_Default_Properties"},{"location":"ft2-module_management.html#ft_new_library","text":"Defined in FT_MODULE_H (freetype/ftmodapi.h). FT_EXPORT( FT_Error ) FT_New_Library ( FT_Memory memory, FT_Library *alibrary ); This function is used to create a new FreeType library instance from a given memory object. It is thus possible to use libraries with distinct memory allocators within the same program. Note, however, that the used FT_Memory structure is expected to remain valid for the life of the FT_Library object. Normally, you would call this function (followed by a call to FT_Add_Default_Modules or a series of calls to FT_Add_Module , and a call to FT_Set_Default_Properties ) instead of FT_Init_FreeType to initialize the FreeType library. Don't use FT_Done_FreeType but FT_Done_Library to destroy a library instance.","title":"FT_New_Library"},{"location":"ft2-module_management.html#ft_done_library","text":"Defined in FT_MODULE_H (freetype/ftmodapi.h). FT_EXPORT( FT_Error ) FT_Done_Library ( FT_Library library ); Discard a given library object. This closes all drivers and discards all resource objects.","title":"FT_Done_Library"},{"location":"ft2-module_management.html#ft_reference_library","text":"Defined in FT_MODULE_H (freetype/ftmodapi.h). FT_EXPORT( FT_Error ) FT_Reference_Library ( FT_Library library ); A counter gets initialized to 1 at the time an FT_Library structure is created. This function increments the counter. FT_Done_Library then only destroys a library if the counter is 1, otherwise it simply decrements the counter. This function helps in managing life-cycles of structures that reference FT_Library objects.","title":"FT_Reference_Library"},{"location":"ft2-module_management.html#ft_renderer","text":"Defined in FT_FREETYPE_H (freetype/freetype.h). typedef struct FT_RendererRec_* FT_Renderer ; A handle to a given FreeType renderer. A renderer is a module in charge of converting a glyph's outline image to a bitmap. It supports a single glyph image format, and one or more target surface depths.","title":"FT_Renderer"},{"location":"ft2-module_management.html#ft_renderer_class","text":"Defined in FT_RENDER_H (freetype/ftrender.h). typedef struct FT_Renderer_Class_ { FT_Module_Class root; FT_Glyph_Format glyph_format; FT_Renderer_RenderFunc render_glyph; FT_Renderer_TransformFunc transform_glyph; FT_Renderer_GetCBoxFunc get_glyph_cbox; FT_Renderer_SetModeFunc set_mode; FT_Raster_Funcs * raster_class; } FT_Renderer_Class ; The renderer module class descriptor.","title":"FT_Renderer_Class"},{"location":"ft2-module_management.html#ft_get_renderer","text":"Defined in FT_RENDER_H (freetype/ftrender.h). FT_EXPORT( FT_Renderer ) FT_Get_Renderer ( FT_Library library, FT_Glyph_Format format ); Retrieve the current renderer for a given glyph format.","title":"FT_Get_Renderer"},{"location":"ft2-module_management.html#ft_set_renderer","text":"Defined in FT_RENDER_H (freetype/ftrender.h). FT_EXPORT( FT_Error ) FT_Set_Renderer ( FT_Library library, FT_Renderer renderer, FT_UInt num_params, FT_Parameter * parameters ); Set the current renderer to use, and set additional mode.","title":"FT_Set_Renderer"},{"location":"ft2-module_management.html#ft_set_debug_hook","text":"Defined in FT_MODULE_H (freetype/ftmodapi.h). FT_EXPORT( void ) FT_Set_Debug_Hook ( FT_Library library, FT_UInt hook_index, FT_DebugHook_Func debug_hook ); Set a debug hook function for debugging the interpreter of a font format. While this is a public API function, an application needs access to FreeType's internal header files to do something useful. Have a look at the source code of the ttdebug FreeType demo program for an example of its usage.","title":"FT_Set_Debug_Hook"},{"location":"ft2-module_management.html#ft_driver","text":"Defined in FT_FREETYPE_H (freetype/freetype.h). typedef struct FT_DriverRec_* FT_Driver ; A handle to a given FreeType font driver object. A font driver is a module capable of creating faces from font files.","title":"FT_Driver"},{"location":"ft2-module_management.html#ft_debughook_func","text":"Defined in FT_MODULE_H (freetype/ftmodapi.h). typedef FT_Error (* FT_DebugHook_Func )( void * arg ); A drop-in replacement (or rather a wrapper) for the bytecode or charstring interpreter's main loop function. Its job is essentially to activate debug mode to enforce single-stepping, to call the main loop function to interpret the next opcode, and to show the changed context to the user. An example for such a main loop function is TT_RunIns (declared in FreeType's internal header file src/truetype/ttinterp.h ). Have a look at the source code of the ttdebug FreeType demo program for an example of a drop-in replacement.","title":"FT_DebugHook_Func"},{"location":"ft2-module_management.html#ft_debug_hook_xxx","text":"Defined in FT_MODULE_H (freetype/ftmodapi.h). # define FT_DEBUG_HOOK_TRUETYPE 0 A list of named debug hook indices.","title":"FT_DEBUG_HOOK_XXX"},{"location":"ft2-multiple_masters.html","text":"FreeType \u00bb Docs \u00bb Format-Specific API \u00bb Multiple Masters Multiple Masters \u00b6 Synopsis \u00b6 The following types and functions are used to manage Multiple Master fonts, i.e., the selection of specific design instances by setting design axis coordinates. Besides Adobe MM fonts, the interface supports Apple's TrueType GX and OpenType variation fonts. Some of the routines only work with Adobe MM fonts, others will work with all three types. They are similar enough that a consistent interface makes sense. FT_MM_Axis \u00b6 Defined in FT_MULTIPLE_MASTERS_H (freetype/ftmm.h). typedef struct FT_MM_Axis_ { FT_String * name; FT_Long minimum; FT_Long maximum; } FT_MM_Axis ; A structure to model a given axis in design space for Multiple Masters fonts. This structure can't be used for TrueType GX or OpenType variation fonts. fields name The axis's name. minimum The axis's minimum design coordinate. maximum The axis's maximum design coordinate. FT_Multi_Master \u00b6 Defined in FT_MULTIPLE_MASTERS_H (freetype/ftmm.h). typedef struct FT_Multi_Master_ { FT_UInt num_axis; FT_UInt num_designs; FT_MM_Axis axis[T1_MAX_MM_AXIS]; } FT_Multi_Master ; A structure to model the axes and space of a Multiple Masters font. This structure can't be used for TrueType GX or OpenType variation fonts. fields num_axis Number of axes. Cannot exceed 4. num_designs Number of designs; should be normally 2^num_axis even though the Type 1 specification strangely allows for intermediate designs to be present. This number cannot exceed 16. axis A table of axis descriptors. FT_Var_Axis \u00b6 Defined in FT_MULTIPLE_MASTERS_H (freetype/ftmm.h). typedef struct FT_Var_Axis_ { FT_String * name; FT_Fixed minimum; FT_Fixed def; FT_Fixed maximum; FT_ULong tag; FT_UInt strid; } FT_Var_Axis ; A structure to model a given axis in design space for Multiple Masters, TrueType GX, and OpenType variation fonts. fields name The axis's name. Not always meaningful for TrueType GX or OpenType variation fonts. minimum The axis's minimum design coordinate. def The axis's default design coordinate. FreeType computes meaningful default values for Adobe MM fonts. maximum The axis's maximum design coordinate. tag The axis's tag (the equivalent to \u2018name\u2019 for TrueType GX and OpenType variation fonts). FreeType provides default values for Adobe MM fonts if possible. strid The axis name entry in the font's \u2018name\u2019 table. This is another (and often better) version of the \u2018name\u2019 field for TrueType GX or OpenType variation fonts. Not meaningful for Adobe MM fonts. note The fields minimum , def , and maximum are 16.16 fractional values for TrueType GX and OpenType variation fonts. For Adobe MM fonts, the values are integers. FT_Var_Named_Style \u00b6 Defined in FT_MULTIPLE_MASTERS_H (freetype/ftmm.h). typedef struct FT_Var_Named_Style_ { FT_Fixed * coords; FT_UInt strid; FT_UInt psid; /* since 2.7.1 */ } FT_Var_Named_Style ; A structure to model a named instance in a TrueType GX or OpenType variation font. This structure can't be used for Adobe MM fonts. fields coords The design coordinates for this instance. This is an array with one entry for each axis. strid The entry in \u2018name\u2019 table identifying this instance. psid The entry in \u2018name\u2019 table identifying a PostScript name for this instance. Value 0xFFFF indicates a missing entry. FT_MM_Var \u00b6 Defined in FT_MULTIPLE_MASTERS_H (freetype/ftmm.h). typedef struct FT_MM_Var_ { FT_UInt num_axis; FT_UInt num_designs; FT_UInt num_namedstyles; FT_Var_Axis * axis; FT_Var_Named_Style * namedstyle; } FT_MM_Var ; A structure to model the axes and space of an Adobe MM, TrueType GX, or OpenType variation font. Some fields are specific to one format and not to the others. fields num_axis The number of axes. The maximum value is 4 for Adobe MM fonts; no limit in TrueType GX or OpenType variation fonts. num_designs The number of designs; should be normally 2^num_axis for Adobe MM fonts. Not meaningful for TrueType GX or OpenType variation fonts (where every glyph could have a different number of designs). num_namedstyles The number of named styles; a \u2018named style\u2019 is a tuple of design coordinates that has a string ID (in the \u2018name\u2019 table) associated with it. The font can tell the user that, for example, [Weight=1.5,Width=1.1] is \u2018Bold\u2019. Another name for \u2018named style\u2019 is \u2018named instance\u2019. For Adobe Multiple Masters fonts, this value is always zero because the format does not support named styles. axis An axis descriptor table. TrueType GX and OpenType variation fonts contain slightly more data than Adobe MM fonts. Memory management of this pointer is done internally by FreeType. namedstyle A named style (instance) table. Only meaningful for TrueType GX and OpenType variation fonts. Memory management of this pointer is done internally by FreeType. FT_Get_Multi_Master \u00b6 Defined in FT_MULTIPLE_MASTERS_H (freetype/ftmm.h). FT_EXPORT( FT_Error ) FT_Get_Multi_Master ( FT_Face face, FT_Multi_Master *amaster ); Retrieve a variation descriptor of a given Adobe MM font. This function can't be used with TrueType GX or OpenType variation fonts. input face A handle to the source face. output amaster The Multiple Masters descriptor. return FreeType error code. 0 means success. FT_Get_MM_Var \u00b6 Defined in FT_MULTIPLE_MASTERS_H (freetype/ftmm.h). FT_EXPORT( FT_Error ) FT_Get_MM_Var ( FT_Face face, FT_MM_Var * *amaster ); Retrieve a variation descriptor for a given font. This function works with all supported variation formats. input face A handle to the source face. output amaster The variation descriptor. Allocates a data structure, which the user must deallocate with a call to FT_Done_MM_Var after use. return FreeType error code. 0 means success. FT_Done_MM_Var \u00b6 Defined in FT_MULTIPLE_MASTERS_H (freetype/ftmm.h). FT_EXPORT( FT_Error ) FT_Done_MM_Var ( FT_Library library, FT_MM_Var *amaster ); Free the memory allocated by FT_Get_MM_Var . input library A handle of the face's parent library object that was used in the call to FT_Get_MM_Var to create amaster . return FreeType error code. 0 means success. FT_Set_MM_Design_Coordinates \u00b6 Defined in FT_MULTIPLE_MASTERS_H (freetype/ftmm.h). FT_EXPORT( FT_Error ) FT_Set_MM_Design_Coordinates ( FT_Face face, FT_UInt num_coords, FT_Long * coords ); For Adobe MM fonts, choose an interpolated font design through design coordinates. This function can't be used with TrueType GX or OpenType variation fonts. inout face A handle to the source face. input num_coords The number of available design coordinates. If it is larger than the number of axes, ignore the excess values. If it is smaller than the number of axes, use default values for the remaining axes. coords An array of design coordinates. return FreeType error code. 0 means success. note [Since 2.8.1] To reset all axes to the default values, call the function with num_coords set to zero and coords set to NULL . [Since 2.9] If num_coords is larger than zero, this function sets the FT_FACE_FLAG_VARIATION bit in FT_Face 's face_flags field (i.e., FT_IS_VARIATION will return true). If num_coords is zero, this bit flag gets unset. FT_Set_Var_Design_Coordinates \u00b6 Defined in FT_MULTIPLE_MASTERS_H (freetype/ftmm.h). FT_EXPORT( FT_Error ) FT_Set_Var_Design_Coordinates ( FT_Face face, FT_UInt num_coords, FT_Fixed * coords ); Choose an interpolated font design through design coordinates. This function works with all supported variation formats. inout face A handle to the source face. input num_coords The number of available design coordinates. If it is larger than the number of axes, ignore the excess values. If it is smaller than the number of axes, use default values for the remaining axes. coords An array of design coordinates. return FreeType error code. 0 means success. note [Since 2.8.1] To reset all axes to the default values, call the function with num_coords set to zero and coords set to NULL . [Since 2.9] \u2018Default values\u2019 means the currently selected named instance (or the base font if no named instance is selected). [Since 2.9] If num_coords is larger than zero, this function sets the FT_FACE_FLAG_VARIATION bit in FT_Face 's face_flags field (i.e., FT_IS_VARIATION will return true). If num_coords is zero, this bit flag gets unset. FT_Get_Var_Design_Coordinates \u00b6 Defined in FT_MULTIPLE_MASTERS_H (freetype/ftmm.h). FT_EXPORT( FT_Error ) FT_Get_Var_Design_Coordinates ( FT_Face face, FT_UInt num_coords, FT_Fixed * coords ); Get the design coordinates of the currently selected interpolated font. This function works with all supported variation formats. input face A handle to the source face. num_coords The number of design coordinates to retrieve. If it is larger than the number of axes, set the excess values to 0. output coords The design coordinates array. return FreeType error code. 0 means success. since 2.7.1 FT_Set_MM_Blend_Coordinates \u00b6 Defined in FT_MULTIPLE_MASTERS_H (freetype/ftmm.h). FT_EXPORT( FT_Error ) FT_Set_MM_Blend_Coordinates ( FT_Face face, FT_UInt num_coords, FT_Fixed * coords ); Choose an interpolated font design through normalized blend coordinates. This function works with all supported variation formats. inout face A handle to the source face. input num_coords The number of available design coordinates. If it is larger than the number of axes, ignore the excess values. If it is smaller than the number of axes, use default values for the remaining axes. coords The design coordinates array (each element must be between 0 and 1.0 for Adobe MM fonts, and between -1.0 and 1.0 for TrueType GX and OpenType variation fonts). return FreeType error code. 0 means success. note [Since 2.8.1] To reset all axes to the default values, call the function with num_coords set to zero and coords set to NULL . [Since 2.9] \u2018Default values\u2019 means the currently selected named instance (or the base font if no named instance is selected). [Since 2.9] If num_coords is larger than zero, this function sets the FT_FACE_FLAG_VARIATION bit in FT_Face 's face_flags field (i.e., FT_IS_VARIATION will return true). If num_coords is zero, this bit flag gets unset. FT_Get_MM_Blend_Coordinates \u00b6 Defined in FT_MULTIPLE_MASTERS_H (freetype/ftmm.h). FT_EXPORT( FT_Error ) FT_Get_MM_Blend_Coordinates ( FT_Face face, FT_UInt num_coords, FT_Fixed * coords ); Get the normalized blend coordinates of the currently selected interpolated font. This function works with all supported variation formats. input face A handle to the source face. num_coords The number of normalized blend coordinates to retrieve. If it is larger than the number of axes, set the excess values to 0.5 for Adobe MM fonts, and to 0 for TrueType GX and OpenType variation fonts. output coords The normalized blend coordinates array. return FreeType error code. 0 means success. since 2.7.1 FT_Set_Var_Blend_Coordinates \u00b6 Defined in FT_MULTIPLE_MASTERS_H (freetype/ftmm.h). FT_EXPORT( FT_Error ) FT_Set_Var_Blend_Coordinates ( FT_Face face, FT_UInt num_coords, FT_Fixed * coords ); This is another name of FT_Set_MM_Blend_Coordinates . FT_Get_Var_Blend_Coordinates \u00b6 Defined in FT_MULTIPLE_MASTERS_H (freetype/ftmm.h). FT_EXPORT( FT_Error ) FT_Get_Var_Blend_Coordinates ( FT_Face face, FT_UInt num_coords, FT_Fixed * coords ); This is another name of FT_Get_MM_Blend_Coordinates . since 2.7.1 FT_Set_MM_WeightVector \u00b6 Defined in FT_MULTIPLE_MASTERS_H (freetype/ftmm.h). FT_EXPORT( FT_Error ) FT_Set_MM_WeightVector ( FT_Face face, FT_UInt len, FT_Fixed * weightvector ); For Adobe MM fonts, choose an interpolated font design by directly setting the weight vector. This function can't be used with TrueType GX or OpenType variation fonts. inout face A handle to the source face. input len The length of the weight vector array. If it is larger than the number of designs, the extra values are ignored. If it is less than the number of designs, the remaining values are set to zero. weightvector An array representing the weight vector. return FreeType error code. 0 means success. note Adobe Multiple Master fonts limit the number of designs, and thus the length of the weight vector to 16. If len is zero and weightvector is NULL , the weight vector array is reset to the default values. The Adobe documentation also states that the values in the WeightVector array must total 1.0 \u00b1 0.001. In practice this does not seem to be enforced, so is not enforced here, either. since 2.10 FT_Get_MM_WeightVector \u00b6 Defined in FT_MULTIPLE_MASTERS_H (freetype/ftmm.h). FT_EXPORT( FT_Error ) FT_Get_MM_WeightVector ( FT_Face face, FT_UInt * len, FT_Fixed * weightvector ); For Adobe MM fonts, retrieve the current weight vector of the font. This function can't be used with TrueType GX or OpenType variation fonts. inout face A handle to the source face. len A pointer to the size of the array to be filled. If the size of the array is less than the number of designs, FT_Err_Invalid_Argument is returned, and len is set to the required size (the number of designs). If the size of the array is greater than the number of designs, the remaining entries are set to 0. On successful completion, len is set to the number of designs (i.e., the number of values written to the array). output weightvector An array to be filled. return FreeType error code. 0 means success. note Adobe Multiple Master fonts limit the number of designs, and thus the length of the WeightVector to 16. since 2.10 FT_VAR_AXIS_FLAG_XXX \u00b6 Defined in FT_MULTIPLE_MASTERS_H (freetype/ftmm.h). # define FT_VAR_AXIS_FLAG_HIDDEN 1 A list of bit flags used in the return value of FT_Get_Var_Axis_Flags . values FT_VAR_AXIS_FLAG_HIDDEN The variation axis should not be exposed to user interfaces. since 2.8.1 FT_Get_Var_Axis_Flags \u00b6 Defined in FT_MULTIPLE_MASTERS_H (freetype/ftmm.h). FT_EXPORT( FT_Error ) FT_Get_Var_Axis_Flags ( FT_MM_Var * master, FT_UInt axis_index, FT_UInt * flags ); Get the \u2018flags\u2019 field of an OpenType Variation Axis Record. Not meaningful for Adobe MM fonts ( *flags is always zero). input master The variation descriptor. axis_index The index of the requested variation axis. output flags The \u2018flags\u2019 field. See FT_VAR_AXIS_FLAG_XXX for possible values. return FreeType error code. 0 means success. since 2.8.1 FT_Set_Named_Instance \u00b6 Defined in FT_MULTIPLE_MASTERS_H (freetype/ftmm.h). FT_EXPORT( FT_Error ) FT_Set_Named_Instance ( FT_Face face, FT_UInt instance_index ); Set or change the current named instance. input face A handle to the source face. instance_index The index of the requested instance, starting with value 1. If set to value 0, FreeType switches to font access without a named instance. return FreeType error code. 0 means success. note The function uses the value of instance_index to set bits 16-30 of the face's face_index field. It also resets any variation applied to the font, and the FT_FACE_FLAG_VARIATION bit of the face's face_flags field gets reset to zero (i.e., FT_IS_VARIATION will return false). For Adobe MM fonts (which don't have named instances) this function simply resets the current face to the default instance. since 2.9","title":"Multiple Masters"},{"location":"ft2-multiple_masters.html#multiple-masters","text":"","title":"Multiple Masters"},{"location":"ft2-multiple_masters.html#synopsis","text":"The following types and functions are used to manage Multiple Master fonts, i.e., the selection of specific design instances by setting design axis coordinates. Besides Adobe MM fonts, the interface supports Apple's TrueType GX and OpenType variation fonts. Some of the routines only work with Adobe MM fonts, others will work with all three types. They are similar enough that a consistent interface makes sense.","title":"Synopsis"},{"location":"ft2-multiple_masters.html#ft_mm_axis","text":"Defined in FT_MULTIPLE_MASTERS_H (freetype/ftmm.h). typedef struct FT_MM_Axis_ { FT_String * name; FT_Long minimum; FT_Long maximum; } FT_MM_Axis ; A structure to model a given axis in design space for Multiple Masters fonts. This structure can't be used for TrueType GX or OpenType variation fonts.","title":"FT_MM_Axis"},{"location":"ft2-multiple_masters.html#ft_multi_master","text":"Defined in FT_MULTIPLE_MASTERS_H (freetype/ftmm.h). typedef struct FT_Multi_Master_ { FT_UInt num_axis; FT_UInt num_designs; FT_MM_Axis axis[T1_MAX_MM_AXIS]; } FT_Multi_Master ; A structure to model the axes and space of a Multiple Masters font. This structure can't be used for TrueType GX or OpenType variation fonts.","title":"FT_Multi_Master"},{"location":"ft2-multiple_masters.html#ft_var_axis","text":"Defined in FT_MULTIPLE_MASTERS_H (freetype/ftmm.h). typedef struct FT_Var_Axis_ { FT_String * name; FT_Fixed minimum; FT_Fixed def; FT_Fixed maximum; FT_ULong tag; FT_UInt strid; } FT_Var_Axis ; A structure to model a given axis in design space for Multiple Masters, TrueType GX, and OpenType variation fonts.","title":"FT_Var_Axis"},{"location":"ft2-multiple_masters.html#ft_var_named_style","text":"Defined in FT_MULTIPLE_MASTERS_H (freetype/ftmm.h). typedef struct FT_Var_Named_Style_ { FT_Fixed * coords; FT_UInt strid; FT_UInt psid; /* since 2.7.1 */ } FT_Var_Named_Style ; A structure to model a named instance in a TrueType GX or OpenType variation font. This structure can't be used for Adobe MM fonts.","title":"FT_Var_Named_Style"},{"location":"ft2-multiple_masters.html#ft_mm_var","text":"Defined in FT_MULTIPLE_MASTERS_H (freetype/ftmm.h). typedef struct FT_MM_Var_ { FT_UInt num_axis; FT_UInt num_designs; FT_UInt num_namedstyles; FT_Var_Axis * axis; FT_Var_Named_Style * namedstyle; } FT_MM_Var ; A structure to model the axes and space of an Adobe MM, TrueType GX, or OpenType variation font. Some fields are specific to one format and not to the others.","title":"FT_MM_Var"},{"location":"ft2-multiple_masters.html#ft_get_multi_master","text":"Defined in FT_MULTIPLE_MASTERS_H (freetype/ftmm.h). FT_EXPORT( FT_Error ) FT_Get_Multi_Master ( FT_Face face, FT_Multi_Master *amaster ); Retrieve a variation descriptor of a given Adobe MM font. This function can't be used with TrueType GX or OpenType variation fonts.","title":"FT_Get_Multi_Master"},{"location":"ft2-multiple_masters.html#ft_get_mm_var","text":"Defined in FT_MULTIPLE_MASTERS_H (freetype/ftmm.h). FT_EXPORT( FT_Error ) FT_Get_MM_Var ( FT_Face face, FT_MM_Var * *amaster ); Retrieve a variation descriptor for a given font. This function works with all supported variation formats.","title":"FT_Get_MM_Var"},{"location":"ft2-multiple_masters.html#ft_done_mm_var","text":"Defined in FT_MULTIPLE_MASTERS_H (freetype/ftmm.h). FT_EXPORT( FT_Error ) FT_Done_MM_Var ( FT_Library library, FT_MM_Var *amaster ); Free the memory allocated by FT_Get_MM_Var .","title":"FT_Done_MM_Var"},{"location":"ft2-multiple_masters.html#ft_set_mm_design_coordinates","text":"Defined in FT_MULTIPLE_MASTERS_H (freetype/ftmm.h). FT_EXPORT( FT_Error ) FT_Set_MM_Design_Coordinates ( FT_Face face, FT_UInt num_coords, FT_Long * coords ); For Adobe MM fonts, choose an interpolated font design through design coordinates. This function can't be used with TrueType GX or OpenType variation fonts.","title":"FT_Set_MM_Design_Coordinates"},{"location":"ft2-multiple_masters.html#ft_set_var_design_coordinates","text":"Defined in FT_MULTIPLE_MASTERS_H (freetype/ftmm.h). FT_EXPORT( FT_Error ) FT_Set_Var_Design_Coordinates ( FT_Face face, FT_UInt num_coords, FT_Fixed * coords ); Choose an interpolated font design through design coordinates. This function works with all supported variation formats.","title":"FT_Set_Var_Design_Coordinates"},{"location":"ft2-multiple_masters.html#ft_get_var_design_coordinates","text":"Defined in FT_MULTIPLE_MASTERS_H (freetype/ftmm.h). FT_EXPORT( FT_Error ) FT_Get_Var_Design_Coordinates ( FT_Face face, FT_UInt num_coords, FT_Fixed * coords ); Get the design coordinates of the currently selected interpolated font. This function works with all supported variation formats.","title":"FT_Get_Var_Design_Coordinates"},{"location":"ft2-multiple_masters.html#ft_set_mm_blend_coordinates","text":"Defined in FT_MULTIPLE_MASTERS_H (freetype/ftmm.h). FT_EXPORT( FT_Error ) FT_Set_MM_Blend_Coordinates ( FT_Face face, FT_UInt num_coords, FT_Fixed * coords ); Choose an interpolated font design through normalized blend coordinates. This function works with all supported variation formats.","title":"FT_Set_MM_Blend_Coordinates"},{"location":"ft2-multiple_masters.html#ft_get_mm_blend_coordinates","text":"Defined in FT_MULTIPLE_MASTERS_H (freetype/ftmm.h). FT_EXPORT( FT_Error ) FT_Get_MM_Blend_Coordinates ( FT_Face face, FT_UInt num_coords, FT_Fixed * coords ); Get the normalized blend coordinates of the currently selected interpolated font. This function works with all supported variation formats.","title":"FT_Get_MM_Blend_Coordinates"},{"location":"ft2-multiple_masters.html#ft_set_var_blend_coordinates","text":"Defined in FT_MULTIPLE_MASTERS_H (freetype/ftmm.h). FT_EXPORT( FT_Error ) FT_Set_Var_Blend_Coordinates ( FT_Face face, FT_UInt num_coords, FT_Fixed * coords ); This is another name of FT_Set_MM_Blend_Coordinates .","title":"FT_Set_Var_Blend_Coordinates"},{"location":"ft2-multiple_masters.html#ft_get_var_blend_coordinates","text":"Defined in FT_MULTIPLE_MASTERS_H (freetype/ftmm.h). FT_EXPORT( FT_Error ) FT_Get_Var_Blend_Coordinates ( FT_Face face, FT_UInt num_coords, FT_Fixed * coords ); This is another name of FT_Get_MM_Blend_Coordinates .","title":"FT_Get_Var_Blend_Coordinates"},{"location":"ft2-multiple_masters.html#ft_set_mm_weightvector","text":"Defined in FT_MULTIPLE_MASTERS_H (freetype/ftmm.h). FT_EXPORT( FT_Error ) FT_Set_MM_WeightVector ( FT_Face face, FT_UInt len, FT_Fixed * weightvector ); For Adobe MM fonts, choose an interpolated font design by directly setting the weight vector. This function can't be used with TrueType GX or OpenType variation fonts.","title":"FT_Set_MM_WeightVector"},{"location":"ft2-multiple_masters.html#ft_get_mm_weightvector","text":"Defined in FT_MULTIPLE_MASTERS_H (freetype/ftmm.h). FT_EXPORT( FT_Error ) FT_Get_MM_WeightVector ( FT_Face face, FT_UInt * len, FT_Fixed * weightvector ); For Adobe MM fonts, retrieve the current weight vector of the font. This function can't be used with TrueType GX or OpenType variation fonts.","title":"FT_Get_MM_WeightVector"},{"location":"ft2-multiple_masters.html#ft_var_axis_flag_xxx","text":"Defined in FT_MULTIPLE_MASTERS_H (freetype/ftmm.h). # define FT_VAR_AXIS_FLAG_HIDDEN 1 A list of bit flags used in the return value of FT_Get_Var_Axis_Flags .","title":"FT_VAR_AXIS_FLAG_XXX"},{"location":"ft2-multiple_masters.html#ft_get_var_axis_flags","text":"Defined in FT_MULTIPLE_MASTERS_H (freetype/ftmm.h). FT_EXPORT( FT_Error ) FT_Get_Var_Axis_Flags ( FT_MM_Var * master, FT_UInt axis_index, FT_UInt * flags ); Get the \u2018flags\u2019 field of an OpenType Variation Axis Record. Not meaningful for Adobe MM fonts ( *flags is always zero).","title":"FT_Get_Var_Axis_Flags"},{"location":"ft2-multiple_masters.html#ft_set_named_instance","text":"Defined in FT_MULTIPLE_MASTERS_H (freetype/ftmm.h). FT_EXPORT( FT_Error ) FT_Set_Named_Instance ( FT_Face face, FT_UInt instance_index ); Set or change the current named instance.","title":"FT_Set_Named_Instance"},{"location":"ft2-ot_validation.html","text":"FreeType \u00bb Docs \u00bb Miscellaneous \u00bb OpenType Validation OpenType Validation \u00b6 Synopsis \u00b6 This section contains the declaration of functions to validate some OpenType tables (BASE, GDEF, GPOS, GSUB, JSTF, MATH). FT_OpenType_Validate \u00b6 Defined in FT_OPENTYPE_VALIDATE_H (freetype/ftotval.h). FT_EXPORT( FT_Error ) FT_OpenType_Validate ( FT_Face face, FT_UInt validation_flags, FT_Bytes *BASE_table, FT_Bytes *GDEF_table, FT_Bytes *GPOS_table, FT_Bytes *GSUB_table, FT_Bytes *JSTF_table ); Validate various OpenType tables to assure that all offsets and indices are valid. The idea is that a higher-level library that actually does the text layout can access those tables without error checking (which can be quite time consuming). input face A handle to the input face. validation_flags A bit field that specifies the tables to be validated. See FT_VALIDATE_OTXXX for possible values. output BASE_table A pointer to the BASE table. GDEF_table A pointer to the GDEF table. GPOS_table A pointer to the GPOS table. GSUB_table A pointer to the GSUB table. JSTF_table A pointer to the JSTF table. return FreeType error code. 0 means success. note This function only works with OpenType fonts, returning an error otherwise. After use, the application should deallocate the five tables with FT_OpenType_Free . A NULL value indicates that the table either doesn't exist in the font, or the application hasn't asked for validation. FT_OpenType_Free \u00b6 Defined in FT_OPENTYPE_VALIDATE_H (freetype/ftotval.h). FT_EXPORT( void ) FT_OpenType_Free ( FT_Face face, FT_Bytes table ); Free the buffer allocated by OpenType validator. input face A handle to the input face. table The pointer to the buffer that is allocated by FT_OpenType_Validate . note This function must be used to free the buffer allocated by FT_OpenType_Validate only. FT_VALIDATE_OTXXX \u00b6 Defined in FT_OPENTYPE_VALIDATE_H (freetype/ftotval.h). # define FT_VALIDATE_BASE 0x0100 # define FT_VALIDATE_GDEF 0x0200 # define FT_VALIDATE_GPOS 0x0400 # define FT_VALIDATE_GSUB 0x0800 # define FT_VALIDATE_JSTF 0x1000 # define FT_VALIDATE_MATH 0x2000 # define FT_VALIDATE_OT ( FT_VALIDATE_BASE | \\ FT_VALIDATE_GDEF | \\ FT_VALIDATE_GPOS | \\ FT_VALIDATE_GSUB | \\ FT_VALIDATE_JSTF | \\ FT_VALIDATE_MATH ) A list of bit-field constants used with FT_OpenType_Validate to indicate which OpenType tables should be validated. values FT_VALIDATE_BASE Validate BASE table. FT_VALIDATE_GDEF Validate GDEF table. FT_VALIDATE_GPOS Validate GPOS table. FT_VALIDATE_GSUB Validate GSUB table. FT_VALIDATE_JSTF Validate JSTF table. FT_VALIDATE_MATH Validate MATH table. FT_VALIDATE_OT Validate all OpenType tables (BASE, GDEF, GPOS, GSUB, JSTF, MATH).","title":"OpenType Validation"},{"location":"ft2-ot_validation.html#opentype-validation","text":"","title":"OpenType Validation"},{"location":"ft2-ot_validation.html#synopsis","text":"This section contains the declaration of functions to validate some OpenType tables (BASE, GDEF, GPOS, GSUB, JSTF, MATH).","title":"Synopsis"},{"location":"ft2-ot_validation.html#ft_opentype_validate","text":"Defined in FT_OPENTYPE_VALIDATE_H (freetype/ftotval.h). FT_EXPORT( FT_Error ) FT_OpenType_Validate ( FT_Face face, FT_UInt validation_flags, FT_Bytes *BASE_table, FT_Bytes *GDEF_table, FT_Bytes *GPOS_table, FT_Bytes *GSUB_table, FT_Bytes *JSTF_table ); Validate various OpenType tables to assure that all offsets and indices are valid. The idea is that a higher-level library that actually does the text layout can access those tables without error checking (which can be quite time consuming).","title":"FT_OpenType_Validate"},{"location":"ft2-ot_validation.html#ft_opentype_free","text":"Defined in FT_OPENTYPE_VALIDATE_H (freetype/ftotval.h). FT_EXPORT( void ) FT_OpenType_Free ( FT_Face face, FT_Bytes table ); Free the buffer allocated by OpenType validator.","title":"FT_OpenType_Free"},{"location":"ft2-ot_validation.html#ft_validate_otxxx","text":"Defined in FT_OPENTYPE_VALIDATE_H (freetype/ftotval.h). # define FT_VALIDATE_BASE 0x0100 # define FT_VALIDATE_GDEF 0x0200 # define FT_VALIDATE_GPOS 0x0400 # define FT_VALIDATE_GSUB 0x0800 # define FT_VALIDATE_JSTF 0x1000 # define FT_VALIDATE_MATH 0x2000 # define FT_VALIDATE_OT ( FT_VALIDATE_BASE | \\ FT_VALIDATE_GDEF | \\ FT_VALIDATE_GPOS | \\ FT_VALIDATE_GSUB | \\ FT_VALIDATE_JSTF | \\ FT_VALIDATE_MATH ) A list of bit-field constants used with FT_OpenType_Validate to indicate which OpenType tables should be validated.","title":"FT_VALIDATE_OTXXX"},{"location":"ft2-outline_processing.html","text":"FreeType \u00bb Docs \u00bb Support API \u00bb Outline Processing Outline Processing \u00b6 Synopsis \u00b6 This section contains routines used to create and destroy scalable glyph images known as \u2018outlines\u2019. These can also be measured, transformed, and converted into bitmaps and pixmaps. FT_Outline \u00b6 Defined in FT_IMAGE_H (freetype/ftimage.h). typedef struct FT_Outline_ { short n_contours; /* number of contours in glyph */ short n_points; /* number of points in the glyph */ FT_Vector * points; /* the outline's points */ char * tags; /* the points flags */ short * contours; /* the contour end points */ int flags; /* outline masks */ } FT_Outline ; This structure is used to describe an outline to the scan-line converter. fields n_contours The number of contours in the outline. n_points The number of points in the outline. points A pointer to an array of n_points FT_Vector elements, giving the outline's point coordinates. tags A pointer to an array of n_points chars, giving each outline point's type. If bit 0 is unset, the point is \u2018off\u2019 the curve, i.e., a Bezier control point, while it is \u2018on\u2019 if set. Bit 1 is meaningful for \u2018off\u2019 points only. If set, it indicates a third-order Bezier arc control point; and a second-order control point if unset. If bit 2 is set, bits 5-7 contain the drop-out mode (as defined in the OpenType specification; the value is the same as the argument to the \u2018SCANMODE\u2019 instruction). Bits 3 and 4 are reserved for internal purposes. contours An array of n_contours shorts, giving the end point of each contour within the outline. For example, the first contour is defined by the points \u20180\u2019 to contours[0] , the second one is defined by the points contours[0]+1 to contours[1] , etc. flags A set of bit flags used to characterize the outline and give hints to the scan-converter and hinter on how to convert/grid-fit it. See FT_OUTLINE_XXX . note The B/W rasterizer only checks bit 2 in the tags array for the first point of each contour. The drop-out mode as given with FT_OUTLINE_IGNORE_DROPOUTS , FT_OUTLINE_SMART_DROPOUTS , and FT_OUTLINE_INCLUDE_STUBS in flags is then overridden. FT_Outline_New \u00b6 Defined in FT_OUTLINE_H (freetype/ftoutln.h). FT_EXPORT( FT_Error ) FT_Outline_New ( FT_Library library, FT_UInt numPoints, FT_Int numContours, FT_Outline *anoutline ); Create a new outline of a given size. input library A handle to the library object from where the outline is allocated. Note however that the new outline will not necessarily be freed , when destroying the library, by FT_Done_FreeType . numPoints The maximum number of points within the outline. Must be smaller than or equal to 0xFFFF (65535). numContours The maximum number of contours within the outline. This value must be in the range 0 to numPoints . output anoutline A handle to the new outline. return FreeType error code. 0 means success. note The reason why this function takes a library parameter is simply to use the library's memory allocator. FT_Outline_Done \u00b6 Defined in FT_OUTLINE_H (freetype/ftoutln.h). FT_EXPORT( FT_Error ) FT_Outline_Done ( FT_Library library, FT_Outline * outline ); Destroy an outline created with FT_Outline_New . input library A handle of the library object used to allocate the outline. outline A pointer to the outline object to be discarded. return FreeType error code. 0 means success. note If the outline's \u2018owner\u2019 field is not set, only the outline descriptor will be released. FT_Outline_Copy \u00b6 Defined in FT_OUTLINE_H (freetype/ftoutln.h). FT_EXPORT( FT_Error ) FT_Outline_Copy ( const FT_Outline * source, FT_Outline *target ); Copy an outline into another one. Both objects must have the same sizes (number of points & number of contours) when this function is called. input source A handle to the source outline. output target A handle to the target outline. return FreeType error code. 0 means success. FT_Outline_Translate \u00b6 Defined in FT_OUTLINE_H (freetype/ftoutln.h). FT_EXPORT( void ) FT_Outline_Translate ( const FT_Outline * outline, FT_Pos xOffset, FT_Pos yOffset ); Apply a simple translation to the points of an outline. inout outline A pointer to the target outline descriptor. input xOffset The horizontal offset. yOffset The vertical offset. FT_Outline_Transform \u00b6 Defined in FT_OUTLINE_H (freetype/ftoutln.h). FT_EXPORT( void ) FT_Outline_Transform ( const FT_Outline * outline, const FT_Matrix * matrix ); Apply a simple 2x2 matrix to all of an outline's points. Useful for applying rotations, slanting, flipping, etc. inout outline A pointer to the target outline descriptor. input matrix A pointer to the transformation matrix. note You can use FT_Outline_Translate if you need to translate the outline's points. FT_Outline_Embolden \u00b6 Defined in FT_OUTLINE_H (freetype/ftoutln.h). FT_EXPORT( FT_Error ) FT_Outline_Embolden ( FT_Outline * outline, FT_Pos strength ); Embolden an outline. The new outline will be at most 4 times strength pixels wider and higher. You may think of the left and bottom borders as unchanged. Negative strength values to reduce the outline thickness are possible also. inout outline A handle to the target outline. input strength How strong the glyph is emboldened. Expressed in 26.6 pixel format. return FreeType error code. 0 means success. note The used algorithm to increase or decrease the thickness of the glyph doesn't change the number of points; this means that certain situations like acute angles or intersections are sometimes handled incorrectly. If you need \u2018better\u2019 metrics values you should call FT_Outline_Get_CBox or FT_Outline_Get_BBox . To get meaningful results, font scaling values must be set with functions like FT_Set_Char_Size before calling FT_Render_Glyph. example FT_Load_Glyph( face, index, FT_LOAD_DEFAULT ); if ( face->glyph->format == FT_GLYPH_FORMAT_OUTLINE ) FT_Outline_Embolden( &face->glyph->outline, strength ); FT_Outline_EmboldenXY \u00b6 Defined in FT_OUTLINE_H (freetype/ftoutln.h). FT_EXPORT( FT_Error ) FT_Outline_EmboldenXY ( FT_Outline * outline, FT_Pos xstrength, FT_Pos ystrength ); Embolden an outline. The new outline will be xstrength pixels wider and ystrength pixels higher. Otherwise, it is similar to FT_Outline_Embolden , which uses the same strength in both directions. since 2.4.10 FT_Outline_Reverse \u00b6 Defined in FT_OUTLINE_H (freetype/ftoutln.h). FT_EXPORT( void ) FT_Outline_Reverse ( FT_Outline * outline ); Reverse the drawing direction of an outline. This is used to ensure consistent fill conventions for mirrored glyphs. inout outline A pointer to the target outline descriptor. note This function toggles the bit flag FT_OUTLINE_REVERSE_FILL in the outline's flags field. It shouldn't be used by a normal client application, unless it knows what it is doing. FT_Outline_Check \u00b6 Defined in FT_OUTLINE_H (freetype/ftoutln.h). FT_EXPORT( FT_Error ) FT_Outline_Check ( FT_Outline * outline ); Check the contents of an outline descriptor. input outline A handle to a source outline. return FreeType error code. 0 means success. note An empty outline, or an outline with a single point only is also valid. FT_Outline_Get_CBox \u00b6 Defined in FT_OUTLINE_H (freetype/ftoutln.h). FT_EXPORT( void ) FT_Outline_Get_CBox ( const FT_Outline * outline, FT_BBox *acbox ); Return an outline's \u2018control box\u2019. The control box encloses all the outline's points, including Bezier control points. Though it coincides with the exact bounding box for most glyphs, it can be slightly larger in some situations (like when rotating an outline that contains Bezier outside arcs). Computing the control box is very fast, while getting the bounding box can take much more time as it needs to walk over all segments and arcs in the outline. To get the latter, you can use the \u2018ftbbox\u2019 component, which is dedicated to this single task. input outline A pointer to the source outline descriptor. output acbox The outline's control box. note See FT_Glyph_Get_CBox for a discussion of tricky fonts. FT_Outline_Get_BBox \u00b6 Defined in FT_BBOX_H (freetype/ftbbox.h). FT_EXPORT( FT_Error ) FT_Outline_Get_BBox ( FT_Outline * outline, FT_BBox *abbox ); Compute the exact bounding box of an outline. This is slower than computing the control box. However, it uses an advanced algorithm that returns very quickly when the two boxes coincide. Otherwise, the outline Bezier arcs are traversed to extract their extrema. input outline A pointer to the source outline. output abbox The outline's exact bounding box. return FreeType error code. 0 means success. note If the font is tricky and the glyph has been loaded with FT_LOAD_NO_SCALE , the resulting BBox is meaningless. To get reasonable values for the BBox it is necessary to load the glyph at a large ppem value (so that the hinting instructions can properly shift and scale the subglyphs), then extracting the BBox, which can be eventually converted back to font units. FT_Outline_Get_Bitmap \u00b6 Defined in FT_OUTLINE_H (freetype/ftoutln.h). FT_EXPORT( FT_Error ) FT_Outline_Get_Bitmap ( FT_Library library, FT_Outline * outline, const FT_Bitmap *abitmap ); Render an outline within a bitmap. The outline's image is simply OR-ed to the target bitmap. input library A handle to a FreeType library object. outline A pointer to the source outline descriptor. inout abitmap A pointer to the target bitmap descriptor. return FreeType error code. 0 means success. note This function does not create the bitmap, it only renders an outline image within the one you pass to it! Consequently, the various fields in abitmap should be set accordingly. It will use the raster corresponding to the default glyph format. The value of the num_grays field in abitmap is ignored. If you select the gray-level rasterizer, and you want less than 256 gray levels, you have to use FT_Outline_Render directly. FT_Outline_Render \u00b6 Defined in FT_OUTLINE_H (freetype/ftoutln.h). FT_EXPORT( FT_Error ) FT_Outline_Render ( FT_Library library, FT_Outline * outline, FT_Raster_Params * params ); Render an outline within a bitmap using the current scan-convert. input library A handle to a FreeType library object. outline A pointer to the source outline descriptor. inout params A pointer to an FT_Raster_Params structure used to describe the rendering operation. return FreeType error code. 0 means success. note This advanced function uses FT_Raster_Params as an argument. The field params.source will be set to outline before the scan converter is called, which means that the value you give to it is actually ignored. Either params.target must point to preallocated bitmap, or FT_RASTER_FLAG_DIRECT must be set in params.flags allowing FreeType rasterizer to be used for direct composition, translucency, etc. See FT_Raster_Params for more details. FT_Outline_Decompose \u00b6 Defined in FT_OUTLINE_H (freetype/ftoutln.h). FT_EXPORT( FT_Error ) FT_Outline_Decompose ( FT_Outline * outline, const FT_Outline_Funcs * func_interface, void * user ); Walk over an outline's structure to decompose it into individual segments and Bezier arcs. This function also emits \u2018move to\u2019 operations to indicate the start of new contours in the outline. input outline A pointer to the source target. func_interface A table of \u2018emitters\u2019, i.e., function pointers called during decomposition to indicate path operations. inout user A typeless pointer that is passed to each emitter during the decomposition. It can be used to store the state during the decomposition. return FreeType error code. 0 means success. note A contour that contains a single point only is represented by a \u2018move to\u2019 operation followed by \u2018line to\u2019 to the same point. In most cases, it is best to filter this out before using the outline for stroking purposes (otherwise it would result in a visible dot when round caps are used). Similarly, the function returns success for an empty outline also (doing nothing, this is, not calling any emitter); if necessary, you should filter this out, too. FT_Outline_Funcs \u00b6 Defined in FT_IMAGE_H (freetype/ftimage.h). typedef struct FT_Outline_Funcs_ { FT_Outline_MoveToFunc move_to; FT_Outline_LineToFunc line_to; FT_Outline_ConicToFunc conic_to; FT_Outline_CubicToFunc cubic_to; int shift; FT_Pos delta; } FT_Outline_Funcs ; A structure to hold various function pointers used during outline decomposition in order to emit segments, conic, and cubic Beziers. fields move_to The \u2018move to\u2019 emitter. line_to The segment emitter. conic_to The second-order Bezier arc emitter. cubic_to The third-order Bezier arc emitter. shift The shift that is applied to coordinates before they are sent to the emitter. delta The delta that is applied to coordinates before they are sent to the emitter, but after the shift. note The point coordinates sent to the emitters are the transformed version of the original coordinates (this is important for high accuracy during scan-conversion). The transformation is simple: x' = (x << shift) - delta y' = (y << shift) - delta Set the values of shift and delta to 0 to get the original point coordinates. FT_Outline_MoveToFunc \u00b6 Defined in FT_IMAGE_H (freetype/ftimage.h). typedef int (* FT_Outline_MoveToFunc )( const FT_Vector * to, void * user ); # define FT_Outline_MoveTo_Func FT_Outline_MoveToFunc A function pointer type used to describe the signature of a \u2018move to\u2019 function during outline walking/decomposition. A \u2018move to\u2019 is emitted to start a new contour in an outline. input to A pointer to the target point of the \u2018move to\u2019. user A typeless pointer, which is passed from the caller of the decomposition function. return Error code. 0 means success. FT_Outline_LineToFunc \u00b6 Defined in FT_IMAGE_H (freetype/ftimage.h). typedef int (* FT_Outline_LineToFunc )( const FT_Vector * to, void * user ); # define FT_Outline_LineTo_Func FT_Outline_LineToFunc A function pointer type used to describe the signature of a \u2018line to\u2019 function during outline walking/decomposition. A \u2018line to\u2019 is emitted to indicate a segment in the outline. input to A pointer to the target point of the \u2018line to\u2019. user A typeless pointer, which is passed from the caller of the decomposition function. return Error code. 0 means success. FT_Outline_ConicToFunc \u00b6 Defined in FT_IMAGE_H (freetype/ftimage.h). typedef int (* FT_Outline_ConicToFunc )( const FT_Vector * control, const FT_Vector * to, void * user ); # define FT_Outline_ConicTo_Func FT_Outline_ConicToFunc A function pointer type used to describe the signature of a \u2018conic to\u2019 function during outline walking or decomposition. A \u2018conic to\u2019 is emitted to indicate a second-order Bezier arc in the outline. input control An intermediate control point between the last position and the new target in to . to A pointer to the target end point of the conic arc. user A typeless pointer, which is passed from the caller of the decomposition function. return Error code. 0 means success. FT_Outline_CubicToFunc \u00b6 Defined in FT_IMAGE_H (freetype/ftimage.h). typedef int (* FT_Outline_CubicToFunc )( const FT_Vector * control1, const FT_Vector * control2, const FT_Vector * to, void * user ); # define FT_Outline_CubicTo_Func FT_Outline_CubicToFunc A function pointer type used to describe the signature of a \u2018cubic to\u2019 function during outline walking or decomposition. A \u2018cubic to\u2019 is emitted to indicate a third-order Bezier arc. input control1 A pointer to the first Bezier control point. control2 A pointer to the second Bezier control point. to A pointer to the target end point. user A typeless pointer, which is passed from the caller of the decomposition function. return Error code. 0 means success. FT_Orientation \u00b6 Defined in FT_OUTLINE_H (freetype/ftoutln.h). typedef enum FT_Orientation_ { FT_ORIENTATION_TRUETYPE = 0, FT_ORIENTATION_POSTSCRIPT = 1, FT_ORIENTATION_FILL_RIGHT = FT_ORIENTATION_TRUETYPE , FT_ORIENTATION_FILL_LEFT = FT_ORIENTATION_POSTSCRIPT , FT_ORIENTATION_NONE } FT_Orientation ; A list of values used to describe an outline's contour orientation. The TrueType and PostScript specifications use different conventions to determine whether outline contours should be filled or unfilled. values FT_ORIENTATION_TRUETYPE According to the TrueType specification, clockwise contours must be filled, and counter-clockwise ones must be unfilled. FT_ORIENTATION_POSTSCRIPT According to the PostScript specification, counter-clockwise contours must be filled, and clockwise ones must be unfilled. FT_ORIENTATION_FILL_RIGHT This is identical to FT_ORIENTATION_TRUETYPE , but is used to remember that in TrueType, everything that is to the right of the drawing direction of a contour must be filled. FT_ORIENTATION_FILL_LEFT This is identical to FT_ORIENTATION_POSTSCRIPT , but is used to remember that in PostScript, everything that is to the left of the drawing direction of a contour must be filled. FT_ORIENTATION_NONE The orientation cannot be determined. That is, different parts of the glyph have different orientation. FT_Outline_Get_Orientation \u00b6 Defined in FT_OUTLINE_H (freetype/ftoutln.h). FT_EXPORT( FT_Orientation ) FT_Outline_Get_Orientation ( FT_Outline * outline ); This function analyzes a glyph outline and tries to compute its fill orientation (see FT_Orientation ). This is done by integrating the total area covered by the outline. The positive integral corresponds to the clockwise orientation and FT_ORIENTATION_POSTSCRIPT is returned. The negative integral corresponds to the counter-clockwise orientation and FT_ORIENTATION_TRUETYPE is returned. Note that this will return FT_ORIENTATION_TRUETYPE for empty outlines. input outline A handle to the source outline. return The orientation. FT_OUTLINE_XXX \u00b6 Defined in FT_IMAGE_H (freetype/ftimage.h). # define FT_OUTLINE_NONE 0x0 # define FT_OUTLINE_OWNER 0x1 # define FT_OUTLINE_EVEN_ODD_FILL 0x2 # define FT_OUTLINE_REVERSE_FILL 0x4 # define FT_OUTLINE_IGNORE_DROPOUTS 0x8 # define FT_OUTLINE_SMART_DROPOUTS 0x10 # define FT_OUTLINE_INCLUDE_STUBS 0x20 # define FT_OUTLINE_OVERLAP 0x40 # define FT_OUTLINE_HIGH_PRECISION 0x100 # define FT_OUTLINE_SINGLE_PASS 0x200 /* these constants are deprecated; use the corresponding */ /* ` FT_OUTLINE_XXX ` values instead */ # define ft_outline_none FT_OUTLINE_NONE # define ft_outline_owner FT_OUTLINE_OWNER # define ft_outline_even_odd_fill FT_OUTLINE_EVEN_ODD_FILL # define ft_outline_reverse_fill FT_OUTLINE_REVERSE_FILL # define ft_outline_ignore_dropouts FT_OUTLINE_IGNORE_DROPOUTS # define ft_outline_high_precision FT_OUTLINE_HIGH_PRECISION # define ft_outline_single_pass FT_OUTLINE_SINGLE_PASS A list of bit-field constants used for the flags in an outline's flags field. values FT_OUTLINE_NONE Value 0 is reserved. FT_OUTLINE_OWNER If set, this flag indicates that the outline's field arrays (i.e., points , flags , and contours ) are \u2018owned\u2019 by the outline object, and should thus be freed when it is destroyed. FT_OUTLINE_EVEN_ODD_FILL By default, outlines are filled using the non-zero winding rule. If set to 1, the outline will be filled using the even-odd fill rule (only works with the smooth rasterizer). FT_OUTLINE_REVERSE_FILL By default, outside contours of an outline are oriented in clock-wise direction, as defined in the TrueType specification. This flag is set if the outline uses the opposite direction (typically for Type 1 fonts). This flag is ignored by the scan converter. FT_OUTLINE_IGNORE_DROPOUTS By default, the scan converter will try to detect drop-outs in an outline and correct the glyph bitmap to ensure consistent shape continuity. If set, this flag hints the scan-line converter to ignore such cases. See below for more information. FT_OUTLINE_SMART_DROPOUTS Select smart dropout control. If unset, use simple dropout control. Ignored if FT_OUTLINE_IGNORE_DROPOUTS is set. See below for more information. FT_OUTLINE_INCLUDE_STUBS If set, turn pixels on for \u2018stubs\u2019, otherwise exclude them. Ignored if FT_OUTLINE_IGNORE_DROPOUTS is set. See below for more information. FT_OUTLINE_OVERLAP This flag indicates that this outline contains overlapping contrours and the anti-aliased renderer should perform oversampling to mitigate possible artifacts. This flag should not be set for well designed glyphs without overlaps because it quadruples the rendering time. FT_OUTLINE_HIGH_PRECISION This flag indicates that the scan-line converter should try to convert this outline to bitmaps with the highest possible quality. It is typically set for small character sizes. Note that this is only a hint that might be completely ignored by a given scan-converter. FT_OUTLINE_SINGLE_PASS This flag is set to force a given scan-converter to only use a single pass over the outline to render a bitmap glyph image. Normally, it is set for very large character sizes. It is only a hint that might be completely ignored by a given scan-converter. note The flags FT_OUTLINE_IGNORE_DROPOUTS , FT_OUTLINE_SMART_DROPOUTS , and FT_OUTLINE_INCLUDE_STUBS are ignored by the smooth rasterizer. There exists a second mechanism to pass the drop-out mode to the B/W rasterizer; see the tags field in FT_Outline . Please refer to the description of the \u2018SCANTYPE\u2019 instruction in the OpenType specification (in file ttinst1.doc ) how simple drop-outs, smart drop-outs, and stubs are defined.","title":"Outline Processing"},{"location":"ft2-outline_processing.html#outline-processing","text":"","title":"Outline Processing"},{"location":"ft2-outline_processing.html#synopsis","text":"This section contains routines used to create and destroy scalable glyph images known as \u2018outlines\u2019. These can also be measured, transformed, and converted into bitmaps and pixmaps.","title":"Synopsis"},{"location":"ft2-outline_processing.html#ft_outline","text":"Defined in FT_IMAGE_H (freetype/ftimage.h). typedef struct FT_Outline_ { short n_contours; /* number of contours in glyph */ short n_points; /* number of points in the glyph */ FT_Vector * points; /* the outline's points */ char * tags; /* the points flags */ short * contours; /* the contour end points */ int flags; /* outline masks */ } FT_Outline ; This structure is used to describe an outline to the scan-line converter.","title":"FT_Outline"},{"location":"ft2-outline_processing.html#ft_outline_new","text":"Defined in FT_OUTLINE_H (freetype/ftoutln.h). FT_EXPORT( FT_Error ) FT_Outline_New ( FT_Library library, FT_UInt numPoints, FT_Int numContours, FT_Outline *anoutline ); Create a new outline of a given size.","title":"FT_Outline_New"},{"location":"ft2-outline_processing.html#ft_outline_done","text":"Defined in FT_OUTLINE_H (freetype/ftoutln.h). FT_EXPORT( FT_Error ) FT_Outline_Done ( FT_Library library, FT_Outline * outline ); Destroy an outline created with FT_Outline_New .","title":"FT_Outline_Done"},{"location":"ft2-outline_processing.html#ft_outline_copy","text":"Defined in FT_OUTLINE_H (freetype/ftoutln.h). FT_EXPORT( FT_Error ) FT_Outline_Copy ( const FT_Outline * source, FT_Outline *target ); Copy an outline into another one. Both objects must have the same sizes (number of points & number of contours) when this function is called.","title":"FT_Outline_Copy"},{"location":"ft2-outline_processing.html#ft_outline_translate","text":"Defined in FT_OUTLINE_H (freetype/ftoutln.h). FT_EXPORT( void ) FT_Outline_Translate ( const FT_Outline * outline, FT_Pos xOffset, FT_Pos yOffset ); Apply a simple translation to the points of an outline.","title":"FT_Outline_Translate"},{"location":"ft2-outline_processing.html#ft_outline_transform","text":"Defined in FT_OUTLINE_H (freetype/ftoutln.h). FT_EXPORT( void ) FT_Outline_Transform ( const FT_Outline * outline, const FT_Matrix * matrix ); Apply a simple 2x2 matrix to all of an outline's points. Useful for applying rotations, slanting, flipping, etc.","title":"FT_Outline_Transform"},{"location":"ft2-outline_processing.html#ft_outline_embolden","text":"Defined in FT_OUTLINE_H (freetype/ftoutln.h). FT_EXPORT( FT_Error ) FT_Outline_Embolden ( FT_Outline * outline, FT_Pos strength ); Embolden an outline. The new outline will be at most 4 times strength pixels wider and higher. You may think of the left and bottom borders as unchanged. Negative strength values to reduce the outline thickness are possible also.","title":"FT_Outline_Embolden"},{"location":"ft2-outline_processing.html#ft_outline_emboldenxy","text":"Defined in FT_OUTLINE_H (freetype/ftoutln.h). FT_EXPORT( FT_Error ) FT_Outline_EmboldenXY ( FT_Outline * outline, FT_Pos xstrength, FT_Pos ystrength ); Embolden an outline. The new outline will be xstrength pixels wider and ystrength pixels higher. Otherwise, it is similar to FT_Outline_Embolden , which uses the same strength in both directions.","title":"FT_Outline_EmboldenXY"},{"location":"ft2-outline_processing.html#ft_outline_reverse","text":"Defined in FT_OUTLINE_H (freetype/ftoutln.h). FT_EXPORT( void ) FT_Outline_Reverse ( FT_Outline * outline ); Reverse the drawing direction of an outline. This is used to ensure consistent fill conventions for mirrored glyphs.","title":"FT_Outline_Reverse"},{"location":"ft2-outline_processing.html#ft_outline_check","text":"Defined in FT_OUTLINE_H (freetype/ftoutln.h). FT_EXPORT( FT_Error ) FT_Outline_Check ( FT_Outline * outline ); Check the contents of an outline descriptor.","title":"FT_Outline_Check"},{"location":"ft2-outline_processing.html#ft_outline_get_cbox","text":"Defined in FT_OUTLINE_H (freetype/ftoutln.h). FT_EXPORT( void ) FT_Outline_Get_CBox ( const FT_Outline * outline, FT_BBox *acbox ); Return an outline's \u2018control box\u2019. The control box encloses all the outline's points, including Bezier control points. Though it coincides with the exact bounding box for most glyphs, it can be slightly larger in some situations (like when rotating an outline that contains Bezier outside arcs). Computing the control box is very fast, while getting the bounding box can take much more time as it needs to walk over all segments and arcs in the outline. To get the latter, you can use the \u2018ftbbox\u2019 component, which is dedicated to this single task.","title":"FT_Outline_Get_CBox"},{"location":"ft2-outline_processing.html#ft_outline_get_bbox","text":"Defined in FT_BBOX_H (freetype/ftbbox.h). FT_EXPORT( FT_Error ) FT_Outline_Get_BBox ( FT_Outline * outline, FT_BBox *abbox ); Compute the exact bounding box of an outline. This is slower than computing the control box. However, it uses an advanced algorithm that returns very quickly when the two boxes coincide. Otherwise, the outline Bezier arcs are traversed to extract their extrema.","title":"FT_Outline_Get_BBox"},{"location":"ft2-outline_processing.html#ft_outline_get_bitmap","text":"Defined in FT_OUTLINE_H (freetype/ftoutln.h). FT_EXPORT( FT_Error ) FT_Outline_Get_Bitmap ( FT_Library library, FT_Outline * outline, const FT_Bitmap *abitmap ); Render an outline within a bitmap. The outline's image is simply OR-ed to the target bitmap.","title":"FT_Outline_Get_Bitmap"},{"location":"ft2-outline_processing.html#ft_outline_render","text":"Defined in FT_OUTLINE_H (freetype/ftoutln.h). FT_EXPORT( FT_Error ) FT_Outline_Render ( FT_Library library, FT_Outline * outline, FT_Raster_Params * params ); Render an outline within a bitmap using the current scan-convert.","title":"FT_Outline_Render"},{"location":"ft2-outline_processing.html#ft_outline_decompose","text":"Defined in FT_OUTLINE_H (freetype/ftoutln.h). FT_EXPORT( FT_Error ) FT_Outline_Decompose ( FT_Outline * outline, const FT_Outline_Funcs * func_interface, void * user ); Walk over an outline's structure to decompose it into individual segments and Bezier arcs. This function also emits \u2018move to\u2019 operations to indicate the start of new contours in the outline.","title":"FT_Outline_Decompose"},{"location":"ft2-outline_processing.html#ft_outline_funcs","text":"Defined in FT_IMAGE_H (freetype/ftimage.h). typedef struct FT_Outline_Funcs_ { FT_Outline_MoveToFunc move_to; FT_Outline_LineToFunc line_to; FT_Outline_ConicToFunc conic_to; FT_Outline_CubicToFunc cubic_to; int shift; FT_Pos delta; } FT_Outline_Funcs ; A structure to hold various function pointers used during outline decomposition in order to emit segments, conic, and cubic Beziers.","title":"FT_Outline_Funcs"},{"location":"ft2-outline_processing.html#ft_outline_movetofunc","text":"Defined in FT_IMAGE_H (freetype/ftimage.h). typedef int (* FT_Outline_MoveToFunc )( const FT_Vector * to, void * user ); # define FT_Outline_MoveTo_Func FT_Outline_MoveToFunc A function pointer type used to describe the signature of a \u2018move to\u2019 function during outline walking/decomposition. A \u2018move to\u2019 is emitted to start a new contour in an outline.","title":"FT_Outline_MoveToFunc"},{"location":"ft2-outline_processing.html#ft_outline_linetofunc","text":"Defined in FT_IMAGE_H (freetype/ftimage.h). typedef int (* FT_Outline_LineToFunc )( const FT_Vector * to, void * user ); # define FT_Outline_LineTo_Func FT_Outline_LineToFunc A function pointer type used to describe the signature of a \u2018line to\u2019 function during outline walking/decomposition. A \u2018line to\u2019 is emitted to indicate a segment in the outline.","title":"FT_Outline_LineToFunc"},{"location":"ft2-outline_processing.html#ft_outline_conictofunc","text":"Defined in FT_IMAGE_H (freetype/ftimage.h). typedef int (* FT_Outline_ConicToFunc )( const FT_Vector * control, const FT_Vector * to, void * user ); # define FT_Outline_ConicTo_Func FT_Outline_ConicToFunc A function pointer type used to describe the signature of a \u2018conic to\u2019 function during outline walking or decomposition. A \u2018conic to\u2019 is emitted to indicate a second-order Bezier arc in the outline.","title":"FT_Outline_ConicToFunc"},{"location":"ft2-outline_processing.html#ft_outline_cubictofunc","text":"Defined in FT_IMAGE_H (freetype/ftimage.h). typedef int (* FT_Outline_CubicToFunc )( const FT_Vector * control1, const FT_Vector * control2, const FT_Vector * to, void * user ); # define FT_Outline_CubicTo_Func FT_Outline_CubicToFunc A function pointer type used to describe the signature of a \u2018cubic to\u2019 function during outline walking or decomposition. A \u2018cubic to\u2019 is emitted to indicate a third-order Bezier arc.","title":"FT_Outline_CubicToFunc"},{"location":"ft2-outline_processing.html#ft_orientation","text":"Defined in FT_OUTLINE_H (freetype/ftoutln.h). typedef enum FT_Orientation_ { FT_ORIENTATION_TRUETYPE = 0, FT_ORIENTATION_POSTSCRIPT = 1, FT_ORIENTATION_FILL_RIGHT = FT_ORIENTATION_TRUETYPE , FT_ORIENTATION_FILL_LEFT = FT_ORIENTATION_POSTSCRIPT , FT_ORIENTATION_NONE } FT_Orientation ; A list of values used to describe an outline's contour orientation. The TrueType and PostScript specifications use different conventions to determine whether outline contours should be filled or unfilled.","title":"FT_Orientation"},{"location":"ft2-outline_processing.html#ft_outline_get_orientation","text":"Defined in FT_OUTLINE_H (freetype/ftoutln.h). FT_EXPORT( FT_Orientation ) FT_Outline_Get_Orientation ( FT_Outline * outline ); This function analyzes a glyph outline and tries to compute its fill orientation (see FT_Orientation ). This is done by integrating the total area covered by the outline. The positive integral corresponds to the clockwise orientation and FT_ORIENTATION_POSTSCRIPT is returned. The negative integral corresponds to the counter-clockwise orientation and FT_ORIENTATION_TRUETYPE is returned. Note that this will return FT_ORIENTATION_TRUETYPE for empty outlines.","title":"FT_Outline_Get_Orientation"},{"location":"ft2-outline_processing.html#ft_outline_xxx","text":"Defined in FT_IMAGE_H (freetype/ftimage.h). # define FT_OUTLINE_NONE 0x0 # define FT_OUTLINE_OWNER 0x1 # define FT_OUTLINE_EVEN_ODD_FILL 0x2 # define FT_OUTLINE_REVERSE_FILL 0x4 # define FT_OUTLINE_IGNORE_DROPOUTS 0x8 # define FT_OUTLINE_SMART_DROPOUTS 0x10 # define FT_OUTLINE_INCLUDE_STUBS 0x20 # define FT_OUTLINE_OVERLAP 0x40 # define FT_OUTLINE_HIGH_PRECISION 0x100 # define FT_OUTLINE_SINGLE_PASS 0x200 /* these constants are deprecated; use the corresponding */ /* ` FT_OUTLINE_XXX ` values instead */ # define ft_outline_none FT_OUTLINE_NONE # define ft_outline_owner FT_OUTLINE_OWNER # define ft_outline_even_odd_fill FT_OUTLINE_EVEN_ODD_FILL # define ft_outline_reverse_fill FT_OUTLINE_REVERSE_FILL # define ft_outline_ignore_dropouts FT_OUTLINE_IGNORE_DROPOUTS # define ft_outline_high_precision FT_OUTLINE_HIGH_PRECISION # define ft_outline_single_pass FT_OUTLINE_SINGLE_PASS A list of bit-field constants used for the flags in an outline's flags field.","title":"FT_OUTLINE_XXX"},{"location":"ft2-parameter_tags.html","text":"FreeType \u00bb Docs \u00bb Controlling FreeType Modules \u00bb Parameter Tags Parameter Tags \u00b6 Synopsis \u00b6 This section contains macros for the FT_Parameter structure that are used with various functions to activate some special functionality or different behaviour of various components of FreeType. FT_PARAM_TAG_IGNORE_TYPOGRAPHIC_FAMILY \u00b6 # define FT_PARAM_TAG_IGNORE_TYPOGRAPHIC_FAMILY \\ FT_MAKE_TAG ( 'i', 'g', 'p', 'f' ) /* this constant is deprecated */ # define FT_PARAM_TAG_IGNORE_PREFERRED_FAMILY \\ FT_PARAM_TAG_IGNORE_TYPOGRAPHIC_FAMILY A tag for FT_Parameter to make FT_Open_Face ignore typographic family names in the \u2018name\u2019 table (introduced in OpenType version 1.4). Use this for backward compatibility with legacy systems that have a four-faces-per-family restriction. since 2.8 FT_PARAM_TAG_IGNORE_TYPOGRAPHIC_SUBFAMILY \u00b6 # define FT_PARAM_TAG_IGNORE_TYPOGRAPHIC_SUBFAMILY \\ FT_MAKE_TAG ( 'i', 'g', 'p', 's' ) /* this constant is deprecated */ # define FT_PARAM_TAG_IGNORE_PREFERRED_SUBFAMILY \\ FT_PARAM_TAG_IGNORE_TYPOGRAPHIC_SUBFAMILY A tag for FT_Parameter to make FT_Open_Face ignore typographic subfamily names in the \u2018name\u2019 table (introduced in OpenType version 1.4). Use this for backward compatibility with legacy systems that have a four-faces-per-family restriction. since 2.8 FT_PARAM_TAG_INCREMENTAL \u00b6 # define FT_PARAM_TAG_INCREMENTAL \\ FT_MAKE_TAG ( 'i', 'n', 'c', 'r' ) An FT_Parameter tag to be used with FT_Open_Face to indicate incremental glyph loading. FT_PARAM_TAG_LCD_FILTER_WEIGHTS \u00b6 # define FT_PARAM_TAG_LCD_FILTER_WEIGHTS \\ FT_MAKE_TAG ( 'l', 'c', 'd', 'f' ) An FT_Parameter tag to be used with FT_Face_Properties . The corresponding argument specifies the five LCD filter weights for a given face (if using FT_LOAD_TARGET_LCD , for example), overriding the global default values or the values set up with FT_Library_SetLcdFilterWeights . since 2.8 FT_PARAM_TAG_RANDOM_SEED \u00b6 # define FT_PARAM_TAG_RANDOM_SEED \\ FT_MAKE_TAG ( 's', 'e', 'e', 'd' ) An FT_Parameter tag to be used with FT_Face_Properties . The corresponding 32bit signed integer argument overrides the font driver's random seed value with a face-specific one; see random-seed . since 2.8 FT_PARAM_TAG_STEM_DARKENING \u00b6 # define FT_PARAM_TAG_STEM_DARKENING \\ FT_MAKE_TAG ( 'd', 'a', 'r', 'k' ) An FT_Parameter tag to be used with FT_Face_Properties . The corresponding Boolean argument specifies whether to apply stem darkening, overriding the global default values or the values set up with FT_Property_Set (see no-stem-darkening ). This is a passive setting that only takes effect if the font driver or autohinter honors it, which the CFF, Type 1, and CID drivers always do, but the autohinter only in \u2018light\u2019 hinting mode (as of version 2.9). since 2.8 FT_PARAM_TAG_UNPATENTED_HINTING \u00b6 # define FT_PARAM_TAG_UNPATENTED_HINTING \\ FT_MAKE_TAG ( 'u', 'n', 'p', 'a' ) Deprecated, no effect. Previously: A constant used as the tag of an FT_Parameter structure to indicate that unpatented methods only should be used by the TrueType bytecode interpreter for a typeface opened by FT_Open_Face .","title":"Parameter Tags"},{"location":"ft2-parameter_tags.html#parameter-tags","text":"","title":"Parameter Tags"},{"location":"ft2-parameter_tags.html#synopsis","text":"This section contains macros for the FT_Parameter structure that are used with various functions to activate some special functionality or different behaviour of various components of FreeType.","title":"Synopsis"},{"location":"ft2-parameter_tags.html#ft_param_tag_ignore_typographic_family","text":"# define FT_PARAM_TAG_IGNORE_TYPOGRAPHIC_FAMILY \\ FT_MAKE_TAG ( 'i', 'g', 'p', 'f' ) /* this constant is deprecated */ # define FT_PARAM_TAG_IGNORE_PREFERRED_FAMILY \\ FT_PARAM_TAG_IGNORE_TYPOGRAPHIC_FAMILY A tag for FT_Parameter to make FT_Open_Face ignore typographic family names in the \u2018name\u2019 table (introduced in OpenType version 1.4). Use this for backward compatibility with legacy systems that have a four-faces-per-family restriction.","title":"FT_PARAM_TAG_IGNORE_TYPOGRAPHIC_FAMILY"},{"location":"ft2-parameter_tags.html#ft_param_tag_ignore_typographic_subfamily","text":"# define FT_PARAM_TAG_IGNORE_TYPOGRAPHIC_SUBFAMILY \\ FT_MAKE_TAG ( 'i', 'g', 'p', 's' ) /* this constant is deprecated */ # define FT_PARAM_TAG_IGNORE_PREFERRED_SUBFAMILY \\ FT_PARAM_TAG_IGNORE_TYPOGRAPHIC_SUBFAMILY A tag for FT_Parameter to make FT_Open_Face ignore typographic subfamily names in the \u2018name\u2019 table (introduced in OpenType version 1.4). Use this for backward compatibility with legacy systems that have a four-faces-per-family restriction.","title":"FT_PARAM_TAG_IGNORE_TYPOGRAPHIC_SUBFAMILY"},{"location":"ft2-parameter_tags.html#ft_param_tag_incremental","text":"# define FT_PARAM_TAG_INCREMENTAL \\ FT_MAKE_TAG ( 'i', 'n', 'c', 'r' ) An FT_Parameter tag to be used with FT_Open_Face to indicate incremental glyph loading.","title":"FT_PARAM_TAG_INCREMENTAL"},{"location":"ft2-parameter_tags.html#ft_param_tag_lcd_filter_weights","text":"# define FT_PARAM_TAG_LCD_FILTER_WEIGHTS \\ FT_MAKE_TAG ( 'l', 'c', 'd', 'f' ) An FT_Parameter tag to be used with FT_Face_Properties . The corresponding argument specifies the five LCD filter weights for a given face (if using FT_LOAD_TARGET_LCD , for example), overriding the global default values or the values set up with FT_Library_SetLcdFilterWeights .","title":"FT_PARAM_TAG_LCD_FILTER_WEIGHTS"},{"location":"ft2-parameter_tags.html#ft_param_tag_random_seed","text":"# define FT_PARAM_TAG_RANDOM_SEED \\ FT_MAKE_TAG ( 's', 'e', 'e', 'd' ) An FT_Parameter tag to be used with FT_Face_Properties . The corresponding 32bit signed integer argument overrides the font driver's random seed value with a face-specific one; see random-seed .","title":"FT_PARAM_TAG_RANDOM_SEED"},{"location":"ft2-parameter_tags.html#ft_param_tag_stem_darkening","text":"# define FT_PARAM_TAG_STEM_DARKENING \\ FT_MAKE_TAG ( 'd', 'a', 'r', 'k' ) An FT_Parameter tag to be used with FT_Face_Properties . The corresponding Boolean argument specifies whether to apply stem darkening, overriding the global default values or the values set up with FT_Property_Set (see no-stem-darkening ). This is a passive setting that only takes effect if the font driver or autohinter honors it, which the CFF, Type 1, and CID drivers always do, but the autohinter only in \u2018light\u2019 hinting mode (as of version 2.9).","title":"FT_PARAM_TAG_STEM_DARKENING"},{"location":"ft2-parameter_tags.html#ft_param_tag_unpatented_hinting","text":"# define FT_PARAM_TAG_UNPATENTED_HINTING \\ FT_MAKE_TAG ( 'u', 'n', 'p', 'a' ) Deprecated, no effect. Previously: A constant used as the tag of an FT_Parameter structure to indicate that unpatented methods only should be used by the TrueType bytecode interpreter for a typeface opened by FT_Open_Face .","title":"FT_PARAM_TAG_UNPATENTED_HINTING"},{"location":"ft2-pcf_driver.html","text":"FreeType \u00bb Docs \u00bb Controlling FreeType Modules \u00bb The PCF driver The PCF driver \u00b6 Synopsis \u00b6 While FreeType's PCF driver doesn't expose API functions by itself, it is possible to control its behaviour with FT_Property_Set and FT_Property_Get . Right now, there is a single property no-long-family-names available if FreeType is compiled with PCF_CONFIG_OPTION_LONG_FAMILY_NAMES. The PCF driver's module name is \u2018pcf\u2019.","title":"The PCF driver"},{"location":"ft2-pcf_driver.html#the-pcf-driver","text":"","title":"The PCF driver"},{"location":"ft2-pcf_driver.html#synopsis","text":"While FreeType's PCF driver doesn't expose API functions by itself, it is possible to control its behaviour with FT_Property_Set and FT_Property_Get . Right now, there is a single property no-long-family-names available if FreeType is compiled with PCF_CONFIG_OPTION_LONG_FAMILY_NAMES. The PCF driver's module name is \u2018pcf\u2019.","title":"Synopsis"},{"location":"ft2-pfr_fonts.html","text":"FreeType \u00bb Docs \u00bb Format-Specific API \u00bb PFR Fonts PFR Fonts \u00b6 Synopsis \u00b6 This section contains the declaration of PFR-specific functions. FT_Get_PFR_Metrics \u00b6 Defined in FT_PFR_H (freetype/ftpfr.h). FT_EXPORT( FT_Error ) FT_Get_PFR_Metrics ( FT_Face face, FT_UInt *aoutline_resolution, FT_UInt *ametrics_resolution, FT_Fixed *ametrics_x_scale, FT_Fixed *ametrics_y_scale ); Return the outline and metrics resolutions of a given PFR face. input face Handle to the input face. It can be a non-PFR face. output aoutline_resolution Outline resolution. This is equivalent to face->units_per_EM for non-PFR fonts. Optional (parameter can be NULL ). ametrics_resolution Metrics resolution. This is equivalent to outline_resolution for non-PFR fonts. Optional (parameter can be NULL ). ametrics_x_scale A 16.16 fixed-point number used to scale distance expressed in metrics units to device subpixels. This is equivalent to face->size->x_scale , but for metrics only. Optional (parameter can be NULL ). ametrics_y_scale Same as ametrics_x_scale but for the vertical direction. optional (parameter can be NULL ). return FreeType error code. 0 means success. note If the input face is not a PFR, this function will return an error. However, in all cases, it will return valid values. FT_Get_PFR_Kerning \u00b6 Defined in FT_PFR_H (freetype/ftpfr.h). FT_EXPORT( FT_Error ) FT_Get_PFR_Kerning ( FT_Face face, FT_UInt left, FT_UInt right, FT_Vector *avector ); Return the kerning pair corresponding to two glyphs in a PFR face. The distance is expressed in metrics units, unlike the result of FT_Get_Kerning . input face A handle to the input face. left Index of the left glyph. right Index of the right glyph. output avector A kerning vector. return FreeType error code. 0 means success. note This function always return distances in original PFR metrics units. This is unlike FT_Get_Kerning with the FT_KERNING_UNSCALED mode, which always returns distances converted to outline units. You can use the value of the x_scale and y_scale parameters returned by FT_Get_PFR_Metrics to scale these to device subpixels. FT_Get_PFR_Advance \u00b6 Defined in FT_PFR_H (freetype/ftpfr.h). FT_EXPORT( FT_Error ) FT_Get_PFR_Advance ( FT_Face face, FT_UInt gindex, FT_Pos *aadvance ); Return a given glyph advance, expressed in original metrics units, from a PFR font. input face A handle to the input face. gindex The glyph index. output aadvance The glyph advance in metrics units. return FreeType error code. 0 means success. note You can use the x_scale or y_scale results of FT_Get_PFR_Metrics to convert the advance to device subpixels (i.e., 1/64 th of pixels).","title":"PFR Fonts"},{"location":"ft2-pfr_fonts.html#pfr-fonts","text":"","title":"PFR Fonts"},{"location":"ft2-pfr_fonts.html#synopsis","text":"This section contains the declaration of PFR-specific functions.","title":"Synopsis"},{"location":"ft2-pfr_fonts.html#ft_get_pfr_metrics","text":"Defined in FT_PFR_H (freetype/ftpfr.h). FT_EXPORT( FT_Error ) FT_Get_PFR_Metrics ( FT_Face face, FT_UInt *aoutline_resolution, FT_UInt *ametrics_resolution, FT_Fixed *ametrics_x_scale, FT_Fixed *ametrics_y_scale ); Return the outline and metrics resolutions of a given PFR face.","title":"FT_Get_PFR_Metrics"},{"location":"ft2-pfr_fonts.html#ft_get_pfr_kerning","text":"Defined in FT_PFR_H (freetype/ftpfr.h). FT_EXPORT( FT_Error ) FT_Get_PFR_Kerning ( FT_Face face, FT_UInt left, FT_UInt right, FT_Vector *avector ); Return the kerning pair corresponding to two glyphs in a PFR face. The distance is expressed in metrics units, unlike the result of FT_Get_Kerning .","title":"FT_Get_PFR_Kerning"},{"location":"ft2-pfr_fonts.html#ft_get_pfr_advance","text":"Defined in FT_PFR_H (freetype/ftpfr.h). FT_EXPORT( FT_Error ) FT_Get_PFR_Advance ( FT_Face face, FT_UInt gindex, FT_Pos *aadvance ); Return a given glyph advance, expressed in original metrics units, from a PFR font.","title":"FT_Get_PFR_Advance"},{"location":"ft2-properties.html","text":"FreeType \u00bb Docs \u00bb Controlling FreeType Modules \u00bb Driver properties Driver properties \u00b6 Synopsis \u00b6 Driver modules can be controlled by setting and unsetting properties, using the functions FT_Property_Set and FT_Property_Get . This section documents the available properties, together with auxiliary macros and structures. FT_HINTING_XXX \u00b6 Defined in FT_DRIVER_H (freetype/ftdriver.h). # define FT_HINTING_FREETYPE 0 # define FT_HINTING_ADOBE 1 /* these constants (introduced in 2.4.12) are deprecated */ # define FT_CFF_HINTING_FREETYPE FT_HINTING_FREETYPE # define FT_CFF_HINTING_ADOBE FT_HINTING_ADOBE A list of constants used for the hinting-engine property to select the hinting engine for CFF, Type 1, and CID fonts. values FT_HINTING_FREETYPE Use the old FreeType hinting engine. FT_HINTING_ADOBE Use the hinting engine contributed by Adobe. since 2.9 hinting-engine \u00b6 Thanks to Adobe, which contributed a new hinting (and parsing) engine, an application can select between \u2018freetype\u2019 and \u2018adobe\u2019 if compiled with CFF_CONFIG_OPTION_OLD_ENGINE . If this configuration macro isn't defined, \u2018hinting-engine\u2019 does nothing. The same holds for the Type 1 and CID modules if compiled with T1_CONFIG_OPTION_OLD_ENGINE . For the \u2018cff\u2019 module, the default engine is \u2018freetype\u2019 if CFF_CONFIG_OPTION_OLD_ENGINE is defined, and \u2018adobe\u2019 otherwise. For both the \u2018type1\u2019 and \u2018t1cid\u2019 modules, the default engine is \u2018freetype\u2019 if T1_CONFIG_OPTION_OLD_ENGINE is defined, and \u2018adobe\u2019 otherwise. note This property can be used with FT_Property_Get also. This property can be set via the FREETYPE_PROPERTIES environment variable (using values \u2018adobe\u2019 or \u2018freetype\u2019). example The following example code demonstrates how to select Adobe's hinting engine for the \u2018cff\u2019 module (omitting the error handling). FT_Library library; FT_UInt hinting_engine = FT_HINTING_ADOBE; FT_Init_FreeType( &library ); FT_Property_Set( library, \"cff\", \"hinting-engine\", &hinting_engine ); since 2.4.12 (for \u2018cff\u2019 module) 2.9 (for \u2018type1\u2019 and \u2018t1cid\u2019 modules) no-stem-darkening \u00b6 All glyphs that pass through the auto-hinter will be emboldened unless this property is set to TRUE. The same is true for the CFF, Type 1, and CID font modules if the \u2018Adobe\u2019 engine is selected (which is the default). Stem darkening emboldens glyphs at smaller sizes to make them more readable on common low-DPI screens when using linear alpha blending and gamma correction, see FT_Render_Glyph . When not using linear alpha blending and gamma correction, glyphs will appear heavy and fuzzy! Gamma correction essentially lightens fonts since shades of grey are shifted to higher pixel values (= higher brightness) to match the original intention to the reality of our screens. The side-effect is that glyphs \u2018thin out\u2019. Mac OS X and Adobe's proprietary font rendering library implement a counter-measure: stem darkening at smaller sizes where shades of gray dominate. By emboldening a glyph slightly in relation to its pixel size, individual pixels get higher coverage of filled-in outlines and are therefore \u2018blacker\u2019. This counteracts the \u2018thinning out\u2019 of glyphs, making text remain readable at smaller sizes. For the auto-hinter, stem-darkening is experimental currently and thus switched off by default (this is, no-stem-darkening is set to TRUE by default). Total consistency with the CFF driver is not achieved right now because the emboldening method differs and glyphs must be scaled down on the Y-axis to keep outline points inside their precomputed blue zones. The smaller the size (especially 9ppem and down), the higher the loss of emboldening versus the CFF driver. Note that stem darkening is never applied if FT_LOAD_NO_SCALE is set. note This property can be used with FT_Property_Get also. This property can be set via the FREETYPE_PROPERTIES environment variable (using values 1 and 0 for \u2018on\u2019 and \u2018off\u2019, respectively). It can also be set per face using FT_Face_Properties with FT_PARAM_TAG_STEM_DARKENING . example FT_Library library; FT_Bool no_stem_darkening = TRUE; FT_Init_FreeType( &library ); FT_Property_Set( library, \"cff\", \"no-stem-darkening\", &no_stem_darkening ); since 2.4.12 (for \u2018cff\u2019 module) 2.6.2 (for \u2018autofitter\u2019 module) 2.9 (for \u2018type1\u2019 and \u2018t1cid\u2019 modules) darkening-parameters \u00b6 By default, the Adobe hinting engine, as used by the CFF, Type 1, and CID font drivers, darkens stems as follows (if the no-stem-darkening property isn't set): stem width <= 0.5px: darkening amount = 0.4px stem width = 1px: darkening amount = 0.275px stem width = 1.667px: darkening amount = 0.275px stem width >= 2.333px: darkening amount = 0px and piecewise linear in-between. At configuration time, these four control points can be set with the macro CFF_CONFIG_OPTION_DARKENING_PARAMETERS ; the CFF, Type 1, and CID drivers share these values. At runtime, the control points can be changed using the darkening-parameters property (see the example below that demonstrates this for the Type 1 driver). The x values give the stem width, and the y values the darkening amount. The unit is 1000 th of pixels. All coordinate values must be positive; the x values must be monotonically increasing; the y values must be monotonically decreasing and smaller than or equal to 500 (corresponding to half a pixel); the slope of each linear piece must be shallower than -1 (e.g., -.4). The auto-hinter provides this property, too, as an experimental feature. See no-stem-darkening for more. note This property can be used with FT_Property_Get also. This property can be set via the FREETYPE_PROPERTIES environment variable, using eight comma-separated integers without spaces. Here the above example, using \\ to break the line for readability. FREETYPE_PROPERTIES=\\ type1:darkening-parameters=500,300,1000,200,1500,100,2000,0 example FT_Library library; FT_Int darken_params[8] = { 500, 300, // x1, y1 1000, 200, // x2, y2 1500, 100, // x3, y3 2000, 0 }; // x4, y4 FT_Init_FreeType( &library ); FT_Property_Set( library, \"type1\", \"darkening-parameters\", darken_params ); since 2.5.1 (for \u2018cff\u2019 module) 2.6.2 (for \u2018autofitter\u2019 module) 2.9 (for \u2018type1\u2019 and \u2018t1cid\u2019 modules) random-seed \u00b6 By default, the seed value for the CFF \u2018random\u2019 operator and the similar \u20180 28 callothersubr pop\u2019 command for the Type 1 and CID drivers is set to a random value. However, mainly for debugging purposes, it is often necessary to use a known value as a seed so that the pseudo-random number sequences generated by \u2018random\u2019 are repeatable. The random-seed property does that. Its argument is a signed 32bit integer; if the value is zero or negative, the seed given by the intitialRandomSeed private DICT operator in a CFF file gets used (or a default value if there is no such operator). If the value is positive, use it instead of initialRandomSeed , which is consequently ignored. note This property can be set via the FREETYPE_PROPERTIES environment variable. It can also be set per face using FT_Face_Properties with FT_PARAM_TAG_RANDOM_SEED . since 2.8 (for \u2018cff\u2019 module) 2.9 (for \u2018type1\u2019 and \u2018t1cid\u2019 modules) no-long-family-names \u00b6 If PCF_CONFIG_OPTION_LONG_FAMILY_NAMES is active while compiling FreeType, the PCF driver constructs long family names. There are many PCF fonts just called \u2018Fixed\u2019 which look completely different, and which have nothing to do with each other. When selecting \u2018Fixed\u2019 in KDE or Gnome one gets results that appear rather random, the style changes often if one changes the size and one cannot select some fonts at all. The improve this situation, the PCF module prepends the foundry name (plus a space) to the family name. It also checks whether there are \u2018wide\u2019 characters; all put together, family names like \u2018Sony Fixed\u2019 or \u2018Misc Fixed Wide\u2019 are constructed. If no-long-family-names is set, this feature gets switched off. note This property can be used with FT_Property_Get also. This property can be set via the FREETYPE_PROPERTIES environment variable (using values 1 and 0 for \u2018on\u2019 and \u2018off\u2019, respectively). example FT_Library library; FT_Bool no_long_family_names = TRUE; FT_Init_FreeType( &library ); FT_Property_Set( library, \"pcf\", \"no-long-family-names\", &no_long_family_names ); since 2.8 TT_INTERPRETER_VERSION_XXX \u00b6 Defined in FT_DRIVER_H (freetype/ftdriver.h). # define TT_INTERPRETER_VERSION_35 35 # define TT_INTERPRETER_VERSION_38 38 # define TT_INTERPRETER_VERSION_40 40 A list of constants used for the interpreter-version property to select the hinting engine for Truetype fonts. The numeric value in the constant names represents the version number as returned by the \u2018GETINFO\u2019 bytecode instruction. values TT_INTERPRETER_VERSION_35 Version 35 corresponds to MS rasterizer v.1.7 as used e.g. in Windows 98; only grayscale and B/W rasterizing is supported. TT_INTERPRETER_VERSION_38 Version 38 corresponds to MS rasterizer v.1.9; it is roughly equivalent to the hinting provided by DirectWrite ClearType (as can be found, for example, in the Internet Explorer 9 running on Windows 7). It is used in FreeType to select the \u2018Infinality\u2019 subpixel hinting code. The code may be removed in a future version. TT_INTERPRETER_VERSION_40 Version 40 corresponds to MS rasterizer v.2.1; it is roughly equivalent to the hinting provided by DirectWrite ClearType (as can be found, for example, in Microsoft's Edge Browser on Windows 10). It is used in FreeType to select the \u2018minimal\u2019 subpixel hinting code, a stripped-down and higher performance version of the \u2018Infinality\u2019 code. note This property controls the behaviour of the bytecode interpreter and thus how outlines get hinted. It does not control how glyph get rasterized! In particular, it does not control subpixel color filtering. If FreeType has not been compiled with the configuration option TT_CONFIG_OPTION_SUBPIXEL_HINTING , selecting version 38 or 40 causes an FT_Err_Unimplemented_Feature error. Depending on the graphics framework, Microsoft uses different bytecode and rendering engines. As a consequence, the version numbers returned by a call to the \u2018GETINFO\u2019 bytecode instruction are more convoluted than desired. Here are two tables that try to shed some light on the possible values for the MS rasterizer engine, together with the additional features introduced by it. GETINFO framework version feature ------------------------------------------------------------------- 3 GDI (Win 3.1), v1.0 16-bit, first version TrueImage 33 GDI (Win NT 3.1), v1.5 32-bit HP Laserjet 34 GDI (Win 95) v1.6 font smoothing, new SCANTYPE opcode 35 GDI (Win 98/2000) v1.7 (UN)SCALED_COMPONENT_OFFSET bits in composite glyphs 36 MGDI (Win CE 2) v1.6+ classic ClearType 37 GDI (XP and later), v1.8 ClearType GDI+ old (before Vista) 38 GDI+ old (Vista, Win 7), v1.9 subpixel ClearType, WPF Y-direction ClearType, additional error checking 39 DWrite (before Win 8) v2.0 subpixel ClearType flags in GETINFO opcode, bug fixes 40 GDI+ (after Win 7), v2.1 Y-direction ClearType flag DWrite (Win 8) in GETINFO opcode, Gray ClearType The \u2018version\u2019 field gives a rough orientation only, since some applications provided certain features much earlier (as an example, Microsoft Reader used subpixel and Y-direction ClearType already in Windows 2000). Similarly, updates to a given framework might include improved hinting support. version sampling rendering comment x y x y -------------------------------------------------------------- v1.0 normal normal B/W B/W bi-level v1.6 high high gray gray grayscale v1.8 high normal color-filter B/W (GDI) ClearType v1.9 high high color-filter gray Color ClearType v2.1 high normal gray B/W Gray ClearType v2.1 high high gray gray Gray ClearType Color and Gray ClearType are the two available variants of \u2018Y-direction ClearType\u2019, meaning grayscale rasterization along the Y-direction; the name used in the TrueType specification for this feature is \u2018symmetric smoothing\u2019. \u2018Classic ClearType\u2019 is the original algorithm used before introducing a modified version in Win XP. Another name for v1.6's grayscale rendering is \u2018font smoothing\u2019, and \u2018Color ClearType\u2019 is sometimes also called \u2018DWrite ClearType\u2019. To differentiate between today's Color ClearType and the earlier ClearType variant with B/W rendering along the vertical axis, the latter is sometimes called \u2018GDI ClearType\u2019. \u2018Normal\u2019 and \u2018high\u2019 sampling describe the (virtual) resolution to access the rasterized outline after the hinting process. \u2018Normal\u2019 means 1 sample per grid line (i.e., B/W). In the current Microsoft implementation, \u2018high\u2019 means an extra virtual resolution of 16x16 (or 16x1) grid lines per pixel for bytecode instructions like \u2018MIRP\u2019. After hinting, these 16 grid lines are mapped to 6x5 (or 6x1) grid lines for color filtering if Color ClearType is activated. Note that \u2018Gray ClearType\u2019 is essentially the same as v1.6's grayscale rendering. However, the GETINFO instruction handles it differently: v1.6 returns bit 12 (hinting for grayscale), while v2.1 returns bits 13 (hinting for ClearType), 18 (symmetrical smoothing), and 19 (Gray ClearType). Also, this mode respects bits 2 and 3 for the version 1 gasp table exclusively (like Color ClearType), while v1.6 only respects the values of version 0 (bits 0 and 1). Keep in mind that the features of the above interpreter versions might not map exactly to FreeType features or behavior because it is a fundamentally different library with different internals. interpreter-version \u00b6 Currently, three versions are available, two representing the bytecode interpreter with subpixel hinting support (old \u2018Infinality\u2019 code and new stripped-down and higher performance \u2018minimal\u2019 code) and one without, respectively. The default is subpixel support if TT_CONFIG_OPTION_SUBPIXEL_HINTING is defined, and no subpixel support otherwise (since it isn't available then). If subpixel hinting is on, many TrueType bytecode instructions behave differently compared to B/W or grayscale rendering (except if \u2018native ClearType\u2019 is selected by the font). Microsoft's main idea is to render at a much increased horizontal resolution, then sampling down the created output to subpixel precision. However, many older fonts are not suited to this and must be specially taken care of by applying (hardcoded) tweaks in Microsoft's interpreter. Details on subpixel hinting and some of the necessary tweaks can be found in Greg Hitchcock's whitepaper at \u2018 https://www.microsoft.com/typography/cleartype/truetypecleartype.aspx \u2019. Note that FreeType currently doesn't really \u2018subpixel hint\u2019 (6x1, 6x2, or 6x5 supersampling) like discussed in the paper. Depending on the chosen interpreter, it simply ignores instructions on vertical stems to arrive at very similar results. note This property can be used with FT_Property_Get also. This property can be set via the FREETYPE_PROPERTIES environment variable (using values \u201835\u2019, \u201838\u2019, or \u201840\u2019). example The following example code demonstrates how to deactivate subpixel hinting (omitting the error handling). FT_Library library; FT_Face face; FT_UInt interpreter_version = TT_INTERPRETER_VERSION_35; FT_Init_FreeType( &library ); FT_Property_Set( library, \"truetype\", \"interpreter-version\", &interpreter_version ); since 2.5 glyph-to-script-map \u00b6 Experimental only The auto-hinter provides various script modules to hint glyphs. Examples of supported scripts are Latin or CJK. Before a glyph is auto-hinted, the Unicode character map of the font gets examined, and the script is then determined based on Unicode character ranges, see below. OpenType fonts, however, often provide much more glyphs than character codes (small caps, superscripts, ligatures, swashes, etc.), to be controlled by so-called \u2018features\u2019. Handling OpenType features can be quite complicated and thus needs a separate library on top of FreeType. The mapping between glyph indices and scripts (in the auto-hinter sense, see the FT_AUTOHINTER_SCRIPT_XXX values) is stored as an array with num_glyphs elements, as found in the font's FT_Face structure. The glyph-to-script-map property returns a pointer to this array, which can be modified as needed. Note that the modification should happen before the first glyph gets processed by the auto-hinter so that the global analysis of the font shapes actually uses the modified mapping. example The following example code demonstrates how to access it (omitting the error handling). FT_Library library; FT_Face face; FT_Prop_GlyphToScriptMap prop; FT_Init_FreeType( &library ); FT_New_Face( library, \"foo.ttf\", 0, &face ); prop.face = face; FT_Property_Get( library, \"autofitter\", \"glyph-to-script-map\", &prop ); // adjust `prop.map' as needed right here FT_Load_Glyph( face, ..., FT_LOAD_FORCE_AUTOHINT ); since 2.4.11 FT_AUTOHINTER_SCRIPT_XXX \u00b6 Defined in FT_DRIVER_H (freetype/ftdriver.h). # define FT_AUTOHINTER_SCRIPT_NONE 0 # define FT_AUTOHINTER_SCRIPT_LATIN 1 # define FT_AUTOHINTER_SCRIPT_CJK 2 # define FT_AUTOHINTER_SCRIPT_INDIC 3 Experimental only A list of constants used for the glyph-to-script-map property to specify the script submodule the auto-hinter should use for hinting a particular glyph. values FT_AUTOHINTER_SCRIPT_NONE Don't auto-hint this glyph. FT_AUTOHINTER_SCRIPT_LATIN Apply the latin auto-hinter. For the auto-hinter, \u2018latin\u2019 is a very broad term, including Cyrillic and Greek also since characters from those scripts share the same design constraints. By default, characters from the following Unicode ranges are assigned to this submodule. U+0020 - U+007F // Basic Latin (no control characters) U+00A0 - U+00FF // Latin-1 Supplement (no control characters) U+0100 - U+017F // Latin Extended-A U+0180 - U+024F // Latin Extended-B U+0250 - U+02AF // IPA Extensions U+02B0 - U+02FF // Spacing Modifier Letters U+0300 - U+036F // Combining Diacritical Marks U+0370 - U+03FF // Greek and Coptic U+0400 - U+04FF // Cyrillic U+0500 - U+052F // Cyrillic Supplement U+1D00 - U+1D7F // Phonetic Extensions U+1D80 - U+1DBF // Phonetic Extensions Supplement U+1DC0 - U+1DFF // Combining Diacritical Marks Supplement U+1E00 - U+1EFF // Latin Extended Additional U+1F00 - U+1FFF // Greek Extended U+2000 - U+206F // General Punctuation U+2070 - U+209F // Superscripts and Subscripts U+20A0 - U+20CF // Currency Symbols U+2150 - U+218F // Number Forms U+2460 - U+24FF // Enclosed Alphanumerics U+2C60 - U+2C7F // Latin Extended-C U+2DE0 - U+2DFF // Cyrillic Extended-A U+2E00 - U+2E7F // Supplemental Punctuation U+A640 - U+A69F // Cyrillic Extended-B U+A720 - U+A7FF // Latin Extended-D U+FB00 - U+FB06 // Alphab. Present. Forms (Latin Ligatures) U+1D400 - U+1D7FF // Mathematical Alphanumeric Symbols U+1F100 - U+1F1FF // Enclosed Alphanumeric Supplement FT_AUTOHINTER_SCRIPT_CJK Apply the CJK auto-hinter, covering Chinese, Japanese, Korean, old Vietnamese, and some other scripts. By default, characters from the following Unicode ranges are assigned to this submodule. U+1100 - U+11FF // Hangul Jamo U+2E80 - U+2EFF // CJK Radicals Supplement U+2F00 - U+2FDF // Kangxi Radicals U+2FF0 - U+2FFF // Ideographic Description Characters U+3000 - U+303F // CJK Symbols and Punctuation U+3040 - U+309F // Hiragana U+30A0 - U+30FF // Katakana U+3100 - U+312F // Bopomofo U+3130 - U+318F // Hangul Compatibility Jamo U+3190 - U+319F // Kanbun U+31A0 - U+31BF // Bopomofo Extended U+31C0 - U+31EF // CJK Strokes U+31F0 - U+31FF // Katakana Phonetic Extensions U+3200 - U+32FF // Enclosed CJK Letters and Months U+3300 - U+33FF // CJK Compatibility U+3400 - U+4DBF // CJK Unified Ideographs Extension A U+4DC0 - U+4DFF // Yijing Hexagram Symbols U+4E00 - U+9FFF // CJK Unified Ideographs U+A960 - U+A97F // Hangul Jamo Extended-A U+AC00 - U+D7AF // Hangul Syllables U+D7B0 - U+D7FF // Hangul Jamo Extended-B U+F900 - U+FAFF // CJK Compatibility Ideographs U+FE10 - U+FE1F // Vertical forms U+FE30 - U+FE4F // CJK Compatibility Forms U+FF00 - U+FFEF // Halfwidth and Fullwidth Forms U+1B000 - U+1B0FF // Kana Supplement U+1D300 - U+1D35F // Tai Xuan Hing Symbols U+1F200 - U+1F2FF // Enclosed Ideographic Supplement U+20000 - U+2A6DF // CJK Unified Ideographs Extension B U+2A700 - U+2B73F // CJK Unified Ideographs Extension C U+2B740 - U+2B81F // CJK Unified Ideographs Extension D U+2F800 - U+2FA1F // CJK Compatibility Ideographs Supplement FT_AUTOHINTER_SCRIPT_INDIC Apply the indic auto-hinter, covering all major scripts from the Indian sub-continent and some other related scripts like Thai, Lao, or Tibetan. By default, characters from the following Unicode ranges are assigned to this submodule. U+0900 - U+0DFF // Indic Range U+0F00 - U+0FFF // Tibetan U+1900 - U+194F // Limbu U+1B80 - U+1BBF // Sundanese U+A800 - U+A82F // Syloti Nagri U+ABC0 - U+ABFF // Meetei Mayek U+11800 - U+118DF // Sharada Note that currently Indic support is rudimentary only, missing blue zone support. since 2.4.11 FT_Prop_GlyphToScriptMap \u00b6 Defined in FT_DRIVER_H (freetype/ftdriver.h). typedef struct FT_Prop_GlyphToScriptMap_ { FT_Face face; FT_UShort * map; } FT_Prop_GlyphToScriptMap ; Experimental only The data exchange structure for the glyph-to-script-map property. since 2.4.11 fallback-script \u00b6 Experimental only If no auto-hinter script module can be assigned to a glyph, a fallback script gets assigned to it (see also the glyph-to-script-map property). By default, this is FT_AUTOHINTER_SCRIPT_CJK . Using the fallback-script property, this fallback value can be changed. note This property can be used with FT_Property_Get also. It's important to use the right timing for changing this value: The creation of the glyph-to-script map that eventually uses the fallback script value gets triggered either by setting or reading a face-specific property like glyph-to-script-map , or by auto-hinting any glyph from that face. In particular, if you have already created an FT_Face structure but not loaded any glyph (using the auto-hinter), a change of the fallback script will affect this face. example FT_Library library; FT_UInt fallback_script = FT_AUTOHINTER_SCRIPT_NONE; FT_Init_FreeType( &library ); FT_Property_Set( library, \"autofitter\", \"fallback-script\", &fallback_script ); since 2.4.11 default-script \u00b6 Experimental only If FreeType gets compiled with FT_CONFIG_OPTION_USE_HARFBUZZ to make the HarfBuzz library access OpenType features for getting better glyph coverages, this property sets the (auto-fitter) script to be used for the default (OpenType) script data of a font's GSUB table. Features for the default script are intended for all scripts not explicitly handled in GSUB; an example is a \u2018dlig\u2019 feature, containing the combination of the characters \u2018T\u2019, \u2018E\u2019, and \u2018L\u2019 to form a \u2018TEL\u2019 ligature. By default, this is FT_AUTOHINTER_SCRIPT_LATIN . Using the default-script property, this default value can be changed. note This property can be used with FT_Property_Get also. It's important to use the right timing for changing this value: The creation of the glyph-to-script map that eventually uses the default script value gets triggered either by setting or reading a face-specific property like glyph-to-script-map , or by auto-hinting any glyph from that face. In particular, if you have already created an FT_Face structure but not loaded any glyph (using the auto-hinter), a change of the default script will affect this face. example FT_Library library; FT_UInt default_script = FT_AUTOHINTER_SCRIPT_NONE; FT_Init_FreeType( &library ); FT_Property_Set( library, \"autofitter\", \"default-script\", &default_script ); since 2.5.3 increase-x-height \u00b6 For ppem values in the range 6 <= ppem <= increase-x-height , round up the font's x height much more often than normally. If the value is set to 0, which is the default, this feature is switched off. Use this property to improve the legibility of small font sizes if necessary. note This property can be used with FT_Property_Get also. Set this value right after calling FT_Set_Char_Size , but before loading any glyph (using the auto-hinter). example FT_Library library; FT_Face face; FT_Prop_IncreaseXHeight prop; FT_Init_FreeType( &library ); FT_New_Face( library, \"foo.ttf\", 0, &face ); FT_Set_Char_Size( face, 10 * 64, 0, 72, 0 ); prop.face = face; prop.limit = 14; FT_Property_Set( library, \"autofitter\", \"increase-x-height\", &prop ); since 2.4.11 FT_Prop_IncreaseXHeight \u00b6 Defined in FT_DRIVER_H (freetype/ftdriver.h). typedef struct FT_Prop_IncreaseXHeight_ { FT_Face face; FT_UInt limit; } FT_Prop_IncreaseXHeight ; The data exchange structure for the increase-x-height property. warping \u00b6 Experimental only If FreeType gets compiled with option AF_CONFIG_OPTION_USE_WARPER to activate the warp hinting code in the auto-hinter, this property switches warping on and off. Warping only works in \u2018normal\u2019 auto-hinting mode replacing it. The idea of the code is to slightly scale and shift a glyph along the non-hinted dimension (which is usually the horizontal axis) so that as much of its segments are aligned (more or less) to the grid. To find out a glyph's optimal scaling and shifting value, various parameter combinations are tried and scored. By default, warping is off. note This property can be used with FT_Property_Get also. This property can be set via the FREETYPE_PROPERTIES environment variable (using values 1 and 0 for \u2018on\u2019 and \u2018off\u2019, respectively). The warping code can also change advance widths. Have a look at the lsb_delta and rsb_delta fields in the FT_GlyphSlotRec structure for details on improving inter-glyph distances while rendering. Since warping is a global property of the auto-hinter it is best to change its value before rendering any face. Otherwise, you should reload all faces that get auto-hinted in \u2018normal\u2019 hinting mode. example This example shows how to switch on warping (omitting the error handling). FT_Library library; FT_Bool warping = 1; FT_Init_FreeType( &library ); FT_Property_Set( library, \"autofitter\", \"warping\", &warping ); since 2.6","title":"Driver properties"},{"location":"ft2-properties.html#driver-properties","text":"","title":"Driver properties"},{"location":"ft2-properties.html#synopsis","text":"Driver modules can be controlled by setting and unsetting properties, using the functions FT_Property_Set and FT_Property_Get . This section documents the available properties, together with auxiliary macros and structures.","title":"Synopsis"},{"location":"ft2-properties.html#ft_hinting_xxx","text":"Defined in FT_DRIVER_H (freetype/ftdriver.h). # define FT_HINTING_FREETYPE 0 # define FT_HINTING_ADOBE 1 /* these constants (introduced in 2.4.12) are deprecated */ # define FT_CFF_HINTING_FREETYPE FT_HINTING_FREETYPE # define FT_CFF_HINTING_ADOBE FT_HINTING_ADOBE A list of constants used for the hinting-engine property to select the hinting engine for CFF, Type 1, and CID fonts.","title":"FT_HINTING_XXX"},{"location":"ft2-properties.html#hinting-engine","text":"Thanks to Adobe, which contributed a new hinting (and parsing) engine, an application can select between \u2018freetype\u2019 and \u2018adobe\u2019 if compiled with CFF_CONFIG_OPTION_OLD_ENGINE . If this configuration macro isn't defined, \u2018hinting-engine\u2019 does nothing. The same holds for the Type 1 and CID modules if compiled with T1_CONFIG_OPTION_OLD_ENGINE . For the \u2018cff\u2019 module, the default engine is \u2018freetype\u2019 if CFF_CONFIG_OPTION_OLD_ENGINE is defined, and \u2018adobe\u2019 otherwise. For both the \u2018type1\u2019 and \u2018t1cid\u2019 modules, the default engine is \u2018freetype\u2019 if T1_CONFIG_OPTION_OLD_ENGINE is defined, and \u2018adobe\u2019 otherwise.","title":"hinting-engine"},{"location":"ft2-properties.html#no-stem-darkening","text":"All glyphs that pass through the auto-hinter will be emboldened unless this property is set to TRUE. The same is true for the CFF, Type 1, and CID font modules if the \u2018Adobe\u2019 engine is selected (which is the default). Stem darkening emboldens glyphs at smaller sizes to make them more readable on common low-DPI screens when using linear alpha blending and gamma correction, see FT_Render_Glyph . When not using linear alpha blending and gamma correction, glyphs will appear heavy and fuzzy! Gamma correction essentially lightens fonts since shades of grey are shifted to higher pixel values (= higher brightness) to match the original intention to the reality of our screens. The side-effect is that glyphs \u2018thin out\u2019. Mac OS X and Adobe's proprietary font rendering library implement a counter-measure: stem darkening at smaller sizes where shades of gray dominate. By emboldening a glyph slightly in relation to its pixel size, individual pixels get higher coverage of filled-in outlines and are therefore \u2018blacker\u2019. This counteracts the \u2018thinning out\u2019 of glyphs, making text remain readable at smaller sizes. For the auto-hinter, stem-darkening is experimental currently and thus switched off by default (this is, no-stem-darkening is set to TRUE by default). Total consistency with the CFF driver is not achieved right now because the emboldening method differs and glyphs must be scaled down on the Y-axis to keep outline points inside their precomputed blue zones. The smaller the size (especially 9ppem and down), the higher the loss of emboldening versus the CFF driver. Note that stem darkening is never applied if FT_LOAD_NO_SCALE is set.","title":"no-stem-darkening"},{"location":"ft2-properties.html#darkening-parameters","text":"By default, the Adobe hinting engine, as used by the CFF, Type 1, and CID font drivers, darkens stems as follows (if the no-stem-darkening property isn't set): stem width <= 0.5px: darkening amount = 0.4px stem width = 1px: darkening amount = 0.275px stem width = 1.667px: darkening amount = 0.275px stem width >= 2.333px: darkening amount = 0px and piecewise linear in-between. At configuration time, these four control points can be set with the macro CFF_CONFIG_OPTION_DARKENING_PARAMETERS ; the CFF, Type 1, and CID drivers share these values. At runtime, the control points can be changed using the darkening-parameters property (see the example below that demonstrates this for the Type 1 driver). The x values give the stem width, and the y values the darkening amount. The unit is 1000 th of pixels. All coordinate values must be positive; the x values must be monotonically increasing; the y values must be monotonically decreasing and smaller than or equal to 500 (corresponding to half a pixel); the slope of each linear piece must be shallower than -1 (e.g., -.4). The auto-hinter provides this property, too, as an experimental feature. See no-stem-darkening for more.","title":"darkening-parameters"},{"location":"ft2-properties.html#random-seed","text":"By default, the seed value for the CFF \u2018random\u2019 operator and the similar \u20180 28 callothersubr pop\u2019 command for the Type 1 and CID drivers is set to a random value. However, mainly for debugging purposes, it is often necessary to use a known value as a seed so that the pseudo-random number sequences generated by \u2018random\u2019 are repeatable. The random-seed property does that. Its argument is a signed 32bit integer; if the value is zero or negative, the seed given by the intitialRandomSeed private DICT operator in a CFF file gets used (or a default value if there is no such operator). If the value is positive, use it instead of initialRandomSeed , which is consequently ignored.","title":"random-seed"},{"location":"ft2-properties.html#no-long-family-names","text":"If PCF_CONFIG_OPTION_LONG_FAMILY_NAMES is active while compiling FreeType, the PCF driver constructs long family names. There are many PCF fonts just called \u2018Fixed\u2019 which look completely different, and which have nothing to do with each other. When selecting \u2018Fixed\u2019 in KDE or Gnome one gets results that appear rather random, the style changes often if one changes the size and one cannot select some fonts at all. The improve this situation, the PCF module prepends the foundry name (plus a space) to the family name. It also checks whether there are \u2018wide\u2019 characters; all put together, family names like \u2018Sony Fixed\u2019 or \u2018Misc Fixed Wide\u2019 are constructed. If no-long-family-names is set, this feature gets switched off.","title":"no-long-family-names"},{"location":"ft2-properties.html#tt_interpreter_version_xxx","text":"Defined in FT_DRIVER_H (freetype/ftdriver.h). # define TT_INTERPRETER_VERSION_35 35 # define TT_INTERPRETER_VERSION_38 38 # define TT_INTERPRETER_VERSION_40 40 A list of constants used for the interpreter-version property to select the hinting engine for Truetype fonts. The numeric value in the constant names represents the version number as returned by the \u2018GETINFO\u2019 bytecode instruction.","title":"TT_INTERPRETER_VERSION_XXX"},{"location":"ft2-properties.html#interpreter-version","text":"Currently, three versions are available, two representing the bytecode interpreter with subpixel hinting support (old \u2018Infinality\u2019 code and new stripped-down and higher performance \u2018minimal\u2019 code) and one without, respectively. The default is subpixel support if TT_CONFIG_OPTION_SUBPIXEL_HINTING is defined, and no subpixel support otherwise (since it isn't available then). If subpixel hinting is on, many TrueType bytecode instructions behave differently compared to B/W or grayscale rendering (except if \u2018native ClearType\u2019 is selected by the font). Microsoft's main idea is to render at a much increased horizontal resolution, then sampling down the created output to subpixel precision. However, many older fonts are not suited to this and must be specially taken care of by applying (hardcoded) tweaks in Microsoft's interpreter. Details on subpixel hinting and some of the necessary tweaks can be found in Greg Hitchcock's whitepaper at \u2018 https://www.microsoft.com/typography/cleartype/truetypecleartype.aspx \u2019. Note that FreeType currently doesn't really \u2018subpixel hint\u2019 (6x1, 6x2, or 6x5 supersampling) like discussed in the paper. Depending on the chosen interpreter, it simply ignores instructions on vertical stems to arrive at very similar results.","title":"interpreter-version"},{"location":"ft2-properties.html#glyph-to-script-map","text":"Experimental only The auto-hinter provides various script modules to hint glyphs. Examples of supported scripts are Latin or CJK. Before a glyph is auto-hinted, the Unicode character map of the font gets examined, and the script is then determined based on Unicode character ranges, see below. OpenType fonts, however, often provide much more glyphs than character codes (small caps, superscripts, ligatures, swashes, etc.), to be controlled by so-called \u2018features\u2019. Handling OpenType features can be quite complicated and thus needs a separate library on top of FreeType. The mapping between glyph indices and scripts (in the auto-hinter sense, see the FT_AUTOHINTER_SCRIPT_XXX values) is stored as an array with num_glyphs elements, as found in the font's FT_Face structure. The glyph-to-script-map property returns a pointer to this array, which can be modified as needed. Note that the modification should happen before the first glyph gets processed by the auto-hinter so that the global analysis of the font shapes actually uses the modified mapping.","title":"glyph-to-script-map"},{"location":"ft2-properties.html#ft_autohinter_script_xxx","text":"Defined in FT_DRIVER_H (freetype/ftdriver.h). # define FT_AUTOHINTER_SCRIPT_NONE 0 # define FT_AUTOHINTER_SCRIPT_LATIN 1 # define FT_AUTOHINTER_SCRIPT_CJK 2 # define FT_AUTOHINTER_SCRIPT_INDIC 3 Experimental only A list of constants used for the glyph-to-script-map property to specify the script submodule the auto-hinter should use for hinting a particular glyph.","title":"FT_AUTOHINTER_SCRIPT_XXX"},{"location":"ft2-properties.html#ft_prop_glyphtoscriptmap","text":"Defined in FT_DRIVER_H (freetype/ftdriver.h). typedef struct FT_Prop_GlyphToScriptMap_ { FT_Face face; FT_UShort * map; } FT_Prop_GlyphToScriptMap ; Experimental only The data exchange structure for the glyph-to-script-map property.","title":"FT_Prop_GlyphToScriptMap"},{"location":"ft2-properties.html#fallback-script","text":"Experimental only If no auto-hinter script module can be assigned to a glyph, a fallback script gets assigned to it (see also the glyph-to-script-map property). By default, this is FT_AUTOHINTER_SCRIPT_CJK . Using the fallback-script property, this fallback value can be changed.","title":"fallback-script"},{"location":"ft2-properties.html#default-script","text":"Experimental only If FreeType gets compiled with FT_CONFIG_OPTION_USE_HARFBUZZ to make the HarfBuzz library access OpenType features for getting better glyph coverages, this property sets the (auto-fitter) script to be used for the default (OpenType) script data of a font's GSUB table. Features for the default script are intended for all scripts not explicitly handled in GSUB; an example is a \u2018dlig\u2019 feature, containing the combination of the characters \u2018T\u2019, \u2018E\u2019, and \u2018L\u2019 to form a \u2018TEL\u2019 ligature. By default, this is FT_AUTOHINTER_SCRIPT_LATIN . Using the default-script property, this default value can be changed.","title":"default-script"},{"location":"ft2-properties.html#increase-x-height","text":"For ppem values in the range 6 <= ppem <= increase-x-height , round up the font's x height much more often than normally. If the value is set to 0, which is the default, this feature is switched off. Use this property to improve the legibility of small font sizes if necessary.","title":"increase-x-height"},{"location":"ft2-properties.html#ft_prop_increasexheight","text":"Defined in FT_DRIVER_H (freetype/ftdriver.h). typedef struct FT_Prop_IncreaseXHeight_ { FT_Face face; FT_UInt limit; } FT_Prop_IncreaseXHeight ; The data exchange structure for the increase-x-height property.","title":"FT_Prop_IncreaseXHeight"},{"location":"ft2-properties.html#warping","text":"Experimental only If FreeType gets compiled with option AF_CONFIG_OPTION_USE_WARPER to activate the warp hinting code in the auto-hinter, this property switches warping on and off. Warping only works in \u2018normal\u2019 auto-hinting mode replacing it. The idea of the code is to slightly scale and shift a glyph along the non-hinted dimension (which is usually the horizontal axis) so that as much of its segments are aligned (more or less) to the grid. To find out a glyph's optimal scaling and shifting value, various parameter combinations are tried and scored. By default, warping is off.","title":"warping"},{"location":"ft2-quick_advance.html","text":"FreeType \u00bb Docs \u00bb Support API \u00bb Quick retrieval of advance values Quick retrieval of advance values \u00b6 Synopsis \u00b6 This section contains functions to quickly extract advance values without handling glyph outlines, if possible. FT_Get_Advance \u00b6 Defined in FT_ADVANCES_H (freetype/ftadvanc.h). FT_EXPORT( FT_Error ) FT_Get_Advance ( FT_Face face, FT_UInt gindex, FT_Int32 load_flags, FT_Fixed *padvance ); Retrieve the advance value of a given glyph outline in an FT_Face . input face The source FT_Face handle. gindex The glyph index. load_flags A set of bit flags similar to those used when calling FT_Load_Glyph , used to determine what kind of advances you need. output padvance The advance value. If scaling is performed (based on the value of load_flags ), the advance value is in 16.16 format. Otherwise, it is in font units. If FT_LOAD_VERTICAL_LAYOUT is set, this is the vertical advance corresponding to a vertical layout. Otherwise, it is the horizontal advance in a horizontal layout. return FreeType error code. 0 means success. note This function may fail if you use FT_ADVANCE_FLAG_FAST_ONLY and if the corresponding font backend doesn't have a quick way to retrieve the advances. A scaled advance is returned in 16.16 format but isn't transformed by the affine transformation specified by FT_Set_Transform . FT_Get_Advances \u00b6 Defined in FT_ADVANCES_H (freetype/ftadvanc.h). FT_EXPORT( FT_Error ) FT_Get_Advances ( FT_Face face, FT_UInt start, FT_UInt count, FT_Int32 load_flags, FT_Fixed *padvances ); Retrieve the advance values of several glyph outlines in an FT_Face . input face The source FT_Face handle. start The first glyph index. count The number of advance values you want to retrieve. load_flags A set of bit flags similar to those used when calling FT_Load_Glyph . output padvance The advance values. This array, to be provided by the caller, must contain at least count elements. If scaling is performed (based on the value of load_flags ), the advance values are in 16.16 format. Otherwise, they are in font units. If FT_LOAD_VERTICAL_LAYOUT is set, these are the vertical advances corresponding to a vertical layout. Otherwise, they are the horizontal advances in a horizontal layout. return FreeType error code. 0 means success. note This function may fail if you use FT_ADVANCE_FLAG_FAST_ONLY and if the corresponding font backend doesn't have a quick way to retrieve the advances. Scaled advances are returned in 16.16 format but aren't transformed by the affine transformation specified by FT_S (…)

Completed in 103 milliseconds