File: TextRenderer.html

package info (click to toggle)
openlayer 2.1-2.1
  • links: PTS
  • area: main
  • in suites: bullseye, buster, stretch
  • size: 3,392 kB
  • ctags: 2,317
  • sloc: ansic: 10,433; cpp: 9,890; xml: 109; makefile: 90; sh: 36
file content (68 lines) | stat: -rw-r--r-- 11,480 bytes parent folder | download | duplicates (2)
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
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transistional//EN"><html><head><title>OpenLayer Offline Manual</title><style type="text/css" media="all">@import "CrystalStyle.css";</style><body bgcolor="FFFFFF" ><div align="center" style="pagestyle"><table width="60%"><tr><td><div class="parentLinks"><a href="index.html">OpenLayer</a> | <a href="TextRenderer.html">TextRenderer</a></div><br><div class="BigHeader">TextRenderer</div><br><div class="">The font container
<br>
<br><div class="Surrounded"><table><tr valign="top"><td align="right"><div class="FuncDef"><strong><a href="TextRenderer.html"><font color="#0000CC">TextRenderer</font></a>(</strong></div></td><td><div class="FuncDef"><strong><font color="#777733">const</font> <font color="#777733">char</font> *filename,
<br><font color="#777733">int</font> width = <font color="#994400">9</font>, <font color="#777733">int</font> height = <font color="#994400">12</font>,
<br><a href="Rgba.html"><font color="#0000CC">Rgba</font></a> col = <a href="Rgba.html"><font color="#0000CC">Rgba</font></a>::BLACK, <font color="#777733">int</font> italics = <font color="#994400">0</font>,
<br><font color="#777733">bool</font> useHinting = <font color="#774422">true</font> );
<br></strong></div></td></tr></table>
<br>Construct the font by loading a True Type Font file.
<br></div>
<br>
<br><div class="Surrounded"><table><tr valign="top"><td align="right"><div class="FuncDef"><strong><a href="TextRenderer.html"><font color="#0000CC">TextRenderer</font></a>(</strong></div></td><td><div class="FuncDef"><strong><font color="#777733">const</font> <a href="TextRenderer.html"><font color="#0000CC">TextRenderer</font></a> &amp;otherRenderer,
<br><font color="#777733">int</font> width = <font color="#994400">9</font>, <font color="#777733">int</font> height = <font color="#994400">12</font>,
<br><a href="Rgba.html"><font color="#0000CC">Rgba</font></a> col = <font color="#770044">[inherit]</font>, <font color="#777733">int</font> italics = <font color="#770044">[inherit]</font> );
<br></strong></div></td></tr></table>
<br>Construct the font by making an altered copy of an existing <a href="TextRenderer.html"><font color="#0000CC">TextRenderer</font></a>. If you don't pass anything as the color or the italics parameter they'll be inherited from otherRenderer.
<br></div>
<br>
<br><div class="Surrounded"><table><tr valign="top"><td align="right"><div class="FuncDef"><strong><a href="TextRenderer.html"><font color="#0000CC">TextRenderer</font></a>(</strong></div></td><td><div class="FuncDef"><strong>GLYPH_FACE *face = <font color="#994400">0</font>,
<br><font color="#777733">int</font> width = <font color="#994400">9</font>, <font color="#777733">int</font> height = <font color="#994400">12</font>,
<br><a href="Rgba.html"><font color="#0000CC">Rgba</font></a> col = <a href="Rgba.html"><font color="#0000CC">Rgba</font></a>::BLACK, <font color="#777733">int</font> italics = <font color="#994400">0</font> );
<br></strong></div></td></tr></table>
<br>Construct the font by using a Glyph Keeper font face.
<br></div>
<br>
<br><div class="Surrounded"><table><tr valign="top"><td align="right"><div class="FuncDef"><strong><a href="TextRenderer.html"><font color="#0000CC">TextRenderer</font></a>();
<br></strong></div></td></tr></table>
<br>The default constructor. Note that the TextRenderer will not be ready to use before you call the <a href="Bitmap/Load.html"><font color="#0000CC">Load</font></a> -method (<a href="TextRenderer/IsValid.html"><font color="#0000CC">IsValid</font></a>() returns false).
<br></div>
<br>The constructors do the the same as the equivalent <a href="Bitmap/Load.html"><font color="#0000CC">Load</font></a> -methods. The dimensions are in pixels and the italics angle is in degrees.
<br>
<br>The alpha value of the color controls the opacity of the printed text. The higher the alpha value is, the more visible the text will be. For more information about alpha values see the definition of <a href="Bitmap.html"><font color="#0000CC">Bitmap</font></a>.
<br>
<br>If any of these functions fail to construct the font an error log will be added to the allegro.log file. In addition the <a href="TextRenderer/IsValid.html"><font color="#0000CC">IsValid</font></a>() -method will return false if the TextRenderer is not ready to use. You can also test the validity of a TextRenderer like if the TextRenderer was a boolean value.
<br>
<br>Global TextRenderers are now automated.</div><br><div class="MediumHeader">Examples</div><br><div class="Code"><font color="#999922">//&nbsp;Construct&nbsp;a&nbsp;new&nbsp;font&nbsp;by&nbsp;loading&nbsp;a&nbsp;true&nbsp;type&nbsp;font&nbsp;Arial.ttf&nbsp;in&nbsp;the&nbsp;fonts&nbsp;-folder&nbsp;//</font>
<br><font color="#999922">//&nbsp;with&nbsp;the&nbsp;width&nbsp;of&nbsp;10,&nbsp;the&nbsp;height&nbsp;of&nbsp;15&nbsp;and&nbsp;a&nbsp;black&nbsp;color&nbsp;//</font>
<br><a href="TextRenderer.html"><font color="#0000CC">TextRenderer</font></a>&nbsp;myTextRenderer(&nbsp;<font color="#CC0000">"fonts/Arial.ttf"</font>,&nbsp;<font color="#994400">10</font>,&nbsp;<font color="#994400">15</font>,&nbsp;<a href="Rgba.html"><font color="#0000CC">Rgba</font></a>::BLACK&nbsp;);
<br>
<br><font color="#999922">//&nbsp;Construct&nbsp;a&nbsp;same&nbsp;looking&nbsp;font&nbsp;but&nbsp;with&nbsp;italics&nbsp;angle&nbsp;of&nbsp;12&nbsp;(the&nbsp;common&nbsp;italics&nbsp;angle)&nbsp;//</font>
<br><a href="TextRenderer.html"><font color="#0000CC">TextRenderer</font></a>&nbsp;myItalicsRenderer(&nbsp;<font color="#CC0000">"fonts/Arial.ttf"</font>,&nbsp;<font color="#994400">10</font>,&nbsp;<font color="#994400">15</font>,&nbsp;<a href="Rgba.html"><font color="#0000CC">Rgba</font></a>::BLACK,&nbsp;<font color="#994400">12</font>&nbsp;);
<br>
<br><font color="#999922">//&nbsp;Test&nbsp;if&nbsp;myItalicsRenderer&nbsp;was&nbsp;loaded&nbsp;correctly&nbsp;(maybe&nbsp;it&nbsp;didn't&nbsp;exist)&nbsp;//</font>
<br><font color="#447711">if</font>(&nbsp;!myItalicsRenderer&nbsp;)&nbsp;{
<br>&nbsp;&nbsp;allegro_message(&nbsp;<font color="#CC0000">"Couldn't&nbsp;load&nbsp;fonts/Arial.ttf"</font>&nbsp;);
<br>}
<br>
<br><font color="#999922">//&nbsp;Construct&nbsp;a&nbsp;font&nbsp;which&nbsp;looks&nbsp;like&nbsp;myTextRenderer&nbsp;but&nbsp;with&nbsp;the&nbsp;opacity&nbsp;of&nbsp;only&nbsp;30%&nbsp;//</font>
<br><a href="TextRenderer.html"><font color="#0000CC">TextRenderer</font></a>&nbsp;myTranslucentRenderer(&nbsp;<font color="#CC0000">"fonts/Arial.ttf"</font>,&nbsp;<font color="#994400">10</font>,&nbsp;<font color="#994400">15</font>,&nbsp;<a href="Rgba.html"><font color="#0000CC">Rgba</font></a>(&nbsp;<font color="#994400">0.0</font>,&nbsp;<font color="#994400">0.0</font>,&nbsp;<font color="#994400">0.0</font>,&nbsp;<font color="#994400">0.30</font>&nbsp;));
<br>
<br><font color="#999922">//&nbsp;Construct&nbsp;a&nbsp;smaller&nbsp;copy&nbsp;of&nbsp;an&nbsp;existing&nbsp;font&nbsp;(sized&nbsp;9x12)&nbsp;//</font>
<br><font color="#999922">//&nbsp;If&nbsp;you&nbsp;don't&nbsp;specify&nbsp;a&nbsp;color&nbsp;it'll&nbsp;be&nbsp;inherited&nbsp;//</font>
<br><font color="#999922">//&nbsp;from&nbsp;the&nbsp;passed&nbsp;TextRenderer&nbsp;//</font>
<br><a href="TextRenderer.html"><font color="#0000CC">TextRenderer</font></a>&nbsp;smallerTextRenderer(&nbsp;myTextRenderer,&nbsp;<font color="#994400">9</font>,&nbsp;<font color="#994400">12</font>&nbsp;);
<br>
<br><font color="#999922">//&nbsp;Construct&nbsp;the&nbsp;font&nbsp;from&nbsp;a&nbsp;glyph&nbsp;keeper&nbsp;font&nbsp;face&nbsp;//</font>
<br><font color="#999922">//&nbsp;with&nbsp;a&nbsp;slightly&nbsp;yellow&nbsp;green&nbsp;color&nbsp;//</font>
<br>GLYPH_FACE&nbsp;*glyphKeeperFace&nbsp;=&nbsp;...;&nbsp;
<br>
<br><a href="TextRenderer.html"><font color="#0000CC">TextRenderer</font></a>&nbsp;otherTextRenderer(&nbsp;glyphKeeperFace,&nbsp;<font color="#994400">20</font>,&nbsp;<font color="#994400">15</font>,&nbsp;<a href="Rgba.html"><font color="#0000CC">Rgba</font></a>(&nbsp;<font color="#994400">0.3</font>,&nbsp;<font color="#994400">1.0</font>,&nbsp;<font color="#994400">0.0</font>&nbsp;));</div><div class=""><br><br><div class="MediumHeader">Member functions</div><div class="Surrounded"><table size="100%" cellpadding="0" cellspacing="0"><tr><td halign="center" class="funclist"><a href="TextRenderer/Load.html">Load</a></td><td width="65%" halign="center"><div class="smalltext">Load the font</div></td></tr><tr><td halign="center" class="funclist"><a href="TextRenderer/Print.html">Print</a></td><td width="65%" halign="center"><div class="smalltext">Prints the given text to the screen</div></td></tr><tr><td halign="center" class="funclist"><a href="TextRenderer/SetColor.html">SetColor</a></td><td width="65%" halign="center"><div class="smalltext">
Sets the color of the font</div></td></tr><tr><td halign="center" class="funclist"><a href="TextRenderer/GetColor.html">GetColor</a></td><td width="65%" halign="center"><div class="smalltext">
Returns the text color of the font</div></td></tr><tr><td halign="center" class="funclist"><a href="TextRenderer/SetItalics.html">SetItalics</a></td><td width="65%" halign="center"><div class="smalltext">
Sets the italics angle of the text</div></td></tr><tr><td halign="center" class="funclist"><a href="TextRenderer/GetItalics.html">GetItalics</a></td><td width="65%" halign="center"><div class="smalltext">
Returns the italics angle of the text</div></td></tr><tr><td halign="center" class="funclist"><a href="TextRenderer/Width.html">Width</a></td><td width="65%" halign="center"><div class="smalltext">
Returns the width of the given text</div></td></tr><tr><td halign="center" class="funclist"><a href="TextRenderer/Height.html">Height</a></td><td width="65%" halign="center"><div class="smalltext">
Returns the height of the given text</div></td></tr><tr><td halign="center" class="funclist"><a href="TextRenderer/FirstLineWidth.html">FirstLineWidth</a></td><td width="65%" halign="center"><div class="smalltext">
Returns the width of the first text line of the given text</div></td></tr><tr><td halign="center" class="funclist"><a href="TextRenderer/FirstLineHeight.html">FirstLineHeight</a></td><td width="65%" halign="center"><div class="smalltext">
Returns the height of the first text line of the given text</div></td></tr><tr><td halign="center" class="funclist"><a href="TextRenderer/IsValid.html">IsValid</a></td><td width="65%" halign="center"><div class="smalltext">
Checks if the TextRenderer was loaded correctly</div></td></tr><tr><td colspan="2"><br><div class="SmallHeader"><font color="#775500">Advanced functions</font></div><br></td></tr><tr><td halign="center" class="funclist"><a href="TextRenderer/GetFace.html">GetFace</a></td><td width="65%" halign="center"></td></tr><tr><td halign="center" class="funclist"><a href="TextRenderer/SendToGPU.html">SendToGPU</a></td><td width="65%" halign="center"></td></tr><tr><td halign="center" class="funclist"><a href="TextRenderer/UnloadFromGPU.html">UnloadFromGPU</a></td><td width="65%" halign="center"></td></tr><tr><td halign="center" class="funclist"><a href="TextRenderer/UseAutoDelete.html">UseAutoDelete</a></td><td width="65%" halign="center"></td></tr></table></div><br><div class=""><a href="index.html">Back to the main page of the manual</a></div><br>Questions about TextRenderer? Click <a href="http://crystalstorm.ath.cx/index.php?lan=en&page=CreateFeedback&subject=TextRenderer">here.</a></div></td></tr></table></body></html>