Search

Home

Sort by

Full Search
Definition
Symbol
File Path
History
Type

In Project(s)

Searched refs:upwards (Results 1 - 4 of 4) sorted by relevance

/xsrc/external/mit/MesaLib/dist/src/amd/compiler/
H A D	aco_scheduler.cpp	`77 * Cursor for upwards moves, where a single instruction is moved below 116 /* for moving instructions after the first use of the current instruction upwards / 557 perform_hazard_query(hazard_query query, Instruction* instr, bool upwards) argument 560 if (!upwards && instr->opcode == aco_opcode::p_exit_early_if) 586 if (upwards)`
/xsrc/external/mit/MesaLib/dist/docs/relnotes/
H A D	21.1.1.rst	`217 - aco/scheduler: Fix register demand computation for upwards moves`
H A D	21.2.0.rst	`5107 - aco/scheduler: Fix register demand computation for upwards moves`
/xsrc/external/mit/freetype/dist/docs/reference/search/
H A D	search_index.json	1 {"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' = xxx + yxy y' = xyx + yyy 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' = xxx + yxy y' = xyx + yyy","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 (ab)/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 (ab)/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 (ab)/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 (ab)/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 (a0x10000)/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 (a0x10000)/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 = ab . 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 2pi 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 (ab)/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 (ab)/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 (a0x10000)/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 = ab .","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 2pi 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 (…)

Completed in 41 milliseconds