File: CastleTextureFontData.TTextureFontData.html

package info (click to toggle)
castle-game-engine 5.2.0-3
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 185,428 kB
  • sloc: pascal: 260,781; cpp: 1,363; objc: 713; makefile: 537; xml: 496; sh: 480; php: 4
file content (269 lines) | stat: -rw-r--r-- 16,925 bytes parent folder | download 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
 
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/1999/REC-html401-19991224/loose.dtd">
<html>
<head>
<title>Castle Game Engine: CastleTextureFontData: Class TTextureFontData</title>
<meta name="generator" content="PasDoc 0.13.0">
<meta http-equiv="content-type" content="text/html; charset=utf-8">
<link rel="StyleSheet" type="text/css" href="pasdoc.css">
</head>
<body>
<table class="container"><tr><td class="navigation">
<h2>Castle Game Engine</h2><p><a href="introduction.html" class="navigation">Introduction</a></p><p><a href="AllUnits.html" class="navigation">Units</a></p><p><a href="ClassHierarchy.html" class="navigation">Class Hierarchy</a></p><p><a href="AllClasses.html" class="navigation">Classes, Interfaces, Objects and Records</a></p><p><a href="AllTypes.html" class="navigation">Types</a></p><p><a href="AllVariables.html" class="navigation">Variables</a></p><p><a href="AllConstants.html" class="navigation">Constants</a></p><p><a href="AllFunctions.html" class="navigation">Functions and Procedures</a></p><p><a href="AllIdentifiers.html" class="navigation">Identifiers</a></p></td><td class="content">
<a name="TTextureFontData"></a><h1 class="cio">Class TTextureFontData</h1>
<table class="sections wide_list">
<tr>
<td><a class="section" href="#PasDoc-Description">Description</a></td><td><a class="section" href="#PasDoc-Hierarchy">Hierarchy</a></td><td><a class="section" href="#PasDoc-InternalCRs">Internal Classes and Records</a></td><td>Fields</td><td><a class="section" href="#PasDoc-Methods">Methods</a></td><td><a class="section" href="#PasDoc-Properties">Properties</a></td></tr></table>
<a name="PasDoc-Description"></a><h2 class="unit">Unit</h2>
<p class="unitlink">
<a  href="CastleTextureFontData.html">CastleTextureFontData</a></p>
<h2 class="declaration">Declaration</h2>
<p class="declaration">
<code>type TTextureFontData = class(TObject)</code></p>
<h2 class="description">Description</h2>
<p>
Data for a 2D font initialized from a FreeType font file, like ttf.</p>
<a name="PasDoc-Hierarchy"></a><h2 class="hierarchy">Hierarchy</h2>
<ul class="hierarchy"><li class="ancestor">TObject</li>
<li class="thisitem">TTextureFontData</li></ul><h2 class="overview">Overview</h2>
<a name="PasDoc-InternalCRs"></a><h3 class="summary">Internal Classes and Records</h3>
<table class="summary wide_list">
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code><b><a  href="CastleTextureFontData.TTextureFontData.TGlyph.html">TGlyph</a></b> = class(TObject)</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code><b><a  href="CastleTextureFontData.TTextureFontData.TGlyphDictionary.html">TGlyphDictionary</a></b> = class(specialize TFPGMap&lt;<a  href="CastleUnicode.html#TUnicodeChar">TUnicodeChar</a>,<a  href="CastleTextureFontData.TTextureFontData.TGlyph.html">TGlyph</a>&gt;)</code></td>
</tr>
</table>
<a name="PasDoc-Methods"></a><h3 class="summary">Methods</h3>
<table class="summary wide_list">
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>constructor <b><a  href="CastleTextureFontData.TTextureFontData.html#Create">Create</a></b>(const URL: string; const ASize: Integer; const AnAntiAliased: boolean; ACharacters: <a  href="CastleUnicode.TUnicodeCharList.html">TUnicodeCharList</a> = nil);</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>constructor <b><a  href="CastleTextureFontData.TTextureFontData.html#CreateFromData">CreateFromData</a></b>(const AGlyphs: <a  href="CastleTextureFontData.TTextureFontData.TGlyphDictionary.html">TGlyphDictionary</a>; const AImage: <a  href="CastleImages.TGrayscaleImage.html">TGrayscaleImage</a>; const ASize: Integer; const AnAntiAliased: boolean);</code></td>
</tr>
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>destructor <b><a  href="CastleTextureFontData.TTextureFontData.html#Destroy">Destroy</a></b>; override;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>function <b><a  href="CastleTextureFontData.TTextureFontData.html#Glyph">Glyph</a></b>(const C: <a  href="CastleUnicode.html#TUnicodeChar">TUnicodeChar</a>): <a  href="CastleTextureFontData.TTextureFontData.TGlyph.html">TGlyph</a>;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>function <b><a  href="CastleTextureFontData.TTextureFontData.html#LoadedGlyphs">LoadedGlyphs</a></b>: <a  href="CastleUnicode.TUnicodeCharList.html">TUnicodeCharList</a>;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>function <b><a  href="CastleTextureFontData.TTextureFontData.html#TextWidth">TextWidth</a></b>(const S: string): Integer;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>function <b><a  href="CastleTextureFontData.TTextureFontData.html#TextHeight">TextHeight</a></b>(const S: string): Integer;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>function <b><a  href="CastleTextureFontData.TTextureFontData.html#TextHeightBase">TextHeightBase</a></b>(const S: string): Integer;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>function <b><a  href="CastleTextureFontData.TTextureFontData.html#TextMove">TextMove</a></b>(const S: string): <a  href="CastleVectors.html#TVector2Integer">TVector2Integer</a>;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>function <b><a  href="CastleTextureFontData.TTextureFontData.html#RowHeight">RowHeight</a></b>: Integer;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>function <b><a  href="CastleTextureFontData.TTextureFontData.html#RowHeightBase">RowHeightBase</a></b>: Integer;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>function <b><a  href="CastleTextureFontData.TTextureFontData.html#Descend">Descend</a></b>: Integer;</code></td>
</tr>
</table>
<a name="PasDoc-Properties"></a><h3 class="summary">Properties</h3>
<table class="summary wide_list">
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>property <b><a  href="CastleTextureFontData.TTextureFontData.html#AntiAliased">AntiAliased</a></b>: boolean read FAntiAliased;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>property <b><a  href="CastleTextureFontData.TTextureFontData.html#Size">Size</a></b>: Integer read FSize;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>property <b><a  href="CastleTextureFontData.TTextureFontData.html#Image">Image</a></b>: <a  href="CastleImages.TGrayscaleImage.html">TGrayscaleImage</a> read FImage;</code></td>
</tr>
</table>
<h2 class="description">Description</h2>
<h3 class="detail">Methods</h3>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="Create"></a><code>constructor <b>Create</b>(const URL: string; const ASize: Integer; const AnAntiAliased: boolean; ACharacters: <a  href="CastleUnicode.TUnicodeCharList.html">TUnicodeCharList</a> = nil);</code></td>
</tr>
<tr><td colspan="2">
<p>
Create by reading a FreeType font file, like ttf.

