Improve documentation of FT_Get_Glyph_Name.

14 years ago · 4bf221964c
parent 96ddc679be
commit 4bf221964c
1 changed files with 4 additions and 0 deletions
--- 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'.                             */