typedef struct FT_LibraryRec_  *FT_Library;

A handle to a FreeType library instance. Each `library' is completely independent from the others; it is the `root' 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).

Library objects are normally created by FT_Init_FreeType, and destroyed with FT_Done_FreeType.

  typedef struct FT_FaceRec_*  FT_Face;

A handle to a given typographic face object. A face object models a given typeface, in a given style.

Each 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 filepathname or a custom input stream.

Use FT_Done_Face to destroy it (along with its slot and sizes).

The FT_FaceRec details the publicly accessible fields of a given face object.

  typedef struct FT_SizeRec_*  FT_Size;

A handle to a given size object. Such an object models the data that depends on the current resolution and _character size_ in a given FT_Face.

Each face object owns one or more sizes. There is however a single active size for the face at any time that will be used by functions like FT_Load_Glyph, FT_Get_Kerning, etc.

You can use the FT_Activate_Size API to change the current active size of any given face.

The FT_SizeRec structure details the publicly accessible fields of a given face object.

  typedef struct FT_GlyphSlotRec_*  FT_GlyphSlot;

A handle to a given `glyph slot'. A slot is a container where it is possible to load any one 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.

FT_GlyphSlotRec details the publicly accessible glyph fields.

  typedef struct FT_CharMapRec_*  FT_CharMap;

A handle to a given character map. 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 "active" and 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.

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.

The FT_CharMapRec details the publicly accessible fields of a given character map.

  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_GB2312,  '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 backwards compatibility */
    FT_ENCODING_MS_SJIS    = FT_ENCODING_SJIS,
    FT_ENCODING_MS_GB2312  = FT_ENCODING_GB2312,
    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;

An enumeration used to specify encodings supported by charmaps. Used in the FT_Select_Charmap API function.

Because of 32-bit charcodes defined in Unicode (i.e., surrogates), all character codes must be expressed as FT_Longs.

The values of this type correspond to specific character repertories (i.e. charsets), and not to text encoding methods (like UTF-8, UTF-16, GB2312_EUC, etc.).

Other encodings might be defined in the future.

By default, FreeType automatically synthetizes a Unicode charmap for Postscript fonts, using their glyph names dictionaries. However, it will also report the encodings defined explicitly in the font file, for the cases when they are needed, with the Adobe values as well.

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 `KOI8' and the `cs_encoding' field is `R', 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 which may be needed to be able to distinguish Apple encoding variants. See

http://www.unicode.org/Public/MAPPINGS/VENDORS/APPLE/README.TXT

to get an idea how to do that. Basically, if the language ID is 0, dont 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.

  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 used 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 is used, values are returned in font units instead.

  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 size of a bitmap strike (i.e., a bitmap instance of the font for a given resolution) in a fixed-size font face. It is used for the `available_sizes' field of the FT_FaceRec structure.

The values in this structure are taken from the bitmap font. If the font doesn't provide a parameter it is set to zero to indicate that the information is not available.

The following formula converts from dpi to ppem:

ppem = size * dpi / 72

where `size' is in points.

Windows FNT: The `size' parameter is not reliable: There exist fonts (e.g., app850.fon) which have a wrong size for some subfonts; x_ppem and y_ppem are thus set equal to pixel width and height given in in the Windows FNT header.

TrueType embedded bitmaps: `size', `width', and `height' values are not contained in the bitmap strike itself. They are computed from the global font parameters.

  typedef struct FT_ModuleRec_*  FT_Module;

A handle to a given FreeType module object. Each module can be a font driver, a renderer, or anything else that provides services to the formers.

  typedef struct FT_DriverRec_*  FT_Driver;

A handle to a given FreeType font driver object. Each font driver is a special module capable of creating faces from font files.

  typedef struct FT_RendererRec_*  FT_Renderer;

A handle to a given FreeType renderer. A renderer is a special module in charge of converting a glyph image to a bitmap, when necessary. Each renderer supports a given glyph image format, and one or more target surface depths.

#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 "encoding" identifiers (see FT_Encoding).

Since many 16bit compilers don't like 32bit 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.

#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_GB2312
#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

These constants are deprecated; use the corresponding FT_Encoding values instead.

  typedef struct  FT_CharMapRec_
  {
    FT_Face      face;
    FT_Encoding  encoding;
    FT_UShort    platform_id;
    FT_UShort    encoding_id;

  } FT_CharMapRec;

The base charmap structure.

  typedef struct FT_Face_InternalRec_*  FT_Face_Internal;