<p>Providing charaters list as <code>Nil</code> means that we only create glyphs for <a class="normal" href="CastleStringUtils.html#SimpleAsciiCharacters">SimpleAsciiCharacters</a>, which includes only the basic ASCII characters. The ACharacters instance <i>does not</i> become owned by this object, so remember to free it after calling this constructor.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="CreateFromData"></a><code>constructor <b>CreateFromData</b>(const AGlyphs: <a  href="CastleTextureFontData.TTextureFontData.TGlyphDictionary.html">TGlyphDictionary</a>; const AImage: <a  href="CastleImages.TGrayscaleImage.html">TGrayscaleImage</a>; const ASize: Integer; const AnAntiAliased: boolean);</code></td>
</tr>
<tr><td colspan="2">
<p>
Create from a ready data for glyphs and image. Useful when font data is embedded inside the Pascal source code. AGlyphs instance, and AImage instance, become owned by this class.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="Destroy"></a><code>destructor <b>Destroy</b>; override;</code></td>
</tr>
<tr><td colspan="2">
&nbsp;</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="Glyph"></a><code>function <b>Glyph</b>(const C: <a  href="CastleUnicode.html#TUnicodeChar">TUnicodeChar</a>): <a  href="CastleTextureFontData.TTextureFontData.TGlyph.html">TGlyph</a>;</code></td>
</tr>
<tr><td colspan="2">
<p>
Read-only information about a <code>glyph</code> for given character. <code>Nil</code> if given <code>glyph</code> not loaded (because was not requested at constructor, or because it doesn't exist in the font).</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="LoadedGlyphs"></a><code>function <b>LoadedGlyphs</b>: <a  href="CastleUnicode.TUnicodeCharList.html">TUnicodeCharList</a>;</code></td>
</tr>
<tr><td colspan="2">
<p>
List all characters for which glyphs are actually loaded. <a class="normal" href="CastleTextureFontData.TTextureFontData.html#Glyph">Glyph</a> will answer non-nil exactly for these characters. The resulting list instance is owned by caller, so take care to free it.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="TextWidth"></a><code>function <b>TextWidth</b>(const S: string): Integer;</code></td>
</tr>
<tr><td colspan="2">
&nbsp;</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="TextHeight"></a><code>function <b>TextHeight</b>(const S: string): Integer;</code></td>
</tr>
<tr><td colspan="2">
&nbsp;</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="TextHeightBase"></a><code>function <b>TextHeightBase</b>(const S: string): Integer;</code></td>
</tr>
<tr><td colspan="2">
<p>
The height (above the baseline) of the text. This doesn't take into account height of the text below the baseline (for example letter &quot;<a class="normal" href="CastleTextureFontData.TTextureFontData.TGlyph.html#Y">y</a>&quot; has the tail below the baseline in most fonts).</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="TextMove"></a><code>function <b>TextMove</b>(const S: string): <a  href="CastleVectors.html#TVector2Integer">TVector2Integer</a>;</code></td>
</tr>
<tr><td colspan="2">
&nbsp;</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="RowHeight"></a><code>function <b>RowHeight</b>: Integer;</code></td>
</tr>
<tr><td colspan="2">
<p>
Height of a row of text in this font. This may be calculated as simply <code><a class="normal" href="CastleTextureFontData.TTextureFontData.html#TextHeight">TextHeight</a>('Wy')</code> for most normal fonts.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="RowHeightBase"></a><code>function <b>RowHeightBase</b>: Integer;</code></td>
</tr>
<tr><td colspan="2">
<p>
Height (above the baseline) of a row of text in this font. Similar to <a class="normal" href="CastleTextureFontData.TTextureFontData.html#TextHeightBase">TextHeightBase</a> and <a class="normal" href="CastleTextureFontData.TTextureFontData.html#TextHeight">TextHeight</a>, note that <code>RowHeightBase</code> is generally smaller than <a class="normal" href="CastleTextureFontData.TTextureFontData.html#RowHeight">RowHeight</a>, because <code>RowHeightBase</code> doesn't care how low the letter may go below the baseline.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="Descend"></a><code>function <b>Descend</b>: Integer;</code></td>
</tr>
<tr><td colspan="2">
<p>
How low the text may go below the baseline.</p>
</td></tr>
</table>
<h3 class="detail">Properties</h3>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="AntiAliased"></a><code>property <b>AntiAliased</b>: boolean read FAntiAliased;</code></td>
</tr>
<tr><td colspan="2">
&nbsp;</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="Size"></a><code>property <b>Size</b>: Integer read FSize;</code></td>
</tr>
<tr><td colspan="2">
&nbsp;</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="Image"></a><code>property <b>Image</b>: <a  href="CastleImages.TGrayscaleImage.html">TGrayscaleImage</a> read FImage;</code></td>
</tr>
<tr><td colspan="2">
&nbsp;</td></tr>
</table>
<!-- Piwik -->
<script type="text/javascript">
  var _paq = _paq || [];
  _paq.push(["trackPageView"]);
  _paq.push(["enableLinkTracking"]);

  (function() {
    var u=(("https:" == document.location.protocol) ? "https" : "http") + "://michalis.ii.uni.wroc.pl/piwik-castle-engine/";
    _paq.push(["setTrackerUrl", u+"piwik.php"]);
    _paq.push(["setSiteId", "1"]);
    var d=document, g=d.createElement("script"), s=d.getElementsByTagName("script")[0]; g.type="text/javascript";
    g.defer=true; g.async=true; g.src=u+"piwik.js"; s.parentNode.insertBefore(g,s);
  })();
</script>
<!-- End Piwik Code -->

<noscript>
<!-- Piwik Image Tracker -->
<img src="http://michalis.ii.uni.wroc.pl/piwik-castle-engine/piwik.php?idsite=1&amp;rec=1" style="border:0" alt="" />
<!-- End Piwik -->
</noscript>
<hr noshade size="1"><span class="appinfo"><em>Generated by <a  href="http://pasdoc.sourceforge.net/">PasDoc 0.13.0</a> on 2015-06-15 04:43:12</em>
</span>
</td></tr></table></body></html>