~reviczky/luatex/texlive-bin-git

« back to all changes in this revision

Viewing changes to libs/freetype2/freetype-2.5.3/docs/reference/ft2-quick_advance.html

  • Committer: Adam Reviczky
  • Date: 2015-04-26 22:40:47 UTC
  • Revision ID: adam.reviczky@kclalumni.net-20150426224047-i2p26n3wqphupq6z
TeX Live 2015 import (rev. 37052)

Show diffs side-by-side

added added

removed removed

Lines of Context:
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.5.3 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.5.3 API Reference</h1></center>
39
 
 
40
 
<center><h1>
41
 
Quick retrieval of advance values
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_ADVANCE_FLAG_FAST_ONLY">FT_ADVANCE_FLAG_FAST_ONLY</a></td><td></td><td><a href="#FT_Get_Advances">FT_Get_Advances</a></td></tr>
46
 
<tr><td></td><td><a href="#FT_Get_Advance">FT_Get_Advance</a></td><td></td><td></td></tr>
47
 
</table><br><br>
48
 
 
49
 
<table align=center width="87%"><tr><td>
50
 
<p>This section contains functions to quickly extract advance values without handling glyph outlines, if possible.</p>
51
 
</td></tr></table><br>
52
 
<table align=center width="75%"><tr><td>
53
 
<h4><a name="FT_ADVANCE_FLAG_FAST_ONLY">FT_ADVANCE_FLAG_FAST_ONLY</a></h4>
54
 
<table align=center width="87%"><tr><td>
55
 
Defined in FT_ADVANCES_H (ftadvanc.h).
56
 
</td></tr></table><br>
57
 
<table align=center width="87%"><tr bgcolor="#D6E8FF"><td><pre>
58
 
 
59
 
#define <b>FT_ADVANCE_FLAG_FAST_ONLY</b>  0x20000000UL
60
 
 
61
 
</pre></table><br>
62
 
<table align=center width="87%"><tr><td>
63
 
<p>A bit-flag to be OR-ed with the &lsquo;flags&rsquo; parameter of the <a href="ft2-quick_advance.html#FT_Get_Advance">FT_Get_Advance</a> and <a href="ft2-quick_advance.html#FT_Get_Advances">FT_Get_Advances</a> functions.</p>
64
 
<p>If set, it indicates that you want these functions to fail if the corresponding hinting mode or font driver doesn't allow for very quick advance computation.</p>
65
 
<p>Typically, glyphs that are either unscaled, unhinted, bitmapped, or light-hinted can have their advance width computed very quickly.</p>
66
 
<p>Normal and bytecode hinted modes that require loading, scaling, and hinting of the glyph outline, are extremely slow by comparison.</p>
67
 
</td></tr></table><br>
68
 
</td></tr></table>
69
 
<hr width="75%">
70
 
<table align=center width="75%"><tr><td><font size=-2>[<a href="ft2-index.html">Index</a>]</font></td>
71
 
<td width="100%"></td>
72
 
<td><font size=-2>[<a href="ft2-toc.html">TOC</a>]</font></td></tr></table>
73
 
 
74
 
<table align=center width="75%"><tr><td>
75
 
<h4><a name="FT_Get_Advance">FT_Get_Advance</a></h4>
76
 
<table align=center width="87%"><tr><td>
77
 
Defined in FT_ADVANCES_H (ftadvanc.h).
78
 
</td></tr></table><br>
79
 
<table align=center width="87%"><tr bgcolor="#D6E8FF"><td><pre>
80
 
 
81
 
  FT_EXPORT( <a href="ft2-basic_types.html#FT_Error">FT_Error</a> )
82
 
  <b>FT_Get_Advance</b>( <a href="ft2-base_interface.html#FT_Face">FT_Face</a>    face,
83
 
                  <a href="ft2-basic_types.html#FT_UInt">FT_UInt</a>    gindex,
84
 
                  <a href="ft2-basic_types.html#FT_Int32">FT_Int32</a>   load_flags,
85
 
                  <a href="ft2-basic_types.html#FT_Fixed">FT_Fixed</a>  *padvance );
86
 
 
87
 
</pre></table><br>
88
 
<table align=center width="87%"><tr><td>
89
 
<p>Retrieve the advance value of a given glyph outline in an <a href="ft2-base_interface.html#FT_Face">FT_Face</a>.</p>
90
 
</td></tr></table><br>
91
 
<table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>input</b></em></td></tr><tr><td>
92
 
<p></p>
93
 
<table cellpadding=3 border=0>
94
 
<tr valign=top><td><b>face</b></td><td>
95
 
<p>The source <a href="ft2-base_interface.html#FT_Face">FT_Face</a> handle.</p>
96
 
</td></tr>
97
 
<tr valign=top><td><b>gindex</b></td><td>
98
 
<p>The glyph index.</p>
99
 
</td></tr>
100
 
<tr valign=top><td><b>load_flags</b></td><td>
101
 
<p>A set of bit flags similar to those used when calling <a href="ft2-base_interface.html#FT_Load_Glyph">FT_Load_Glyph</a>, used to determine what kind of advances you need.</p>
102
 
</td></tr>
103
 
</table>
104
 
</td></tr></table>
105
 
<table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>output</b></em></td></tr><tr><td>
106
 
<p></p>
107
 
<table cellpadding=3 border=0>
108
 
<tr valign=top><td><b>padvance</b></td><td>
109
 
<p>The advance value. If scaling is performed (based on the value of &lsquo;load_flags&rsquo;), the advance value is in 16.16 format. Otherwise, it is in font units.</p>
110
 
<p>If <a href="ft2-base_interface.html#FT_LOAD_XXX">FT_LOAD_VERTICAL_LAYOUT</a> is set, this is the vertical advance corresponding to a vertical layout. Otherwise, it is the horizontal advance in a horizontal layout.</p>
111
 
</td></tr>
112
 
</table>
113
 
</td></tr></table>
114
 
<table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>return</b></em></td></tr><tr><td>
115
 
<p>FreeType error code. 0 means success.</p>
116
 
</td></tr></table>
117
 
<table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>note</b></em></td></tr><tr><td>
118
 
<p>This function may fail if you use <a href="ft2-quick_advance.html#FT_ADVANCE_FLAG_FAST_ONLY">FT_ADVANCE_FLAG_FAST_ONLY</a> and if the corresponding font backend doesn't have a quick way to retrieve the advances.</p>
119
 
<p>A scaled advance is returned in 16.16 format but isn't transformed by the affine transformation specified by <a href="ft2-base_interface.html#FT_Set_Transform">FT_Set_Transform</a>.</p>
120
 
</td></tr></table>
121
 
</td></tr></table>
122
 
<hr width="75%">
123
 
<table align=center width="75%"><tr><td><font size=-2>[<a href="ft2-index.html">Index</a>]</font></td>
124
 
<td width="100%"></td>
125
 
<td><font size=-2>[<a href="ft2-toc.html">TOC</a>]</font></td></tr></table>
126
 
 
127
 
<table align=center width="75%"><tr><td>
128
 
<h4><a name="FT_Get_Advances">FT_Get_Advances</a></h4>
129
 
<table align=center width="87%"><tr><td>
130
 
Defined in FT_ADVANCES_H (ftadvanc.h).
131
 
</td></tr></table><br>
132
 
<table align=center width="87%"><tr bgcolor="#D6E8FF"><td><pre>
133
 
 
134
 
  FT_EXPORT( <a href="ft2-basic_types.html#FT_Error">FT_Error</a> )
135
 
  <b>FT_Get_Advances</b>( <a href="ft2-base_interface.html#FT_Face">FT_Face</a>    face,
136
 
                   <a href="ft2-basic_types.html#FT_UInt">FT_UInt</a>    start,
137
 
                   <a href="ft2-basic_types.html#FT_UInt">FT_UInt</a>    count,
138
 
                   <a href="ft2-basic_types.html#FT_Int32">FT_Int32</a>   load_flags,
139
 
                   <a href="ft2-basic_types.html#FT_Fixed">FT_Fixed</a>  *padvances );
140
 
 
141
 
</pre></table><br>
142
 
<table align=center width="87%"><tr><td>
143
 
<p>Retrieve the advance values of several glyph outlines in an <a href="ft2-base_interface.html#FT_Face">FT_Face</a>.</p>
144
 
</td></tr></table><br>
145
 
<table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>input</b></em></td></tr><tr><td>
146
 
<p></p>
147
 
<table cellpadding=3 border=0>
148
 
<tr valign=top><td><b>face</b></td><td>
149
 
<p>The source <a href="ft2-base_interface.html#FT_Face">FT_Face</a> handle.</p>
150
 
</td></tr>
151
 
<tr valign=top><td><b>start</b></td><td>
152
 
<p>The first glyph index.</p>
153
 
</td></tr>
154
 
<tr valign=top><td><b>count</b></td><td>
155
 
<p>The number of advance values you want to retrieve.</p>
156
 
</td></tr>
157
 
<tr valign=top><td><b>load_flags</b></td><td>
158
 
<p>A set of bit flags similar to those used when calling <a href="ft2-base_interface.html#FT_Load_Glyph">FT_Load_Glyph</a>.</p>
159
 
</td></tr>
160
 
</table>
161
 
</td></tr></table>
162
 
<table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>output</b></em></td></tr><tr><td>
163
 
<p></p>
164
 
<table cellpadding=3 border=0>
165
 
<tr valign=top><td><b>padvance</b></td><td>
166
 
<p>The advance values. This array, to be provided by the caller, must contain at least &lsquo;count&rsquo; elements.</p>
167
 
<p>If scaling is performed (based on the value of &lsquo;load_flags&rsquo;), the advance values are in 16.16 format. Otherwise, they are in font units.</p>
168
 
<p>If <a href="ft2-base_interface.html#FT_LOAD_XXX">FT_LOAD_VERTICAL_LAYOUT</a> is set, these are the vertical advances corresponding to a vertical layout. Otherwise, they are the horizontal advances in a horizontal layout.</p>
169
 
</td></tr>
170
 
</table>
171
 
</td></tr></table>
172
 
<table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>return</b></em></td></tr><tr><td>
173
 
<p>FreeType error code. 0 means success.</p>
174
 
</td></tr></table>
175
 
<table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>note</b></em></td></tr><tr><td>
176
 
<p>This function may fail if you use <a href="ft2-quick_advance.html#FT_ADVANCE_FLAG_FAST_ONLY">FT_ADVANCE_FLAG_FAST_ONLY</a> and if the corresponding font backend doesn't have a quick way to retrieve the advances.</p>
177
 
<p>Scaled advances are returned in 16.16 format but aren't transformed by the affine transformation specified by <a href="ft2-base_interface.html#FT_Set_Transform">FT_Set_Transform</a>.</p>
178
 
</td></tr></table>
179
 
</td></tr></table>
180
 
<hr width="75%">
181
 
<table align=center width="75%"><tr><td><font size=-2>[<a href="ft2-index.html">Index</a>]</font></td>
182
 
<td width="100%"></td>
183
 
<td><font size=-2>[<a href="ft2-toc.html">TOC</a>]</font></td></tr></table>
184
 
 
185
 
</body>
186
 
</html>