summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorWerner Lemberg <wl@gnu.org>2022-07-02 09:34:13 +0200
committerWerner Lemberg <wl@gnu.org>2022-07-02 09:34:13 +0200
commit31005d98a43803d161773193286d0c34d78f4fea (patch)
tree51d295c00796717a2eeb836fdc4ef2b430e3be6d
parentbec4ef415ef07ad1fa9542978136d9863dd7a6d0 (diff)
downloadfreetype2-31005d98a43803d161773193286d0c34d78f4fea.tar.gz
include/freetype/ftmm.h: Improve documentation.
-rw-r--r--include/freetype/ftmm.h17
1 files changed, 13 insertions, 4 deletions
diff --git a/include/freetype/ftmm.h b/include/freetype/ftmm.h
index c74ce618c..e98302127 100644
--- a/include/freetype/ftmm.h
+++ b/include/freetype/ftmm.h
@@ -398,6 +398,10 @@ FT_BEGIN_HEADER
* FreeType error code. 0~means success.
*
* @note:
+ * The design coordinates are 16.16 fractional values for TrueType GX and
+ * OpenType variation fonts. For Adobe MM fonts, the values are
+ * integers.
+ *
* [Since 2.8.1] To reset all axes to the default values, call the
* function with `num_coords` set to zero and `coords` set to `NULL`.
* [Since 2.9] 'Default values' means the currently selected named
@@ -440,6 +444,11 @@ FT_BEGIN_HEADER
* @return:
* FreeType error code. 0~means success.
*
+ * @note:
+ * The design coordinates are 16.16 fractional values for TrueType GX and
+ * OpenType variation fonts. For Adobe MM fonts, the values are
+ * integers.
+ *
* @since:
* 2.7.1
*/
@@ -471,9 +480,9 @@ FT_BEGIN_HEADER
* the number of axes, use default values for the remaining axes.
*
* coords ::
- * The design coordinates array (each element must be between 0 and 1.0
- * for Adobe MM fonts, and between -1.0 and 1.0 for TrueType GX and
- * OpenType variation fonts).
+ * The design coordinates array. Each element is a 16.16 fractional
+ * value and must be between 0 and 1.0 for Adobe MM fonts, and between
+ * -1.0 and 1.0 for TrueType GX and OpenType variation fonts.
*
* @return:
* FreeType error code. 0~means success.
@@ -518,7 +527,7 @@ FT_BEGIN_HEADER
*
* @output:
* coords ::
- * The normalized blend coordinates array.
+ * The normalized blend coordinates array (as 16.16 fractional values).
*
* @return:
* FreeType error code. 0~means success.