Commit 8e438ead7103b6d017aaaac7d4ab29272094de2d
2006-04-21T08:35:11
* include/freetype/ftincrem.h, include/freetype/ftmodapi.h, include/freetype/freetype.h: Documentation update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338
diff --git a/ChangeLog b/ChangeLog
index 1b511e0..1ad62c8 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -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>
* src/autofit/afloader.c: removing superfluous code in the auto-fitter's
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/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 <TetiSoft@apg.lahn.de>
+2006-03-29 Detlef Wrkner <TetiSoft@apg.lahn.de>
* 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 <TetiSoft@apg.lahn.de>
+2005-11-15 Detlef Wrkner <TetiSoft@apg.lahn.de>
* 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 <haavardw@ifi.uio.no>
+2005-11-21 H�ard Wall <haavardw@ifi.uio.no>
* src/bdf/bdfdrivr.c (bdf_interpret_style, BDF_Face_Done): Fix small
memory leak.
@@ -1692,14 +1697,14 @@
FT_Done_Memory), builds/win32/ftdebug.c (FT_Message, FT_Panic):
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,
FT_Trace_Get_Name, FT_Message, FT_Panic),
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 <TetiSoft@apg.lahn.de>
+2005-11-17 Detlef Wrkner <TetiSoft@apg.lahn.de>
* 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 <stolstov@esri.com>.
-2005-11-03 Ville Syrjälä <syrjala@sci.fi>
+2005-11-03 Ville Syrj�� <syrjala@sci.fi>
* src/base/ftobjs.c (FT_Open_Face): Avoid possible memory leak.
diff --git a/include/freetype/freetype.h b/include/freetype/freetype.h
index 2674563..3f3925f 100644
--- a/include/freetype/freetype.h
+++ b/include/freetype/freetype.h
@@ -3028,6 +3028,85 @@ FT_BEGIN_HEADER
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 );
- /*************************************************************************
- *
- * @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 );
-
/* */
diff --git a/include/freetype/ftincrem.h b/include/freetype/ftincrem.h
index 457c2ee..6cf3c2d 100644
--- 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.
+ */
/***************************************************************************
*
@@ -269,6 +295,14 @@ FT_BEGIN_HEADER
} FT_Incremental_InterfaceRec;
+ /***
+ * @type: FT_Incremental_Interface
+ *
+ * @description:
+ * a pointer to a @FT_Incremental_InterfaceRec structure
+ */
+ typedef FT_Incremental_InterfaceRec* FT_Incremental_Interface;
+
/***************************************************************************
*
diff --git a/include/freetype/ftmodapi.h b/include/freetype/ftmodapi.h
index 24cddd6..bb6c342 100644
--- a/include/freetype/ftmodapi.h
+++ b/include/freetype/ftmodapi.h
@@ -255,7 +255,7 @@ FT_BEGIN_HEADER
FT_EXPORT( FT_Error )
FT_Done_Library( FT_Library library );
-
+/* */
typedef void
(*FT_DebugHook_Func)( void* arg );
@@ -307,6 +307,23 @@ FT_BEGIN_HEADER
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: