shithub: freetype+ttf2subf

Download patch

ref: 8e438ead7103b6d017aaaac7d4ab29272094de2d
parent: 7dc7f21533899dcbbc6a4dca4c2013bf808ec055
author: David Turner <[email protected]>
date: Fri Apr 21 04:35:11 EDT 2006

* include/freetype/ftincrem.h, include/freetype/ftmodapi.h,
  include/freetype/freetype.h: Documentation update

git/fs: mount .git/fs: mount/attach disallowed
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,9 +1,14 @@
+2006-04-21  David Turner  <[email protected]>
+
+  * include/freetype/ftincrem.h, include/freetype/ftmodapi.h,
+  include/freetype/freetype.h: Documentation update
+
 2006-04-13  David Turner  <[email protected]>
 
   * src/autofit/afloader.c: removing superfluous code in the auto-fitter's
   loader
 
-2006-04-05  Detlef W�rkner  <[email protected]>
+2006-04-05  Detlef Wrkner  <[email protected]>
 
 	* builds/amiga/makefile, builds/amiga/makefile.os4,
 	builds/amiga/smakefile: Added FT2_BUILD_LIBRARY define.
@@ -36,7 +41,7 @@
 	* builds/unix/install.mk (uninstall): Don't handle `cache'
 	directory which no longer exists.
 
-2006-03-29  Detlef W�rkner  <[email protected]>
+2006-03-29  Detlef Wrkner  <[email protected]>
 
 	* src/psaux/psconv.c: Changed some variables which are expected to
 	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
 	missing).
 
-2005-11-15  Detlef W�rkner  <[email protected]>
+2005-11-15  Detlef Wrkner  <[email protected]>
 
 	* builds/amiga/smakefile: Adjusted the compiler options
 	to the current sources, now really builds the gxvalid, gzip
@@ -1633,7 +1638,7 @@
 	builds/mac/FreeType.ppc_carbon.make.txt:
 	Updated for MPW to build all available modules.
 
-2005-11-21  H�vard Wall  <[email protected]>
+2005-11-21  H�ard Wall  <[email protected]>
 
 	* src/bdf/bdfdrivr.c (bdf_interpret_style, BDF_Face_Done): Fix small
 	memory leak.
@@ -1692,7 +1697,7 @@
 	FT_Done_Memory), builds/win32/ftdebug.c (FT_Message, FT_Panic):
 	s/FT_EXPORT/FT_BASE/.
 
-2005-11-17  Detlef W�rkner  <[email protected]>
+2005-11-17  Detlef Wrkner  <[email protected]>
 
 	* builds/amiga/src/base/ftdebug.c (FT_Trace_Get_Count,
 	FT_Trace_Get_Name, FT_Message, FT_Panic),
@@ -1699,7 +1704,7 @@
 	builds/amiga/src/base/ftsystem.c (FT_New_Memory, FT_Done_Memory,
 	FT_Stream_Open): s/FT_EXPORT/FT_BASE/.
 
-2005-11-17  Detlef W�rkner  <[email protected]>
+2005-11-17  Detlef Wrkner  <[email protected]>
 
 	* builds/amiga/makefile, builds/amiga/makefile.os4,
 	builds/amiga/smakefile,
@@ -1783,7 +1788,7 @@
 	* src/type1/t1afm.c (T1_Read_PFM): Zero offset means `no kerning
 	table available'.  From Sergey Tolstov <[email protected]>.
 
-2005-11-03  Ville Syrj�l�  <[email protected]>
+2005-11-03  Ville Syrj�� <[email protected]>
 
 	* src/base/ftobjs.c (FT_Open_Face): Avoid possible memory leak.
 
--- a/include/freetype/freetype.h
+++ b/include/freetype/freetype.h
@@ -3028,7 +3028,86 @@
                      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 );
+
+
   /*************************************************************************/
   /*                                                                       */
   /* <Section>                                                             */
@@ -3226,85 +3305,6 @@
   FT_Vector_Transform( FT_Vector*        vec,
                        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 );
 
   /* */
 
--- a/include/freetype/ftincrem.h
+++ b/include/freetype/ftincrem.h
@@ -31,6 +31,32 @@
 
 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.
+  */
 
  /***************************************************************************
   *
@@ -268,6 +294,14 @@
     FT_Incremental                  object;
   
   } FT_Incremental_InterfaceRec;
+
+ /***
+  * @type: FT_Incremental_Interface
+  *
+  * @description:
+  *   a pointer to a @FT_Incremental_InterfaceRec structure
+  */
+  typedef FT_Incremental_InterfaceRec*   FT_Incremental_Interface;
 
 
  /***************************************************************************
--- a/include/freetype/ftmodapi.h
+++ b/include/freetype/ftmodapi.h
@@ -255,8 +255,8 @@
   FT_EXPORT( FT_Error )
   FT_Done_Library( FT_Library  library );
 
+/* */
 
-
   typedef void
   (*FT_DebugHook_Func)( void*  arg );
 
@@ -306,6 +306,23 @@
   FT_EXPORT( void )
   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.
+  */
 
   /**************************************************************************
    *