| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415 |
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
- <html xmlns="http://www.w3.org/1999/xhtml">
- <head>
- <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
- <meta http-equiv="X-UA-Compatible" content="IE=9"/>
- <meta name="generator" content="Doxygen 1.8.3.1"/>
- <title>TorqueScript Reference: Font</title>
- <link href="tabs.css" rel="stylesheet" type="text/css"/>
- <script type="text/javascript" src="jquery.js"></script>
- <script type="text/javascript" src="dynsections.js"></script>
- <link href="doxygen.css" rel="stylesheet" type="text/css" />
- <link href="t2d-stylesheet-extra.css" rel="stylesheet" type="text/css"/>
- </head>
- <body>
- <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
- <div id="titlearea">
- <table cellspacing="0" cellpadding="0">
- <tbody>
- <tr style="height: 56px;">
- <td style="padding-left: 0.5em;">
- <div id="projectname">TorqueScript Reference
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <!-- end header part -->
- <!-- Generated by Doxygen 1.8.3.1 -->
- <div id="navrow1" class="tabs">
- <ul class="tablist">
- <li><a href="index.html"><span>Main Page</span></a></li>
- <li><a href="pages.html"><span>Related Pages</span></a></li>
- <li><a href="modules.html"><span>Modules</span></a></li>
- <li><a href="annotated.html"><span>Classes</span></a></li>
- </ul>
- </div>
- </div><!-- top -->
- <div class="header">
- <div class="summary">
- <a href="#func-members">Functions</a> </div>
- <div class="headertitle">
- <div class="title">Font<div class="ingroups"><a class="el" href="group__TorqueScriptFunctions.html">Function Categories</a></div></div> </div>
- </div><!--header-->
- <div class="contents">
- <table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
- Functions</h2></td></tr>
- <tr class="memitem:ga71d7d5188e69d6002f95b418e1ec564e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__FontFunctions.html#ga71d7d5188e69d6002f95b418e1ec564e">dumpFontCacheStatus</a> ()</td></tr>
- <tr class="separator:ga71d7d5188e69d6002f95b418e1ec564e"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga9b953bb421f46ff8b77779a416a0b406"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__FontFunctions.html#ga9b953bb421f46ff8b77779a416a0b406">duplicateCachedFont</a> (oldFontName, oldFontSize, newFontName)</td></tr>
- <tr class="separator:ga9b953bb421f46ff8b77779a416a0b406"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:gab4f929b88f2764b49fe2856a2332efa4"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__FontFunctions.html#gab4f929b88f2764b49fe2856a2332efa4">exportCachedFont</a> (fontName, size, <a class="el" href="group__FileSystemFunctions.html#ga4ea5109dc203259fb3c01292345bc0ee">fileName</a>, padding, kerning)</td></tr>
- <tr class="separator:gab4f929b88f2764b49fe2856a2332efa4"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga2f7a61ba13d4f92f4663e0756f488a11"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__FontFunctions.html#ga2f7a61ba13d4f92f4663e0756f488a11">importCachedFont</a> (fontName, size, <a class="el" href="group__FileSystemFunctions.html#ga4ea5109dc203259fb3c01292345bc0ee">fileName</a>, padding, kerning)</td></tr>
- <tr class="separator:ga2f7a61ba13d4f92f4663e0756f488a11"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:gab2c5339f9bef52061989eda483ca860b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__FontFunctions.html#gab2c5339f9bef52061989eda483ca860b">populateAllFontCacheRange</a> (rangeStart, rangeEnd)</td></tr>
- <tr class="separator:gab2c5339f9bef52061989eda483ca860b"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga17a30a4a1d0fdbeb8652a42ec113ce6d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__FontFunctions.html#ga17a30a4a1d0fdbeb8652a42ec113ce6d">populateAllFontCacheString</a> (string inString)</td></tr>
- <tr class="separator:ga17a30a4a1d0fdbeb8652a42ec113ce6d"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga6653bfac817cd36a127884917b4036d4"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__FontFunctions.html#ga6653bfac817cd36a127884917b4036d4">populateFontCacheRange</a> (faceName, size, rangeStart, rangeEnd)</td></tr>
- <tr class="separator:ga6653bfac817cd36a127884917b4036d4"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga82a9ee22d4c2b4b220e336e78de1b438"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__FontFunctions.html#ga82a9ee22d4c2b4b220e336e78de1b438">populateFontCacheString</a> (faceName, size, string)</td></tr>
- <tr class="separator:ga82a9ee22d4c2b4b220e336e78de1b438"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga97e9cb8bcb1d93c4fffe93166341c79b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__FontFunctions.html#ga97e9cb8bcb1d93c4fffe93166341c79b">writeFontCache</a> ()</td></tr>
- <tr class="separator:ga97e9cb8bcb1d93c4fffe93166341c79b"><td class="memSeparator" colspan="2"> </td></tr>
- </table>
- <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
- <h2 class="groupheader">Function Documentation</h2>
- <a class="anchor" id="ga71d7d5188e69d6002f95b418e1ec564e"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void dumpFontCacheStatus </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Dump a full description of all cached fonts, along with info on the codepoints each contains. </p>
- <dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>
- </div>
- </div>
- <a class="anchor" id="ga9b953bb421f46ff8b77779a416a0b406"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void duplicateCachedFont </td>
- <td>(</td>
- <td class="paramtype">oldFontName </td>
- <td class="paramname">, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">oldFontSize </td>
- <td class="paramname">, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">newFontName </td>
- <td class="paramname"> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Copy the specified old font to a new name. The new copy will not have a platform font backing it, and so will never have characters added to it. But this is useful for making copies of fonts to add postprocessing effects to via exportCachedFont. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">oldFontName</td><td>The original font. </td></tr>
- <tr><td class="paramname">oldFontSize</td><td>The original font's size property. </td></tr>
- <tr><td class="paramname">newFontName</td><td>The name to set the copy to. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
- </div>
- </div>
- <a class="anchor" id="gab4f929b88f2764b49fe2856a2332efa4"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void exportCachedFont </td>
- <td>(</td>
- <td class="paramtype">fontName </td>
- <td class="paramname">, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">size </td>
- <td class="paramname">, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="group__FileSystemFunctions.html#ga4ea5109dc203259fb3c01292345bc0ee">fileName</a> </td>
- <td class="paramname">, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">padding </td>
- <td class="paramname">, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">kerning </td>
- <td class="paramname"> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Export specified font to the specified filename as a PNG. The image can then be processed in Photoshop or another tool and reimported using importCachedFont. Characters in the font are exported as one long strip. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">fontName</td><td>The name of the font to export. </td></tr>
- <tr><td class="paramname">size</td><td>The size of the font </td></tr>
- <tr><td class="paramname">fileName</td><td>The export file name. </td></tr>
- <tr><td class="paramname">padding</td><td>Desired padding settings. </td></tr>
- <tr><td class="paramname">kerning</td><td>Kerning settings (space between elements) </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
- </div>
- </div>
- <a class="anchor" id="ga2f7a61ba13d4f92f4663e0756f488a11"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void importCachedFont </td>
- <td>(</td>
- <td class="paramtype">fontName </td>
- <td class="paramname">, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">size </td>
- <td class="paramname">, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="group__FileSystemFunctions.html#ga4ea5109dc203259fb3c01292345bc0ee">fileName</a> </td>
- <td class="paramname">, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">padding </td>
- <td class="paramname">, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">kerning </td>
- <td class="paramname"> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Import an image strip from exportCachedFont. Call with the same parameters you called exportCachedFont. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">fontName</td><td>The name of the font to import. </td></tr>
- <tr><td class="paramname">size</td><td>The size of the font </td></tr>
- <tr><td class="paramname">fileName</td><td>The imported file name. </td></tr>
- <tr><td class="paramname">padding</td><td>Desired padding settings. </td></tr>
- <tr><td class="paramname">kerning</td><td>Kerning settings (space between elements) </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
- </div>
- </div>
- <a class="anchor" id="gab2c5339f9bef52061989eda483ca860b"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void populateAllFontCacheRange </td>
- <td>(</td>
- <td class="paramtype">rangeStart </td>
- <td class="paramname">, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">rangeEnd </td>
- <td class="paramname"> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Populate the font cache for all fonts with Unicode code points in the specified range. Note we only support BMP-0, so code points range from 0 to 65535. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">rangeStart,rangeEnd</td><td>The range of the unicode points to populate caches with </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>
- </div>
- </div>
- <a class="anchor" id="ga17a30a4a1d0fdbeb8652a42ec113ce6d"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void populateAllFontCacheString </td>
- <td>(</td>
- <td class="paramtype">string </td>
- <td class="paramname"><em>inString</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Populate the font cache for all fonts with characters from the specified string. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">inString</td><td>The string to use to set the font caches </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
- </div>
- </div>
- <a class="anchor" id="ga6653bfac817cd36a127884917b4036d4"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void populateFontCacheRange </td>
- <td>(</td>
- <td class="paramtype">faceName </td>
- <td class="paramname">, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">size </td>
- <td class="paramname">, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">rangeStart </td>
- <td class="paramname">, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">rangeEnd </td>
- <td class="paramname"> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Populate the font cache for the specified font with Unicode code points in the specified range. Note we only support BMP-0, so code points range from 0 to 65535. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">faceName</td><td>The name of the font </td></tr>
- <tr><td class="paramname">size</td><td>The size of the font. </td></tr>
- <tr><td class="paramname">rangeStart</td><td>The initial Unicode point </td></tr>
- <tr><td class="paramname">rangeEnd</td><td>The final Unicode point in range </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>
- </div>
- </div>
- <a class="anchor" id="ga82a9ee22d4c2b4b220e336e78de1b438"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void populateFontCacheString </td>
- <td>(</td>
- <td class="paramtype">faceName </td>
- <td class="paramname">, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">size </td>
- <td class="paramname">, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">string </td>
- <td class="paramname"> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Populate the font cache for the specified font with characters from the specified string. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">faceName</td><td>The font's name </td></tr>
- <tr><td class="paramname">size</td><td>The size of the font. </td></tr>
- <tr><td class="paramname">string</td><td>The string to use to fill font cache </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
- </div>
- </div>
- <a class="anchor" id="ga97e9cb8bcb1d93c4fffe93166341c79b"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void writeFontCache </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>force all cached fonts to serialize themselves to the cache. </p>
- <dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>
- </div>
- </div>
- </div><!-- contents -->
- <!-- start footer part -->
- <hr class="footer"/><address class="footer"><small>
- Generated by  <a href="http://www.doxygen.org/index.html">
- <img class="footer" src="doxygen.png" alt="doxygen"/>
- </a> 1.8.3.1
- </small></address>
- </body>
- </html>
|