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
|
<!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> | <a href="../TextRenderer/Load.html">Load</a></div><br><div class="BigHeader">Load</div><br><div class=""><div class="Surrounded"><table><tr valign="top"><td align="right"><div class="FuncDef"><strong><font color="#777733">bool</font> <a href="../Bitmap/Load.html"><font color="#0000CC">Load</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>Load the font from a True Type Font file.
<br></div>
<br>
<br><div class="Surrounded"><table><tr valign="top"><td align="right"><div class="FuncDef"><strong><font color="#777733">bool</font> <a href="../Bitmap/Load.html"><font color="#0000CC">Load</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> &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>Load 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><font color="#777733">bool</font> <a href="../Bitmap/Load.html"><font color="#0000CC">Load</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><font color="#777733">bool</font> useHinting = <font color="#774422">true</font> );
<br></strong></div></td></tr></table>
<br>Load the font by using a GlyphKeeper font face.
<br></div>
<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 load 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.
<br>
<br>A word of caution: You can't load any TextRenderers before <a href="../Setup.html"><font color="#0000CC">Setup</font></a>::<a href="../Setup/SetupProgram.html"><font color="#0000CC">SetupProgram</font></a> and <a href="../Setup.html"><font color="#0000CC">Setup</font></a>::<a href="../Setup/SetupScreen.html"><font color="#0000CC">SetupScreen</font></a> are called!</div><br><div class="MediumHeader">Examples</div><br><div class="Code"><font color="#999922">// The usage of the Load -method is generally the same as with the constructors //</font>
<br>
<br><font color="#999922">// Construct a new font by loading a true type font Arial.ttf in the fonts -folder //</font>
<br><font color="#999922">// with the width of 10, the height of 15 and a black color //</font>
<br><a href="../TextRenderer.html"><font color="#0000CC">TextRenderer</font></a> myTextRenderer;
<br><font color="#447711">if</font>( myTextRenderer.<a href="../Bitmap/Load.html"><font color="#0000CC">Load</font></a>( <font color="#CC0000">"fonts/Arial.ttf"</font>, <font color="#994400">10</font>, <font color="#994400">15</font>, <a href="../Rgba.html"><font color="#0000CC">Rgba</font></a>::BLACK ) == <font color="#774422">false</font> ) {
<br> allegro_message( <font color="#CC0000">"Couldn't load the font Arial.ttf!"</font> );
<br> exit( -<font color="#994400">1</font> );
<br>}
<br>
<br><font color="#999922">// Construct a same looking font but with italics angle of 12 (the common italics angle) //</font>
<br><a href="../TextRenderer.html"><font color="#0000CC">TextRenderer</font></a> myItalicsRenderer;
<br><font color="#447711">if</font>( myItalicsRenderer.<a href="../Bitmap/Load.html"><font color="#0000CC">Load</font></a>( <font color="#CC0000">"fonts/Arial.ttf"</font>, <font color="#994400">10</font>, <font color="#994400">15</font>, <a href="../Rgba.html"><font color="#0000CC">Rgba</font></a>::BLACK, <font color="#994400">12</font> ) == <font color="#774422">false</font> ) {
<br> allegro_message( <font color="#CC0000">"Couldn't load the font Arial.ttf!"</font> );
<br> exit( -<font color="#994400">1</font> );
<br>}
<br>
<br><font color="#999922">// Construct a font which looks like myTextRenderer but with the opacity of only 30% //</font>
<br><a href="../TextRenderer.html"><font color="#0000CC">TextRenderer</font></a> myTranslucentRenderer;
<br><font color="#447711">if</font>( myTranslucentRenderer.<a href="../Bitmap/Load.html"><font color="#0000CC">Load</font></a>( <font color="#CC0000">"fonts/Arial.ttf"</font>, <font color="#994400">10</font>, <font color="#994400">15</font>, <a href="../Rgba.html"><font color="#0000CC">Rgba</font></a>( <font color="#994400">0.0</font>, <font color="#994400">0.0</font>, <font color="#994400">0.0</font>, <font color="#994400">0.30</font> )) == <font color="#774422">false</font> ) {
<br> allegro_message( <font color="#CC0000">"Couldn't load the font Arial.ttf!"</font> );
<br> exit( -<font color="#994400">1</font> );
<br>}
<br>
<br><font color="#999922">// Construct a smaller copy of an existing font (sized 9x12) //</font>
<br><font color="#999922">// If you don't specify a color it'll be inherited //</font>
<br><font color="#999922">// from the passed TextRenderer //</font>
<br><a href="../TextRenderer.html"><font color="#0000CC">TextRenderer</font></a> smallerTextRenderer;
<br>smallerTextRenderer.<a href="../Bitmap/Load.html"><font color="#0000CC">Load</font></a>( myTextRenderer, <font color="#994400">9</font>, <font color="#994400">12</font> );
<br>
<br><font color="#999922">// Construct the font from a glyph keeper font face //</font>
<br><font color="#999922">// with a slightly yellow green color //</font>
<br>GLYPH_FACE *glyphKeeperFace = ...;
<br>
<br><a href="../TextRenderer.html"><font color="#0000CC">TextRenderer</font></a> otherTextRenderer;
<br><font color="#447711">if</font>( otherTextRenderer.<a href="../Bitmap/Load.html"><font color="#0000CC">Load</font></a>( glyphKeeperFace, <font color="#994400">20</font>, <font color="#994400">15</font>, <a href="../Rgba.html"><font color="#0000CC">Rgba</font></a>( <font color="#994400">0.3</font>, <font color="#994400">1.0</font>, <font color="#994400">0.0</font> )) == <font color="#774422">false</font> ) {
<br> allegro_message( <font color="#CC0000">"Couldn't load the font from a Glyph Keeper face!"</font> );
<br> exit( -<font color="#994400">1</font> );
<br>}
<br>
<br></div><div class=""><br><br><div class="MediumHeader">Other functions of the class <a href="../TextRenderer.html"><font color="#0000CC">TextRenderer</font></a></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 Load? Click <a href="http://crystalstorm.ath.cx/index.php?lan=en&page=CreateFeedback&subject=Load">here.</a></div></td></tr></table></body></html>
|