rgraves
/
freetype2
forked from minhngoc25a/freetype2
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

include/freetype/ftmm.h: Improve documentation.

This commit is contained in:
Werner Lemberg 2022-07-02 09:34:13 +02:00
parent bec4ef415e
commit 31005d98a4
1 changed files with 13 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
include/freetype/ftmm.h
View File

@ -398,6 +398,10 @@ FT_BEGIN_HEADER
* FreeType error code. 0~means success. * FreeType error code. 0~means success.
* *
* @note: * @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 * [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`. * function with `num_coords` set to zero and `coords` set to `NULL`.
* [Since 2.9] 'Default values' means the currently selected named * [Since 2.9] 'Default values' means the currently selected named
@ -440,6 +444,11 @@ FT_BEGIN_HEADER
* @return: * @return:
* FreeType error code. 0~means success. * 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: * @since:
* 2.7.1 * 2.7.1
*/ */
@ -471,9 +480,9 @@ FT_BEGIN_HEADER
* the number of axes, use default values for the remaining axes. * the number of axes, use default values for the remaining axes.
* *
* coords :: * coords ::
* The design coordinates array (each element must be between 0 and 1.0 * The design coordinates array. Each element is a 16.16 fractional
* for Adobe MM fonts, and between -1.0 and 1.0 for TrueType GX and * value and must be between 0 and 1.0 for Adobe MM fonts, and between
* OpenType variation fonts). * -1.0 and 1.0 for TrueType GX and OpenType variation fonts.
* *
* @return: * @return:
* FreeType error code. 0~means success. * FreeType error code. 0~means success.
@ -518,7 +527,7 @@ FT_BEGIN_HEADER
* *
* @output: * @output:
* coords :: * coords ::
* The normalized blend coordinates array. * The normalized blend coordinates array (as 16.16 fractional values).
* *
* @return: * @return:
* FreeType error code. 0~means success. * FreeType error code. 0~means success.