diff options
Diffstat (limited to 'include/freetype/ftlcdfil.h')
| -rw-r--r-- | include/freetype/ftlcdfil.h | 90 |
1 files changed, 45 insertions, 45 deletions
diff --git a/include/freetype/ftlcdfil.h b/include/freetype/ftlcdfil.h index 8d27135e3..02a37c959 100644 --- a/include/freetype/ftlcdfil.h +++ b/include/freetype/ftlcdfil.h @@ -47,7 +47,7 @@ FT_BEGIN_HEADER * @description: * FreeType provides two alternative subpixel rendering technologies. * Should you #define FT_CONFIG_OPTION_SUBPIXEL_RENDERING in your - * `ftoption.h', this enables patented ClearType-style rendering. + * `ftoption.h`, this enables patented ClearType-style rendering. * Otherwise, Harmony LCD rendering is enabled. These technologies are * controlled differently and API described below, although always * available, performs its function when appropriate method is enabled @@ -58,7 +58,8 @@ FT_BEGIN_HEADER * the stripe (usually horizontal RGB) by a factor of~3. Using the * subpixels coverages unfiltered can create severe color fringes * especially when rendering thin features. Indeed, to produce - * black-on-white text, the nearby color subpixels must be dimmed equally. + * black-on-white text, the nearby color subpixels must be dimmed + * equally. * * A good 5-tap FIR filter should be applied to subpixel coverages * regardless of pixel boundaries and should have these properties: @@ -82,32 +83,32 @@ FT_BEGIN_HEADER * subpixel-rendered bitmaps generated through @FT_Render_Glyph. * * Harmony LCD rendering is suitable to panels with any regular subpixel - * structure, not just monitors with 3 color striped subpixels, as long as - * the color subpixels have fixed positions relative to the pixel center. - * In this case, each color channel is then rendered separately after - * shifting the outline opposite to the subpixel shift so that the + * structure, not just monitors with 3 color striped subpixels, as long + * as the color subpixels have fixed positions relative to the pixel + * center. In this case, each color channel is then rendered separately + * after shifting the outline opposite to the subpixel shift so that the * coverage maps are aligned. This method is immune to color fringes * because the shifts do not change integral coverage. * * The subpixel geometry must be specified by xy-coordinates for each - * subpixel. By convention they may come in the RGB order: - * {{-1/3, 0}, {0, 0}, {1/3, 0}} for standard RGB striped panel or - * {{-1/6, 1/4}, {-1/6, -1/4}, {1/3, 0}} for a certain PenTile panel. + * subpixel. By convention they may come in the RGB order: {{-1/3, 0}, + * {0, 0}, {1/3, 0}} for standard RGB striped panel or {{-1/6, 1/4}, + * {-1/6, -1/4}, {1/3, 0}} for a certain PenTile panel. * * Use the @FT_Library_SetLcdGeometry API to specify subpixel positions. - * If one follows the RGB order convention, the same order applies - * to the resulting @FT_PIXEL_MODE_LCD and @FT_PIXEL_MODE_LCD_V bitmaps. - * Note, however, that the coordinate frame for the latter must be rotated + * If one follows the RGB order convention, the same order applies to the + * resulting @FT_PIXEL_MODE_LCD and @FT_PIXEL_MODE_LCD_V bitmaps. Note, + * however, that the coordinate frame for the latter must be rotated * clockwise. Harmony with default LCD geometry is equivalent to * ClearType with light filter. * - * As a result of ClearType filtering or Harmony rendering, the dimensions - * of LCD bitmaps can be either wider or taller than the dimensions of - * the corresponding outline with regard to the pixel grid. For example, - * for @FT_RENDER_MODE_LCD, the filter adds 2~subpixels to the left, and - * 2~subpixels to the right. The bitmap offset values are adjusted - * accordingly, so clients shouldn't need to modify their layout and - * glyph positioning code when enabling the filter. + * As a result of ClearType filtering or Harmony rendering, the + * dimensions of LCD bitmaps can be either wider or taller than the + * dimensions of the corresponding outline with regard to the pixel grid. + * For example, for @FT_RENDER_MODE_LCD, the filter adds 2~subpixels to + * the left, and 2~subpixels to the right. The bitmap offset values are + * adjusted accordingly, so clients shouldn't need to modify their layout + * and glyph positioning code when enabling the filter. * * The ClearType and Harmony rendering is applicable to glyph bitmaps * rendered through @FT_Render_Glyph, @FT_Load_Glyph, @FT_Load_Char, and @@ -116,10 +117,10 @@ FT_BEGIN_HEADER * @FT_Outline_Get_Bitmap. * * The described algorithms can completely remove color artefacts when - * combined with gamma-corrected alpha blending in linear space. - * Each of the 3~alpha values (subpixels) must by independently used to - * blend one color channel. That is, red alpha blends the red channel of - * the text color with the red channel of the background pixel. + * combined with gamma-corrected alpha blending in linear space. Each of + * the 3~alpha values (subpixels) must by independently used to blend one + * color channel. That is, red alpha blends the red channel of the text + * color with the red channel of the background pixel. */ @@ -141,8 +142,8 @@ FT_BEGIN_HEADER * with weights of [0x08 0x4D 0x56 0x4D 0x08] in 1/256th units. * * FT_LCD_FILTER_LIGHT :: - * this is a boxy, normalized, and color-balanced three-tap filter - * with weights of [0x00 0x55 0x56 0x55 0x00] in 1/256th units. + * this is a boxy, normalized, and color-balanced three-tap filter with + * weights of [0x00 0x55 0x56 0x55 0x00] in 1/256th units. * * FT_LCD_FILTER_LEGACY :: * FT_LCD_FILTER_LEGACY1 :: @@ -151,12 +152,11 @@ FT_BEGIN_HEADER * fringes if glyphs are not extremely well hinted to the pixel grid. * This filter is only provided for comparison purposes, and might be * disabled or stay unsupported in the future. The second value is - * provided for compatibility with FontConfig, which historically - * used different enumeration, sometimes incorrectly forwarded to - * FreeType. + * provided for compatibility with FontConfig, which historically used + * different enumeration, sometimes incorrectly forwarded to FreeType. * * @since: - * 2.3.0 (`FT_LCD_FILTER_LEGACY1' since 2.6.2) + * 2.3.0 (`FT_LCD_FILTER_LEGACY1` since 2.6.2) */ typedef enum FT_LcdFilter_ { @@ -189,22 +189,22 @@ FT_BEGIN_HEADER * The filter type. * * You can use @FT_LCD_FILTER_NONE here to disable this feature, or - * @FT_LCD_FILTER_DEFAULT to use a default filter that should work - * well on most LCD screens. + * @FT_LCD_FILTER_DEFAULT to use a default filter that should work well + * on most LCD screens. * * @return: * FreeType error code. 0~means success. * * @note: * This feature is always disabled by default. Clients must make an - * explicit call to this function with a `filter' value other than + * explicit call to this function with a 'filter' value other than * @FT_LCD_FILTER_NONE in order to enable it. * - * Due to *PATENTS* covering subpixel rendering, this function doesn't - * do anything except returning `FT_Err_Unimplemented_Feature' if the - * configuration macro FT_CONFIG_OPTION_SUBPIXEL_RENDERING is not - * defined in your build of the library, which should correspond to all - * default builds of FreeType. + * Due to **PATENTS** covering subpixel rendering, this function doesn't + * do anything except returning `FT_Err_Unimplemented_Feature` if the + * configuration macro FT_CONFIG_OPTION_SUBPIXEL_RENDERING is not defined + * in your build of the library, which should correspond to all default + * builds of FreeType. * * @since: * 2.3.0 @@ -235,11 +235,11 @@ FT_BEGIN_HEADER * FreeType error code. 0~means success. * * @note: - * Due to *PATENTS* covering subpixel rendering, this function doesn't - * do anything except returning `FT_Err_Unimplemented_Feature' if the - * configuration macro FT_CONFIG_OPTION_SUBPIXEL_RENDERING is not - * defined in your build of the library, which should correspond to all - * default builds of FreeType. + * Due to **PATENTS** covering subpixel rendering, this function doesn't + * do anything except returning `FT_Err_Unimplemented_Feature` if the + * configuration macro FT_CONFIG_OPTION_SUBPIXEL_RENDERING is not defined + * in your build of the library, which should correspond to all default + * builds of FreeType. * * LCD filter weights can also be set per face using @FT_Face_Properties * with @FT_PARAM_TAG_LCD_FILTER_WEIGHTS. @@ -296,8 +296,8 @@ FT_BEGIN_HEADER * - {{-21, 0}, {0, 0}, {21, 0}} is the default, corresponding to 3 color * stripes shifted by a third of a pixel. This could be an RGB panel. * - * - {{21, 0}, {0, 0}, {-21, 0}} looks the same as the default but - * can specify a BGR panel instead, while keeping the bitmap in the same + * - {{21, 0}, {0, 0}, {-21, 0}} looks the same as the default but can + * specify a BGR panel instead, while keeping the bitmap in the same * RGB888 format. * * - {{0, 21}, {0, 0}, {0, -21}} is the vertical RGB, but the bitmap @@ -305,7 +305,7 @@ FT_BEGIN_HEADER * * - {{-11, 16}, {-11, -16}, {22, 0}} is a certain PenTile arrangement. * - * This function does nothing and returns `FT_Err_Unimplemented_Feature' + * This function does nothing and returns `FT_Err_Unimplemented_Feature` * in the context of ClearType-style subpixel rendering when * FT_CONFIG_OPTION_SUBPIXEL_RENDERING is defined in your build of the * library. |