From 6fca2e5b1b5d07b16f79d46ac5ff89b1d51e73bf Mon Sep 17 00:00:00 2001 From: Werner Lemberg Date: Sat, 31 Oct 2020 06:52:18 +0100 Subject: Minor clean-ups of last commit. --- include/freetype/freetype.h | 21 ++++++++++++++------- include/freetype/ftimage.h | 43 ++++++++++++++++++++++--------------------- 2 files changed, 36 insertions(+), 28 deletions(-) diff --git a/include/freetype/freetype.h b/include/freetype/freetype.h index d02bbd222..b19a1b7c5 100644 --- a/include/freetype/freetype.h +++ b/include/freetype/freetype.h @@ -38,15 +38,22 @@ FT_BEGIN_HEADER * @title: * Preamble * - * @abstract + * @abstract: * What FreeType is and isn't * - * @descriptiom - * FreeType is a library that provides access to glyphs in font files. - * It scales the glyph images and their metrics to a requested size but - * it is not a text layout engine. FreeType rasterizes the glyph images - * and produces pixel or subpixel alpha coverage bitmaps but it does not - * perform alpha blending or compositing itself. + * @description: + * FreeType is a library that provides access to glyphs in font files. It + * scales the glyph images and their metrics to a requested size, and it + * rasterizes the glyph images to produce pixel or subpixel alpha coverage + * bitmaps. + * + * Note that FreeType is _not_ a text layout engine. You have to use + * higher-level libraries like HarfBuzz, Pango, or ICU for that. + * + * Note also that FreeType does _not_ perform alpha blending or + * compositing the resulting bitmaps or pixmaps by itself. Use your + * favourite graphics library (for example, Cairo or Skia) to further + * process FreeType's output. * */ diff --git a/include/freetype/ftimage.h b/include/freetype/ftimage.h index 82e9f4029..a759e1399 100644 --- a/include/freetype/ftimage.h +++ b/include/freetype/ftimage.h @@ -785,26 +785,27 @@ FT_BEGIN_HEADER * How vectorial outlines are converted into bitmaps and pixmaps. * * @description: - * A raster or a raterizer is a scan converter in charge of producing - * a pixel coverage bitmap that can be used as an alpha channel when + + * A raster or a rasterizer is a scan converter in charge of producing a + * pixel coverage bitmap that can be used as an alpha channel when * compositing a glyph with a background. FreeType comes with two * rasterizers: bilevel `raster1` and anti-aliased `smooth` are two - * separate modules. They are usually called from high-level - * @FT_Load_Glyph or @FT_Render_Glyph and produce the entire coverage - * bitmap at once, while staying largely invisible to users. - * - * Instead of working with complete coverage bitmaps, it is also - * possible to intercept consecutive pixel runs on the same scanline - * with the same coverage, called spans, and process them individually. - * Only `smooth` rasterizer permits this when calling @FT_Outline_Render - * with @FT_Raster_Params described below. - * - * Whether working with complete bitmaps or spans, it is important to - * think of them as colorless coverage objects suitable as alpha channels - * in blending arbitrary colors with background. For best results, it is - * recommended to use gamma correction too. - * - * This section also describes public API needed to set up alternative + * separate modules. They are usually called from the high-level + * @FT_Load_Glyph or @FT_Render_Glyph functions and produce the entire + * coverage bitmap at once, while staying largely invisible to users. + * + * Instead of working with complete coverage bitmaps, it is also possible + * to intercept consecutive pixel runs on the same scanline with the same + * coverage, called _spans_, and process them individually. Only the + * `smooth` rasterizer permits this when calling @FT_Outline_Render with + * @FT_Raster_Params as described below. + * + * Working with either complete bitmaps or spans it is important to think + * of them as colorless coverage objects suitable as alpha channels to + * blend arbitrary colors with a background. For best results, it is + * recommended to use gamma correction, too. + * + * This section also describes the public API needed to set up alternative * @FT_Renderer modules. * * @order: @@ -830,8 +831,8 @@ FT_BEGIN_HEADER * FT_Span * * @description: - * A structure used to model a single span of consecutive pixels - * when rendering an anti-aliased bitmap. + * A structure to model a single span of consecutive pixels when + * rendering an anti-aliased bitmap. * * @fields: * x :: @@ -849,7 +850,7 @@ FT_BEGIN_HEADER * @FT_SpanFunc that takes the y~coordinate of the span as a parameter. * * The anti-aliased rasterizer produces coverage values from 0 to 255, - * from completely transparent to completely opaque. + * this is, from completely transparent to completely opaque. */ typedef struct FT_Span_ { -- cgit v1.2.1