Commit 448d128ec5821ec8147d58950860de0d70d0f42f

Werner Lemberg 2012-04-24T15:25:54

Document that the auto-hinter needs a valid cmap.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
diff --git a/include/freetype/freetype.h b/include/freetype/freetype.h
index 6fe1166..f7dd889 100644
--- a/include/freetype/freetype.h
+++ b/include/freetype/freetype.h
@@ -2507,6 +2507,13 @@ FT_BEGIN_HEADER
    *   Besides deciding which hinter to use, you can also decide which
    *   hinting algorithm to use.  See @FT_LOAD_TARGET_XXX for details.
    *
+   *   Note that the auto-hinter needs a valid Unicode cmap (either a native
+   *   one or synthesized by FreeType) for producing correct results.  If a
+   *   font provides an incorrect mapping (for example, assigning the
+   *   character code U+005A, LATIN CAPITAL LETTER Z, to a glyph depicting a
+   *   mathematical integral sign), the auto-hinter might produce useless
+   *   results.
+   *
    */
 #define FT_LOAD_DEFAULT                      0x0
 #define FT_LOAD_NO_SCALE                     ( 1L << 0 )