An opaque handle to an FT_Face_InternalRec structure, used to model 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.

  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 are only relevant to scalable outlines */
    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;
    void*             extensions;

    FT_Face_Internal  internal;

    /*@private end */

  } FT_FaceRec;

FreeType root face class structure. A face object models the resolution and point-size independent data found in a font file.

#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 )

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.

#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).

FT_HAS_VERTICAL can be used to check for vertical metrics.

#define FT_HAS_VERTICAL( face ) \
          ( face->face_flags & FT_FACE_FLAG_VERTICAL )

A macro that returns true whenever a face object contains vertical metrics.

#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.

#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, CID, and OpenType/CFF font formats.

#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.

#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 "monospace", "fixed-pitch", etc.) glyphs.

#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.

#define FT_HAS_FAST_GLYPHS( face ) \
          ( face->face_flags & FT_FACE_FLAG_FAST_GLYPHS )

Deprecated; indicates that the face contains so-called "fast" glyph bitmaps.

#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.

#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.

#define FT_STYLE_FLAG_ITALIC  ( 1 << 0 )
#define FT_STYLE_FLAG_BOLD    ( 1 << 1 )

A list of bit-flags used to indicate the style of a given face. These are used in the `style_flags' field of FT_FaceRec.

  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.

  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;     /* two scales used to convert font units  */
    FT_Fixed   y_scale;     /* to 26.6 frac. pixel coordinates        */

    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 returned scaled important distances for a given size object.

For scalable fonts, the values of `ascender', `descender', and `height' are scaled versions of `face->ascender', `face->descender', and `face->height', respectively.

Unfortunately, due to glyph hinting, these values might not be exact for certain fonts. They thus must be treated as unreliable with an error margin of at least one pixel!

Indeed, the only way to get the exact pixel ascender and descender is to render all glyphs. As this would be a definite performance hit, it is up to client applications to perform such computations.

  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 the resolution and pointsize dependent data of a given face.

  typedef struct FT_SubGlyphRec_*  FT_SubGlyph;

The subglyph structure is an internal object used to describe subglyphs (for example, in the case of composites).

The subglyph implementation is not part of the high-level API, hence the forward structure declaration.

  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.

  typedef struct  FT_GlyphSlotRec_
  {
    FT_Library        library;
    FT_Face           face;
    FT_GlyphSlot      next;
    FT_UInt           reserved;       /* retained for binary compatibility */
    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 vectorial or bitmap/graymaps.

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. a vectorial outline for TrueType and Type 1 formats).

This image can later be converted into a bitmap by calling FT_Render_Glyph. This function finds 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 convert 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 a small pseudo code fragment which shows how to use `lsb_delta' and `rsb_delta':

  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 - face->glyph->lsb_delta >= 32 )           
      origin_x -= 64;                                              
    else if ( prev_rsb_delta - face->glyph->lsb_delta < -32 )      
      origin_x += 64;                                              
                                                                   
    prev_rsb_delta = face->glyph->rsb_delta;                       
                                                                   
    <save glyph image, or render glyph, or ...>                    
                                                                   
    origin_x += face->glyph->advance.x;                            
  endfor                                                           

  FT_EXPORT( FT_Error )
  FT_Init_FreeType( FT_Library  *alibrary );

Initializes a new FreeType library object. The set of modules that are registered by this function is determined at build time.

FreeType error code. 0 means success.

  FT_EXPORT( void )
  FT_Library_Version( FT_Library   library,
                      FT_Int      *amajor,
                      FT_Int      *aminor,
                      FT_Int      *apatch );

Return the version of the FreeType library being used. This is useful when dynamically linking to the library, since one cannot use the macros FT_FREETYPE_MAJOR, FT_FREETYPE_MINOR, and FT_FREETYPE_PATCH.

The reason why this function takes a 'library' argument is because certain programs implement library initialization in a custom way that doesn't use `FT_Init_FreeType'.

In such cases, the library version might not be available before the library object has been created.

  FT_EXPORT( FT_Error )
  FT_Done_FreeType( FT_Library  library );

Destroys a given FreeType library object and all of its childs, including resources, drivers, faces, sizes, etc.

FreeType error code. 0 means success.

#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

#define ft_open_memory    FT_OPEN_MEMORY     /* deprecated */
#define ft_open_stream    FT_OPEN_STREAM     /* deprecated */
#define ft_open_pathname  FT_OPEN_PATHNAME   /* deprecated */
#define ft_open_driver    FT_OPEN_DRIVER     /* deprecated */
#define ft_open_params    FT_OPEN_PARAMS     /* deprecated */

A list of bit-field constants used within the `flags' field of the FT_Open_Args structure.

The `FT_OPEN_MEMORY', `FT_OPEN_STREAM', and `FT_OPEN_PATHNAME' flags are mutually exclusive.

  typedef struct  FT_Parameter_
  {
    FT_ULong    tag;
    FT_Pointer  data;

  } FT_Parameter;

A simple structure used to pass more or less generic parameters to FT_Open_Face.

The id and function of parameters are driver-specific.

  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 used to indicate how to open a new font file/stream. A pointer to such a structure can be used as a parameter for the functions FT_Open_Face and FT_Attach_Stream.

The stream type is determined by the contents of `flags' which 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'.

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 will only try 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' will be used. They are ignored otherwise.

  FT_EXPORT( FT_Error )
  FT_New_Face( FT_Library   library,
               const char*  filepathname,
               FT_Long      face_index,
               FT_Face     *aface );

Creates a new face object from a given resource and typeface index using a pathname to the font file.

FreeType error code. 0 means success.

Unlike FreeType 1.x, this function automatically creates a glyph slot for the face object which can be accessed directly through `face->glyph'.

FT_New_Face can be used to determine and/or check the font format of a given font resource. If the `face_index' field is negative, the function will not return any face handle in `aface'; the return value is 0 if the font format is recognized, or non-zero otherwise.

Each new face object created with this function also owns a default FT_Size object, accessible as `face->size'.

  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 );

Creates a new face object from a given resource and typeface index using a font file already loaded into memory.

FreeType error code. 0 means success.

The font data bytes are used directly by the FT_Face object. This means that they are not copied, and that the client is responsible for releasing/destroying them after the corresponding call to FT_Done_Face .

Unlike FreeType 1.x, this function automatically creates a glyph slot for the face object which can be accessed directly through `face->glyph'.

FT_New_Memory_Face can be used to determine and/or check the font format of a given font resource. If the `face_index' field is negative, the function will not return any face handle in `aface'; the return value is 0 if the font format is recognized, or non-zero otherwise.

  FT_EXPORT( FT_Error )
  FT_Open_Face( FT_Library           library,
                const FT_Open_Args*  args,
                FT_Long              face_index,
                FT_Face             *aface );

Opens a face object from a given resource and typeface index using an `FT_Open_Args' structure. If the face object doesn't exist, it will be created.

FreeType error code. 0 means success.

Unlike FreeType 1.x, this function automatically creates a glyph slot for the face object which can be accessed directly through `face->glyph'.

FT_Open_Face can be used to determine and/or check the font format of a given font resource. If the `face_index' field is negative, the function will not return any face handle in `*face'; the return value is 0 if the font format is recognized, or non-zero otherwise.

  FT_EXPORT( FT_Error )
  FT_Attach_File( FT_Face      face,
                  const char*  filepathname );

`Attaches' a given font file to an existing face. This is usually to read additional information for a single face object. For example, it is used to read the AFM files that come with Type 1 fonts in order to add kerning data and other metrics.

FreeType error code. 0 means success.

If your font file is in memory, or if you want to provide your own input stream object, use FT_Attach_Stream.

The meaning of the `attach' action (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 attachments.

  FT_EXPORT( FT_Error )
  FT_Attach_Stream( FT_Face        face,
                    FT_Open_Args*  parameters );

This function is similar to FT_Attach_File with the exception that it reads the attachment from an arbitrary stream.

FreeType error code. 0 means success.

The meaning of the `attach' (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 attachments.

  FT_EXPORT( FT_Error )
  FT_Done_Face( FT_Face  face );

Discards a given face object, as well as all of its child slots and sizes.

FreeType error code. 0 means success.

  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 );

Sets the character dimensions of a given face object. The `char_width' and `char_height' values are used for the width and height, respectively, expressed in 26.6 fractional points.

If the horizontal or vertical resolution values are zero, a default value of 72dpi is used. Similarly, if one of the character dimensions is zero, its value is set equal to the other.

FreeType error code. 0 means success.

When dealing with fixed-size faces (i.e., non-scalable formats), FT_Set_Pixel_Sizes provides a more convenient interface.

  FT_EXPORT( FT_Error )
  FT_Set_Pixel_Sizes( FT_Face  face,
                      FT_UInt  pixel_width,
                      FT_UInt  pixel_height );

