From 462f18c7b25fe3e467f837647d07ab0a78aa8d2b Mon Sep 17 00:00:00 2001 From: marha Date: Sun, 22 Feb 2015 21:39:56 +0100 Subject: Merged origin/release (checked in because wanted to merge new stuff) --- freetype/docs/reference/ft2-auto_hinter.html | 329 +- freetype/docs/reference/ft2-base_interface.html | 4814 +++++++++----------- freetype/docs/reference/ft2-basic_types.html | 1525 +++---- freetype/docs/reference/ft2-bdf_fonts.html | 336 +- freetype/docs/reference/ft2-bitmap_handling.html | 383 +- freetype/docs/reference/ft2-bzip2.html | 151 +- freetype/docs/reference/ft2-cache_subsystem.html | 1500 +++--- freetype/docs/reference/ft2-cff_driver.html | 231 +- freetype/docs/reference/ft2-cid_fonts.html | 278 +- freetype/docs/reference/ft2-computations.html | 1002 ++-- freetype/docs/reference/ft2-font_formats.html | 145 +- freetype/docs/reference/ft2-gasp_table.html | 215 +- freetype/docs/reference/ft2-glyph_management.html | 687 ++- freetype/docs/reference/ft2-glyph_stroker.html | 1161 +++-- freetype/docs/reference/ft2-glyph_variants.html | 347 +- freetype/docs/reference/ft2-gx_validation.html | 534 +-- freetype/docs/reference/ft2-gzip.html | 213 +- .../docs/reference/ft2-header_file_macros.html | 1011 ++-- freetype/docs/reference/ft2-header_inclusion.html | 105 +- freetype/docs/reference/ft2-incremental.html | 450 +- freetype/docs/reference/ft2-index.html | 632 +-- freetype/docs/reference/ft2-lcd_filtering.html | 255 +- freetype/docs/reference/ft2-list_processing.html | 630 ++- freetype/docs/reference/ft2-lzw.html | 151 +- freetype/docs/reference/ft2-mac_specific.html | 436 +- freetype/docs/reference/ft2-module_management.html | 974 ++-- freetype/docs/reference/ft2-multiple_masters.html | 563 ++- freetype/docs/reference/ft2-ot_validation.html | 313 +- .../docs/reference/ft2-outline_processing.html | 1485 +++--- freetype/docs/reference/ft2-pfr_fonts.html | 268 +- freetype/docs/reference/ft2-quick_advance.html | 256 +- freetype/docs/reference/ft2-raster.html | 732 ++- freetype/docs/reference/ft2-sfnt_names.html | 298 +- freetype/docs/reference/ft2-sizes_management.html | 234 +- freetype/docs/reference/ft2-system_interface.html | 474 +- freetype/docs/reference/ft2-toc.html | 279 +- freetype/docs/reference/ft2-truetype_engine.html | 198 +- freetype/docs/reference/ft2-truetype_tables.html | 1477 +++--- freetype/docs/reference/ft2-tt_driver.html | 178 +- freetype/docs/reference/ft2-type1_tables.html | 1087 +++-- freetype/docs/reference/ft2-user_allocation.html | 105 +- freetype/docs/reference/ft2-version.html | 321 +- freetype/docs/reference/ft2-winfnt_fonts.html | 306 +- 43 files changed, 13039 insertions(+), 14030 deletions(-) (limited to 'freetype/docs/reference') diff --git a/freetype/docs/reference/ft2-auto_hinter.html b/freetype/docs/reference/ft2-auto_hinter.html index d434ec47c..71dede419 100644 --- a/freetype/docs/reference/ft2-auto_hinter.html +++ b/freetype/docs/reference/ft2-auto_hinter.html @@ -3,58 +3,121 @@ -FreeType-2.5.3 API Reference +FreeType-2.5.5 API Reference - - -

[Index]

[TOC]

FreeType-2.5.3 API Reference

[Index]

[TOC]

FreeType-2.5.5 API Reference

-The auto-hinter -

The auto-hinter

Synopsis

- - - - - -

	glyph-to-script-map		default-script
	FT_AUTOHINTER_SCRIPT_XXX		increase-x-height
	FT_Prop_GlyphToScriptMap		FT_Prop_IncreaseXHeight
	fallback-script

- -

+ + + + + +

glyph-to-script-map	default-script
FT_AUTOHINTER_SCRIPT_XXX	increase-x-height
FT_Prop_GlyphToScriptMap	FT_Prop_IncreaseXHeight
fallback-script

+ +

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 ‘autofitter’ for historical reasons.

glyph-to-script-map

+ +

glyph-to-script-map

Experimental only

The auto-hinter provides various script modules to hint glyphs. Examples of supported scripts are Latin or CJK. Before a glyph is auto-hinted, the Unicode character map of the font gets examined, and the script is then determined based on Unicode character ranges, see below.

OpenType fonts, however, often provide much more glyphs than character codes (small caps, superscripts, ligatures, swashes, etc.), to be controlled by so-called ‘features’. Handling OpenType features can be quite complicated and thus needs a separate library on top of FreeType.

@@ -78,39 +141,29 @@ The auto-hinter FT_Load_Glyph( face, ..., FT_LOAD_FORCE_AUTOHINT ); -

- - -

[Index]

[TOC]

- -

FT_AUTOHINTER_SCRIPT_XXX

-Defined in FT_AUTOHINTER_H (ftautoh.h). -

-
-#define FT_AUTOHINTER_SCRIPT_NONE   0
-#define FT_AUTOHINTER_SCRIPT_LATIN  1
-#define FT_AUTOHINTER_SCRIPT_CJK    2
-#define FT_AUTOHINTER_SCRIPT_INDIC  3
-
-

+ +

[Index]

[Top]

[TOC]

+ +

FT_AUTOHINTER_SCRIPT_XXX

Defined in FT_AUTOHINTER_H (ftautoh.h).

+#define FT_AUTOHINTER_SCRIPT_NONE   0
+#define FT_AUTOHINTER_SCRIPT_LATIN  1
+#define FT_AUTOHINTER_SCRIPT_CJK    2
+#define FT_AUTOHINTER_SCRIPT_INDIC  3
+

Experimental only

A list of constants used for the glyph-to-script-map property to specify the script submodule the auto-hinter should use for hinting a particular glyph.

values

- - -

FT_AUTOHINTER_SCRIPT_NONE

+ +

values

+ + - - - - - -

FT_AUTOHINTER_SCRIPT_NONE	Don't auto-hint this glyph.
FT_AUTOHINTER_SCRIPT_LATIN
	+
FT_AUTOHINTER_SCRIPT_LATIN	Apply the latin auto-hinter. For the auto-hinter, ‘latin’ is a very broad term, including Cyrillic and Greek also since characters from those scripts share the same design constraints. By default, characters from the following Unicode ranges are assigned to this submodule. @@ -145,8 +198,7 @@ Defined in FT_AUTOHINTER_H (ftautoh.h).
FT_AUTOHINTER_SCRIPT_CJK
	+
FT_AUTOHINTER_SCRIPT_CJK	Apply the CJK auto-hinter, covering Chinese, Japanese, Korean, old Vietnamese, and some other scripts. By default, characters from the following Unicode ranges are assigned to this submodule. @@ -185,8 +237,7 @@ Defined in FT_AUTOHINTER_H (ftautoh.h).
FT_AUTOHINTER_SCRIPT_INDIC
	+
FT_AUTOHINTER_SCRIPT_INDIC	Apply the indic auto-hinter, covering all major scripts from the Indian sub-continent and some other related scripts like Thai, Lao, or Tibetan. By default, characters from the following Unicode ranges are assigned to this submodule. @@ -201,41 +252,31 @@ Defined in FT_AUTOHINTER_H (ftautoh.h). Note that currently Indic support is rudimentary only, missing blue zone support.

- - -

[Index]

[TOC]

- -

FT_Prop_GlyphToScriptMap

-Defined in FT_AUTOHINTER_H (ftautoh.h). -

-
-   typedef struct  FT_Prop_GlyphToScriptMap_
-   {
-     FT_Face   face;
-     FT_Byte*  map;
-
-   } FT_Prop_GlyphToScriptMap;
-
-

+ +

[Index]

[Top]

[TOC]

+ +

FT_Prop_GlyphToScriptMap

Defined in FT_AUTOHINTER_H (ftautoh.h).

+  typedef struct  FT_Prop_GlyphToScriptMap_
+  {
+    FT_Face   face;
+    FT_Byte*  map;
+
+  } FT_Prop_GlyphToScriptMap;
+

Experimental only

The data exchange structure for the glyph-to-script-map property.

- - -

[Index]

[TOC]

- -

fallback-script

+ +

[Index]

[Top]

[TOC]

+ +

fallback-script

Experimental only

If no auto-hinter script module can be assigned to a glyph, a fallback script gets assigned to it (see also the glyph-to-script-map property). By default, this is FT_AUTOHINTER_SCRIPT_CJK. Using the ‘fallback-script’ property, this fallback value can be changed.

@@ -248,20 +289,17 @@ Defined in FT_AUTOHINTER_H (ftautoh.h).
   FT_Property_Set( library, "autofitter",
                             "fallback-script", &fallback_script );

note

+ +

note

This property can be used with FT_Property_Get also.

It's important to use the right timing for changing this value: The creation of the glyph-to-script map that eventually uses the fallback script value gets triggered either by setting or reading a face-specific property like glyph-to-script-map, or by auto-hinting any glyph from that face. In particular, if you have already created an FT_Face structure but not loaded any glyph (using the auto-hinter), a change of the fallback script will affect this face.

- - -

[Index]

[TOC]

- -

default-script

+ +

[Index]

[Top]

[TOC]

+ +

default-script

Experimental only

If Freetype gets compiled with FT_CONFIG_OPTION_USE_HARFBUZZ to make the HarfBuzz library access OpenType features for getting better glyph coverages, this property sets the (auto-fitter) script to be used for the default (OpenType) script data of a font's GSUB table. Features for the default script are intended for all scripts not explicitly handled in GSUB; an example is a ‘dlig’ feature, containing the combination of the characters ‘T’, ‘E’, and ‘L’ to form a ‘TEL’ ligature.

By default, this is FT_AUTOHINTER_SCRIPT_LATIN. Using the ‘default-script’ property, this default value can be changed.

@@ -275,20 +313,17 @@ Defined in FT_AUTOHINTER_H (ftautoh.h). FT_Property_Set( library, "autofitter", "default-script", &default_script ); -

note

+ +

note

This property can be used with FT_Property_Get also.

It's important to use the right timing for changing this value: The creation of the glyph-to-script map that eventually uses the default script value gets triggered either by setting or reading a face-specific property like glyph-to-script-map, or by auto-hinting any glyph from that face. In particular, if you have already created an FT_Face structure but not loaded any glyph (using the auto-hinter), a change of the default script will affect this face.

- - -

[Index]

[TOC]

- -

increase-x-height

+ +

[Index]

[Top]

[TOC]

+ +

increase-x-height

For ppem values in the range 6 <= ppem <= ‘increase-x-height’, round up the font's x height much more often than normally. If the value is set to 0, which is the default, this feature is switched off. Use this property to improve the legibility of small font sizes if necessary.

   FT_Library               library;
@@ -306,40 +341,30 @@ Defined in FT_AUTOHINTER_H (ftautoh.h).
   FT_Property_Set( library, "autofitter",
                             "increase-x-height", &prop );

note

+ +

note

This property can be used with FT_Property_Get also.

Set this value right after calling FT_Set_Char_Size, but before loading any glyph (using the auto-hinter).

- - -

[Index]

[TOC]

- -

FT_Prop_IncreaseXHeight

-Defined in FT_AUTOHINTER_H (ftautoh.h). -

-
-   typedef struct  FT_Prop_IncreaseXHeight_
-   {
-     FT_Face  face;
-     FT_UInt  limit;
-
-   } FT_Prop_IncreaseXHeight;
-
-

+ +

[Index]

[Top]

[TOC]

+ +

FT_Prop_IncreaseXHeight

Defined in FT_AUTOHINTER_H (ftautoh.h).

+  typedef struct  FT_Prop_IncreaseXHeight_
+  {
+    FT_Face  face;
+    FT_UInt  limit;
+
+  } FT_Prop_IncreaseXHeight;
+

The data exchange structure for the increase-x-height property.

- - -

[Index]

[TOC]

+ +

[Index]

[Top]

[TOC]

diff --git a/freetype/docs/reference/ft2-base_interface.html b/freetype/docs/reference/ft2-base_interface.html index 229254510..4547b6f1c 100644 --- a/freetype/docs/reference/ft2-base_interface.html +++ b/freetype/docs/reference/ft2-base_interface.html @@ -3,323 +3,378 @@ -FreeType-2.5.3 API Reference +FreeType-2.5.5 API Reference - - -

[Index]

[TOC]

FreeType-2.5.3 API Reference

[Index]

[TOC]

FreeType-2.5.5 API Reference

-Base Interface -

Base Interface

Synopsis

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

FT_Library	FT_IS_TRICKY	FT_Load_Glyph
FT_Face	FT_HAS_COLOR	FT_Load_Char
FT_Size	FT_STYLE_FLAG_XXX	FT_LOAD_XXX
FT_GlyphSlot	FT_Size_Internal	FT_LOAD_TARGET_XXX
FT_CharMap	FT_Size_Metrics	FT_LOAD_TARGET_MODE
FT_Encoding	FT_SizeRec	FT_Set_Transform
FT_Glyph_Metrics	FT_SubGlyph	FT_Render_Mode
FT_Bitmap_Size	FT_Slot_Internal	ft_render_mode_xxx
FT_Module	FT_GlyphSlotRec	FT_Render_Glyph
FT_Driver	FT_Init_FreeType	FT_Kerning_Mode
FT_Renderer	FT_Done_FreeType	ft_kerning_default
FT_ENC_TAG	FT_OPEN_XXX	ft_kerning_unfitted
ft_encoding_xxx	FT_Parameter	ft_kerning_unscaled
FT_CharMapRec	FT_Open_Args	FT_Get_Kerning
FT_Face_Internal	FT_New_Face	FT_Get_Track_Kerning
FT_FaceRec	FT_New_Memory_Face	FT_Get_Glyph_Name
FT_FACE_FLAG_XXX	FT_Open_Face	FT_Get_Postscript_Name
FT_HAS_HORIZONTAL	FT_Attach_File	FT_Select_Charmap
FT_HAS_VERTICAL	FT_Attach_Stream	FT_Set_Charmap
FT_HAS_KERNING	FT_Reference_Face	FT_Get_Charmap_Index
FT_IS_SCALABLE	FT_Done_Face	FT_Get_Char_Index
FT_IS_SFNT	FT_Select_Size	FT_Get_First_Char
FT_IS_FIXED_WIDTH	FT_Size_Request_Type	FT_Get_Next_Char
FT_HAS_FIXED_SIZES	FT_Size_RequestRec	FT_Get_Name_Index
FT_HAS_FAST_GLYPHS	FT_Size_Request	FT_SUBGLYPH_FLAG_XXX
FT_HAS_GLYPH_NAMES	FT_Request_Size	FT_Get_SubGlyph_Info
FT_HAS_MULTIPLE_MASTERS	FT_Set_Char_Size	FT_FSTYPE_XXX
FT_IS_CID_KEYED	FT_Set_Pixel_Sizes	FT_Get_FSType_Flags

- -

This section describes the public high-level API of FreeType 2.

FT_Library

-Defined in FT_FREETYPE_H (freetype.h). -

- + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

FT_Library	FT_Glyph_Metrics	FT_LOAD_COLOR
FT_Face	FT_SubGlyph
FT_Size		FT_LOAD_VERTICAL_LAYOUT
FT_GlyphSlot	FT_Bitmap_Size	FT_LOAD_IGNORE_TRANSFORM
FT_CharMap		FT_LOAD_FORCE_AUTOHINT
FT_Encoding	FT_Init_FreeType	FT_LOAD_NO_RECURSE
FT_ENC_TAG	FT_Done_FreeType	FT_LOAD_PEDANTIC

FT_FaceRec	FT_New_Face	FT_LOAD_TARGET_NORMAL
	FT_Done_Face	FT_LOAD_TARGET_LIGHT
FT_FACE_FLAG_SCALABLE	FT_Reference_Face	FT_LOAD_TARGET_MONO
FT_FACE_FLAG_FIXED_SIZES	FT_New_Memory_Face	FT_LOAD_TARGET_LCD
FT_FACE_FLAG_FIXED_WIDTH	FT_Open_Face	FT_LOAD_TARGET_LCD_V
FT_FACE_FLAG_HORIZONTAL	FT_Open_Args
FT_FACE_FLAG_VERTICAL	FT_Parameter	FT_LOAD_TARGET_MODE
FT_FACE_FLAG_COLOR	FT_Attach_File
FT_FACE_FLAG_SFNT	FT_Attach_Stream	FT_Render_Glyph
FT_FACE_FLAG_CID_KEYED		FT_Render_Mode
FT_FACE_FLAG_TRICKY	FT_Set_Char_Size	FT_Get_Kerning
FT_FACE_FLAG_KERNING	FT_Set_Pixel_Sizes	FT_Kerning_Mode
FT_FACE_FLAG_MULTIPLE_MASTERS	FT_Request_Size	FT_Get_Track_Kerning
FT_FACE_FLAG_GLYPH_NAMES	FT_Select_Size	FT_Get_Glyph_Name
FT_FACE_FLAG_EXTERNAL_STREAM	FT_Size_Request_Type	FT_Get_Postscript_Name
FT_FACE_FLAG_HINTER	FT_Size_RequestRec
FT_FACE_FLAG_TRICKY	FT_Size_Request	FT_CharMapRec
	FT_Set_Transform	FT_Select_Charmap
