ref: 350444d4809fc7b3c19e2eafe86e33b036b99124
parent: c4bdb7357186a820e6064d10cc6fb71d1b4cb26f
author: Werner Lemberg <[email protected]>
date: Mon Nov 2 03:12:45 EST 2009
Improve documentation of the various advance values.
--- a/include/freetype/freetype.h
+++ b/include/freetype/freetype.h
@@ -231,6 +231,10 @@
/* vertAdvance :: */
/* Advance height for vertical layout. */
/* */
+ /* <Note> */
+ /* If not disabled with @FT_LOAD_NO_HINTING, the values represent */
+ /* dimensions of the hinted glyph (in case hinting is applicable). */
+ /* */
typedef struct FT_Glyph_Metrics_
{FT_Pos width;
@@ -1477,8 +1481,13 @@
/* important to perform correct WYSIWYG layout. */
/* Only relevant for outline glyphs. */
/* */
- /* advance :: This is the transformed advance width for the */
- /* glyph (in 26.6 fractional pixel format). */
+ /* advance :: This shorthand is, depending on */
+ /* @FT_LOAD_IGNORE_TRANSFORM, the transformed */
+ /* 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 :: This field indicates the format of the image */
/* contained in the glyph slot. Typically */