Commit 4bf221964ca0f1db75c3fb7b08984fd50314a0a9

Werner Lemberg 2011-06-29T09:45:51

Improve documentation of FT_Get_Glyph_Name.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
diff --git a/include/freetype/freetype.h b/include/freetype/freetype.h
index a0a3530..fcdc258 100644
--- a/include/freetype/freetype.h
+++ b/include/freetype/freetype.h
@@ -2916,6 +2916,10 @@ FT_BEGIN_HEADER
   /*    The glyph name is truncated to fit within the buffer if it is too  */
   /*    long.  The returned string is always zero-terminated.              */
   /*                                                                       */
+  /*    Be aware that FreeType reorders glyph indices internally so that   */
+  /*    glyph index~0 always corresponds to the `missing glyph' (called    */
+  /*    `.notdef').                                                        */
+  /*                                                                       */
   /*    This function is not compiled within the library if the config     */
   /*    macro `FT_CONFIG_OPTION_NO_GLYPH_NAMES' is defined in              */
   /*    `include/freetype/config/ftoptions.h'.                             */