FT_HAS_HORIZONTAL	FT_Load_Glyph	FT_Set_Charmap
FT_HAS_VERTICAL	FT_Get_Char_Index	FT_Get_Charmap_Index
FT_HAS_KERNING	FT_Get_First_Char
FT_HAS_FIXED_SIZES	FT_Get_Next_Char	FT_Get_FSType_Flags
FT_HAS_GLYPH_NAMES	FT_Get_Name_Index	FT_Get_SubGlyph_Info
FT_HAS_MULTIPLE_MASTERS	FT_Load_Char
FT_HAS_COLOR		FT_Face_Internal
	FT_OPEN_MEMORY	FT_Size_Internal
FT_IS_SFNT	FT_OPEN_STREAM	FT_Slot_Internal
FT_IS_SCALABLE	FT_OPEN_PATHNAME
FT_IS_FIXED_WIDTH	FT_OPEN_DRIVER	FT_FACE_FLAG_XXX
FT_IS_CID_KEYED	FT_OPEN_PARAMS	FT_STYLE_FLAG_XXX
FT_IS_TRICKY		FT_OPEN_XXX
	FT_LOAD_DEFAULT	FT_LOAD_XXX
FT_STYLE_FLAG_BOLD	FT_LOAD_RENDER	FT_LOAD_TARGET_XXX
FT_STYLE_FLAG_ITALIC	FT_LOAD_MONOCHROME	FT_SUBGLYPH_FLAG_XXX
	FT_LOAD_LINEAR_DESIGN	FT_FSTYPE_XXX
FT_SizeRec	FT_LOAD_NO_SCALE
FT_Size_Metrics	FT_LOAD_NO_HINTING	FT_HAS_FAST_GLYPHS
	FT_LOAD_NO_BITMAP
FT_GlyphSlotRec	FT_LOAD_NO_AUTOHINT

+ + +

This section describes the most important public high-level API functions of FreeType 2.

+ +

FT_Library

Defined in FT_FREETYPE_H (freetype.h).

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

In multi-threaded applications, make sure that the same FT_Library object or any of its children doesn't get accessed in parallel.

note

+ +

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.

- - -

[Index]

[TOC]

- -

FT_Face

-Defined in FT_FREETYPE_H (freetype.h). -

 
+
+[Index] [Top] [TOC]
+
+
+FT_Face
+Defined in FT_FREETYPE_H (freetype.h).
+   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.

note

+ +

note

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

also

+ +

also

See FT_FaceRec for the publicly accessible fields of a given face object.

- - -

[Index]

[TOC]

- -

FT_Size

-Defined in FT_FREETYPE_H (freetype.h). -

 
+
+[Index] [Top] [TOC]
+
+
+FT_Size
+Defined in FT_FREETYPE_H (freetype.h).
+   typedef struct FT_SizeRec_*  FT_Size;
+
 
-

A handle to an object used to model a face scaled to a given character size.

note

+ +

note

Each FT_Face has an 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

+ +

also

See FT_SizeRec for the publicly accessible fields of a given size object.

- - -

[Index]

[TOC]

- -

FT_GlyphSlot

-Defined in FT_FREETYPE_H (freetype.h). -

 
+
+[Index] [Top] [TOC]
+
+
+FT_GlyphSlot
+Defined in FT_FREETYPE_H (freetype.h).
+   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 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

+ +

also

See FT_GlyphSlotRec for the publicly accessible glyph fields.

- - -

[Index]

[TOC]

- -

FT_CharMap

-Defined in FT_FREETYPE_H (freetype.h). -

 
+
+[Index] [Top] [TOC]
+
+
+FT_CharMap
+Defined in FT_FREETYPE_H (freetype.h).
+   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.

note

+ +

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.

also

+ +

also

See FT_CharMapRec for the publicly accessible fields of a given character map.

- - -

[Index]

[TOC]

- -

FT_Encoding

-Defined in FT_FREETYPE_H (freetype.h). -

 
+
+[Index] [Top] [TOC]
+
+
+FT_Encoding
+Defined in FT_FREETYPE_H (freetype.h).
+   typedef enum  FT_Encoding_
   {
-    FT_ENC_TAG( FT_ENCODING_NONE, 0, 0, 0, 0 ),
+    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_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' ),
+    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_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_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_OLD_LATIN_2, 'l', 'a', 't', '2' ),
 
-    FT_ENC_TAG( FT_ENCODING_APPLE_ROMAN, 'a', 'r', 'm', 'n' )
+    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_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 + +

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

note

+ +

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

+ +

values

+ + - - - - - - - - - - - - - - - - - - - - - - - -

FT_ENCODING_NONE	The encoding value 0 is reserved.
FT_ENCODING_UNICODE	+
FT_ENCODING_UNICODE	Corresponds to 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	+
FT_ENCODING_MS_SYMBOL	Corresponds to the Microsoft Symbol encoding, used to encode mathematical symbols in the 32..255 character code range. For more information, see ‘http://www.kostis.net/charsets/symbol.htm’.
FT_ENCODING_SJIS	+
FT_ENCODING_SJIS	Corresponds to Japanese SJIS encoding. More info at at ‘http://en.wikipedia.org/wiki/Shift_JIS’. See note on multi-byte encodings below.
FT_ENCODING_GB2312	+
FT_ENCODING_GB2312	Corresponds to an encoding system for Simplified Chinese as used used in mainland China.
FT_ENCODING_BIG5	+
FT_ENCODING_BIG5	Corresponds to an encoding system for Traditional Chinese as used in Taiwan and Hong Kong.
FT_ENCODING_WANSUNG	+
FT_ENCODING_WANSUNG	Corresponds to the Korean encoding system known as Wansung. For more information see ‘http://msdn.microsoft.com/en-US/goglobal/cc305154’.
FT_ENCODING_JOHAB	+
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 Hangeul character combinations.
FT_ENCODING_ADOBE_LATIN_1
	+
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
	+
FT_ENCODING_ADOBE_STANDARD	Corresponds to the Adobe Standard encoding, as found in Type 1, CFF, and OpenType/CFF fonts. It is limited to 256 character codes.
FT_ENCODING_ADOBE_EXPERT
	+
FT_ENCODING_ADOBE_EXPERT	Corresponds to the Adobe Expert encoding, as found in Type 1, CFF, and OpenType/CFF fonts. It is limited to 256 character codes.
FT_ENCODING_ADOBE_CUSTOM
	+
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
	+
FT_ENCODING_APPLE_ROMAN	Corresponds to the 8-bit Apple roman encoding. Many TrueType and OpenType fonts contain a charmap for this encoding, since older versions of Mac OS are able to use it.
FT_ENCODING_OLD_LATIN_2
	+
FT_ENCODING_OLD_LATIN_2	This value is deprecated and was never used nor reported by FreeType. Don't use or test for it.
FT_ENCODING_MS_SJIS	+
FT_ENCODING_MS_SJIS	Same as FT_ENCODING_SJIS. Deprecated.
FT_ENCODING_MS_GB2312	+
FT_ENCODING_MS_GB2312	Same as FT_ENCODING_GB2312. Deprecated.
FT_ENCODING_MS_BIG5	+
FT_ENCODING_MS_BIG5	Same as FT_ENCODING_BIG5. Deprecated.
FT_ENCODING_MS_WANSUNG	+
FT_ENCODING_MS_WANSUNG	Same as FT_ENCODING_WANSUNG. Deprecated.
FT_ENCODING_MS_JOHAB	+
FT_ENCODING_MS_JOHAB	Same as FT_ENCODING_JOHAB. Deprecated.

note

+ +

note

By default, FreeType automatically synthesizes a Unicode charmap for PostScript fonts, using their glyph names dictionaries. However, it also reports 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).

@@ -327,195 +382,14 @@ Defined in FT_FREETYPE_H (freetype.h).

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

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

- - -

[Index]

[TOC]

- -

FT_Glyph_Metrics

