Commit e592982a836c41050600d63ecf449ff8ab6a9a76
2021-07-13T10:00:22
[sdf] Improve documentation.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39
diff --git a/include/freetype/freetype.h b/include/freetype/freetype.h
index 29a0f71..f393e3d 100644
--- a/include/freetype/freetype.h
+++ b/include/freetype/freetype.h
@@ -3307,13 +3307,13 @@ FT_BEGIN_HEADER
* pixels and use the @FT_PIXEL_MODE_LCD_V mode.
*
* FT_RENDER_MODE_SDF ::
- * This mode corresponds to 8-bit signed distance fields (SDF)
- * bitmaps. Each pixel in a SDF bitmap contains information about the
- * nearest edge of the glyph outline. The distances are calculated
- * from the center of the pixel and are positive if they are filled by
- * the outline (i.e., inside the outline) and negative otherwise.
- * Check the note below on how to convert the output values to usable
- * data.
+ * This mode corresponds to 8-bit, single-channel signed distance field
+ * (SDF) bitmaps. Each pixel in the SDF grid is the value from the
+ * pixel's position to the nearest glyph's outline. The distances are
+ * calculated from the center of the pixel and are positive if they are
+ * filled by the outline (i.e., inside the outline) and negative
+ * otherwise. Check the note below on how to convert the output values
+ * to usable data.
*
* @note:
* The selected render mode only affects vector glyphs of a font.
diff --git a/src/sdf/ftsdf.c b/src/sdf/ftsdf.c
index 65a8f32..d3722b1 100644
--- a/src/sdf/ftsdf.c
+++ b/src/sdf/ftsdf.c
@@ -41,7 +41,8 @@
* file `ftbsdf.c` for more.
*
* * The basic idea of generating the SDF is taken from Viktor Chlumsky's
- * research paper.
+ * research paper. The paper explains both single and multi-channel
+ * SDF, however, this implementation only generates single-channel SDF.
*
* Chlumsky, Viktor: Shape Decomposition for Multi-channel Distance
* Fields. Master's thesis. Czech Technical University in Prague,