* include/freetype/ftincrem.h, include/freetype/ftmodapi.h,

include/freetype/freetype.h: Documentation update
This commit is contained in:
David Turner 2006-04-21 08:35:11 +00:00
parent 7dc7f21533
commit 8e438ead71
4 changed files with 143 additions and 87 deletions

View File

@ -1,9 +1,14 @@
2006-04-21 David Turner <david@freetype.org>
* include/freetype/ftincrem.h, include/freetype/ftmodapi.h,
include/freetype/freetype.h: Documentation update
2006-04-13 David Turner <david@freetype.org> 2006-04-13 David Turner <david@freetype.org>
* src/autofit/afloader.c: removing superfluous code in the auto-fitter's * src/autofit/afloader.c: removing superfluous code in the auto-fitter's
loader loader
2006-04-05 Detlef Würkner <TetiSoft@apg.lahn.de> 2006-04-05 Detlef Wrkner <TetiSoft@apg.lahn.de>
* builds/amiga/makefile, builds/amiga/makefile.os4, * builds/amiga/makefile, builds/amiga/makefile.os4,
builds/amiga/smakefile: Added FT2_BUILD_LIBRARY define. builds/amiga/smakefile: Added FT2_BUILD_LIBRARY define.
@ -36,7 +41,7 @@
* builds/unix/install.mk (uninstall): Don't handle `cache' * builds/unix/install.mk (uninstall): Don't handle `cache'
directory which no longer exists. directory which no longer exists.
2006-03-29 Detlef Würkner <TetiSoft@apg.lahn.de> 2006-03-29 Detlef Wrkner <TetiSoft@apg.lahn.de>
* src/psaux/psconv.c: Changed some variables which are expected to * src/psaux/psconv.c: Changed some variables which are expected to
hold negative values from `char' to `FT_Char' to allow building with hold negative values from `char' to `FT_Char' to allow building with
@ -1615,7 +1620,7 @@
(tt_face_build_cmaps): Check table and offset correctly (equality is (tt_face_build_cmaps): Check table and offset correctly (equality is
missing). missing).
2005-11-15 Detlef Würkner <TetiSoft@apg.lahn.de> 2005-11-15 Detlef Wrkner <TetiSoft@apg.lahn.de>
* builds/amiga/smakefile: Adjusted the compiler options * builds/amiga/smakefile: Adjusted the compiler options
to the current sources, now really builds the gxvalid, gzip to the current sources, now really builds the gxvalid, gzip
@ -1633,7 +1638,7 @@
builds/mac/FreeType.ppc_carbon.make.txt: builds/mac/FreeType.ppc_carbon.make.txt:
Updated for MPW to build all available modules. Updated for MPW to build all available modules.
2005-11-21 Håvard Wall <haavardw@ifi.uio.no> 2005-11-21 H<EFBFBD>ard Wall <haavardw@ifi.uio.no>
* src/bdf/bdfdrivr.c (bdf_interpret_style, BDF_Face_Done): Fix small * src/bdf/bdfdrivr.c (bdf_interpret_style, BDF_Face_Done): Fix small
memory leak. memory leak.
@ -1692,14 +1697,14 @@
FT_Done_Memory), builds/win32/ftdebug.c (FT_Message, FT_Panic): FT_Done_Memory), builds/win32/ftdebug.c (FT_Message, FT_Panic):
s/FT_EXPORT/FT_BASE/. s/FT_EXPORT/FT_BASE/.
2005-11-17 Detlef Würkner <TetiSoft@apg.lahn.de> 2005-11-17 Detlef Wrkner <TetiSoft@apg.lahn.de>
* builds/amiga/src/base/ftdebug.c (FT_Trace_Get_Count, * builds/amiga/src/base/ftdebug.c (FT_Trace_Get_Count,
FT_Trace_Get_Name, FT_Message, FT_Panic), FT_Trace_Get_Name, FT_Message, FT_Panic),
builds/amiga/src/base/ftsystem.c (FT_New_Memory, FT_Done_Memory, builds/amiga/src/base/ftsystem.c (FT_New_Memory, FT_Done_Memory,
FT_Stream_Open): s/FT_EXPORT/FT_BASE/. FT_Stream_Open): s/FT_EXPORT/FT_BASE/.
2005-11-17 Detlef Würkner <TetiSoft@apg.lahn.de> 2005-11-17 Detlef Wrkner <TetiSoft@apg.lahn.de>
* builds/amiga/makefile, builds/amiga/makefile.os4, * builds/amiga/makefile, builds/amiga/makefile.os4,
builds/amiga/smakefile, builds/amiga/smakefile,
@ -1783,7 +1788,7 @@
* src/type1/t1afm.c (T1_Read_PFM): Zero offset means `no kerning * src/type1/t1afm.c (T1_Read_PFM): Zero offset means `no kerning
table available'. From Sergey Tolstov <stolstov@esri.com>. table available'. From Sergey Tolstov <stolstov@esri.com>.
2005-11-03 Ville Syrjälä <syrjala@sci.fi> 2005-11-03 Ville Syrj<EFBFBD><EFBFBD> <syrjala@sci.fi>
* src/base/ftobjs.c (FT_Open_Face): Avoid possible memory leak. * src/base/ftobjs.c (FT_Open_Face): Avoid possible memory leak.

View File

@ -3028,6 +3028,85 @@ FT_BEGIN_HEADER
FT_String* glyph_name ); FT_String* glyph_name );
/*************************************************************************
*
* @macro:
* FT_SUBGLYPH_FLAG_XXX
*
* @description:
* 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 ::
* FT_SUBGLYPH_FLAG_ARGS_ARE_XY_VALUES ::
* FT_SUBGLYPH_FLAG_ROUND_XY_TO_GRID ::
* FT_SUBGLYPH_FLAG_SCALE ::
* FT_SUBGLYPH_FLAG_XY_SCALE ::
* FT_SUBGLYPH_FLAG_2X2 ::
* FT_SUBGLYPH_FLAG_USE_MY_METRICS ::
*
*/
#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
/*************************************************************************
*
* @func:
* FT_Get_SubGlyph_Info
*
* @description:
* Retrieve a description of a given subglyph. Only use it if
* `glyph->format' is @FT_GLYPH_FORMAT_COMPOSITE, or an error is
* returned.
*
* @input:
* glyph ::
* The source glyph slot.
*
* sub_index ::
* The index of subglyph. Must be less than `glyph->num_subglyphs'.
*
* @output:
* p_index ::
* The glyph index of the subglyph.
*
* p_flags ::
* The subglyph flags, see @FT_SUBGLYPH_FLAG_XXX.
*
* p_arg1 ::
* The subglyph's first argument (if any).
*
* p_arg2 ::
* The subglyph's second argument (if any).
*
* p_transform ::
* The subglyph transformation (if any).
*
* @return:
* FreeType error code. 0 means success.
*
* @note:
* The values of *p_arg1, *p_arg2 and *p_transform must be interpreted
* depending on the flags returns in *p_flags. See the TrueType
* specification 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 );
/*************************************************************************/ /*************************************************************************/
/* */ /* */
@ -3227,85 +3306,6 @@ FT_BEGIN_HEADER
const FT_Matrix* matrix ); const FT_Matrix* matrix );
/*************************************************************************
*
* @macro:
* FT_SUBGLYPH_FLAG_XXX
*
* @description:
* 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 ::
* FT_SUBGLYPH_FLAG_ARGS_ARE_XY_VALUES ::
* FT_SUBGLYPH_FLAG_ROUND_XY_TO_GRID ::
* FT_SUBGLYPH_FLAG_SCALE ::
* FT_SUBGLYPH_FLAG_XY_SCALE ::
* FT_SUBGLYPH_FLAG_2X2 ::
* FT_SUBGLYPH_FLAG_USE_MY_METRICS ::
*
*/
#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
/*************************************************************************
*
* @func:
* FT_Get_SubGlyph_Info
*
* @description:
* Retrieve a description of a given subglyph. Only use it if
* `glyph->format' is @FT_GLYPH_FORMAT_COMPOSITE, or an error is
* returned.
*
* @input:
* glyph ::
* The source glyph slot.
*
* sub_index ::
* The index of subglyph. Must be less than `glyph->num_subglyphs'.
*
* @output:
* p_index ::
* The glyph index of the subglyph.
*
* p_flags ::
* The subglyph flags, see @FT_SUBGLYPH_FLAG_XXX.
*
* p_arg1 ::
* The subglyph's first argument (if any).
*
* p_arg2 ::
* The subglyph's second argument (if any).
*
* p_transform ::
* The subglyph transformation (if any).
*
* @return:
* FreeType error code. 0 means success.
*
* @note:
* The values of *p_arg1, *p_arg2 and *p_transform must be interpreted
* depending on the flags returns in *p_flags. See the TrueType
* specification 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 );
/* */ /* */

View File

@ -31,6 +31,32 @@
FT_BEGIN_HEADER FT_BEGIN_HEADER
/***************************************************************
*
* @section:
* incremental
*
* @title:
* Incremental Loading
*
* @abstract:
* Custom Glyph Loading
*
* @description:
* This section contains various functions used to perform
* so-called "incremental" glyph loading. This is a mode where
* all glyphs loaded from a given FT_Face are provided by the
* client application,
*
* Apart from that, all other tables are loaded normally from
* the font file. This mode is useful when FreeType is used
* within another engine, e.g. a Postscript Imaging Processor.
*
* to enable this mode, you must use @FT_Open_Face, passing
* an @FT_Parameter with the @FT_PARAM_TAG_INCREMENTAL tag
* and a @FT_Incremental_Interface value. See the comments
* for @FT_Incremental_InterfaceRec for an example.
*/
/*************************************************************************** /***************************************************************************
* *
@ -269,6 +295,14 @@ FT_BEGIN_HEADER
} FT_Incremental_InterfaceRec; } FT_Incremental_InterfaceRec;
/***
* @type: FT_Incremental_Interface
*
* @description:
* a pointer to a @FT_Incremental_InterfaceRec structure
*/
typedef FT_Incremental_InterfaceRec* FT_Incremental_Interface;
/*************************************************************************** /***************************************************************************
* *

View File

@ -255,7 +255,7 @@ FT_BEGIN_HEADER
FT_EXPORT( FT_Error ) FT_EXPORT( FT_Error )
FT_Done_Library( FT_Library library ); FT_Done_Library( FT_Library library );
/* */
typedef void typedef void
(*FT_DebugHook_Func)( void* arg ); (*FT_DebugHook_Func)( void* arg );
@ -307,6 +307,23 @@ FT_BEGIN_HEADER
FT_Add_Default_Modules( FT_Library library ); FT_Add_Default_Modules( FT_Library library );
/***************************************************************
*
* @section:
* ttengine
*
* @title:
* TrueType Engine
*
* @abstract:
* TrueType bytecode support
*
* @description:
* This section contains a function used to query the level
* of TrueType bytecode support compiled in this version of
* the library.
*/
/************************************************************************** /**************************************************************************
* *
* @enum: * @enum: