Mercurial > hg > Game > Cerium

annotate freetype2/freetype/ftlcdfil.h @ 1254:34944900f266 draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
minor fix
author Shinji KONO <kono@ie.u-ryukyu.ac.jp>
date Fri, 18 Nov 2011 16:56:11 +0900
parents a8ab91f49cac
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1206
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
1 /***************************************************************************/
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
2 /* */
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
3 /* ftlcdfil.h */
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
4 /* */
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
5 /* FreeType API for color filtering of subpixel bitmap glyphs */
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
6 /* (specification). */
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
7 /* */
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
8 /* Copyright 2006, 2007, 2008, 2010 by */
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
9 /* David Turner, Robert Wilhelm, and Werner Lemberg. */
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
10 /* */
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
11 /* This file is part of the FreeType project, and may only be used, */
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
12 /* modified, and distributed under the terms of the FreeType project */
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
13 /* license, LICENSE.TXT. By continuing to use, modify, or distribute */
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
14 /* this file you indicate that you have read the license and */
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
15 /* understand and accept it fully. */
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
16 /* */
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
17 /***************************************************************************/
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
18
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
19
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
20 #ifndef __FT_LCD_FILTER_H__
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
21 #define __FT_LCD_FILTER_H__
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
22
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
23 #include <ft2build.h>
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
24 #include FT_FREETYPE_H
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
25
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
26 #ifdef FREETYPE_H
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
27 #error "freetype.h of FreeType 1 has been loaded!"
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
28 #error "Please fix the directory search order for header files"
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
29 #error "so that freetype.h of FreeType 2 is found first."
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
30 #endif
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
31
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
32
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
33 FT_BEGIN_HEADER
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
34
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
35 /***************************************************************************
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
36 *
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
37 * @section:
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
38 * lcd_filtering
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
39 *
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
40 * @title:
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
41 * LCD Filtering
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
42 *
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
43 * @abstract:
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
44 * Reduce color fringes of LCD-optimized bitmaps.
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
45 *
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
46 * @description:
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
47 * The @FT_Library_SetLcdFilter API can be used to specify a low-pass
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
48 * filter which is then applied to LCD-optimized bitmaps generated
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
49 * through @FT_Render_Glyph. This is useful to reduce color fringes
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
50 * which would occur with unfiltered rendering.
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
51 *
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
52 * Note that no filter is active by default, and that this function is
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
53 * *not* implemented in default builds of the library. You need to
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
54 * #define FT_CONFIG_OPTION_SUBPIXEL_RENDERING in your `ftoption.h' file
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
55 * in order to activate it.
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
56 */
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
57
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
58
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
59 /****************************************************************************
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
60 *
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
61 * @enum:
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
62 * FT_LcdFilter
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
63 *
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
64 * @description:
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
65 * A list of values to identify various types of LCD filters.
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
66 *
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
67 * @values:
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
68 * FT_LCD_FILTER_NONE ::
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
69 * Do not perform filtering. When used with subpixel rendering, this
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
70 * results in sometimes severe color fringes.
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
71 *
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
72 * FT_LCD_FILTER_DEFAULT ::
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
73 * The default filter reduces color fringes considerably, at the cost
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
74 * of a slight blurriness in the output.
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
75 *
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
76 * FT_LCD_FILTER_LIGHT ::
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
77 * The light filter is a variant that produces less blurriness at the
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
78 * cost of slightly more color fringes than the default one. It might
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
79 * be better, depending on taste, your monitor, or your personal vision.
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
80 *
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
81 * FT_LCD_FILTER_LEGACY ::
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
82 * This filter corresponds to the original libXft color filter. It
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
83 * provides high contrast output but can exhibit really bad color
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
84 * fringes if glyphs are not extremely well hinted to the pixel grid.
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
85 * In other words, it only works well if the TrueType bytecode
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
86 * interpreter is enabled *and* high-quality hinted fonts are used.
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
87 *
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
88 * This filter is only provided for comparison purposes, and might be
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
89 * disabled or stay unsupported in the future.
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
90 *
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
91 * @since:
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
92 * 2.3.0
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
93 */
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
94 typedef enum FT_LcdFilter_
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
95 {
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
96 FT_LCD_FILTER_NONE = 0,
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
97 FT_LCD_FILTER_DEFAULT = 1,
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
98 FT_LCD_FILTER_LIGHT = 2,
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
99 FT_LCD_FILTER_LEGACY = 16,
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
100
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
101 FT_LCD_FILTER_MAX /* do not remove */
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
102
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
103 } FT_LcdFilter;
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
104
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
105
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
106 /**************************************************************************
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
107 *
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
108 * @func:
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
109 * FT_Library_SetLcdFilter
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
110 *
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
111 * @description:
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
112 * This function is used to apply color filtering to LCD decimated
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
113 * bitmaps, like the ones used when calling @FT_Render_Glyph with
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
114 * @FT_RENDER_MODE_LCD or @FT_RENDER_MODE_LCD_V.
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
115 *
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
116 * @input:
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
117 * library ::
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
118 * A handle to the target library instance.
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
119 *
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
120 * filter ::
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
121 * The filter type.
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
122 *
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
123 * You can use @FT_LCD_FILTER_NONE here to disable this feature, or
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
124 * @FT_LCD_FILTER_DEFAULT to use a default filter that should work
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
125 * well on most LCD screens.
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
126 *
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
127 * @return:
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
128 * FreeType error code. 0~means success.
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
129 *
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
130 * @note:
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
131 * This feature is always disabled by default. Clients must make an
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
132 * explicit call to this function with a `filter' value other than
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
133 * @FT_LCD_FILTER_NONE in order to enable it.
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
134 *
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
135 * Due to *PATENTS* covering subpixel rendering, this function doesn't
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
136 * do anything except returning `FT_Err_Unimplemented_Feature' if the
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
137 * configuration macro FT_CONFIG_OPTION_SUBPIXEL_RENDERING is not
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
138 * defined in your build of the library, which should correspond to all
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
139 * default builds of FreeType.
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
140 *
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
141 * The filter affects glyph bitmaps rendered through @FT_Render_Glyph,
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
142 * @FT_Outline_Get_Bitmap, @FT_Load_Glyph, and @FT_Load_Char.
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
143 *
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
144 * It does _not_ affect the output of @FT_Outline_Render and
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
145 * @FT_Outline_Get_Bitmap.
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
146 *
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
147 * If this feature is activated, the dimensions of LCD glyph bitmaps are
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
148 * either larger or taller than the dimensions of the corresponding
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
149 * outline with regards to the pixel grid. For example, for
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
150 * @FT_RENDER_MODE_LCD, the filter adds up to 3~pixels to the left, and
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
151 * up to 3~pixels to the right.
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
152 *
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
153 * The bitmap offset values are adjusted correctly, so clients shouldn't
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
154 * need to modify their layout and glyph positioning code when enabling
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
155 * the filter.
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
156 *
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
157 * @since:
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
158 * 2.3.0
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
159 */
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
160 FT_EXPORT( FT_Error )
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
161 FT_Library_SetLcdFilter( FT_Library library,
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
162 FT_LcdFilter filter );
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
163
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
164
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
165 /**************************************************************************
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
166 *
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
167 * @func:
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
168 * FT_Library_SetLcdFilterWeights
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
169 *
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
170 * @description:
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
171 * Use this function to override the filter weights selected by
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
172 * @FT_Library_SetLcdFilter. By default, FreeType uses the quintuple
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
173 * (0x00, 0x55, 0x56, 0x55, 0x00) for FT_LCD_FILTER_LIGHT, and (0x10,
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
174 * 0x40, 0x70, 0x40, 0x10) for FT_LCD_FILTER_DEFAULT and
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
175 * FT_LCD_FILTER_LEGACY.
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
176 *
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
177 * @input:
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
178 * library ::
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
179 * A handle to the target library instance.
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
180 *
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
181 * weights ::
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
182 * A pointer to an array; the function copies the first five bytes and
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
183 * uses them to specify the filter weights.
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
184 *
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
185 * @return:
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
186 * FreeType error code. 0~means success.
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
187 *
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
188 * @note:
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
189 * Due to *PATENTS* covering subpixel rendering, this function doesn't
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
190 * do anything except returning `FT_Err_Unimplemented_Feature' if the
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
191 * configuration macro FT_CONFIG_OPTION_SUBPIXEL_RENDERING is not
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
192 * defined in your build of the library, which should correspond to all
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
193 * default builds of FreeType.
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
194 *
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
195 * This function must be called after @FT_Library_SetLcdFilter to have
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
196 * any effect.
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
197 *
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
198 * @since:
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
199 * 2.4.0
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
200 */
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
201 FT_EXPORT( FT_Error )
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
202 FT_Library_SetLcdFilterWeights( FT_Library library,
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
203 unsigned char *weights );
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
204
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
205 /* */
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
206
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
207
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
208 FT_END_HEADER
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
209
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
210 #endif /* __FT_LCD_FILTER_H__ */
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
211
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
212
a8ab91f49cac add freetype2,ft2build.h
Takao YONAMINE <e095763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
213 /* END */