FreeType-2.1.10 API Reference
Header File Macros
Synopsis
#FT_CONFIG_CONFIG_H
FT_CONFIG_CONFIG_H
#FT_TRUETYPE_TABLES_H
FT_TRUETYPE_TABLES_H
#FT_CONFIG_STANDARD_LIBRARY_H
FT_CONFIG_STANDARD_LIBRARY_H
#FT_TRUETYPE_TAGS_H
FT_TRUETYPE_TAGS_H
#FT_CONFIG_OPTIONS_H
FT_CONFIG_OPTIONS_H
#FT_BDF_H
FT_BDF_H
#FT_CONFIG_MODULES_H
FT_CONFIG_MODULES_H
#FT_GZIP_H
FT_GZIP_H
#FT_FREETYPE_H
FT_FREETYPE_H
#FT_LZW_H
FT_LZW_H
#FT_ERRORS_H
FT_ERRORS_H
#FT_WINFONTS_H
FT_WINFONTS_H
#FT_MODULE_ERRORS_H
FT_MODULE_ERRORS_H
#FT_GLYPH_H
FT_GLYPH_H
#FT_SYSTEM_H
FT_SYSTEM_H
#FT_BITMAP_H
FT_BITMAP_H
#FT_IMAGE_H
FT_IMAGE_H
#FT_BBOX_H
FT_BBOX_H
#FT_TYPES_H
FT_TYPES_H
#FT_CACHE_H
FT_CACHE_H
#FT_LIST_H
FT_LIST_H
#FT_CACHE_IMAGE_H
FT_CACHE_IMAGE_H
#FT_OUTLINE_H
FT_OUTLINE_H
#FT_CACHE_SMALL_BITMAPS_H
FT_CACHE_SMALL_BITMAPS_H
#FT_SIZES_H
FT_SIZES_H
#FT_CACHE_CHARMAP_H
FT_CACHE_CHARMAP_H
#FT_MODULE_H
FT_MODULE_H
#FT_MAC_H
FT_MAC_H
#FT_RENDER_H
FT_RENDER_H
#FT_MULTIPLE_MASTERS_H
FT_MULTIPLE_MASTERS_H
#FT_TYPE1_TABLES_H
FT_TYPE1_TABLES_H
#FT_SFNT_NAMES_H
FT_SFNT_NAMES_H
#FT_TRUETYPE_IDS_H
FT_TRUETYPE_IDS_H
#FT_OPENTYPE_VALIDATE_H
FT_OPENTYPE_VALIDATE_H
The following macros are defined to the name of specific FreeType 2 header files. They can be used directly in #include statements as in:
#include FT_FREETYPE_H
#include FT_MULTIPLE_MASTERS_H
#include FT_GLYPH_H
There are several reasons why we are now using macros to name public header files. The first one is that such macros are not limited to the infamous 8.3 naming rule required by DOS (and `FT_MULTIPLE_MASTERS_H' is a lot more meaningful than `ftmm.h').
The second reason is that is allows for more flexibility in the way FreeType 2 is installed on a given system.
FT_CONFIG_CONFIG_H
#ifndef
FT_CONFIG_CONFIG_H
#define
FT_CONFIG_CONFIG_H
<freetype/config/ftconfig.h>
#endif
A macro used in #include statements to name the file containing FreeType 2 configuration data.
FT_CONFIG_STANDARD_LIBRARY_H
#ifndef
FT_CONFIG_STANDARD_LIBRARY_H
#define
FT_CONFIG_STANDARD_LIBRARY_H
<freetype/config/ftstdlib.h>
#endif
A macro used in #include statements to name the file containing FreeType 2 configuration data.
FT_CONFIG_OPTIONS_H
#ifndef
FT_CONFIG_OPTIONS_H
#define
FT_CONFIG_OPTIONS_H
<freetype/config/ftoption.h>
#endif
A macro used in #include statements to name the file containing FreeType 2 project-specific configuration options.
FT_CONFIG_MODULES_H
#ifndef
FT_CONFIG_MODULES_H
#define
FT_CONFIG_MODULES_H
<freetype/config/ftmodule.h>
#endif
/* public headers */
A macro used in #include statements to name the file containing the list of FreeType 2 modules that are statically linked to new library instances in
ft2-base_interface.html#FT_Init_FreeType
FT_Init_FreeType
.
FT_FREETYPE_H
#define
FT_FREETYPE_H
<freetype/freetype.h>
A macro used in #include statements to name the file containing the base FreeType 2 API.
FT_ERRORS_H
#define
FT_ERRORS_H
<freetype/fterrors.h>
A macro used in #include statements to name the file containing the list of FreeType 2 error codes (and messages).
It is included by
ft2-header_file_macros.html#FT_FREETYPE_H
FT_FREETYPE_H
.
FT_MODULE_ERRORS_H
#define
FT_MODULE_ERRORS_H
<freetype/ftmoderr.h>
A macro used in #include statements to name the file containing the list of FreeType 2 module error offsets (and messages).
FT_SYSTEM_H
#define
FT_SYSTEM_H
<freetype/ftsystem.h>
A macro used in #include statements to name the file containing the FreeType 2 interface to low-level operations (i.e. memory management and stream i/o).
It is included by
ft2-header_file_macros.html#FT_FREETYPE_H
FT_FREETYPE_H
.
FT_IMAGE_H
#define
FT_IMAGE_H
<freetype/ftimage.h>
A macro used in #include statements to name the file containing types definitions related to glyph images (i.e. bitmaps, outlines, scan-converter parameters).
It is included by
ft2-header_file_macros.html#FT_FREETYPE_H
FT_FREETYPE_H
.
FT_TYPES_H
#define
FT_TYPES_H
<freetype/fttypes.h>
A macro used in #include statements to name the file containing the basic data types defined by FreeType 2.
It is included by
ft2-header_file_macros.html#FT_FREETYPE_H
FT_FREETYPE_H
.
FT_LIST_H
#define
FT_LIST_H
<freetype/ftlist.h>
A macro used in #include statements to name the file containing the list management API of FreeType 2.
(Most applications will never need to include this file.)
FT_OUTLINE_H
#define
FT_OUTLINE_H
<freetype/ftoutln.h>
A macro used in #include statements to name the file containing the scalable outline management API of FreeType 2.
FT_SIZES_H
#define
FT_SIZES_H
<freetype/ftsizes.h>
A macro used in #include statements to name the file containing the API used to manage multiple
ft2-base_interface.html#FT_Size
FT_Size
objects per face.
FT_MODULE_H
#define
FT_MODULE_H
<freetype/ftmodapi.h>
A macro used in #include statements to name the file containing the module management API of FreeType 2.
FT_RENDER_H
#define
FT_RENDER_H
<freetype/ftrender.h>
A macro used in #include statements to name the file containing the renderer module management API of FreeType 2.
FT_TYPE1_TABLES_H
#define
FT_TYPE1_TABLES_H
<freetype/t1tables.h>
A macro used in #include statements to name the file containing the types and API specific to the Type 1 format.
FT_TRUETYPE_IDS_H
#define
FT_TRUETYPE_IDS_H
<freetype/ttnameid.h>
A macro used in #include statements to name the file containing the enumeration values used to identify name strings, languages, encodings, etc. This file really contains a
large
set of constant macro definitions, taken from the TrueType and OpenType specifications.
FT_TRUETYPE_TABLES_H
#define
FT_TRUETYPE_TABLES_H
<freetype/tttables.h>
A macro used in #include statements to name the file containing the types and API specific to the TrueType (as well as OpenType) format.
FT_TRUETYPE_TAGS_H
#define
FT_TRUETYPE_TAGS_H
<freetype/tttags.h>
A macro used in #include statements to name the file containing the definitions of TrueType 4-byte `tags' used to identify blocks in SFNT-based font formats (i.e. TrueType and OpenType).
FT_BDF_H
#define
FT_BDF_H
<freetype/ftbdf.h>
A macro used in #include statements to name the file containing the definitions of an API to access BDF-specific strings from a face.
FT_GZIP_H
#define
FT_GZIP_H
<freetype/ftgzip.h>
A macro used in #include statements to name the file containing the definitions of an API to support for gzip-compressed files.
FT_LZW_H
#define
FT_LZW_H
<freetype/ftlzw.h>
A macro used in #include statements to name the file containing the definitions of an API to support for LZW-compressed files.
FT_WINFONTS_H
#define
FT_WINFONTS_H
<freetype/ftwinfnt.h>
A macro used in #include statements to name the file containing the definitions of an API to support Windows .FNT files
FT_GLYPH_H
#define
FT_GLYPH_H
<freetype/ftglyph.h>
A macro used in #include statements to name the file containing the API of the optional glyph management component.
FT_BITMAP_H
#define
FT_BITMAP_H
<freetype/ftbitmap.h>
A macro used in #include statements to name the file containing the API of the optional bitmap conversion component.
FT_BBOX_H
#define
FT_BBOX_H
<freetype/ftbbox.h>
A macro used in #include statements to name the file containing the API of the optional exact bounding box computation routines.
FT_CACHE_H
#define
FT_CACHE_H
<freetype/ftcache.h>
A macro used in #include statements to name the file containing the API of the optional FreeType 2 cache sub-system.
FT_CACHE_IMAGE_H
#define
FT_CACHE_IMAGE_H
ft2-header_file_macros.html#FT_CACHE_H
FT_CACHE_H
A macro used in #include statements to name the file containing the `glyph image' API of the FreeType 2 cache sub-system.
It is used to define a cache for
ft2-glyph_management.html#FT_Glyph
FT_Glyph
elements. You can also see the API defined in
ft2-header_file_macros.html#FT_CACHE_SMALL_BITMAPS_H
FT_CACHE_SMALL_BITMAPS_H
if you only need to store small glyph bitmaps, as it will use less memory.
This macro is deprecated. Simply include
ft2-header_file_macros.html#FT_CACHE_H
FT_CACHE_H
to have all glyph image-related cache declarations.
FT_CACHE_SMALL_BITMAPS_H
#define
FT_CACHE_SMALL_BITMAPS_H
ft2-header_file_macros.html#FT_CACHE_H
FT_CACHE_H
A macro used in #include statements to name the file containing the `small bitmaps' API of the FreeType 2 cache sub-system.
It is used to define a cache for small glyph bitmaps in a relatively memory-efficient way. You can also use the API defined in
ft2-header_file_macros.html#FT_CACHE_IMAGE_H
FT_CACHE_IMAGE_H
if you want to cache arbitrary glyph images, including scalable outlines.
This macro is deprecated. Simply include
ft2-header_file_macros.html#FT_CACHE_H
FT_CACHE_H
to have all small bitmaps-related cache declarations.
FT_CACHE_CHARMAP_H
#define
FT_CACHE_CHARMAP_H
ft2-header_file_macros.html#FT_CACHE_H
FT_CACHE_H
A macro used in #include statements to name the file containing the `charmap' API of the FreeType 2 cache sub-system.
This macro is deprecated. Simply include
ft2-header_file_macros.html#FT_CACHE_H
FT_CACHE_H
to have all charmap-based cache declarations.
FT_MAC_H
#define
FT_MAC_H
<freetype/ftmac.h>
A macro used in #include statements to name the file containing the Macintosh-specific FreeType 2 API. The latter is used to access fonts embedded in resource forks.
This header file must be explicitly included by client applications compiled on the Mac (note that the base API still works though).
FT_MULTIPLE_MASTERS_H
#define
FT_MULTIPLE_MASTERS_H
<freetype/ftmm.h>
A macro used in #include statements to name the file containing the optional multiple-masters management API of FreeType 2.
FT_SFNT_NAMES_H
#define
FT_SFNT_NAMES_H
<freetype/ftsnames.h>
A macro used in #include statements to name the file containing the optional FreeType 2 API used to access embedded `name' strings in SFNT-based font formats (i.e. TrueType and OpenType).
FT_OPENTYPE_VALIDATE_H
#define
FT_OPENTYPE_VALIDATE_H
<freetype/ftotval.h>
A macro used in #include statements to name the file containing the optional FreeType 2 API used to validate OpenType tables (BASE, GDEF, GPOS, GSUB, JSTF).