-Defined in FT_FREETYPE_H (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 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 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.

- - -

[Index]

[TOC]

- -

FT_Bitmap_Size

-Defined in FT_FREETYPE_H (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. Thus when the driver finds it incorrect, it sets ‘size’ to some calculated values and sets ‘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.

- - -

[Index]

[TOC]

- -

FT_Module

-Defined in FT_FREETYPE_H (freetype.h). -

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

- - -

[Index]

[TOC]

- -

FT_Driver

-Defined in FT_FREETYPE_H (freetype.h). -

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

- - -

[Index]

[TOC]

- -

FT_Renderer

-Defined in FT_FREETYPE_H (freetype.h). -

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

- - -

[Index]

[TOC]

- -

FT_ENC_TAG

-Defined in FT_FREETYPE_H (freetype.h). -

+
+[Index] [Top] [TOC]
 
+
+FT_ENC_TAG
+Defined in FT_FREETYPE_H (freetype.h).
+ #ifndef FT_ENC_TAG
 #define FT_ENC_TAG( value, a, b, c, d )         \
           value = ( ( (FT_UInt32)(a) << 24 ) |  \
@@ -524,127 +398,24 @@ Defined in FT_FREETYPE_H (freetype.h).
                       (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).

note

+ +

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.

- - -

[Index]

[TOC]

- -

ft_encoding_xxx

-Defined in FT_FREETYPE_H (freetype.h). -

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

- - -

[Index]

[TOC]

- -

FT_CharMapRec

-Defined in FT_FREETYPE_H (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 should be emulated for other formats. -
encoding_id	- A platform specific encoding number. This also comes from the TrueType specification and should be emulated similarly. -

- - -

[Index]

[TOC]

- -

FT_Face_Internal

-Defined in FT_FREETYPE_H (freetype.h). -

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

- - -

[Index]

[TOC]

- -

FT_FaceRec

-Defined in FT_FREETYPE_H (freetype.h). -

+
+[Index] [Top] [TOC]
 
+
+FT_FaceRec
+Defined in FT_FREETYPE_H (freetype.h).
+   typedef struct  FT_FaceRec_
   {
     FT_Long           num_faces;
@@ -688,7 +459,7 @@ Defined in FT_FREETYPE_H (freetype.h).
 
     /*@private begin */
 
-    FT_Driver         driver;
+    FT_Driver         driver;
     FT_Memory         memory;
     FT_Stream         stream;
 
@@ -702,517 +473,292 @@ Defined in FT_FREETYPE_H (freetype.h).
     /*@private end */
 
   } FT_FaceRec;
+
 
-

FreeType root face class structure. A face object models a typeface in a font file.

fields

- -

num_faces

+ +

fields

+ + - - - - - - - - - - - - - - - - - - - - - - -

num_faces	The number of faces in the font file. Some font formats can have multiple faces in a font file.
face_index	+
face_index	The index of the face in the font file. It is set to 0 if there is only one face in the font file.
face_flags	+
face_flags	A set of bit flags that give important information about the face; see FT_FACE_FLAG_XXX for the details.
style_flags	+
style_flags	A set of bit flags indicating the style of the face; see FT_STYLE_FLAG_XXX for the details.
num_glyphs	+
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, this value gives the highest CID used in the font.
family_name	+
family_name	The face's family name. This is an ASCII string, usually in English, that describes the typeface's family (like ‘Times New Roman’, ‘Bodoni’, ‘Garamond’, 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).
style_name	+
style_name	The face's style name. This is an ASCII string, usually in English, that describes the typeface's style (like ‘Italic’, ‘Bold’, ‘Condensed’, 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	+
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 ‘sbits’ in that case.
available_sizes	+
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.
num_charmaps	+
num_charmaps	The number of charmaps in the face.
charmaps	+
charmaps	An array of the charmaps of the face.
generic	+
generic	A field reserved for client uses. See the FT_Generic type description.
bbox	+
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 ‘maximum ascender’, and ‘bbox.yMin’ as the ‘minimum descender’. 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.
units_per_EM	+
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	+
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	+
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 usually negative. Only relevant for scalable formats.
height	+
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	+
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	+
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	+
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	+
underline_thickness	The thickness, in font units, of the underline for this face. Only relevant for scalable formats.
glyph	+
glyph	The face's associated glyph slot(s).
size	+
size	The current active size for this face.
charmap	+
charmap	The current active charmap for this face.

note

+ +

note

Fields may be changed after a call to FT_Attach_File or FT_Attach_Stream.

- - -

[Index]

[TOC]

- -

FT_FACE_FLAG_XXX

-Defined in FT_FREETYPE_H (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 )
-
-

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	- Indicates that the face contains outline glyphs. This doesn't prevent bitmap strikes, i.e., a face can have both this and and FT_FACE_FLAG_FIXED_SIZES set. -
FT_FACE_FLAG_FIXED_SIZES
	- Indicates that the face contains bitmap strikes. See also the ‘num_fixed_sizes’ and ‘available_sizes’ fields of FT_FaceRec. -
FT_FACE_FLAG_FIXED_WIDTH
	- Indicates that the face contains fixed-width characters (like Courier, Lucido, MonoType, etc.). -
FT_FACE_FLAG_SFNT	- Indicates that the face uses the ‘sfnt’ storage scheme. For now, this means TrueType and OpenType. -
FT_FACE_FLAG_HORIZONTAL
	- Indicates that the face contains horizontal glyph metrics. This should be set for all common formats. -
FT_FACE_FLAG_VERTICAL	- Indicates that the face contains vertical glyph metrics. This is only available in some formats, not all of them. -
FT_FACE_FLAG_KERNING	- Indicates that the face contains kerning information. If set, the kerning distance can be retrieved through the function FT_Get_Kerning. Otherwise the function always return the vector (0,0). Note that FreeType doesn't handle kerning data from the ‘GPOS’ table (as present in some OpenType fonts). -
FT_FACE_FLAG_FAST_GLYPHS
	- THIS FLAG IS DEPRECATED. DO NOT USE OR TEST IT. -
FT_FACE_FLAG_MULTIPLE_MASTERS
	- Indicates that the font contains multiple masters and is capable of interpolating between them. See the multiple-masters specific API for details. -
FT_FACE_FLAG_GLYPH_NAMES
	- Indicates that the font contains glyph names that can be retrieved through 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	- Set if the font driver has a hinting machine of its own. For example, with TrueType fonts, it makes sense to use data from the SFNT ‘gasp’ table only if the native TrueType hinting engine (with the bytecode interpreter) is available and active. -
FT_FACE_FLAG_CID_KEYED	- Set if the font is CID-keyed. In that case, the font 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 don't have this flag set since the glyphs are accessed in the normal way (using contiguous indices); the ‘CID-ness’ isn't visible to the application. -
FT_FACE_FLAG_TRICKY	- Set if the font is ‘tricky’, this is, it always needs the font format's native hinting engine to get a reasonable result. A typical example is the Chinese font ‘mingli.ttf’ that uses TrueType bytecode instructions to move and scale all of its subglyphs. - It is not possible to autohint 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	- Set if the font has color glyph tables. To access color glyphs use FT_LOAD_COLOR. -

- - -

[Index]

[TOC]

FT_HAS_HORIZONTAL

-Defined in FT_FREETYPE_H (freetype.h). -

+
+[Index] [Top] [TOC]
 
+
+FT_HAS_HORIZONTAL
+Defined in FT_FREETYPE_H (freetype.h).
+ #define FT_HAS_HORIZONTAL( face ) \
-          ( face->face_flags & FT_FACE_FLAG_HORIZONTAL )
+          ( 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

+ +

also

FT_HAS_VERTICAL can be used to check for vertical metrics.

- - -

[Index]

[TOC]

- -

FT_HAS_VERTICAL

-Defined in FT_FREETYPE_H (freetype.h). -

 
+
+[Index] [Top] [TOC]
+
+
+FT_HAS_VERTICAL
+Defined in FT_FREETYPE_H (freetype.h).
+ #define FT_HAS_VERTICAL( face ) \
-          ( face->face_flags & FT_FACE_FLAG_VERTICAL )
+          ( 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).

- - -

[Index]

[TOC]

- -

FT_HAS_KERNING

-Defined in FT_FREETYPE_H (freetype.h). -

 
+
+[Index] [Top] [TOC]
+
+
+FT_HAS_KERNING
+Defined in FT_FREETYPE_H (freetype.h).
+ #define FT_HAS_KERNING( face ) \
-          ( face->face_flags & FT_FACE_FLAG_KERNING )
+          ( 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.

- - -

[Index]

[TOC]

- -

FT_IS_SCALABLE

-Defined in FT_FREETYPE_H (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.

- - -

[Index]

[TOC]

- -

FT_IS_SFNT

-Defined in FT_FREETYPE_H (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.

- - -

[Index]

[TOC]

- -

FT_IS_FIXED_WIDTH

-Defined in FT_FREETYPE_H (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 ‘monospace’, ‘fixed-pitch’, etc.) glyphs.

- - -

[Index]

[TOC]

- -

FT_HAS_FIXED_SIZES

-Defined in FT_FREETYPE_H (freetype.h). -

+
+[Index] [Top] [TOC]
 
+
+FT_HAS_FIXED_SIZES
+Defined in FT_FREETYPE_H (freetype.h).
+ #define FT_HAS_FIXED_SIZES( face ) \
-          ( face->face_flags & FT_FACE_FLAG_FIXED_SIZES )
+          ( 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.

- - -

[Index]

[TOC]

- -

FT_HAS_FAST_GLYPHS

-Defined in FT_FREETYPE_H (freetype.h). -

-
-#define FT_HAS_FAST_GLYPHS( face )  0
 
-

Deprecated.

- - -

[Index]

[TOC]

- -

FT_HAS_GLYPH_NAMES

-Defined in FT_FREETYPE_H (freetype.h). -

+
+[Index] [Top] [TOC]
 
+
+FT_HAS_GLYPH_NAMES
+Defined in FT_FREETYPE_H (freetype.h).
+ #define FT_HAS_GLYPH_NAMES( face ) \
-          ( face->face_flags & FT_FACE_FLAG_GLYPH_NAMES )
+          ( 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.

- - -

[Index]

[TOC]

- -

FT_HAS_MULTIPLE_MASTERS

-Defined in FT_FREETYPE_H (freetype.h). -

 
+
+[Index] [Top] [TOC]
+
+
+FT_HAS_MULTIPLE_MASTERS
+Defined in FT_FREETYPE_H (freetype.h).
+ #define FT_HAS_MULTIPLE_MASTERS( face ) \
-          ( face->face_flags & FT_FACE_FLAG_MULTIPLE_MASTERS )
+          ( 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.

- - -

[Index]

[TOC]

- -

FT_IS_CID_KEYED

-Defined in FT_FREETYPE_H (freetype.h). -

 
+
+[Index] [Top] [TOC]
+
+
+FT_HAS_COLOR
+Defined in FT_FREETYPE_H (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.
+
+
+[Index] [Top] [TOC]
+
+
+FT_IS_SFNT
+Defined in FT_FREETYPE_H (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.
+
+
+[Index] [Top] [TOC]
+
+
+FT_IS_SCALABLE
+Defined in FT_FREETYPE_H (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.
+
+
+[Index] [Top] [TOC]
+
+
+FT_IS_FIXED_WIDTH
+Defined in FT_FREETYPE_H (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 ‘monospace’, ‘fixed-pitch’, etc.) glyphs.
+
+
+[Index] [Top] [TOC]
+
+
+FT_IS_CID_KEYED
+Defined in FT_FREETYPE_H (freetype.h).
+ #define FT_IS_CID_KEYED( face ) \
-          ( face->face_flags & FT_FACE_FLAG_CID_KEYED )
+          ( 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.

- - -

[Index]

[TOC]

- -

FT_IS_TRICKY

-Defined in FT_FREETYPE_H (freetype.h). -

 
+
+[Index] [Top] [TOC]
+
+
+FT_IS_TRICKY
+Defined in FT_FREETYPE_H (freetype.h).
+ #define FT_IS_TRICKY( face ) \
-          ( face->face_flags & FT_FACE_FLAG_TRICKY )
+          ( face->face_flags & FT_FACE_FLAG_TRICKY )
+
 
-

A macro that returns true whenever a face represents a ‘tricky’ font. See the discussion of FT_FACE_FLAG_TRICKY for more details.

- - -

[Index]

[TOC]

- -

FT_HAS_COLOR

-Defined in FT_FREETYPE_H (freetype.h). -

 
-#define FT_HAS_COLOR( face ) \
-          ( face->face_flags & FT_FACE_FLAG_COLOR )
+
+[Index] [Top] [TOC]
 
-

A macro that returns true whenever a face object contains tables for color glyphs.

- - -

[Index]

[TOC]

- -

FT_STYLE_FLAG_XXX

-Defined in FT_FREETYPE_H (freetype.h). -

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

values

- -

FT_STYLE_FLAG_ITALIC

Indicates that a given face style is italic or oblique.

FT_SizeRec

Defined in FT_FREETYPE_H (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.
FT_STYLE_FLAG_BOLD	- Indicates that a given face is bold. +
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.

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 ‘OS/2’ table in SFNT based fonts).

- - -

[Index]

[TOC]

- -

FT_Size_Internal

-Defined in FT_FREETYPE_H (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.

- - -

[Index]

[TOC]

- -

FT_Size_Metrics

-Defined in FT_FREETYPE_H (freetype.h). -

+
+[Index] [Top] [TOC]
 
+
+FT_Size_Metrics
+Defined in FT_FREETYPE_H (freetype.h).
+   typedef struct  FT_Size_Metrics_
   {
     FT_UShort  x_ppem;      /* horizontal pixels per EM               */
@@ -1227,141 +773,51 @@ Defined in FT_FREETYPE_H (freetype.h).
     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

+ +

fields

+ + - - - - - - -

x_ppem	The width of the scaled EM square in pixels, hence the term ‘ppem’ (pixels per EM). It is also referred to as ‘nominal width’.
y_ppem	+
y_ppem	The height of the scaled EM square in pixels, hence the term ‘ppem’ (pixels per EM). It is also referred to as ‘nominal height’.
x_scale	+
x_scale	A 16.16 fractional scaling value used to convert horizontal metrics from font units to 26.6 fractional pixels. Only relevant for scalable font formats.
y_scale	+
y_scale	A 16.16 fractional scaling value used to convert vertical metrics from font units to 26.6 fractional pixels. Only relevant for scalable font formats.
ascender	+
ascender	The ascender in 26.6 fractional pixels. See FT_FaceRec for the details.
descender	+
descender	The descender in 26.6 fractional pixels. See FT_FaceRec for the details.
height	+
height	The height in 26.6 fractional pixels. See FT_FaceRec for the details.
max_advance	+
max_advance	The maximum advance width in 26.6 fractional pixels. See FT_FaceRec for the details.

note

+ +

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.

Note that due to glyph hinting, these values might not be exact for certain fonts. Thus 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.

- - -

[Index]

[TOC]

- -

FT_SizeRec

-Defined in FT_FREETYPE_H (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. -

- - -

[Index]

[TOC]

- -

FT_SubGlyph

-Defined in FT_FREETYPE_H (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.

- - -

[Index]

[TOC]

- -

FT_Slot_Internal

-Defined in FT_FREETYPE_H (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.

- - -

[Index]

[TOC]

- -

FT_GlyphSlotRec

-Defined in FT_FREETYPE_H (freetype.h). -

+
+[Index] [Top] [TOC]
 
+
+FT_GlyphSlotRec
+Defined in FT_FREETYPE_H (freetype.h).
+   typedef struct  FT_GlyphSlotRec_
   {
     FT_Library        library;
@@ -1397,84 +853,82 @@ Defined in FT_FREETYPE_H (freetype.h).
     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

+ +

fields

+ + - - - - - - - - - - - - - - - - - - -

library	A handle to the FreeType library instance this slot belongs to.
face	+
face	A handle to the parent face object.
next	+
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.
generic	+
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	+
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	+
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	+
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	+
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	+
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 others are possible.
bitmap	+
bitmap	This field is used as a bitmap descriptor when the slot format is FT_GLYPH_FORMAT_BITMAP. 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	- This is the bitmap's left bearing expressed in integer pixels. Of course, this is only valid if the format is FT_GLYPH_FORMAT_BITMAP. +
bitmap_left	+ The bitmap's left bearing expressed in integer pixels. Only valid if the format is FT_GLYPH_FORMAT_BITMAP, this is, if the glyph slot contains a bitmap.
bitmap_top	- This is the bitmap's top bearing expressed in integer pixels. Remember that this is the distance from the baseline to the top-most glyph scanline, upwards y coordinates being positive. +
bitmap_top	+ The bitmap's top bearing expressed in integer pixels. Remember that this is the distance from the baseline to the top-most glyph scanline, upwards y coordinates being positive.
outline	+
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, embolded, etc. However, it must not be freed.
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. For now this is internal to FreeType. +
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	+
subglyphs	An array of subglyph descriptors for composite glyphs. There are ‘num_subglyphs’ elements in there. Currently internal to FreeType.
control_data	+
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.
control_len	+
control_len	This is the length in bytes of the control data.
other	+
other	Really wicked formats can use this pointer to present their own glyph image to client applications. Note that the application needs to know about the image format.
lsb_delta	+
lsb_delta	The difference between hinted and unhinted left side bearing while autohinting is active. Zero otherwise.
rsb_delta	+
rsb_delta	The difference between hinted and unhinted right side bearing while autohinting is active. Zero otherwise.

note

+ +

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

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

note

+ +

note

Here a small pseudo code fragment that shows how to use ‘lsb_delta’ and ‘rsb_delta’:

   FT_Pos  origin_x       = 0;                                      
@@ -1499,687 +953,738 @@ Defined in FT_FREETYPE_H (freetype.h).
     origin_x += face->glyph->advance.x;                            
   endfor

- - -

[Index]

[TOC]

FT_Init_FreeType

-Defined in FT_FREETYPE_H (freetype.h). -

+
+[Index] [Top] [TOC]
 
-  FT_EXPORT( FT_Error )
-  FT_Init_FreeType( FT_Library  *alibrary );
+
+FT_Glyph_Metrics
+Defined in FT_FREETYPE_H (freetype.h).
++  typedef struct  FT_Glyph_Metrics_
+  {
+    FT_Pos  width;
+    FT_Pos  height;
 
-

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

For multi-threading applications each thread should have its own FT_Library object.

If you need reference-counting (cf. FT_Reference_Library), use FT_New_Library and FT_Done_Library.

- - -

[Index]

[TOC]

- -

FT_Done_FreeType

-Defined in FT_FREETYPE_H (freetype.h). -

+    FT_Pos  horiBearingX;
+    FT_Pos  horiBearingY;
+    FT_Pos  horiAdvance;
 
-  FT_EXPORT( FT_Error )
-  FT_Done_FreeType( FT_Library  library );
+    FT_Pos  vertBearingX;
+    FT_Pos  vertBearingY;
+    FT_Pos  vertAdvance;
 
-

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.

- - -

[Index]

[TOC]

- -

FT_OPEN_XXX

-Defined in FT_FREETYPE_H (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
-
-#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.

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_Glyph_Metrics; + + +

+ +

fields

+ + - - - - - - -

width	+ The glyph's width.
FT_OPEN_DRIVER	- Use the ‘driver’ field. +
height	+ The glyph's height.
FT_OPEN_PARAMS	- Use the ‘num_params’ and ‘params’ fields. +
horiBearingX	+ Left side bearing for horizontal layout.
ft_open_memory	- Deprecated; use FT_OPEN_MEMORY instead. +
horiBearingY	+ Top side bearing for horizontal layout.
ft_open_stream	- Deprecated; use FT_OPEN_STREAM instead. +
horiAdvance	+ Advance width for horizontal layout.
ft_open_pathname	- Deprecated; use FT_OPEN_PATHNAME instead. +
vertBearingX	+ Left side bearing for vertical layout.
ft_open_driver	- Deprecated; use FT_OPEN_DRIVER instead. +
vertBearingY	+ Top side bearing for vertical layout. Larger positive values mean further below the vertical glyph origin.
ft_open_params	- Deprecated; use FT_OPEN_PARAMS instead. +
vertAdvance	+ Advance height for vertical layout. Positive values mean the glyph has a positive advance downward.

note

The ‘FT_OPEN_MEMORY’, ‘FT_OPEN_STREAM’, and ‘FT_OPEN_PATHNAME’ flags are mutually exclusive.

- - -

[Index]

[TOC]

- -

FT_Parameter

-Defined in FT_FREETYPE_H (freetype.h). -

 
-  typedef struct  FT_Parameter_
-  {
-    FT_ULong    tag;
-    FT_Pointer  data;
+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.
 
-  } FT_Parameter;
+
+[Index] [Top] [TOC]
 
-

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

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 the various FT_PARAM_TAG_XXX flags for more information.

- - -

[Index]

[TOC]

- -

FT_Open_Args

-Defined in FT_FREETYPE_H (freetype.h). -

+
+FT_SubGlyph
+Defined in FT_FREETYPE_H (freetype.h).
++  typedef struct FT_SubGlyphRec_*  FT_SubGlyph;
+
 
-  typedef struct  FT_Open_Args_
+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.
+
+
+[Index] [Top] [TOC]
+
+
+FT_Bitmap_Size
+Defined in FT_FREETYPE_H (freetype.h).
++  typedef struct  FT_Bitmap_Size_
   {
-    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_Short  height;
+    FT_Short  width;
 
-  } FT_Open_Args;
+    FT_Pos    size;
 
-

A structure used 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.

+ 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.
memory_size	- The size in bytes of the file in memory. +
width	+ The average width, in pixels, of all glyphs in the strike.
pathname	- A pointer to an 8-bit file pathname. +
size	+ The nominal size of the strike in 26.6 fractional points. This field is not very useful.
stream	- A handle to a source stream object. +
x_ppem	+ The horizontal ppem (nominal width) in 26.6 fractional pixels.
driver	- This field is exclusively used by FT_Open_Face; it simply specifies the font driver to use to open the face. If set to 0, FreeType tries to load the face with each one of the drivers in its list. +
y_ppem	+ The vertical ppem (nominal height) in 26.6 fractional pixels.
num_params	- The number of extra parameters. +

+ +

note

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

+ +

[Index]

[Top]

[TOC]

+ +

FT_Init_FreeType

Defined in FT_FREETYPE_H (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.
params	- Extra parameters passed to the font driver when opening a new face. +

+ +

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

For multi-threading applications each thread should have its own FT_Library object.

If you need reference-counting (cf. FT_Reference_Library), use FT_New_Library and FT_Done_Library.

+ +

[Index]

[Top]

[TOC]

+ +

FT_Done_FreeType

Defined in FT_FREETYPE_H (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.

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 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 ‘const’; this is missing for API backwards compatibility. In other words, applications should treat them as read-only.

- - -

[Index]

[TOC]

- -

FT_New_Face

-Defined in FT_FREETYPE_H (freetype.h). -

 
+return
+FreeType error code. 0 means success.
+
+
+[Index] [Top] [TOC]
+
+
+FT_New_Face
+Defined in FT_FREETYPE_H (freetype.h).
+   FT_EXPORT( FT_Error )
   FT_New_Face( FT_Library   library,
                const char*  filepathname,
                FT_Long      face_index,
                FT_Face     *aface );
+
 
-

This function calls FT_Open_Face to open a font by its pathname.

inout

- -

library

+ +

inout

+ +

library

A handle to the library resource.

input

- -

pathname

+ +

input

+ + -

pathname	A path to the font file.
face_index	+
face_index	The index of the face within the font. The first face has index 0.

output

- -

aface

+ +

output

+ +

aface

A handle to a new face object. If ‘face_index’ is greater than or equal to zero, it must be non-NULL. See FT_Open_Face for more details.

return

+ +

return

FreeType error code. 0 means success.

note

+ +

note

Use FT_Done_Face to destroy the created FT_Face object (along with its slot and sizes).

- - -

[Index]

[TOC]

- -

FT_New_Memory_Face

-Defined in FT_FREETYPE_H (freetype.h). -

 
+
+[Index] [Top] [TOC]
+
+
+FT_Done_Face
+Defined in FT_FREETYPE_H (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.
+
+
+[Index] [Top] [TOC]
+
+
+FT_Reference_Face
+Defined in FT_FREETYPE_H (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
+
+
+[Index] [Top] [TOC]
+
+
+FT_New_Memory_Face
+Defined in FT_FREETYPE_H (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 );
+
 
-

This function calls FT_Open_Face to open a font that has been loaded into memory.

inout

- -

library

+ +

inout

+ +

library

A handle to the library resource.

input

- -

file_base

+ +

input

+ + - -

file_base	A pointer to the beginning of the font data.
file_size	+
file_size	The size of the memory chunk used by the font data.
face_index	+
face_index	The index of the face within the font. The first face has index 0.

output

- -

aface

+ +

output

+ +

aface

A handle to a new face object. If ‘face_index’ is greater than or equal to zero, it must be non-NULL. See FT_Open_Face for more details.

return

+ +

return

FreeType error code. 0 means success.

note

+ +

note

You must not deallocate the memory before calling FT_Done_Face.

- - -

[Index]

[TOC]

- -

FT_Open_Face

-Defined in FT_FREETYPE_H (freetype.h). -

 
+
+[Index] [Top] [TOC]
+
+
+FT_Open_Face
+Defined in FT_FREETYPE_H (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

+ +

inout

+ +

library

A handle to the library resource.

input

- -

args

+ +

input

+ + -

args	A pointer to an ‘FT_Open_Args’ structure that must be filled by the caller.
face_index	+
face_index	The index of the face within the font. The first face has index 0.

output

- -

aface

+ +

output

+ +

aface

A handle to a new face object. If ‘face_index’ is greater than or equal to zero, it must be non-NULL. See note below.

return

+ +

return

FreeType error code. 0 means success.

note

+ +

note

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

FT_Open_Face can be used to quickly check whether the font format of a given font resource is supported by FreeType. If the ‘face_index’ field is negative, the function's return value is 0 if the font format is recognized, or non-zero otherwise; the function returns a more or less empty face handle in ‘*aface’ (if ‘aface’ isn't NULL). The only useful field in this special case is ‘face->num_faces’ that gives the number of faces within the font file. After examination, the returned FT_Face structure should be deallocated with a call to FT_Done_Face.

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.

- - -

[Index]

[TOC]

- -

FT_Attach_File

-Defined in FT_FREETYPE_H (freetype.h). -

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

This function calls FT_Attach_Stream to attach a file.

inout

- - -

face

The target face object.

input

- - -

filepathname

The pathname.

return

FreeType error code. 0 means success.

- - -

[Index]

[TOC]

- -

FT_Attach_Stream

-Defined in FT_FREETYPE_H (freetype.h). -

 
-  FT_EXPORT( FT_Error )
-  FT_Attach_Stream( FT_Face        face,
-                    FT_Open_Args*  parameters );
+
+[Index] [Top] [TOC]
+
+
+FT_Open_Args
+Defined in FT_FREETYPE_H (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 used 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.
+
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 to open the face. If set to 0, 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 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 ‘const’; this is missing for API backwards compatibility. In other words, applications should treat them as read-only.
+
+
+[Index] [Top] [TOC]
+
+
+FT_Parameter
+Defined in FT_FREETYPE_H (freetype.h).
++  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.
+
+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 the various FT_PARAM_TAG_XXX flags for more information.
+
+
+[Index] [Top] [TOC]
+
+
+FT_Attach_File
+Defined in FT_FREETYPE_H (freetype.h).
++  FT_EXPORT( FT_Error )
+  FT_Attach_File( FT_Face      face,
+                  const char*  filepathname );
+
+
+This function calls FT_Attach_Stream to attach a file.
+
+inout
+
+
+face 
+The target face object.
+
+
+input
+
+
+filepathname 
+The pathname.
+
+
+return
+FreeType error code. 0 means success.
+
+
+[Index] [Top] [TOC]
+
+
+FT_Attach_Stream
+Defined in FT_FREETYPE_H (freetype.h).
++  FT_EXPORT( FT_Error )
+  FT_Attach_Stream( FT_Face        face,
+                    FT_Open_Args*  parameters );
+
 
-

‘Attach’ 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

+ +

inout

+ +

face	The target face object.

input

- -

parameters

+ +

input

+ +

parameters

A pointer to FT_Open_Args that must be filled by the caller.

return

+ +

return

FreeType error code. 0 means success.

note

+ +

note

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.

- - -

[Index]

[TOC]

- -

FT_Reference_Face

-Defined in FT_FREETYPE_H (freetype.h). -

 
+
+[Index] [Top] [TOC]
+
+
+FT_Set_Char_Size
+Defined in FT_FREETYPE_H (freetype.h).
+   FT_EXPORT( FT_Error )
-  FT_Reference_Face( FT_Face  face );
+  FT_Set_Char_Size( FT_Face     face,
+                    FT_F26Dot6  char_width,
+                    FT_F26Dot6  char_height,
+                    FT_UInt     horz_resolution,
+                    FT_UInt     vert_resolution );
+
 
-

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

This function calls FT_Request_Size to request the nominal size (in points).

+ +

inout

+ +

face	A handle to a target face object.

return

+ +

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.

since

2.4.2

- - -

[Index]

[TOC]

- -

FT_Done_Face

-Defined in FT_FREETYPE_H (freetype.h). -

 
+note
+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.
+
+
+[Index] [Top] [TOC]
+
+
+FT_Set_Pixel_Sizes
+Defined in FT_FREETYPE_H (freetype.h).
+   FT_EXPORT( FT_Error )
-  FT_Done_Face( FT_Face  face );
+  FT_Set_Pixel_Sizes( FT_Face  face,
+                      FT_UInt  pixel_width,
+                      FT_UInt  pixel_height );
+
 
-

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

input

- -

face

This function calls 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.

+ +

[Index]

[Top]

[TOC]

+ +

FT_Request_Size

Defined in FT_FREETYPE_H (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.

return

+ +

input

+ + +

req	+ A pointer to a FT_Size_RequestRec. +

+ +

return

FreeType error code. 0 means success.

note

See the discussion of reference counters in the description of FT_Reference_Face.

- - -

[Index]

[TOC]

- -

FT_Select_Size

-Defined in FT_FREETYPE_H (freetype.h). -

 
+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 ‘http://www.freetype.org/freetype2/docs/glyphs/glyphs-2.html’
+Don't use this function if you are using the FreeType cache API.
+
+
+[Index] [Top] [TOC]
+
+
+FT_Select_Size
+Defined in FT_FREETYPE_H (freetype.h).
+   FT_EXPORT( FT_Error )
   FT_Select_Size( FT_Face  face,
                   FT_Int   strike_index );
+
 
-

Select a bitmap strike.

inout

- -

face

+ +

inout

+ +

face	A handle to a target face object.

input

- -

strike_index

+ +

input

+ +

strike_index

The index of the bitmap strike in the ‘available_sizes’ field of FT_FaceRec structure.

return

+ +

return

FreeType error code. 0 means success.

- - -

[Index]

[TOC]

- -

FT_Size_Request_Type

-Defined in FT_FREETYPE_H (freetype.h). -

 
+
+[Index] [Top] [TOC]
+
+
+FT_Size_Request_Type
+Defined in FT_FREETYPE_H (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_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.

values

- - -

FT_SIZE_REQUEST_TYPE_NOMINAL

+ +

values

+ + - - - - - - - -

FT_SIZE_REQUEST_TYPE_NOMINAL	The nominal size. The ‘units_per_EM’ field of FT_FaceRec is used to determine both scaling values.
FT_SIZE_REQUEST_TYPE_REAL_DIM
	+
FT_SIZE_REQUEST_TYPE_REAL_DIM	The real dimension. The sum of the the ‘ascender’ and (minus of) the ‘descender’ fields of FT_FaceRec are used to determine both scaling values.
FT_SIZE_REQUEST_TYPE_BBOX
	+
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
	+
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
	+
FT_SIZE_REQUEST_TYPE_SCALES	Specify the scaling values directly.

note

+ +

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.

- - -

[Index]

[TOC]

- -

FT_Size_RequestRec

-Defined in FT_FREETYPE_H (freetype.h). -

 
+
+[Index] [Top] [TOC]
+
+
+FT_Size_RequestRec
+Defined in FT_FREETYPE_H (freetype.h).
+   typedef struct  FT_Size_RequestRec_
   {
     FT_Size_Request_Type  type;
@@ -2189,1467 +1694,1246 @@ Defined in FT_FREETYPE_H (freetype.h).
     FT_UInt               vertResolution;
 
   } FT_Size_RequestRec;
+
 
-

A structure used to model a size request.

fields

- -

type

+ +

fields

+ + - - - -

type	See FT_Size_Request_Type.
width	+
width	The desired width.
height	+
height	The desired height.
horiResolution	+
horiResolution	The horizontal resolution. If set to zero, ‘width’ is treated as a 26.6 fractional pixel value.
vertResolution	+
vertResolution	The vertical resolution. If set to zero, ‘height’ is treated as a 26.6 fractional pixel value.

note

+ +

note

If ‘width’ is zero, then the horizontal scaling value is set equal to the vertical scaling value, and vice versa.

- - -

[Index]

[TOC]

- -

FT_Size_Request

-Defined in FT_FREETYPE_H (freetype.h). -

 
+
+[Index] [Top] [TOC]
+
+
+FT_Size_Request
+Defined in FT_FREETYPE_H (freetype.h).
+   typedef struct FT_Size_RequestRec_  *FT_Size_Request;
+
 
-

A handle to a size request structure.

- - -

[Index]

[TOC]

- -

FT_Request_Size

-Defined in FT_FREETYPE_H (freetype.h). -

 
-  FT_EXPORT( FT_Error )
-  FT_Request_Size( FT_Face          face,
-                   FT_Size_Request  req );
+
+[Index] [Top] [TOC]
 
-

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 ‘http://www.freetype.org/freetype2/docs/glyphs/glyphs-2.html’

Don't use this function if you are using the FreeType cache API.

- - -

[Index]

[TOC]

- -

FT_Set_Char_Size

-Defined in FT_FREETYPE_H (freetype.h). -

+
+FT_Set_Transform
+Defined in FT_FREETYPE_H (freetype.h).
++  FT_EXPORT( void )
+  FT_Set_Transform( FT_Face     face,
+                    FT_Matrix*  matrix,
+                    FT_Vector*  delta );
+
 
-  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 );
+A function used to set the transformation that is applied to glyph images when they are loaded into a glyph slot through FT_Load_Glyph.
 
-

This function calls FT_Request_Size to request the nominal size (in points).

inout

- -

face

A handle to a target face object.

inout

+ +

face	+ A handle to the source 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.

+ +

input

+ + -

matrix	+ A pointer to the transformation's 2x2 matrix. Use 0 for the identity matrix.
vert_resolution	- The vertical resolution in dpi. +
delta	+ A pointer to the translation vector. Use 0 for the null vector.

return

FreeType error code. 0 means success.

note

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.

- - -

[Index]

[TOC]

- -

FT_Set_Pixel_Sizes

-Defined in FT_FREETYPE_H (freetype.h). -

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

note

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

This function calls 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.

- - -

[Index]

[TOC]

- -

FT_Load_Glyph

-Defined in FT_FREETYPE_H (freetype.h). -

+
+[Index] [Top] [TOC]
 
+
+FT_Load_Glyph
+Defined in FT_FREETYPE_H (freetype.h).
+   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 into the glyph slot of a face object.

inout

- -

face

+ +

inout

+ +

face	A handle to the target face object where the glyph is loaded.

input

- -

glyph_index

+ +

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	+
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

+ +

return

FreeType error code. 0 means success.

note

+ +

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.

- - -

[Index]

[TOC]

- -

FT_Load_Char

-Defined in FT_FREETYPE_H (freetype.h). -

 
-  FT_EXPORT( FT_Error )
-  FT_Load_Char( FT_Face   face,
-                FT_ULong  char_code,
-                FT_Int32  load_flags );
+
+[Index] [Top] [TOC]
 
-

A function used to load a single glyph into the glyph slot of a face object, according to 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.

FT_Get_Char_Index

Defined in FT_FREETYPE_H (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 a charmap object to do the mapping.

+ +

input

+ + -

face	+ A handle to the source face object.
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). +
charcode	+ The character code.

return

FreeType error code. 0 means success.

note

This function simply calls FT_Get_Char_Index and FT_Load_Glyph.

- - -

[Index]

[TOC]

- -

FT_LOAD_XXX

-Defined in FT_FREETYPE_H (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 )
 
-

A list of bit-field constants used with 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:

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

2. If no embedded bitmap is searched or found, FreeType looks for a scalable outline. If one is found, it is loaded from the font file, scaled to device pixels, then ‘hinted’ 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 ‘tricky’ (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 ‘blurrier’ 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

Indicates that the auto-hinter is preferred over the font's native hinter. See also the note below.

FT_LOAD_CROP_BITMAP

Indicates that the font driver should crop the loaded bitmap glyph (i.e., remove all space around its black bits). Not all drivers implement this.

FT_LOAD_PEDANTIC

Indicates that the font driver should perform pedantic verifications during glyph loading. 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_IGNORE_GLOBAL_ADVANCE_WIDTH

Ignored. Deprecated.

FT_LOAD_NO_RECURSE

This flag is only used internally. It merely indicates that the font driver should not load composite glyphs recursively. Instead, it should set the ‘num_subglyph’ and ‘subglyphs’ values of the glyph slot accordingly, and set ‘glyph->format’ to FT_GLYPH_FORMAT_COMPOSITE.

The description of sub-glyphs is not available to client applications for now.

This flag implies FT_LOAD_NO_SCALE and FT_LOAD_IGNORE_TRANSFORM.

FT_LOAD_IGNORE_TRANSFORM

Indicates that the transform matrix set by FT_Set_Transform should be ignored.

return

The glyph index. 0 means ‘undefined character code’.

+ +

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 ‘missing glyph’. If the first glyph is not named ‘.notdef’, then for Type 1 and Type 42 fonts, ‘.notdef’ will be moved into the glyph ID 0 position, and whatever was there will be moved to the position ‘.notdef’ had. For Type 1 fonts, if there is no ‘.notdef’ 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.

+ +

[Index]

[Top]

[TOC]

+ +

FT_Get_First_Char

Defined in FT_FREETYPE_H (freetype.h).

+  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 also returns the corresponding glyph index.

+ +

input

+ + -

face

A handle to the source face object.

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.

+ +

output

+ + -

agindex	+ Glyph index of first character code. 0 if charmap is empty.
FT_LOAD_LINEAR_DESIGN	- Indicates that the ‘linearHoriAdvance’ and ‘linearVertAdvance’ fields of FT_GlyphSlotRec should be kept in font units. See FT_GlyphSlotRec for details. +

+ +

return

The charmap's first character code.

+ +

note

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

+ +

[Index]

[Top]

[TOC]

+ +

FT_Get_Next_Char

Defined in FT_FREETYPE_H (freetype.h).

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

+ +

input

+ + - -

face	+ A handle to the source face object.
FT_LOAD_NO_AUTOHINT	- Disable auto-hinter. See also the note below. +
char_code	+ The starting character code.
FT_LOAD_COLOR	- This flag is used to request loading of color embedded-bitmap images. The resulting color bitmaps, if available, will have the FT_PIXEL_MODE_BGRA format. When the flag is not used and color bitmaps are found, they will be converted to 256-level gray bitmaps transparently. Those bitmaps will be in the FT_PIXEL_MODE_GRAY format. +

+ +

output

+ +

agindex

Glyph index of next character code. 0 if charmap is empty.

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.

- - -

[Index]

[TOC]

- -

FT_LOAD_TARGET_XXX

-Defined in FT_FREETYPE_H (freetype.h). -

 
-#define FT_LOAD_TARGET_( x )   ( (FT_Int32)( (x) & 15 ) << 16 )
+return
+The charmap's next character code.
 
-#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  )
+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 this function for a simple code example.
+Note that ‘*agindex’ is set to 0 when there are no more codes in the charmap.
 
-

A list of values that are used to select a specific hinting algorithm to use by the hinter. You should OR one of these values to your ‘load_flags’ when calling FT_Load_Glyph.

Note that 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.

Also note that FT_LOAD_TARGET_LIGHT is an exception, in that it always implies FT_LOAD_FORCE_AUTOHINT.

values

- -

FT_LOAD_TARGET_NORMAL

This corresponds to the default hinting algorithm, optimized for standard gray-level rendering. For monochrome output, use FT_LOAD_TARGET_MONO instead.

[Index]

[Top]

[TOC]

+ +

FT_Get_Name_Index

Defined in FT_FREETYPE_H (freetype.h).

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

+ +

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

+ +

input

+ + - -

face	+ A handle to the source face object.
FT_LOAD_TARGET_LIGHT	- A lighter hinting algorithm for non-monochrome modes. Many generated glyphs are more fuzzy but better resemble its original shape. A bit like rendering on Mac OS X. - As a special exception, this target implies FT_LOAD_FORCE_AUTOHINT. +
glyph_name	+ The glyph name.
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. +

+ +

return

The glyph index. 0 means ‘undefined character code’.

+ +

[Index]

[Top]

[TOC]

+ +

FT_Load_Char

Defined in FT_FREETYPE_H (freetype.h).

+  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 into the glyph slot of a face object, according to its character code.

+ +

inout

+ + -

face	+ A handle to a target face object where the glyph is loaded.
FT_LOAD_TARGET_LCD	- A variant of FT_LOAD_TARGET_NORMAL optimized for horizontally decimated LCD displays. +

+ +

input

+ + -

char_code	+ The glyph's character code, according to the current charmap used in the face.
FT_LOAD_TARGET_LCD_V	- A variant of FT_LOAD_TARGET_NORMAL optimized for vertically decimated LCD displays. +
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).

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 exeption 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 ‘light’ 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 );
-

- - -

[Index]

[TOC]

return

FreeType error code. 0 means success.

+ +

note

This function simply calls FT_Get_Char_Index and FT_Load_Glyph.

FT_LOAD_TARGET_MODE

-Defined in FT_FREETYPE_H (freetype.h). -

+
+[Index] [Top] [TOC]
 
+
+FT_LOAD_TARGET_MODE
+Defined in FT_FREETYPE_H (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.

- - -

[Index]

[TOC]

- -

FT_Set_Transform

-Defined in FT_FREETYPE_H (freetype.h). -

 
-  FT_EXPORT( void )
-  FT_Set_Transform( FT_Face     face,
-                    FT_Matrix*  matrix,
-                    FT_Vector*  delta );
+
+[Index] [Top] [TOC]
 
-

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

FT_Render_Glyph

Defined in FT_FREETYPE_H (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

- - -

matrix

A pointer to the transformation's 2x2 matrix. Use 0 for the identity matrix.

delta

A pointer to the translation vector. Use 0 for the null vector.

+ +

input

+ +

render_mode

This is the render mode used to render the glyph image into a bitmap. See FT_Render_Mode for a list of possible values.

note

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

- - -

[Index]

[TOC]

- -

FT_Render_Mode

-Defined in FT_FREETYPE_H (freetype.h). -

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.

+ +

[Index]

[Top]

[TOC]

+ +

FT_Render_Mode

Defined in FT_FREETYPE_H (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_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 + +

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.

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.

values

- -

FT_RENDER_MODE_NORMAL

+ +

values

+ + - - - -

FT_RENDER_MODE_NORMAL	This is the default render mode; it corresponds to 8-bit anti-aliased bitmaps.
FT_RENDER_MODE_LIGHT	+
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	+
FT_RENDER_MODE_MONO	This mode corresponds to 1-bit bitmaps (with 2 levels of opacity).
FT_RENDER_MODE_LCD	+
FT_RENDER_MODE_LCD	This mode corresponds to horizontal RGB and BGR sub-pixel 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	+
FT_RENDER_MODE_LCD_V	This mode corresponds to vertical RGB and BGR sub-pixel 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

+ +

note

The LCD-optimized glyph bitmaps produced by FT_Render_Glyph can be filtered to reduce color-fringes by using FT_Library_SetLcdFilter (not active in the default builds). It is up to the caller to either call FT_Library_SetLcdFilter (if available) or do the filtering itself.

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.

- - -

[Index]

[TOC]

- -

ft_render_mode_xxx

-Defined in FT_FREETYPE_H (freetype.h). -

-
-#define ft_render_mode_normal  FT_RENDER_MODE_NORMAL
-#define ft_render_mode_mono    FT_RENDER_MODE_MONO
-
-

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

values

- - - -

ft_render_mode_normal	- see FT_RENDER_MODE_NORMAL -
ft_render_mode_mono	- see FT_RENDER_MODE_MONO -

- - -

[Index]

[TOC]

FT_Render_Glyph

-Defined in FT_FREETYPE_H (freetype.h). -

+
+[Index] [Top] [TOC]
 
+
+FT_Get_Kerning
+Defined in FT_FREETYPE_H (freetype.h).
+   FT_EXPORT( FT_Error )
-  FT_Render_Glyph( FT_GlyphSlot    slot,
-                   FT_Render_Mode  render_mode );
+  FT_Get_Kerning( FT_Face     face,
+                  FT_UInt     left_glyph,
+                  FT_UInt     right_glyph,
+                  FT_UInt     kern_mode,
+                  FT_Vector  *akerning );
+
 
-

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.

Return the kerning vector between two glyphs of a 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.

input

- -

render_mode

This is the render mode used to render the glyph image into a bitmap. See FT_Render_Mode for a list of possible values.

+ +

output

+ +

akerning

The kerning vector. This is either in font units or in pixels (26.6 format) for scalable formats, and in pixels for fixed-sizes formats.

return

+ +

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.

- - -

[Index]

[TOC]

- -

FT_Kerning_Mode

-Defined in FT_FREETYPE_H (freetype.h). -

 
+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.
+
+
+[Index] [Top] [TOC]
+
+
+FT_Kerning_Mode
+Defined in FT_FREETYPE_H (freetype.h).
+   typedef enum  FT_Kerning_Mode_
   {
-    FT_KERNING_DEFAULT  = 0,
-    FT_KERNING_UNFITTED,
-    FT_KERNING_UNSCALED
+    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 used to specify which kerning values to return in FT_Get_Kerning.

values

- -

FT_KERNING_DEFAULT

+ +

values

+ + - -

FT_KERNING_DEFAULT	Return scaled and grid-fitted kerning distances (value is 0).
FT_KERNING_UNFITTED	+
FT_KERNING_UNFITTED	Return scaled but un-grid-fitted kerning distances.
FT_KERNING_UNSCALED	+
FT_KERNING_UNSCALED	Return the kerning vector in original font units.

- - -

[Index]

[TOC]

- -

ft_kerning_default

-Defined in FT_FREETYPE_H (freetype.h). -

-
-#define ft_kerning_default   FT_KERNING_DEFAULT
-
-

This constant is deprecated. Please use FT_KERNING_DEFAULT instead.

- - -

[Index]

[TOC]

- -

ft_kerning_unfitted

-Defined in FT_FREETYPE_H (freetype.h). -

-
-#define ft_kerning_unfitted  FT_KERNING_UNFITTED
-
-

This constant is deprecated. Please use FT_KERNING_UNFITTED instead.

- - -

[Index]

[TOC]

- -

ft_kerning_unscaled

-Defined in FT_FREETYPE_H (freetype.h). -

-
-#define ft_kerning_unscaled  FT_KERNING_UNSCALED
-
-

This constant is deprecated. Please use FT_KERNING_UNSCALED instead.

- - -

[Index]

[TOC]

- -

FT_Get_Kerning

-Defined in FT_FREETYPE_H (freetype.h). -

 
+
+[Index] [Top] [TOC]
+
+
+FT_Get_Track_Kerning
+Defined in FT_FREETYPE_H (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 );
+  FT_Get_Track_Kerning( FT_Face    face,
+                        FT_Fixed   point_size,
+                        FT_Int     degree,
+                        FT_Fixed*  akerning );
+
 
-

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

input

- -

face

Return the track kerning for a given face object at a given size.

+ +

input

+ + - - - -

face	A handle to a source face object.
left_glyph	- The index of the left glyph in the kern pair. +
point_size	+ The point size in 16.16 fractional points.
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 or in pixels (26.6 format) 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.

- - -

[Index]

[TOC]

- -

FT_Get_Track_Kerning

-Defined in FT_FREETYPE_H (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	+
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

+ +

output

+ +

akerning

The kerning in 16.16 fractional points, to be uniformly applied between all glyphs.

return

+ +

return

FreeType error code. 0 means success.

note

+ +

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 the Adobe's AFM specification for more details.

- - -

[Index]

[TOC]

- -

FT_Get_Glyph_Name

-Defined in FT_FREETYPE_H (freetype.h). -

 
+
+[Index] [Top] [TOC]
+
+
+FT_Get_Glyph_Name
+Defined in FT_FREETYPE_H (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

+ +

input

+ + - -

face	A handle to a source face object.
glyph_index	+
glyph_index	The glyph index.
buffer_max	+
buffer_max	The maximum number of bytes available in the buffer.

output

- -

buffer

+ +

output

+ +

buffer

A pointer to a target buffer where the name is copied to.

return

+ +

return

FreeType error code. 0 means success.

note

+ +

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 ‘missing glyph’ (called ‘.notdef’).

This function is not compiled within the library if the config macro ‘FT_CONFIG_OPTION_NO_GLYPH_NAMES’ is defined in ‘ftoptions.h’.

- - -

[Index]

[TOC]

- -

FT_Get_Postscript_Name

-Defined in FT_FREETYPE_H (freetype.h). -

+This function always returns an error if the config macro ‘FT_CONFIG_OPTION_NO_GLYPH_NAMES’ is not defined in ‘ftoptions.h’.
+
+
+[Index] [Top] [TOC]
 
+
+FT_Get_Postscript_Name
+Defined in FT_FREETYPE_H (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 and TrueType fonts.

input

- -

face

+ +

input

+ +

face	A handle to the source face object.

return

+ +

return

A pointer to the face's PostScript name. NULL if unavailable.

note

+ +

note

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

- - -

[Index]

[TOC]

- -

FT_Select_Charmap

-Defined in FT_FREETYPE_H (freetype.h). -

 
+
+[Index] [Top] [TOC]
+
+
+FT_CharMapRec
+Defined in FT_FREETYPE_H (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 should be emulated for other formats.
+
encoding_id 
+A platform specific encoding number. This also comes from the TrueType specification and should be emulated similarly.
+
+
+
+[Index] [Top] [TOC]
+
+
+FT_Select_Charmap
+Defined in FT_FREETYPE_H (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

+ +

inout

+ +

face	A handle to the source face object.

input

- -

encoding

+ +

input

+ +

encoding

A handle to the selected encoding.

return

+ +

return

FreeType error code. 0 means success.

note

+ +

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 (‘best’ 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.

- - -

[Index]

[TOC]

- -

FT_Set_Charmap

-Defined in FT_FREETYPE_H (freetype.h). -

 
+
+[Index] [Top] [TOC]
+
+
+FT_Set_Charmap
+Defined in FT_FREETYPE_H (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

+ +

inout

+ +

face	A handle to the source face object.

input

- -

charmap

+ +

input

+ +

charmap

A handle to the selected charmap.

return

+ +

return

FreeType error code. 0 means success.

note

+ +

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 a type 14 charmap is selected.

- - -

[Index]

[TOC]

- -

FT_Get_Charmap_Index

-Defined in FT_FREETYPE_H (freetype.h). -

 
+
+[Index] [Top] [TOC]
+
+
+FT_Get_Charmap_Index
+Defined in FT_FREETYPE_H (freetype.h).
+   FT_EXPORT( FT_Int )
   FT_Get_Charmap_Index( FT_CharMap  charmap );
+
 
-

Retrieve index of a given charmap.

input

- -

charmap

+ +

input

+ +

charmap

A handle to a charmap.

return

+ +

return

The index into the array of character maps within the face to which ‘charmap’ belongs. If an error occurs, -1 is returned.

- - -

[Index]

[TOC]

- -

FT_Get_Char_Index

-Defined in FT_FREETYPE_H (freetype.h). -

 
-  FT_EXPORT( FT_UInt )
-  FT_Get_Char_Index( FT_Face   face,
-                     FT_ULong  charcode );
+
+[Index] [Top] [TOC]
 
-

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

input

- -

face

FT_Get_FSType_Flags

Defined in FT_FREETYPE_H (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.
charcode	- The character code. -

return

The glyph index. 0 means ‘undefined character code’.

note

- - -

[Index]

[TOC]

- -

FT_Get_First_Char

-Defined in FT_FREETYPE_H (freetype.h). -

 
-  FT_EXPORT( FT_ULong )
-  FT_Get_First_Char( FT_Face   face,
-                     FT_UInt  *agindex );
+return
+The fsType flags, FT_FSTYPE_XXX.
 
-

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

input

- -

face

A handle to the source face object.

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

+ +

[Index]

[Top]

[TOC]

+ +

FT_Get_SubGlyph_Info

Defined in FT_FREETYPE_H (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

- -

agindex

Glyph index of first character code. 0 if charmap is empty.

+ +

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

The charmap's first character code.

note

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

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 TrueType specification for details.

+ +

[Index]

[Top]

[TOC]

+ +

FT_Face_Internal

Defined in FT_FREETYPE_H (freetype.h).

+  typedef struct FT_Face_InternalRec_*  FT_Face_Internal;

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.

- - -

[Index]

[TOC]

- -

FT_Get_Next_Char

-Defined in FT_FREETYPE_H (freetype.h). -

 
-  FT_EXPORT( FT_ULong )
-  FT_Get_Next_Char( FT_Face    face,
-                    FT_ULong   char_code,
-                    FT_UInt   *agindex );
+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.
 
-

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.

input

- -

face

A handle to the source face object.

[Index]

[Top]

[TOC]

+ +

FT_Size_Internal

Defined in FT_FREETYPE_H (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.

+ +

[Index]

[Top]

[TOC]

+ +

FT_Slot_Internal

Defined in FT_FREETYPE_H (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.

+ +

[Index]

[Top]

[TOC]

+ +

FT_FACE_FLAG_XXX

Defined in FT_FREETYPE_H (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 )
+

+ +

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	+ Indicates that the face contains outline glyphs. This doesn't prevent bitmap strikes, i.e., a face can have both this and and FT_FACE_FLAG_FIXED_SIZES set.
char_code	- The starting character code. +
FT_FACE_FLAG_FIXED_SIZES	+ Indicates that the face contains bitmap strikes. See also the ‘num_fixed_sizes’ and ‘available_sizes’ fields of FT_FaceRec. +
FT_FACE_FLAG_FIXED_WIDTH	+ Indicates that the face contains fixed-width characters (like Courier, Lucido, MonoType, etc.). +
FT_FACE_FLAG_SFNT	+ Indicates that the face uses the ‘sfnt’ storage scheme. For now, this means TrueType and OpenType. +
FT_FACE_FLAG_HORIZONTAL	+ Indicates that the face contains horizontal glyph metrics. This should be set for all common formats. +
FT_FACE_FLAG_VERTICAL	+ Indicates that the face contains vertical glyph metrics. This is only available in some formats, not all of them. +
FT_FACE_FLAG_KERNING	+ Indicates that the face contains kerning information. If set, the kerning distance can be retrieved through the function FT_Get_Kerning. Otherwise the function always return the vector (0,0). Note that FreeType doesn't handle kerning data from the ‘GPOS’ table (as present in some OpenType fonts). +
FT_FACE_FLAG_FAST_GLYPHS	+ THIS FLAG IS DEPRECATED. DO NOT USE OR TEST IT. +
FT_FACE_FLAG_MULTIPLE_MASTERS	+ Indicates that the font contains multiple masters and is capable of interpolating between them. See the multiple-masters specific API for details. +
FT_FACE_FLAG_GLYPH_NAMES	+ Indicates that the font contains glyph names that can be retrieved through 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	+ Set if the font driver has a hinting machine of its own. For example, with TrueType fonts, it makes sense to use data from the SFNT ‘gasp’ table only if the native TrueType hinting engine (with the bytecode interpreter) is available and active. +
FT_FACE_FLAG_CID_KEYED	+ Set if the font is CID-keyed. In that case, the font 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 don't have this flag set since the glyphs are accessed in the normal way (using contiguous indices); the ‘CID-ness’ isn't visible to the application. +
FT_FACE_FLAG_TRICKY	+ Set if the font is ‘tricky’, this is, it always needs the font format's native hinting engine to get a reasonable result. A typical example is the Chinese font ‘mingli.ttf’ that uses TrueType bytecode instructions to move and scale all of its subglyphs. + It is not possible to autohint 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	+ Set if the font has color glyph tables. To access color glyphs use FT_LOAD_COLOR.

output

- -

agindex

Glyph index of next character code. 0 if charmap is empty.

+ +

[Index]

[Top]

[TOC]

+ +

FT_STYLE_FLAG_XXX

Defined in FT_FREETYPE_H (freetype.h).

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

+ +

values

+ + +

FT_STYLE_FLAG_ITALIC	+ Indicates that a given face style is italic or oblique. +
FT_STYLE_FLAG_BOLD	+ Indicates that a given face is bold.

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 this function for a simple code example.

Note that ‘*agindex’ is set to 0 when there are no more codes in the charmap.

- - -

[Index]

[TOC]

- -

FT_Get_Name_Index

-Defined in FT_FREETYPE_H (freetype.h). -

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

note

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

input

- -

face

A handle to the source face object.

[Index]

[Top]

[TOC]

+ +

FT_OPEN_XXX

Defined in FT_FREETYPE_H (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.
glyph_name	- The glyph name. +
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.

return

The glyph index. 0 means ‘undefined character code’.

- - -

[Index]

[TOC]

- -

FT_SUBGLYPH_FLAG_XXX

-Defined in FT_FREETYPE_H (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 used to describe subglyphs. Please refer to the TrueType specification for the meaning of the various flags.

values

- - -

FT_SUBGLYPH_FLAG_ARGS_ARE_WORDS

+ +

note

The ‘FT_OPEN_MEMORY’, ‘FT_OPEN_STREAM’, and ‘FT_OPEN_PATHNAME’ flags are mutually exclusive.

+ +

[Index]

[Top]

[TOC]

+ +

FT_LOAD_XXX

Defined in FT_FREETYPE_H (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 )
+

+ +

A list of bit-field constants used with 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: + 1. 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). + 2. If no embedded bitmap is searched or found, FreeType looks for a scalable outline. If one is found, it is loaded from the font file, scaled to device pixels, then ‘hinted’ 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_SUBGLYPH_FLAG_ARGS_ARE_XY_VALUES
	- +
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 ‘tricky’ (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_SUBGLYPH_FLAG_ROUND_XY_TO_GRID
	- +
FT_LOAD_NO_HINTING	+ Disable hinting. This generally generates ‘blurrier’ 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_SUBGLYPH_FLAG_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_SUBGLYPH_FLAG_XY_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_SUBGLYPH_FLAG_2X2	- +
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_SUBGLYPH_FLAG_USE_MY_METRICS
	- +
FT_LOAD_FORCE_AUTOHINT	+ Indicates that the auto-hinter is preferred over the font's native hinter. See also the note below. +
FT_LOAD_PEDANTIC	+ Indicates that the font driver should perform pedantic verifications during glyph loading. 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	+ Indicate that the font driver should not load composite glyphs recursively. Instead, it should set the ‘num_subglyph’ and ‘subglyphs’ values of the glyph slot accordingly, and set ‘glyph->format’ to FT_GLYPH_FORMAT_COMPOSITE. The description of subglyphs can then be accessed with FT_Get_SubGlyph_Info. + This flag implies FT_LOAD_NO_SCALE and FT_LOAD_IGNORE_TRANSFORM. +
FT_LOAD_IGNORE_TRANSFORM	+ Indicates that the transform matrix set by FT_Set_Transform should be ignored. +
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	+ Indicates that the ‘linearHoriAdvance’ and ‘linearVertAdvance’ fields of FT_GlyphSlotRec should be kept in font units. See FT_GlyphSlotRec for details. +
FT_LOAD_NO_AUTOHINT	+ Disable auto-hinter. See also the note below. +
FT_LOAD_COLOR	+ This flag is used to request loading of color embedded-bitmap images. The resulting color bitmaps, if available, will have the FT_PIXEL_MODE_BGRA format. When the flag is not used and color bitmaps are found, they will be converted to 256-level gray bitmaps transparently. Those bitmaps will be in the FT_PIXEL_MODE_GRAY format. +
FT_LOAD_CROP_BITMAP	+ Ignored. Deprecated. +
FT_LOAD_IGNORE_GLOBAL_ADVANCE_WIDTH	+ Ignored. Deprecated.

- - -

[Index]

[TOC]

FT_Get_SubGlyph_Info

-Defined in FT_FREETYPE_H (freetype.h). -

note

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.

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

[Index]

[Top]

[TOC]

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.

FT_LOAD_TARGET_XXX

Defined in FT_FREETYPE_H (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 that are used to select a specific hinting algorithm to use by the hinter. You should OR one of these values to your ‘load_flags’ when calling FT_Load_Glyph.

Also note that FT_LOAD_TARGET_LIGHT is an exception, in that it always implies FT_LOAD_FORCE_AUTOHINT.

+ +

values

+ + - + + +

FT_LOAD_TARGET_NORMAL	+ This corresponds to the default hinting algorithm, optimized for standard gray-level rendering. For monochrome output, use FT_LOAD_TARGET_MONO instead.
sub_index	- The index of the subglyph. Must be less than ‘glyph->num_subglyphs’. +
FT_LOAD_TARGET_LIGHT	+ A lighter hinting algorithm for non-monochrome modes. Many generated glyphs are more fuzzy but better resemble its original shape. A bit like rendering on Mac OS X. + As a special exception, this target implies FT_LOAD_FORCE_AUTOHINT. +
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. +
FT_LOAD_TARGET_LCD	+ A variant of FT_LOAD_TARGET_NORMAL optimized for horizontally decimated LCD displays. +
FT_LOAD_TARGET_LCD_V	+ A variant of FT_LOAD_TARGET_NORMAL optimized for vertically decimated LCD displays.

output

+ +

note

You should use only one of the FT_LOAD_TARGET_XXX values in your ‘load_flags’. They can't be ORed.

+  FT_Load_Glyph( face, glyph_index,
+                 load_flags | FT_LOAD_TARGET_LIGHT );
+
+  FT_Render_Glyph( face->glyph, FT_RENDER_MODE_LCD );
+

+ +

[Index]

[Top]

[TOC]

+ +

FT_SUBGLYPH_FLAG_XXX

Defined in FT_FREETYPE_H (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 used to describe subglyphs. Please refer to the TrueType specification for the meaning of the various flags.

+ +

values

+ +

FT_SUBGLYPH_FLAG_ARGS_ARE_WORDS

- - - - - - + +

p_index	- The glyph index of the subglyph.
p_flags	- The subglyph flags, see FT_SUBGLYPH_FLAG_XXX. +
FT_SUBGLYPH_FLAG_ARGS_ARE_XY_VALUES	+
p_arg1	- The subglyph's first argument (if any). +
FT_SUBGLYPH_FLAG_ROUND_XY_TO_GRID	+
p_arg2	- The subglyph's second argument (if any). +
FT_SUBGLYPH_FLAG_SCALE	+
p_transform	- The subglyph transformation (if any). +
FT_SUBGLYPH_FLAG_XY_SCALE	+ +
FT_SUBGLYPH_FLAG_2X2	+ +
FT_SUBGLYPH_FLAG_USE_MY_METRICS	+

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 TrueType specification for details.

- - -

[Index]

[TOC]

- -

FT_FSTYPE_XXX

-Defined in FT_FREETYPE_H (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
-
-

+ +

[Index]

[Top]

[TOC]

+ +

FT_FSTYPE_XXX

Defined in FT_FREETYPE_H (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 http://www.adobe.com/devnet/acrobat/pdfs/FontPolicies.pdf for more details.

values

- - -

FT_FSTYPE_INSTALLABLE_EMBEDDING

+ +

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
	+
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
	+
FT_FSTYPE_PREVIEW_AND_PRINT_EMBEDDING	If this bit is set, the font may be embedded and temporarily loaded on the remote system. Documents containing Preview & Print fonts must be opened ‘read-only’; no edits can be applied to the document.
FT_FSTYPE_EDITABLE_EMBEDDING
	+
FT_FSTYPE_EDITABLE_EMBEDDING	If this bit is set, 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
	+
FT_FSTYPE_NO_SUBSETTING	If this bit is set, the font may not be subsetted prior to embedding.
FT_FSTYPE_BITMAP_EMBEDDING_ONLY
	+
FT_FSTYPE_BITMAP_EMBEDDING_ONLY	If this bit is set, 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

+ +

note

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.

- - -

[Index]

[TOC]

- -

FT_Get_FSType_Flags

-Defined in FT_FREETYPE_H (freetype.h). -

 
-  FT_EXPORT( FT_UShort )
-  FT_Get_FSType_Flags( FT_Face  face );
+
+[Index] [Top] [TOC]
 
-

Return the fsType flags for a font.

input

- - -

face

A handle to the source face object.

return

The fsType flags, 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

- - -

[Index]

[TOC]

FT_HAS_FAST_GLYPHS

Defined in FT_FREETYPE_H (freetype.h).

+#define FT_HAS_FAST_GLYPHS( face )  0
+

+ +

Deprecated.

+ +

[Index]

[Top]

[TOC]

diff --git a/freetype/docs/reference/ft2-basic_types.html b/freetype/docs/reference/ft2-basic_types.html index c600032e6..e39573d5b 100644 --- a/freetype/docs/reference/ft2-basic_types.html +++ b/freetype/docs/reference/ft2-basic_types.html @@ -3,1208 +3,867 @@ -FreeType-2.5.3 API Reference +FreeType-2.5.5 API Reference - - -

[Index]

[TOC]

FreeType-2.5.3 API Reference

[Index]

[TOC]

FreeType-2.5.5 API Reference

-Basic Data Types -

Basic Data Types

Synopsis

- - - - - - - - - - - - - - - - -

FT_Byte	FT_PtrDist	FT_Pixel_Mode
FT_Bytes	FT_String	ft_pixel_mode_xxx
FT_Char	FT_Tag	FT_Palette_Mode
FT_Int	FT_Error	FT_Bitmap
FT_UInt	FT_Fixed	FT_IMAGE_TAG
FT_Int16	FT_Pointer	FT_Glyph_Format
FT_UInt16	FT_Pos	ft_glyph_format_xxx
FT_Int32	FT_Vector	FT_Data
FT_UInt32	FT_BBox	FT_Generic_Finalizer
FT_Short	FT_Matrix	FT_Generic
FT_UShort	FT_FWord	FT_MAKE_TAG
FT_Long	FT_UFWord	FT_Int64
FT_ULong	FT_F2Dot14	FT_UInt64
FT_Bool	FT_UnitVector
FT_Offset	FT_F26Dot6

- -

+ + + + + + + + + + + + + + + + + + +

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

-Defined in FT_TYPES_H (fttypes.h). -

 
+
+FT_Byte
+Defined in FT_TYPES_H (fttypes.h).
+   typedef unsigned char  FT_Byte;
+
 
-

A simple typedef for the unsigned char type.

- - -

[Index]

[TOC]

- -

FT_Bytes

-Defined in FT_TYPES_H (fttypes.h). -

 
+
+[Index] [Top] [TOC]
+
+
+FT_Bytes
+Defined in FT_TYPES_H (fttypes.h).
+   typedef const FT_Byte*  FT_Bytes;
+
 
-

A typedef for constant memory areas.

- - -

[Index]

[TOC]

- -

FT_Char

-Defined in FT_TYPES_H (fttypes.h). -

 
+
+[Index] [Top] [TOC]
+
+
+FT_Char
+Defined in FT_TYPES_H (fttypes.h).
+   typedef signed char  FT_Char;
+
 
-

A simple typedef for the signed char type.

- - -

[Index]

[TOC]

- -

FT_Int

-Defined in FT_TYPES_H (fttypes.h). -

 
+
+[Index] [Top] [TOC]
+
+
+FT_Int
+Defined in FT_TYPES_H (fttypes.h).
+   typedef signed int  FT_Int;
+
 
-

A typedef for the int type.

- - -

[Index]

[TOC]

- -

FT_UInt

-Defined in FT_TYPES_H (fttypes.h). -

 
+
+[Index] [Top] [TOC]
+
+
+FT_UInt
+Defined in FT_TYPES_H (fttypes.h).
+   typedef unsigned int  FT_UInt;
+
 
-

A typedef for the unsigned int type.

- - -

[Index]

[TOC]

- -

FT_Int16

-Defined in FT_CONFIG_CONFIG_H (config/ftconfig.h). -

 
+
+[Index] [Top] [TOC]
+
+
+FT_Int16
+Defined in FT_CONFIG_CONFIG_H (config/ftconfig.h).
+   typedef signed short  FT_Int16;
+
 
-

A typedef for a 16bit signed integer type.

- - -

[Index]

[TOC]

- -

FT_UInt16

-Defined in FT_CONFIG_CONFIG_H (config/ftconfig.h). -

 
+
+[Index] [Top] [TOC]
+
+
+FT_UInt16
+Defined in FT_CONFIG_CONFIG_H (config/ftconfig.h).
+   typedef unsigned short  FT_UInt16;
+
 
-

A typedef for a 16bit unsigned integer type.

- - -

[Index]

[TOC]

- -

FT_Int32

-Defined in FT_CONFIG_CONFIG_H (config/ftconfig.h). -

 
+
+[Index] [Top] [TOC]
+
+
+FT_Int32
+Defined in FT_CONFIG_CONFIG_H (config/ftconfig.h).
+   typedef signed XXX  FT_Int32;
+
 
-

A typedef for a 32bit signed integer type. The size depends on the configuration.

- - -

[Index]

[TOC]

- -

FT_UInt32

-Defined in FT_CONFIG_CONFIG_H (config/ftconfig.h). -

 
+
+[Index] [Top] [TOC]
+
+
+FT_UInt32
+Defined in FT_CONFIG_CONFIG_H (config/ftconfig.h).
+   typedef unsigned XXX  FT_UInt32;
+
+
+[Index] [Top] [TOC]
 
-

- - -

[Index]

[TOC]

FT_Int64

Defined in FT_CONFIG_CONFIG_H (config/ftconfig.h).

+  typedef signed XXX  FT_Int64;
+

[Index]

[Top]

[TOC]

FT_Short

-Defined in FT_TYPES_H (fttypes.h). -

+
+FT_UInt64
+Defined in FT_CONFIG_CONFIG_H (config/ftconfig.h).
++  typedef unsigned XXX  FT_UInt64;
+
+
+[Index] [Top] [TOC]
 
+
+FT_Short
+Defined in FT_TYPES_H (fttypes.h).
+   typedef signed short  FT_Short;
+
 
-

A typedef for signed short.

- - -

[Index]

[TOC]

- -

FT_UShort

-Defined in FT_TYPES_H (fttypes.h). -

 
+
+[Index] [Top] [TOC]
+
+
+FT_UShort
+Defined in FT_TYPES_H (fttypes.h).
+   typedef unsigned short  FT_UShort;
+
 
-

A typedef for unsigned short.

- - -

[Index]

[TOC]

- -

FT_Long

-Defined in FT_TYPES_H (fttypes.h). -

 
+
+[Index] [Top] [TOC]
+
+
+FT_Long
+Defined in FT_TYPES_H (fttypes.h).
+   typedef signed long  FT_Long;
+
 
-

A typedef for signed long.

- - -

[Index]

[TOC]

- -

FT_ULong

-Defined in FT_TYPES_H (fttypes.h). -

 
+
+[Index] [Top] [TOC]
+
+
+FT_ULong
+Defined in FT_TYPES_H (fttypes.h).
+   typedef unsigned long  FT_ULong;
+
 
-

A typedef for unsigned long.

- - -

[Index]

[TOC]

- -

FT_Bool

-Defined in FT_TYPES_H (fttypes.h). -

 
+
+[Index] [Top] [TOC]
+
+
+FT_Bool
+Defined in FT_TYPES_H (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.

- - -

[Index]

[TOC]

- -

FT_Offset

-Defined in FT_TYPES_H (fttypes.h). -

 
+
+[Index] [Top] [TOC]
+
+
+FT_Offset
+Defined in FT_TYPES_H (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.

- - -

[Index]

[TOC]

- -

FT_PtrDist

-Defined in FT_TYPES_H (fttypes.h). -

 
+
+[Index] [Top] [TOC]
+
+
+FT_PtrDist
+Defined in FT_TYPES_H (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.

- - -

[Index]

[TOC]

- -

FT_String

-Defined in FT_TYPES_H (fttypes.h). -

 
+
+[Index] [Top] [TOC]
+
+
+FT_String
+Defined in FT_TYPES_H (fttypes.h).
+   typedef char  FT_String;
+
 
-

A simple typedef for the char type, usually used for strings.

- - -

[Index]

[TOC]

- -

FT_Tag

-Defined in FT_TYPES_H (fttypes.h). -

 
+
+[Index] [Top] [TOC]
+
+
+FT_Tag
+Defined in FT_TYPES_H (fttypes.h).
+   typedef FT_UInt32  FT_Tag;
+
 
-

A typedef for 32-bit tags (as used in the SFNT format).

- - -

[Index]

[TOC]

- -

FT_Error

-Defined in FT_TYPES_H (fttypes.h). -

 
+
+[Index] [Top] [TOC]
+
+
+FT_Error
+Defined in FT_TYPES_H (fttypes.h).
+   typedef int  FT_Error;
+
 
-

The FreeType error code type. A value of 0 is always interpreted as a successful operation.

- - -

[Index]

[TOC]

- -

FT_Fixed

-Defined in FT_TYPES_H (fttypes.h). -

 
+
+[Index] [Top] [TOC]
+
+
+FT_Fixed
+Defined in FT_TYPES_H (fttypes.h).
+   typedef signed long  FT_Fixed;
+
 
-

This type is used to store 16.16 fixed-point values, like scaling values or matrix coefficients.

- - -

[Index]

[TOC]

- -

FT_Pointer

-Defined in FT_TYPES_H (fttypes.h). -

 
+
+[Index] [Top] [TOC]
+
+
+FT_Pointer
+Defined in FT_TYPES_H (fttypes.h).
+   typedef void*  FT_Pointer;
+
 
-

A simple typedef for a typeless pointer.

- - -

[Index]

[TOC]

- -

FT_Pos

-Defined in FT_IMAGE_H (ftimage.h). -

 
+
+[Index] [Top] [TOC]
+
+
+FT_Pos
+Defined in FT_IMAGE_H (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.

- - -

[Index]

[TOC]

- -

FT_Vector

-Defined in FT_IMAGE_H (ftimage.h). -

 
+
+[Index] [Top] [TOC]
+
+
+FT_Vector
+Defined in FT_IMAGE_H (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

- -

+ +

fields

+ + -

x	The horizontal coordinate.
y	+
y	The vertical coordinate.

- - -

[Index]

[TOC]

- -

FT_BBox

-Defined in FT_IMAGE_H (ftimage.h). -

 
+
+[Index] [Top] [TOC]
+
+
+FT_BBox
+Defined in FT_IMAGE_H (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

+ +

fields

+ + - - -

xMin	The horizontal minimum (left-most).
yMin	+
yMin	The vertical minimum (bottom-most).
xMax	+
xMax	The horizontal maximum (right-most).
yMax	+
yMax	The vertical maximum (top-most).

note

+ +

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.

- - -

[Index]

[TOC]

- -

FT_Matrix

-Defined in FT_TYPES_H (fttypes.h). -

 
+
+[Index] [Top] [TOC]
+
+
+FT_Matrix
+Defined in FT_TYPES_H (fttypes.h).
+   typedef struct  FT_Matrix_
   {
     FT_Fixed  xx, xy;
     FT_Fixed  yx, yy;
 
   } FT_Matrix;
+
 
-

A simple structure used to store a 2x2 matrix. Coefficients are in 16.16 fixed-point format. The computation performed is:

    x' = x*xx + y*xy                                             
    y' = x*yx + y*yy

fields

- -

+ +

fields

+ + - - -

xx	Matrix coefficient.
xy	+
xy	Matrix coefficient.
yx	+
yx	Matrix coefficient.
yy	+
yy	Matrix coefficient.

- - -

[Index]

[TOC]

- -

FT_FWord

-Defined in FT_TYPES_H (fttypes.h). -

 
+
+[Index] [Top] [TOC]
+
+
+FT_FWord
+Defined in FT_TYPES_H (fttypes.h).
+   typedef signed short  FT_FWord;   /* distance in FUnits */
+
 
-

A signed 16-bit integer used to store a distance in original font units.

- - -

[Index]

[TOC]

- -

FT_UFWord

-Defined in FT_TYPES_H (fttypes.h). -

 
+
+[Index] [Top] [TOC]
+
+
+FT_UFWord
+Defined in FT_TYPES_H (fttypes.h).
+   typedef unsigned short  FT_UFWord;  /* unsigned distance */
+
 
-

An unsigned 16-bit integer used to store a distance in original font units.

- - -

[Index]

[TOC]

- -

FT_F2Dot14

-Defined in FT_TYPES_H (fttypes.h). -

 
+
+[Index] [Top] [TOC]
+
+
+FT_F2Dot14
+Defined in FT_TYPES_H (fttypes.h).
+   typedef signed short  FT_F2Dot14;
+
 
-

A signed 2.14 fixed-point type used for unit vectors.

- - -

[Index]

[TOC]

- -

FT_UnitVector

-Defined in FT_TYPES_H (fttypes.h). -

 
+
+[Index] [Top] [TOC]
+
+
+FT_UnitVector
+Defined in FT_TYPES_H (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

- -

+ +

fields

+ + -

x	Horizontal coordinate.
y	+
y	Vertical coordinate.

- - -

[Index]

[TOC]

- -

FT_F26Dot6

-Defined in FT_TYPES_H (fttypes.h). -

 
+
+[Index] [Top] [TOC]
+
+
+FT_F26Dot6
+Defined in FT_TYPES_H (fttypes.h).
+   typedef signed long  FT_F26Dot6;
+
 
-

A signed 26.6 fixed-point type used for vectorial pixel coordinates.

- - -

[Index]

[TOC]

- -

FT_Pixel_Mode

-Defined in FT_IMAGE_H (ftimage.h). -

 
-  typedef enum  FT_Pixel_Mode_
+
+[Index] [Top] [TOC]
+
+
+FT_Data
+Defined in FT_TYPES_H (fttypes.h).
++  typedef struct  FT_Data_
   {
-    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,
+    const FT_Byte*  pointer;
+    FT_Int          length;
 
-    FT_PIXEL_MODE_MAX      /* do not remove */
+  } FT_Data;
+
 
-  } FT_Pixel_Mode;
+Read-only binary data represented as a pointer and a length.
 
-

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 ‘gray’ 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	- 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 ‘00,00,80,80’, not ‘00,00,FF,80’. See also FT_LOAD_COLOR. -

- - -

[Index]

[TOC]

- -

ft_pixel_mode_xxx

-Defined in FT_IMAGE_H (ftimage.h). -

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

A list of deprecated constants. Use the corresponding FT_Pixel_Mode values instead.

values

- - - - -

ft_pixel_mode_none

See FT_PIXEL_MODE_NONE.

ft_pixel_mode_mono

See FT_PIXEL_MODE_MONO.

ft_pixel_mode_grays

See FT_PIXEL_MODE_GRAY.

ft_pixel_mode_pal2

See FT_PIXEL_MODE_GRAY2.

fields

+ + -

pointer	+ The data.
ft_pixel_mode_pal4	- See FT_PIXEL_MODE_GRAY4. +
length	+ The length of the data in bytes.

- - -

[Index]

[TOC]

- -

FT_Palette_Mode

-Defined in FT_IMAGE_H (ftimage.h). -

-
-  typedef enum  FT_Palette_Mode_
+
+
+[Index] [Top] [TOC]
+
+
+FT_MAKE_TAG
+Defined in FT_TYPES_H (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.
+
+
+[Index] [Top] [TOC]
+
+
+FT_Generic
+Defined in FT_TYPES_H (fttypes.h).
++  typedef struct  FT_Generic_
   {
-    ft_palette_mode_rgb = 0,
-    ft_palette_mode_rgba,
-
-    ft_palette_mode_max   /* do not remove */
-
-  } FT_Palette_Mode;
-
-

THIS TYPE IS DEPRECATED. DO NOT USE IT!

An enumeration type to describe the format of a bitmap palette, used with ft_pixel_mode_pal4 and ft_pixel_mode_pal8.

values

- -

ft_palette_mode_rgb

The palette is an array of 3-byte RGB records.

+ 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 ‘finalizer’ 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.
ft_palette_mode_rgba	- The palette is an array of 4-byte RGBA records. +
finalizer	+ A pointer to a ‘generic finalizer’ function, which will be called when the object is destroyed. If this field is set to NULL, no code will be called.

note

As ft_pixel_mode_pal2, pal4 and pal8 are currently unused by FreeType, these types are not handled by the library itself.

- - -

[Index]

[TOC]

- -

FT_Bitmap

-Defined in FT_IMAGE_H (ftimage.h). -

 
+
+[Index] [Top] [TOC]
+
+
+FT_Generic_Finalizer
+Defined in FT_TYPES_H (fttypes.h).
++  typedef void  (*FT_Generic_Finalizer)(void*  object);
+
+
+Describe a function used to destroy the ‘client’ 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.
+
+
+[Index] [Top] [TOC]
+
+
+FT_Bitmap
+Defined in FT_IMAGE_H (ftimage.h).
+   typedef struct  FT_Bitmap_
   {
-    int             rows;
-    int             width;
+    unsigned int    rows;
+    unsigned int    width;
     int             pitch;
     unsigned char*  buffer;
-    short           num_grays;
-    char            pixel_mode;
-    char            palette_mode;
+    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

+ +

fields

+ + - - - - - - -

rows	The number of bitmap rows.
width	+
width	The number of pixels in bitmap row.
pitch	+
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 ‘down’ flow, and negative when it has an ‘up’ flow. In all cases, the pitch is an offset to add to a bitmap pointer in order to go down one row. Note that ‘padding’ 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	+
buffer	A typeless pointer to the bitmap buffer. This value should be aligned on 32-bit boundaries in most cases.
num_grays	+
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	+
pixel_mode	The pixel mode, i.e., how pixel bits are stored. See FT_Pixel_Mode for possible values.
palette_mode	+
palette_mode	This field is intended for paletted pixel modes; it indicates how the palette is stored. Not used currently.
palette	+
palette	A typeless pointer to the bitmap palette; this field is intended for paletted pixel modes. Not used currently.

note

+ +

note

For now, the only pixel modes supported by FreeType are mono and grays. However, drivers might be added in the future to support more ‘colorful’ options.

- - -

[Index]

[TOC]

- -

FT_IMAGE_TAG

-Defined in FT_IMAGE_H (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 */
+
+[Index] [Top] [TOC]
 
-

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.

- - -

[Index]

[TOC]

- -

FT_Glyph_Format

-Defined in FT_IMAGE_H (ftimage.h). -

-
-  typedef enum  FT_Glyph_Format_
+
+FT_Pixel_Mode
+Defined in FT_IMAGE_H (ftimage.h).
++  typedef enum  FT_Pixel_Mode_
   {
-    FT_IMAGE_TAG( FT_GLYPH_FORMAT_NONE, 0, 0, 0, 0 ),
+    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_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_PIXEL_MODE_MAX      /* do not remove */
 
-  } FT_Glyph_Format;
+  } FT_Pixel_Mode;
 
-

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.

+ + /* 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_GLYPH_FORMAT_OUTLINE
	- The glyph image is a vectorial outline made of line segments and Bézier 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_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_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_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 ‘gray’ levels is stored in the ‘num_grays’ field of the FT_Bitmap structure (it generally is 256).

- - -

[Index]

[TOC]

- -

ft_glyph_format_xxx

-Defined in FT_IMAGE_H (ftimage.h). -

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

A list of deprecated constants. Use the corresponding FT_Glyph_Format values instead.

values

- - - - - - - - -

ft_glyph_format_none	- See FT_GLYPH_FORMAT_NONE. +
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_glyph_format_composite
	- See FT_GLYPH_FORMAT_COMPOSITE. +
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_glyph_format_bitmap	- See FT_GLYPH_FORMAT_BITMAP. +
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_glyph_format_outline
	- See FT_GLYPH_FORMAT_OUTLINE. +
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_glyph_format_plotter
	- See FT_GLYPH_FORMAT_PLOTTER. +
FT_PIXEL_MODE_BGRA	+ 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 ‘00,00,80,80’, not ‘00,00,FF,80’. See also FT_LOAD_COLOR.

- - -

[Index]

[TOC]

- -

FT_Data

-Defined in FT_TYPES_H (fttypes.h). -

 
-  typedef struct  FT_Data_
-  {
-    const FT_Byte*  pointer;
-    FT_Int          length;
+
+[Index] [Top] [TOC]
 
-  } FT_Data;
+
+FT_Glyph_Format
+Defined in FT_IMAGE_H (ftimage.h).
++  typedef enum  FT_Glyph_Format_
+  {
+    FT_IMAGE_TAG( FT_GLYPH_FORMAT_NONE, 0, 0, 0, 0 ),
 
-

Read-only binary data represented as a pointer and a length.

fields

- - - -

pointer	- The data. -
length	- The length of the data in bytes. -

- - -

[Index]

[TOC]

- -

FT_Generic_Finalizer

-Defined in FT_TYPES_H (fttypes.h). -

+    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' )
 
-  typedef void  (*FT_Generic_Finalizer)(void*  object);
+  } FT_Glyph_Format;
 
-

Describe a function used to destroy the ‘client’ 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.

- - -

[Index]

[TOC]

- -

FT_Generic

-Defined in FT_TYPES_H (fttypes.h). -

 
-  typedef struct  FT_Generic_
-  {
-    void*                 data;
-    FT_Generic_Finalizer  finalizer;
+  /* 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
+

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

fields

- -

data

A typeless pointer to any client-specified data. This field is completely ignored by the FreeType library.

values

+ + - + + +

FT_GLYPH_FORMAT_NONE	+ The value 0 is reserved.
finalizer	- A pointer to a ‘generic finalizer’ function, which will be called when the object is destroyed. If this field is set to NULL, no code will be called. +
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 Bézier 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.

- - -

[Index]

[TOC]

- -

FT_MAKE_TAG

-Defined in FT_TYPES_H (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.

- - -

[Index]

[TOC]

- -

FT_Int64

-Defined in FT_CONFIG_CONFIG_H (config/ftconfig.h). -

 
-  typedef signed XXX  FT_Int64;
+
+[Index] [Top] [TOC]
 
-

- - -

[Index]

[TOC]

FT_IMAGE_TAG

Defined in FT_IMAGE_H (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 */
+

FT_UInt64

-Defined in FT_CONFIG_CONFIG_H (config/ftconfig.h). -

This macro converts four-letter tags to an unsigned long type.

- typedef unsigned XXX FT_UInt64; +

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.

- - -

[Index]

[TOC]

[Index]

[Top]

[TOC]

diff --git a/freetype/docs/reference/ft2-bdf_fonts.html b/freetype/docs/reference/ft2-bdf_fonts.html index 92d887a92..daf2307c0 100644 --- a/freetype/docs/reference/ft2-bdf_fonts.html +++ b/freetype/docs/reference/ft2-bdf_fonts.html @@ -3,126 +3,169 @@ -FreeType-2.5.3 API Reference +FreeType-2.5.5 API Reference - - -

[Index]

[TOC]

FreeType-2.5.3 API Reference

[Index]

[TOC]

FreeType-2.5.5 API Reference

-BDF and PCF Files -

BDF and PCF Files

Synopsis

- - - -

	FT_PropertyType		BDF_PropertyRec		FT_Get_BDF_Property
	BDF_Property		FT_Get_BDF_Charset_ID

+ + + +

BDF_PropertyType	BDF_PropertyRec	FT_Get_BDF_Property
BDF_Property	FT_Get_BDF_Charset_ID

+ -

This section contains the declaration of functions specific to BDF and PCF fonts.

FT_PropertyType

-Defined in FT_BDF_H (ftbdf.h). -

 
+
+BDF_PropertyType
+Defined in FT_BDF_H (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_PROPERTY_TYPE_NONE     = 0,
+    BDF_PROPERTY_TYPE_ATOM     = 1,
+    BDF_PROPERTY_TYPE_INTEGER  = 2,
+    BDF_PROPERTY_TYPE_CARDINAL = 3
 
-  } BDF_PropertyType;
+  } BDF_PropertyType;
+
 
-

A list of BDF property types.

values

- -

BDF_PROPERTY_TYPE_NONE

+ +

values

+ + - - - - -

BDF_PROPERTY_TYPE_NONE	Value 0 is used to indicate a missing property.
BDF_PROPERTY_TYPE_ATOM	+
BDF_PROPERTY_TYPE_ATOM	Property is a string atom.
BDF_PROPERTY_TYPE_INTEGER
	+
BDF_PROPERTY_TYPE_INTEGER	Property is a 32-bit signed integer.
BDF_PROPERTY_TYPE_CARDINAL
	+
BDF_PROPERTY_TYPE_CARDINAL	Property is a 32-bit unsigned integer.

- - -

[Index]

[TOC]

- -

BDF_Property

-Defined in FT_BDF_H (ftbdf.h). -

 
+
+[Index] [Top] [TOC]
+
+
+BDF_Property
+Defined in FT_BDF_H (ftbdf.h).
+   typedef struct BDF_PropertyRec_*  BDF_Property;
+
 
-

A handle to a BDF_PropertyRec structure to model a given BDF/PCF property.

- - -

[Index]

[TOC]

- -

BDF_PropertyRec

-Defined in FT_BDF_H (ftbdf.h). -

 
+
+[Index] [Top] [TOC]
+
+
+BDF_PropertyRec
+Defined in FT_BDF_H (ftbdf.h).
+   typedef struct  BDF_PropertyRec_
   {
-    BDF_PropertyType  type;
+    BDF_PropertyType  type;
     union {
       const char*     atom;
       FT_Int32        integer;
@@ -131,130 +174,107 @@ Defined in FT_BDF_H (ftbdf.h).
     } u;
 
   } BDF_PropertyRec;
+
 
-

This structure models a given BDF/PCF property.

fields

- -

type

+ +

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.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.integer	+ A signed integer, if type is BDF_PROPERTY_TYPE_INTEGER.
u.cardinal	- An unsigned integer, if type is BDF_PROPERTY_TYPE_CARDINAL. +
u.cardinal	+ An unsigned integer, if type is BDF_PROPERTY_TYPE_CARDINAL.

- - -

[Index]

[TOC]

- -

FT_Get_BDF_Charset_ID

-Defined in FT_BDF_H (ftbdf.h). -

 
+
+[Index] [Top] [TOC]
+
+
+FT_Get_BDF_Charset_ID
+Defined in FT_BDF_H (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

+ +

input

+ +

face	A handle to the input face.

output

- -

acharset_encoding

+ +

output

+ + -

acharset_encoding	Charset encoding, as a C string, owned by the face.
acharset_registry	+
acharset_registry	Charset registry, as a C string, owned by the face.

return

+ +

return

FreeType error code. 0 means success.

note

+ +

note

This function only works with BDF faces, returning an error otherwise.

- - -

[Index]

[TOC]

- -

FT_Get_BDF_Property

-Defined in FT_BDF_H (ftbdf.h). -

 
+
+[Index] [Top] [TOC]
+
+
+FT_Get_BDF_Property
+Defined in FT_BDF_H (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

+ +

input

+ + -

face	A handle to the input face.
name	+
name	The property name.

output

- -

aproperty

+ +

output

+ +

aproperty

The property.

return

+ +

return

FreeType error code. 0 means success.

note

+ +

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 ‘property’ 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 ‘signed’ 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.

- - -

[Index]

[TOC]

Integer properties are always stored as ‘signed’ 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.

+ +

[Index]

[Top]

[TOC]

diff --git a/freetype/docs/reference/ft2-bitmap_handling.html b/freetype/docs/reference/ft2-bitmap_handling.html index b1d9f8853..a0eec744f 100644 --- a/freetype/docs/reference/ft2-bitmap_handling.html +++ b/freetype/docs/reference/ft2-bitmap_handling.html @@ -3,300 +3,313 @@ -FreeType-2.5.3 API Reference +FreeType-2.5.5 API Reference - - -

[Index]

[TOC]

FreeType-2.5.3 API Reference

[Index]

[TOC]

FreeType-2.5.5 API Reference

-Bitmap Handling -

Bitmap Handling

Synopsis

- - - -

	FT_Bitmap_New		FT_Bitmap_Embolden		FT_GlyphSlot_Own_Bitmap
	FT_Bitmap_Copy		FT_Bitmap_Convert		FT_Bitmap_Done

- -

This section contains functions for converting FT_Bitmap objects.

FT_Bitmap_New

-Defined in FT_BITMAP_H (ftbitmap.h). -

+
+
+
+FT_Bitmap_New FT_Bitmap_Embolden FT_GlyphSlot_Own_Bitmap
FT_Bitmap_Copy FT_Bitmap_Convert FT_Bitmap_Done
+
 
+This section contains functions for handling FT_Bitmap objects. Note that none of the functions changes the bitmap's ‘flow’ (as indicated by the sign of the ‘pitch’ field in ‘FT_Bitmap’).
+
+
+FT_Bitmap_New
+Defined in FT_BITMAP_H (ftbitmap.h).
+   FT_EXPORT( void )
   FT_Bitmap_New( FT_Bitmap  *abitmap );
+
 
-

Initialize a pointer to an FT_Bitmap structure.

inout

- -

abitmap

+ +

inout

+ +

abitmap

A pointer to the bitmap structure.

- - -

[Index]

[TOC]

- -

FT_Bitmap_Copy

-Defined in FT_BITMAP_H (ftbitmap.h). -

 
+
+[Index] [Top] [TOC]
+
+
+FT_Bitmap_Copy
+Defined in FT_BITMAP_H (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

+ +

input

+ + -

library	A handle to a library object.
source	+
source	A handle to the source bitmap.

output

- -

target

+ +

output

+ +

target

A handle to the target bitmap.

return

+ +

return

FreeType error code. 0 means success.

- - -

[Index]

[TOC]

- -

FT_Bitmap_Embolden

-Defined in FT_BITMAP_H (ftbitmap.h). -

 
+
+[Index] [Top] [TOC]
+
+
+FT_Bitmap_Embolden
+Defined in FT_BITMAP_H (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

+ +

input

+ + - -

library	A handle to a library object.
xStrength	+
xStrength	How strong the glyph is emboldened horizontally. Expressed in 26.6 pixel format.
yStrength	+
yStrength	How strong the glyph is emboldened vertically. Expressed in 26.6 pixel format.

inout

- -

bitmap

+ +

inout

+ +

bitmap

A handle to the target bitmap.

return

+ +

return

FreeType error code. 0 means success.

note

+ +

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.

- - -

[Index]

[TOC]

- -

FT_Bitmap_Convert

-Defined in FT_BITMAP_H (ftbitmap.h). -

+Bitmaps in FT_PIXEL_MODE_GRAY2 and FT_PIXEL_MODE_GRAY@ format are converted to FT_PIXEL_MODE_GRAY format (i.e., 8bpp).
+
+
+[Index] [Top] [TOC]
 
+
+FT_Bitmap_Convert
+Defined in FT_BITMAP_H (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 line (a.k.a. the ‘pitch’) a multiple of ‘alignment’.

input

- -

library

+ +

input

+ + - -

library	A handle to a library object.
source	+
source	The source bitmap.
alignment	+
alignment	The pitch of the bitmap is a multiple of this parameter. Common values are 1, 2, or 4.

output

- -

target

+ +

output

+ +

target

The target bitmap.

return

+ +

return

FreeType error code. 0 means success.

note

+ +

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.

- - -

[Index]

[TOC]

- -

FT_GlyphSlot_Own_Bitmap

-Defined in FT_BITMAP_H (ftbitmap.h). -

 
+
+[Index] [Top] [TOC]
+
+
+FT_GlyphSlot_Own_Bitmap
+Defined in FT_BITMAP_H (ftbitmap.h).
+   FT_EXPORT( FT_Error )
   FT_GlyphSlot_Own_Bitmap( FT_GlyphSlot  slot );
+
 
-

Make sure that a glyph slot owns ‘slot->bitmap’.

input

- -

slot

+ +

input

+ +

slot	The glyph slot.

return

+ +

return

FreeType error code. 0 means success.

note

+ +

note

This function is to be used in combination with FT_Bitmap_Embolden.

- - -

[Index]

[TOC]

- -

FT_Bitmap_Done

-Defined in FT_BITMAP_H (ftbitmap.h). -

 
+
+[Index] [Top] [TOC]
+
+
+FT_Bitmap_Done
+Defined in FT_BITMAP_H (ftbitmap.h).
+   FT_EXPORT( FT_Error )
   FT_Bitmap_Done( FT_Library  library,
                   FT_Bitmap  *bitmap );
+
 
-

Destroy a bitmap object created with FT_Bitmap_New.

input

- -

library

+ +

input

+ + -

library	A handle to a library object.
bitmap	+
bitmap	The bitmap object to be freed.

return

+ +

return

FreeType error code. 0 means success.

note

+ +

note

The ‘library’ argument is taken to have access to FreeType's memory handling functions.

- - -

[Index]

[TOC]

+ +

[Index]

[Top]

[TOC]

diff --git a/freetype/docs/reference/ft2-bzip2.html b/freetype/docs/reference/ft2-bzip2.html index 59e15464e..dc33973b1 100644 --- a/freetype/docs/reference/ft2-bzip2.html +++ b/freetype/docs/reference/ft2-bzip2.html @@ -3,92 +3,147 @@ -FreeType-2.5.3 API Reference +FreeType-2.5.5 API Reference - - -

[Index]

[TOC]

FreeType-2.5.3 API Reference

[Index]

[TOC]

FreeType-2.5.5 API Reference

-BZIP2 Streams -

BZIP2 Streams

Synopsis

- - -

FT_Stream_OpenBzip2

+ + +

FT_Stream_OpenBzip2

+ -

This section contains the declaration of Bzip2-specific functions.

FT_Stream_OpenBzip2

-Defined in FT_BZIP2_H (ftbzip2.h). -

 
+
+FT_Stream_OpenBzip2
+Defined in FT_BZIP2_H (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

+ +

input

+ + -

stream	The target embedding stream.
source	+
source	The source stream.

return

+ +

return

FreeType error code. 0 means success.

note

+ +

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.

The stream implementation is very basic and resets the decompression process each time seeking backwards is needed within the stream.

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.

This function may return ‘FT_Err_Unimplemented_Feature’ if your build of FreeType was not compiled with bzip2 support.

- - -

[Index]

[TOC]

+ +

[Index]

[Top]

[TOC]

diff --git a/freetype/docs/reference/ft2-cache_subsystem.html b/freetype/docs/reference/ft2-cache_subsystem.html index 772a29a6e..18650de7e 100644 --- a/freetype/docs/reference/ft2-cache_subsystem.html +++ b/freetype/docs/reference/ft2-cache_subsystem.html @@ -3,62 +3,128 @@ -FreeType-2.5.3 API Reference +FreeType-2.5.5 API Reference - - -

[Index]

[TOC]

FreeType-2.5.3 API Reference

[Index]

[TOC]

FreeType-2.5.5 API Reference

-Cache Sub-System -

Cache Sub-System

Synopsis

- - - - - - - - - - - - - - - -

	FTC_Manager		FTC_CMapCache_New
	FTC_FaceID		FTC_CMapCache_Lookup
	FTC_Face_Requester		FTC_ImageTypeRec
	FTC_Node		FTC_ImageType
	FTC_Manager_New		FTC_ImageCache
	FTC_Manager_Reset		FTC_ImageCache_New
	FTC_Manager_Done		FTC_ImageCache_Lookup
	FTC_Manager_LookupFace		FTC_ImageCache_LookupScaler
	FTC_ScalerRec		FTC_SBit
	FTC_Scaler		FTC_SBitRec
	FTC_Manager_LookupSize		FTC_SBitCache
	FTC_Node_Unref		FTC_SBitCache_New
	FTC_Manager_RemoveFaceID		FTC_SBitCache_Lookup
	FTC_CMapCache		FTC_SBitCache_LookupScaler

- -

+ + + + + + + + + + + + + + + + + + + + +

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:

@@ -72,135 +138,88 @@ Cache Sub-System

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

-Defined in FT_CACHE_H (ftcache.h). -

 
+
+FTC_Manager
+Defined in FT_CACHE_H (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 ‘nodes’ 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.

- - -

[Index]

[TOC]

- -

FTC_FaceID

-Defined in FT_CACHE_H (ftcache.h). -

 
+
+[Index] [Top] [TOC]
+
+
+FTC_FaceID
+Defined in FT_CACHE_H (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

+ +

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.

- - -

[Index]

[TOC]

- -

FTC_Face_Requester

-Defined in FT_CACHE_H (ftcache.h). -

 
+
+[Index] [Top] [TOC]
+
+
+FTC_Face_Requester
+Defined in FT_CACHE_H (ftcache.h).
+   typedef FT_Error
   (*FTC_Face_Requester)( FTC_FaceID  face_id,
                          FT_Library  library,
-                         FT_Pointer  request_data,
+                         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

+ +

input

+ + - -

face_id	The face ID to resolve.
library	+
library	A handle to a FreeType library object.
req_data	+
req_data	Application-provided request data (see note below).

output

- -

aface

+ +

output

+ +

aface

A new FT_Face handle.

return

+ +

return

FreeType error code. 0 means success.

note

+ +

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!

- - -

[Index]

[TOC]

- -

FTC_Node

-Defined in FT_CACHE_H (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 ‘acquire’ them, i.e., to increment their reference count. This will prevent the node from being flushed out of the cache until you explicitly ‘release’ it (see FTC_Node_Unref).

- - -

[Index]

[TOC]

- -

FTC_Manager_New

-Defined in FT_CACHE_H (ftcache.h). -

+
+[Index] [Top] [TOC]
 
+
+FTC_Manager_New
+Defined in FT_CACHE_H (ftcache.h).
+   FT_EXPORT( FT_Error )
   FTC_Manager_New( FT_Library          library,
                    FT_UInt             max_faces,
@@ -209,463 +228,574 @@ Defined in FT_CACHE_H (ftcache.h).
                    FTC_Face_Requester  requester,
                    FT_Pointer          req_data,
                    FTC_Manager        *amanager );
+
 
-

Create a new cache manager.

input

- -

library

+ +

input

+ + - - - - -

library	The parent FreeType library handle to use.
max_faces	+
max_faces	Maximum number of opened FT_Face objects managed by this cache instance. Use 0 for defaults.
max_sizes	+
max_sizes	Maximum number of opened FT_Size objects managed by this cache instance. Use 0 for defaults.
max_bytes	+
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	+
requester	An application-provided callback used to translate face IDs into real FT_Face objects.
req_data	+
req_data	A generic pointer that is passed to the requester each time it is called (see FTC_Face_Requester).

output

- -

amanager

+ +

output

+ +

amanager

A handle to a new manager object. 0 in case of failure.

return

+ +

return

FreeType error code. 0 means success.

- - -

[Index]

[TOC]

- -

FTC_Manager_Reset

-Defined in FT_CACHE_H (ftcache.h). -

 
+
+[Index] [Top] [TOC]
+
+
+FTC_Manager_Reset
+Defined in FT_CACHE_H (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

+ +

inout

+ +

manager

A handle to the manager.

- - -

[Index]

[TOC]

- -

FTC_Manager_Done

-Defined in FT_CACHE_H (ftcache.h). -

 
+
+[Index] [Top] [TOC]
+
+
+FTC_Manager_Done
+Defined in FT_CACHE_H (ftcache.h).
+   FT_EXPORT( void )
   FTC_Manager_Done( FTC_Manager  manager );
+
 
-

Destroy a given manager after emptying it.

input

- -

manager

+ +

input

+ +

manager

A handle to the target cache manager object.

- - -

[Index]

[TOC]

- -

FTC_Manager_LookupFace

-Defined in FT_CACHE_H (ftcache.h). -

 
+
+[Index] [Top] [TOC]
+
+
+FTC_Manager_LookupFace
+Defined in FT_CACHE_H (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

+ +

input

+ + -

manager	A handle to the cache manager.
face_id	+
face_id	The ID of the face object.

output

- -

aface

+ +

output

+ +

aface

A handle to the face object.

return

+ +

return

FreeType error code. 0 means success.

note

+ +

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 ‘font size’, 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.

- - -

[Index]

[TOC]

- -

FTC_ScalerRec

-Defined in FT_CACHE_H (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.

- - -

[Index]

[TOC]

- -

FTC_Scaler

-Defined in FT_CACHE_H (ftcache.h). -

-
-  typedef struct FTC_ScalerRec_*  FTC_Scaler;
-
-

A handle to an FTC_ScalerRec structure.

- - -

[Index]

[TOC]

- -

FTC_Manager_LookupSize

-Defined in FT_CACHE_H (ftcache.h). -

+
+[Index] [Top] [TOC]
 
+
+FTC_Manager_LookupSize
+Defined in FT_CACHE_H (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

+ +

input

+ + -

manager	A handle to the cache manager.
scaler	+
scaler	A scaler handle.

output

- -

asize

+ +

output

+ +

asize

A handle to the size object.

return

+ +

return

FreeType error code. 0 means success.

note

+ +

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

+ +

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.

- - -

[Index]

[TOC]

- -

FTC_Node_Unref

-Defined in FT_CACHE_H (ftcache.h). -

 
+
+[Index] [Top] [TOC]
+
+
+FTC_Manager_RemoveFaceID
+Defined in FT_CACHE_H (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.
+
+
+[Index] [Top] [TOC]
+
+
+FTC_Node
+Defined in FT_CACHE_H (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 ‘acquire’ them, i.e., to increment their reference count. This will prevent the node from being flushed out of the cache until you explicitly ‘release’ it (see FTC_Node_Unref).
+See also FTC_SBitCache_Lookup and FTC_ImageCache_Lookup.
+
+
+[Index] [Top] [TOC]
+
+
+FTC_Node_Unref
+Defined in FT_CACHE_H (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

+ +

input

+ + -

node	The cache node handle.
manager	+
manager	The cache manager handle.

- - -

[Index]

[TOC]

- -

FTC_Manager_RemoveFaceID

-Defined in FT_CACHE_H (ftcache.h). -

 
-  FT_EXPORT( void )
-  FTC_Manager_RemoveFaceID( FTC_Manager  manager,
-                            FTC_FaceID   face_id );
+
+[Index] [Top] [TOC]
 
-

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.

FTC_ImageCache

Defined in FT_CACHE_H (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.

+ +

[Index]

[Top]

[TOC]

+ +

FTC_ImageCache_New

Defined in FT_CACHE_H (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.
face_id	- The FTC_FaceID to be removed. +

+ +

output

+ +

acache

A handle to the new glyph image cache object.

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.

- - -

[Index]

[TOC]

- -

FTC_CMapCache

-Defined in FT_CACHE_H (ftcache.h). -

 
+return
+FreeType error code. 0 means success.
+
+
+[Index] [Top] [TOC]
+
+
+FTC_ImageCache_Lookup
+Defined in FT_CACHE_H (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 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 ‘release’ 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!
+
+
+[Index] [Top] [TOC]
+
+
+FTC_SBit
+Defined in FT_CACHE_H (ftcache.h).
++  typedef struct FTC_SBitRec_*  FTC_SBit;
+
+
+A handle to a small bitmap descriptor. See the FTC_SBitRec structure for details.
+
+
+[Index] [Top] [TOC]
+
+
+FTC_SBitCache
+Defined in FT_CACHE_H (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.
+
+
+[Index] [Top] [TOC]
+
+
+FTC_SBitCache_New
+Defined in FT_CACHE_H (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.
+
+
+[Index] [Top] [TOC]
+
+
+FTC_SBitCache_Lookup
+Defined in FT_CACHE_H (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 ‘lock’ 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 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 ‘release’ 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!
+
+
+[Index] [Top] [TOC]
+
+
+FTC_CMapCache
+Defined in FT_CACHE_H (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.

- - -

[Index]

[TOC]

- -

FTC_CMapCache_New

-Defined in FT_CACHE_H (ftcache.h). -

 
+
+[Index] [Top] [TOC]
+
+
+FTC_CMapCache_New
+Defined in FT_CACHE_H (ftcache.h).
+   FT_EXPORT( FT_Error )
   FTC_CMapCache_New( FTC_Manager     manager,
                      FTC_CMapCache  *acache );
+
 
-

Create a new charmap cache.

input

- -

manager

+ +

input

+ +

manager

A handle to the cache manager.

output

- -

acache

+ +

output

+ +

return

+ +

return

FreeType error code. 0 means success.

note

+ +

note

Like all other caches, this one will be destroyed with the cache manager.

- - -

[Index]

[TOC]

- -

FTC_CMapCache_Lookup

-Defined in FT_CACHE_H (ftcache.h). -

 
+
+[Index] [Top] [TOC]
+
+
+FTC_CMapCache_Lookup
+Defined in FT_CACHE_H (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

- -

- - -

[Index]

[TOC]

- -

FTC_ImageTypeRec

- - -

- -

- - -

- -

- - -

- -

- - -

- -

- - -

- -