Upload tizen 2.0 beta source
[framework/graphics/freetype.git] / docs / reference / ft2-gasp_table.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
2 "http://www.w3.org/TR/html4/loose.dtd">
3 <html>
4 <head>
5 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
6 <title>FreeType-2.4.9 API Reference</title>
7 <style type="text/css">
8   body { font-family: Verdana, Geneva, Arial, Helvetica, serif;
9          color: #000000;
10          background: #FFFFFF; }
11
12   p { text-align: justify; }
13   h1 { text-align: center; }
14   li { text-align: justify; }
15   td { padding: 0 0.5em 0 0.5em; }
16   td.left { padding: 0 0.5em 0 0.5em;
17             text-align: left; }
18
19   a:link { color: #0000EF; }
20   a:visited { color: #51188E; }
21   a:hover { color: #FF0000; }
22
23   span.keyword { font-family: monospace;
24                  text-align: left;
25                  white-space: pre;
26                  color: darkblue; }
27
28   pre.colored { color: blue; }
29
30   ul.empty { list-style-type: none; }
31 </style>
32 </head>
33 <body>
34
35 <table align=center><tr><td><font size=-1>[<a href="ft2-index.html">Index</a>]</font></td>
36 <td width="100%"></td>
37 <td><font size=-1>[<a href="ft2-toc.html">TOC</a>]</font></td></tr></table>
38 <center><h1>FreeType-2.4.9 API Reference</h1></center>
39
40 <center><h1>
41 Gasp Table
42 </h1></center>
43 <h2>Synopsis</h2>
44 <table align=center cellspacing=5 cellpadding=0 border=0>
45 <tr><td></td><td><a href="#FT_GASP_XXX">FT_GASP_XXX</a></td><td></td><td><a href="#FT_Get_Gasp">FT_Get_Gasp</a></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td></tr>
46 </table><br><br>
47
48 <table align=center width="87%"><tr><td>
49 <p>The function <a href="ft2-gasp_table.html#FT_Get_Gasp">FT_Get_Gasp</a> can be used to query a TrueType or OpenType font for specific entries in its &lsquo;gasp&rsquo; table, if any. This is mainly useful when implementing native TrueType hinting with the bytecode interpreter to duplicate the Windows text rendering results.</p>
50 </td></tr></table><br>
51 <table align=center width="75%"><tr><td>
52 <h4><a name="FT_GASP_XXX">FT_GASP_XXX</a></h4>
53 <table align=center width="87%"><tr><td>
54 Defined in FT_GASP_H (freetype/ftgasp.h).
55 </td></tr></table><br>
56 <table align=center width="87%"><tr bgcolor="#D6E8FF"><td><pre>
57
58 #define <a href="ft2-gasp_table.html#FT_GASP_XXX">FT_GASP_NO_TABLE</a>               -1
59 #define <a href="ft2-gasp_table.html#FT_GASP_XXX">FT_GASP_DO_GRIDFIT</a>           0x01
60 #define <a href="ft2-gasp_table.html#FT_GASP_XXX">FT_GASP_DO_GRAY</a>              0x02
61 #define <a href="ft2-gasp_table.html#FT_GASP_XXX">FT_GASP_SYMMETRIC_SMOOTHING</a>  0x08
62 #define <a href="ft2-gasp_table.html#FT_GASP_XXX">FT_GASP_SYMMETRIC_GRIDFIT</a>    0x10
63
64 </pre></table><br>
65 <table align=center width="87%"><tr><td>
66 <p>A list of values and/or bit-flags returned by the <a href="ft2-gasp_table.html#FT_Get_Gasp">FT_Get_Gasp</a> function.</p>
67 </td></tr></table><br>
68 <table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>values</b></em></td></tr><tr><td>
69 <p></p>
70 <table cellpadding=3 border=0>
71 <tr valign=top><td><b>FT_GASP_NO_TABLE</b></td><td>
72 <p>This special value means that there is no GASP table in this face. It is up to the client to decide what to do.</p>
73 </td></tr>
74 <tr valign=top><td><b>FT_GASP_DO_GRIDFIT</b></td><td>
75 <p>Grid-fitting and hinting should be performed at the specified ppem. This <b>really</b> means TrueType bytecode interpretation. If this bit is not set, no hinting gets applied.</p>
76 </td></tr>
77 <tr valign=top><td><b>FT_GASP_DO_GRAY</b></td><td>
78 <p>Anti-aliased rendering should be performed at the specified ppem. If not set, do monochrome rendering.</p>
79 </td></tr>
80 <tr valign=top><td colspan=0><b>FT_GASP_SYMMETRIC_SMOOTHING</b></td></tr>
81 <tr valign=top><td></td><td>
82 <p>If set, smoothing along multiple axes must be used with ClearType.</p>
83 </td></tr>
84 <tr valign=top><td colspan=0><b>FT_GASP_SYMMETRIC_GRIDFIT</b></td></tr>
85 <tr valign=top><td></td><td>
86 <p>Grid-fitting must be used with ClearType's symmetric smoothing.</p>
87 </td></tr>
88 </table>
89 </td></tr></table>
90 <table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>note</b></em></td></tr><tr><td>
91 <p>The bit-flags &lsquo;FT_GASP_DO_GRIDFIT&rsquo; and &lsquo;FT_GASP_DO_GRAY&rsquo; are to be used for standard font rasterization only. Independently of that, &lsquo;FT_GASP_SYMMETRIC_SMOOTHING&rsquo; and &lsquo;FT_GASP_SYMMETRIC_GRIDFIT&rsquo; are to be used if ClearType is enabled (and &lsquo;FT_GASP_DO_GRIDFIT&rsquo; and &lsquo;FT_GASP_DO_GRAY&rsquo; are consequently ignored).</p>
92 <p>&lsquo;ClearType&rsquo; is Microsoft's implementation of LCD rendering, partly protected by patents.</p>
93 </td></tr></table>
94 <table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>since</b></em></td></tr><tr><td>
95 <p>2.3.0</p>
96 </td></tr></table>
97 </td></tr></table>
98 <hr width="75%">
99 <table align=center width="75%"><tr><td><font size=-2>[<a href="ft2-index.html">Index</a>]</font></td>
100 <td width="100%"></td>
101 <td><font size=-2>[<a href="ft2-toc.html">TOC</a>]</font></td></tr></table>
102
103 <table align=center width="75%"><tr><td>
104 <h4><a name="FT_Get_Gasp">FT_Get_Gasp</a></h4>
105 <table align=center width="87%"><tr><td>
106 Defined in FT_GASP_H (freetype/ftgasp.h).
107 </td></tr></table><br>
108 <table align=center width="87%"><tr bgcolor="#D6E8FF"><td><pre>
109
110   FT_EXPORT( <a href="ft2-basic_types.html#FT_Int">FT_Int</a> )
111   <b>FT_Get_Gasp</b>( <a href="ft2-base_interface.html#FT_Face">FT_Face</a>  face,
112                <a href="ft2-basic_types.html#FT_UInt">FT_UInt</a>  ppem );
113
114 </pre></table><br>
115 <table align=center width="87%"><tr><td>
116 <p>Read the &lsquo;gasp&rsquo; table from a TrueType or OpenType font file and return the entry corresponding to a given character pixel size.</p>
117 </td></tr></table><br>
118 <table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>input</b></em></td></tr><tr><td>
119 <p></p>
120 <table cellpadding=3 border=0>
121 <tr valign=top><td><b>face</b></td><td>
122 <p>The source face handle.</p>
123 </td></tr>
124 <tr valign=top><td><b>ppem</b></td><td>
125 <p>The vertical character pixel size.</p>
126 </td></tr>
127 </table>
128 </td></tr></table>
129 <table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>return</b></em></td></tr><tr><td>
130 <p>Bit flags (see <a href="ft2-gasp_table.html#FT_GASP_XXX">FT_GASP_XXX</a>), or <a href="ft2-gasp_table.html#FT_GASP_XXX">FT_GASP_NO_TABLE</a> if there is no &lsquo;gasp&rsquo; table in the face.</p>
131 </td></tr></table>
132 <table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>since</b></em></td></tr><tr><td>
133 <p>2.3.0</p>
134 </td></tr></table>
135 </td></tr></table>
136 <hr width="75%">
137 <table align=center width="75%"><tr><td><font size=-2>[<a href="ft2-index.html">Index</a>]</font></td>
138 <td width="100%"></td>
139 <td><font size=-2>[<a href="ft2-toc.html">TOC</a>]</font></td></tr></table>
140
141 </body>
142 </html>