-/***************************************************************************/\r
-/* */\r
-/* ftlcdfil.h */\r
-/* */\r
-/* FreeType API for color filtering of subpixel bitmap glyphs */\r
-/* (specification). */\r
-/* */\r
-/* Copyright 2006, 2007 by */\r
-/* David Turner, Robert Wilhelm, and Werner Lemberg. */\r
-/* */\r
-/* This file is part of the FreeType project, and may only be used, */\r
-/* modified, and distributed under the terms of the FreeType project */\r
-/* license, LICENSE.TXT. By continuing to use, modify, or distribute */\r
-/* this file you indicate that you have read the license and */\r
-/* understand and accept it fully. */\r
-/* */\r
-/***************************************************************************/\r
-\r
-\r
-#ifndef __FT_LCD_FILTER_H__\r
-#define __FT_LCD_FILTER_H__\r
-\r
-#include <ft2build.h>\r
-#include FT_FREETYPE_H\r
-\r
-\r
-FT_BEGIN_HEADER\r
-\r
- /***************************************************************************\r
- *\r
- * @section:\r
- * lcd_filtering\r
- *\r
- * @title:\r
- * LCD Filtering\r
- *\r
- * @abstract:\r
- * Reduce color fringes of LCD-optimized bitmaps.\r
- *\r
- * @description:\r
- * The @FT_Library_SetLcdFilter API can be used to specify a low-pass\r
- * filter which is then applied to LCD-optimized bitmaps generated\r
- * through @FT_Render_Glyph. This is useful to reduce color fringes\r
- * which would occur with unfiltered rendering.\r
- *\r
- * Note that no filter is active by default, and that this function is\r
- * *not* implemented in default builds of the library. You need to\r
- * #define FT_CONFIG_OPTION_SUBPIXEL_RENDERING in your `ftoption.h' file\r
- * in order to activate it.\r
- */\r
-\r
-\r
- /****************************************************************************\r
- *\r
- * @func:\r
- * FT_LcdFilter\r
- *\r
- * @description:\r
- * A list of values to identify various types of LCD filters.\r
- *\r
- * @values:\r
- * FT_LCD_FILTER_NONE ::\r
- * Do not perform filtering. When used with subpixel rendering, this\r
- * results in sometimes severe color fringes.\r
- *\r
- * FT_LCD_FILTER_DEFAULT ::\r
- * The default filter reduces color fringes considerably, at the cost\r
- * of a slight blurriness in the output.\r
- *\r
- * FT_LCD_FILTER_LIGHT ::\r
- * The light filter is a variant that produces less blurriness at the\r
- * cost of slightly more color fringes than the default one. It might\r
- * be better, depending on taste, your monitor, or your personal vision.\r
- *\r
- * FT_LCD_FILTER_LEGACY ::\r
- * This filter corresponds to the original libXft color filter. It\r
- * provides high contrast output but can exhibit really bad color\r
- * fringes if glyphs are not extremely well hinted to the pixel grid.\r
- * In other words, it only works well if the TrueType bytecode\r
- * interpreter is enabled *and* high-quality hinted fonts are used.\r
- *\r
- * This filter is only provided for comparison purposes, and might be\r
- * disabled or stay unsupported in the future.\r
- *\r
- * @since:\r
- * 2.3.0\r
- */\r
- typedef enum\r
- {\r
- FT_LCD_FILTER_NONE = 0,\r
- FT_LCD_FILTER_DEFAULT = 1,\r
- FT_LCD_FILTER_LIGHT = 2,\r
- FT_LCD_FILTER_LEGACY = 16,\r
-\r
- FT_LCD_FILTER_MAX /* do not remove */\r
-\r
- } FT_LcdFilter;\r
-\r
-\r
- /**************************************************************************\r
- *\r
- * @func:\r
- * FT_Library_SetLcdFilter\r
- *\r
- * @description:\r
- * This function is used to apply color filtering to LCD decimated\r
- * bitmaps, like the ones used when calling @FT_Render_Glyph with\r
- * @FT_RENDER_MODE_LCD or @FT_RENDER_MODE_LCD_V.\r
- *\r
- * @input:\r
- * library ::\r
- * A handle to the target library instance.\r
- *\r
- * filter ::\r
- * The filter type.\r
- *\r
- * You can use @FT_LCD_FILTER_NONE here to disable this feature, or\r
- * @FT_LCD_FILTER_DEFAULT to use a default filter that should work\r
- * well on most LCD screens.\r
- *\r
- * @return:\r
- * FreeType error code. 0 means success.\r
- *\r
- * @note:\r
- * This feature is always disabled by default. Clients must make an\r
- * explicit call to this function with a `filter' value other than\r
- * @FT_LCD_FILTER_NONE in order to enable it.\r
- *\r
- * Due to *PATENTS* covering subpixel rendering, this function doesn't\r
- * do anything except returning `FT_Err_Unimplemented_Feature' if the\r
- * configuration macro FT_CONFIG_OPTION_SUBPIXEL_RENDERING is not\r
- * defined in your build of the library, which should correspond to all\r
- * default builds of FreeType.\r
- *\r
- * The filter affects glyph bitmaps rendered through @FT_Render_Glyph,\r
- * @FT_Outline_Get_Bitmap, @FT_Load_Glyph, and @FT_Load_Char.\r
- *\r
- * It does _not_ affect the output of @FT_Outline_Render and\r
- * @FT_Outline_Get_Bitmap.\r
- *\r
- * If this feature is activated, the dimensions of LCD glyph bitmaps are\r
- * either larger or taller than the dimensions of the corresponding\r
- * outline with regards to the pixel grid. For example, for\r
- * @FT_RENDER_MODE_LCD, the filter adds up to 3 pixels to the left, and\r
- * up to 3 pixels to the right.\r
- *\r
- * The bitmap offset values are adjusted correctly, so clients shouldn't\r
- * need to modify their layout and glyph positioning code when enabling\r
- * the filter.\r
- *\r
- * @since:\r
- * 2.3.0\r
- */\r
- FT_EXPORT( FT_Error )\r
- FT_Library_SetLcdFilter( FT_Library library,\r
- FT_LcdFilter filter );\r
-\r
- /* */\r
-\r
-\r
-FT_END_HEADER\r
-\r
-#endif /* __FT_LCD_FILTER_H__ */\r
-\r
-\r
-/* END */\r
+/***************************************************************************/
+/* */
+/* ftlcdfil.h */
+/* */
+/* FreeType API for color filtering of subpixel bitmap glyphs */
+/* (specification). */
+/* */
+/* Copyright 2006, 2007 by */
+/* David Turner, Robert Wilhelm, and Werner Lemberg. */
+/* */
+/* This file is part of the FreeType project, and may only be used, */
+/* modified, and distributed under the terms of the FreeType project */
+/* license, LICENSE.TXT. By continuing to use, modify, or distribute */
+/* this file you indicate that you have read the license and */
+/* understand and accept it fully. */
+/* */
+/***************************************************************************/
+
+
+#ifndef __FT_LCD_FILTER_H__
+#define __FT_LCD_FILTER_H__
+
+#include <ft2build.h>
+#include FT_FREETYPE_H
+
+
+FT_BEGIN_HEADER
+
+ /***************************************************************************
+ *
+ * @section:
+ * lcd_filtering
+ *
+ * @title:
+ * LCD Filtering
+ *
+ * @abstract:
+ * Reduce color fringes of LCD-optimized bitmaps.
+ *
+ * @description:
+ * The @FT_Library_SetLcdFilter API can be used to specify a low-pass
+ * filter which is then applied to LCD-optimized bitmaps generated
+ * through @FT_Render_Glyph. This is useful to reduce color fringes
+ * which would occur with unfiltered rendering.
+ *
+ * Note that no filter is active by default, and that this function is
+ * *not* implemented in default builds of the library. You need to
+ * #define FT_CONFIG_OPTION_SUBPIXEL_RENDERING in your `ftoption.h' file
+ * in order to activate it.
+ */
+
+
+ /****************************************************************************
+ *
+ * @func:
+ * FT_LcdFilter
+ *
+ * @description:
+ * A list of values to identify various types of LCD filters.
+ *
+ * @values:
+ * FT_LCD_FILTER_NONE ::
+ * Do not perform filtering. When used with subpixel rendering, this
+ * results in sometimes severe color fringes.
+ *
+ * FT_LCD_FILTER_DEFAULT ::
+ * The default filter reduces color fringes considerably, at the cost
+ * of a slight blurriness in the output.
+ *
+ * FT_LCD_FILTER_LIGHT ::
+ * The light filter is a variant that produces less blurriness at the
+ * cost of slightly more color fringes than the default one. It might
+ * be better, depending on taste, your monitor, or your personal vision.
+ *
+ * FT_LCD_FILTER_LEGACY ::
+ * This filter corresponds to the original libXft color filter. It
+ * provides high contrast output but can exhibit really bad color
+ * fringes if glyphs are not extremely well hinted to the pixel grid.
+ * In other words, it only works well if the TrueType bytecode
+ * interpreter is enabled *and* high-quality hinted fonts are used.
+ *
+ * This filter is only provided for comparison purposes, and might be
+ * disabled or stay unsupported in the future.
+ *
+ * @since:
+ * 2.3.0
+ */
+ typedef enum
+ {
+ FT_LCD_FILTER_NONE = 0,
+ FT_LCD_FILTER_DEFAULT = 1,
+ FT_LCD_FILTER_LIGHT = 2,
+ FT_LCD_FILTER_LEGACY = 16,
+
+ FT_LCD_FILTER_MAX /* do not remove */
+
+ } FT_LcdFilter;
+
+
+ /**************************************************************************
+ *
+ * @func:
+ * FT_Library_SetLcdFilter
+ *
+ * @description:
+ * This function is used to apply color filtering to LCD decimated
+ * bitmaps, like the ones used when calling @FT_Render_Glyph with
+ * @FT_RENDER_MODE_LCD or @FT_RENDER_MODE_LCD_V.
+ *
+ * @input:
+ * library ::
+ * A handle to the target library instance.
+ *
+ * filter ::
+ * 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.
+ *
+ * @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
+ * @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.
+ *
+ * The filter affects glyph bitmaps rendered through @FT_Render_Glyph,
+ * @FT_Outline_Get_Bitmap, @FT_Load_Glyph, and @FT_Load_Char.
+ *
+ * It does _not_ affect the output of @FT_Outline_Render and
+ * @FT_Outline_Get_Bitmap.
+ *
+ * If this feature is activated, the dimensions of LCD glyph bitmaps are
+ * either larger or taller than the dimensions of the corresponding
+ * outline with regards to the pixel grid. For example, for
+ * @FT_RENDER_MODE_LCD, the filter adds up to 3 pixels to the left, and
+ * up to 3 pixels to the right.
+ *
+ * The bitmap offset values are adjusted correctly, so clients shouldn't
+ * need to modify their layout and glyph positioning code when enabling
+ * the filter.
+ *
+ * @since:
+ * 2.3.0
+ */
+ FT_EXPORT( FT_Error )
+ FT_Library_SetLcdFilter( FT_Library library,
+ FT_LcdFilter filter );
+
+ /* */
+
+
+FT_END_HEADER
+
+#endif /* __FT_LCD_FILTER_H__ */
+
+
+/* END */
projects / reactos.git / blobdiff