Sets the character dimensions of a given face object. The width and height are expressed in integer pixels.

If one of the character dimensions is zero, its value is set equal to the other.

FreeType error code. 0 means success.

The values of `pixel_width' and `pixel_height' correspond to the pixel values of the typographic character size, which are NOT necessarily the same as the dimensions of the glyph `bitmap cells'.

The `character size' is really the size of an abstract square called the `EM', used to design the font. However, depending on the font design, glyphs will be smaller or greater than the EM.

This means that setting the pixel size to, say, 8x8 doesn't guarantee in any way that you will get glyph bitmaps that all fit within an 8x8 cell (sometimes even far from it).

For bitmap fonts, `pixel_height' usually is a reliable value for the height of the bitmap cell. Drivers for bitmap font formats which contain a single bitmap strike only (BDF, PCF, FNT) ignore `pixel_width'.

  FT_EXPORT( FT_Error )
  FT_Load_Glyph( FT_Face   face,
                 FT_UInt   glyph_index,
                 FT_Int32  load_flags );

A function used to load a single glyph within a given glyph slot, for a given size.

FreeType error code. 0 means success.

If the glyph image is not a bitmap, and if the bit flag FT_LOAD_IGNORE_TRANSFORM is unset, the glyph image will be transformed with the information passed to a previous call to FT_Set_Transform.

Note that this also transforms the `face.glyph.advance' field, but not the values in `face.glyph.metrics'.

  FT_EXPORT( FT_Error )
  FT_Load_Char( FT_Face   face,
                FT_ULong  char_code,
                FT_Int32  load_flags );

A function used to load a single glyph within a given glyph slot, for a given size, according to its character code.

FreeType error code. 0 means success.

If the face has no current charmap, or if the character code is not defined in the charmap, this function will return an error.

If the glyph image is not a bitmap, and if the bit flag FT_LOAD_IGNORE_TRANSFORM is unset, the glyph image will be transformed with the information passed to a previous call to FT_Set_Transform.

Note that this also transforms the `face.glyph.advance' field, but not the values in `face.glyph.metrics'.

#define FT_LOAD_DEFAULT                      0x0
#define FT_LOAD_NO_SCALE                     0x1
#define FT_LOAD_NO_HINTING                   0x2
#define FT_LOAD_RENDER                       0x4
#define FT_LOAD_NO_BITMAP                    0x8
#define FT_LOAD_VERTICAL_LAYOUT              0x10
#define FT_LOAD_FORCE_AUTOHINT               0x20
#define FT_LOAD_CROP_BITMAP                  0x40
#define FT_LOAD_PEDANTIC                     0x80
#define FT_LOAD_IGNORE_GLOBAL_ADVANCE_WIDTH  0x200
#define FT_LOAD_NO_RECURSE                   0x400
#define FT_LOAD_IGNORE_TRANSFORM             0x800
#define FT_LOAD_MONOCHROME                   0x1000
#define FT_LOAD_LINEAR_DESIGN                0x2000

  /* temporary hack! */
#define FT_LOAD_SBITS_ONLY                   0x4000
#define FT_LOAD_NO_AUTOHINT                  0x8000U

A list of bit-field constants, used with FT_Load_Glyph to indicate what kind of operations to perform during glyph loading.

  FT_EXPORT( void )
  FT_Set_Transform( FT_Face     face,
                    FT_Matrix*  matrix,
                    FT_Vector*  delta );

A function used to set the transformation that is applied to glyph images just before they are converted to bitmaps in a glyph slot when FT_Render_Glyph is called.

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.

  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;

An enumeration type that lists the render modes supported by FreeType 2. Each mode corresponds to a specific type of scanline conversion performed on the outline, as well as specific hinting optimizations.

For bitmap fonts the `bitmap->pixel_mode' field in the FT_GlyphSlotRec structure gives the format of the returned bitmap.

The LCD-optimized glyph bitmaps produced by FT_Render_Glyph are _not filtered_ to reduce color-fringes. It is up to the caller to perform this pass.

#define ft_render_mode_normal  FT_RENDER_MODE_NORMAL
#define ft_render_mode_mono    FT_RENDER_MODE_MONO

These constats are deprecated. Use the corresponding FT_Render_Mode values instead.

  FT_EXPORT( FT_Error )
  FT_Render_Glyph( FT_GlyphSlot    slot,
                   FT_Render_Mode  render_mode );

Converts a given glyph image to a bitmap. It does so by inspecting the glyph image format, find the relevant renderer, and invoke it.

FreeType error code. 0 means success.

  typedef enum  FT_Kerning_Mode_
  {
    FT_KERNING_DEFAULT  = 0,
    FT_KERNING_UNFITTED,
    FT_KERNING_UNSCALED

  } FT_Kerning_Mode;

An enumeration used to specify which kerning values to return in FT_Get_Kerning.

#define ft_kerning_default   FT_KERNING_DEFAULT

This constant is deprecated. Please use FT_KERNING_DEFAULT instead.

#define ft_kerning_unfitted  FT_KERNING_UNFITTED

This constant is deprecated. Please use FT_KERNING_UNFITTED instead.

#define ft_kerning_unscaled  FT_KERNING_UNSCALED

This constant is deprecated. Please use FT_KERNING_UNSCALED instead.

  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 );

Returns the kerning vector between two glyphs of a same face.

FreeType error code. 0 means success.

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.

  FT_EXPORT( FT_Error )
  FT_Get_Glyph_Name( FT_Face     face,
                     FT_UInt     glyph_index,
                     FT_Pointer  buffer,
                     FT_UInt     buffer_max );

Retrieves the ASCII name of a given glyph in a face. This only works for those faces where FT_HAS_GLYPH_NAME(face) returns true.

FreeType error code. 0 means success.

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' will be 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.

This function is not compiled within the library if the config macro FT_CONFIG_OPTION_NO_GLYPH_NAMES is defined in `include/freetype/config/ftoptions.h'

  FT_EXPORT( const char* )
  FT_Get_Postscript_Name( FT_Face  face );

Retrieves the ASCII Postscript name of a given face, if available. This should only work with Postscript and TrueType fonts.

A pointer to the face's Postscript name. NULL if un-available.

The returned pointer is owned by the face and will be destroyed with it.

  FT_EXPORT( FT_Error )
  FT_Select_Charmap( FT_Face      face,
                     FT_Encoding  encoding );

Selects a given charmap by its encoding tag (as listed in `freetype.h').

FreeType error code. 0 means success.

This function will return an error if no charmap in the face corresponds to the encoding queried here.

  FT_EXPORT( FT_Error )
  FT_Set_Charmap( FT_Face     face,
                  FT_CharMap  charmap );

Selects a given charmap for character code to glyph index decoding.

FreeType error code. 0 means success.

This function will return an error if the charmap is not part of the face (i.e., if it is not listed in the face->charmaps[] table).

  FT_EXPORT( FT_Int )
  FT_Get_Charmap_Index( FT_CharMap  charmap );

Retrieve index of a given charmap.

The index into the array of character maps within the face to which `charmap' belongs.

  FT_EXPORT( FT_UInt )
  FT_Get_Char_Index( FT_Face   face,
                     FT_ULong  charcode );

Returns the glyph index of a given character code. This function uses a charmap object to do the translation.

The glyph index. 0 means `undefined character code'.

FreeType computes its own glyph indices which are not necessarily the same as used in the font in case the font is based on glyph indices. Reason for this behaviour is to assure that index 0 is never used, representing the missing glyph.

  FT_EXPORT( FT_ULong )
  FT_Get_First_Char( FT_Face   face,
                     FT_UInt  *agindex );

This function is used to return the first character code in the current charmap of a given face. It will also return the corresponding glyph index.

The charmap's first character code.

You should use this function with FT_Get_Next_Char to be able 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 );        
  }                                                                

Note that `*agindex' will be set to 0 if the charmap is empty. The result itself can be 0 in two cases: if the charmap is empty or when the value 0 is the first valid character code.

  FT_EXPORT( FT_ULong )
  FT_Get_Next_Char( FT_Face    face,
                    FT_ULong   char_code,
                    FT_UInt   *agindex );

This function is used to 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.

The charmap's next character code.

You should use this function with FT_Get_First_Char to walk through all character codes available in a given charmap. See the note for this function for a simple code example.

Note that `*agindex' will be set to 0 when there are no more codes in the charmap.

  FT_EXPORT( FT_UInt )
  FT_Get_Name_Index( FT_Face     face,
                     FT_String*  glyph_name );

Returns the glyph index of a given glyph name. This function uses driver specific objects to do the translation.

The glyph index. 0 means `undefined character code'.