Commit 9e7748f55c971ae97399da544596f70feaee74d9

Werner Lemberg 2016-11-17T08:04:52

Improve documentation of `lsb_delta' and `rsb_delta' (#19044).

diff --git a/include/freetype/freetype.h b/include/freetype/freetype.h
index f3287b7..d979605 100644
--- a/include/freetype/freetype.h
+++ b/include/freetype/freetype.h
@@ -1731,7 +1731,6 @@ FT_BEGIN_HEADER
   /*    position (e.g., coordinates (0,0) on the baseline).  Of course,    */
   /*    `slot->format' is also changed to @FT_GLYPH_FORMAT_BITMAP.         */
   /*                                                                       */
-  /* <Note>                                                                */
   /*    Here is a small pseudo code fragment that shows how to use         */
   /*    `lsb_delta' and `rsb_delta':                                       */
   /*                                                                       */
@@ -1759,6 +1758,12 @@ FT_BEGIN_HEADER
   /*      endfor                                                           */
   /*    }                                                                  */
   /*                                                                       */
+  /*    If you use strong auto-hinting, you *must* apply these delta       */
+  /*    values!  Otherwise you will experience far too large inter-glyph   */
+  /*    spacing at small rendering sizes in most cases.  Note that it      */
+  /*    doesn't harm to use the above code for other hinting modes also,   */
+  /*    since the delta values are zero then.                              */
+  /*                                                                       */
   typedef struct  FT_GlyphSlotRec_
   {
     FT_Library        library;