From 4d51f78de9b26de3d182f17b7aa47eb644a708d4 Mon Sep 17 00:00:00 2001 From: Werner Lemberg Date: Sat, 23 Feb 2019 11:21:48 +0100 Subject: More documentation updates. In particular, mark the new behaviour of `FT_LOAD_COLOR' as experimental. --- include/freetype/config/ftoption.h | 4 ++-- include/freetype/freetype.h | 32 +++++++++++++++++--------------- include/freetype/ftcolor.h | 3 --- 3 files changed, 19 insertions(+), 20 deletions(-) (limited to 'include') diff --git a/include/freetype/config/ftoption.h b/include/freetype/config/ftoption.h index d73a7f672..12f47a82e 100644 --- a/include/freetype/config/ftoption.h +++ b/include/freetype/config/ftoption.h @@ -747,8 +747,8 @@ FT_BEGIN_HEADER * `T1_MAX_CHARSTRING_OPERANDS` is the charstring stack's capacity. A * minimum of~16 is required. * - * The Chinese font 'MingTiEG-Medium' (covering a CNS 11643 character set) - * needs 256. + * The Chinese font 'MingTiEG-Medium' (covering the CNS 11643 character + * set) needs 256. */ #define T1_MAX_CHARSTRINGS_OPERANDS 256 diff --git a/include/freetype/freetype.h b/include/freetype/freetype.h index 42cf0d8a6..e45b311b9 100644 --- a/include/freetype/freetype.h +++ b/include/freetype/freetype.h @@ -2968,15 +2968,15 @@ FT_BEGIN_HEADER * color bitmaps are found, they are converted to 256-level gray * bitmaps, using the @FT_PIXEL_MODE_GRAY format. * - * [Since 2.10] If the glyph index contains an entry in the face's - * 'COLR' table with a 'CPAL' palette table (as defined in the OpenType - * specification), make @FT_Render_Glyph provide a default blending of - * the color glyph layers associated with the glyph index, using the - * same bitmap format as embedded color bitmap images. This is mainly - * for convenience; for full control of color layers use + * [Since 2.10, experimental] If the glyph index contains an entry in + * the face's 'COLR' table with a 'CPAL' palette table (as defined in + * the OpenType specification), make @FT_Render_Glyph provide a default + * blending of the color glyph layers associated with the glyph index, + * using the same bitmap format as embedded color bitmap images. This + * is mainly for convenience; for full control of color layers use * @FT_Get_Color_Glyph_Layer and FreeType's color functions like - * @FT_Palette_Select instead of setting FT_LOAD_COLOR for rendering so - * that the client application can handle blending by itself. + * @FT_Palette_Select instead of setting @FT_LOAD_COLOR for rendering + * so that the client application can handle blending by itself. * * FT_LOAD_COMPUTE_METRICS :: * [Since 2.6.1] Compute glyph metrics from the glyph data, without the @@ -3288,11 +3288,12 @@ FT_BEGIN_HEADER * The render mode used to render the glyph image into a bitmap. See * @FT_Render_Mode for a list of possible values. * - * If @FT_RENDER_MODE_NORMAL is used, the flag @FT_LOAD_COLOR can be - * additionally set to make the function provide a default blending of - * colored glyph layers associated with the current glyph slot - * (provided the font contains such layers) instead of rendering the - * glyph slot's outline. See @FT_LOAD_COLOR for more information. + * If @FT_RENDER_MODE_NORMAL is used, a previous call of @FT_Load_Glyph + * with flag @FT_LOAD_COLOR makes the FT_Render_Glyph provide a default + * blending of colored glyph layers associated with the current glyph + * slot (provided the font contains such layers) instead of rendering + * the glyph slot's outline. This is an experimental feature; see + * @FT_LOAD_COLOR for more information. * * @return: * FreeType error code. 0~means success. @@ -4126,8 +4127,9 @@ FT_BEGIN_HEADER * objects (like @FT_Get_Glyph or @FT_Glyph_To_Bitmap) don't have access * to this information. * - * @FT_Render_Glyph, however, handles colored glyph layers automatically - * if the @FT_LOAD_COLOR flag is passed to it. + * Note that @FT_Render_Glyph is able to handle colored glyph layers + * automatically if the @FT_LOAD_COLOR flag is passed to a previous call + * to @FT_Load_Glyph. [This is an experimental feature.] * * @example: * ``` diff --git a/include/freetype/ftcolor.h b/include/freetype/ftcolor.h index ab9422c1b..cf1802195 100644 --- a/include/freetype/ftcolor.h +++ b/include/freetype/ftcolor.h @@ -249,9 +249,6 @@ FT_BEGIN_HEADER * FreeType error code. 0~means success. * * @note: - * The number of color entries is given by the `num_palette_entries` - * field in the @FT_Palette_Data structure. - * * The array pointed to by `apalette_entries` is owned and managed by * FreeType. * -- cgit v1.2.1