group__FontFunctions.html 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.3.1"/>
  7. <title>TorqueScript Reference: Font</title>
  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  9. <script type="text/javascript" src="jquery.js"></script>
  10. <script type="text/javascript" src="dynsections.js"></script>
  11. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  12. <link href="t2d-stylesheet-extra.css" rel="stylesheet" type="text/css"/>
  13. </head>
  14. <body>
  15. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  16. <div id="titlearea">
  17. <table cellspacing="0" cellpadding="0">
  18. <tbody>
  19. <tr style="height: 56px;">
  20. <td style="padding-left: 0.5em;">
  21. <div id="projectname">TorqueScript Reference
  22. </div>
  23. </td>
  24. </tr>
  25. </tbody>
  26. </table>
  27. </div>
  28. <!-- end header part -->
  29. <!-- Generated by Doxygen 1.8.3.1 -->
  30. <div id="navrow1" class="tabs">
  31. <ul class="tablist">
  32. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  33. <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
  34. <li><a href="modules.html"><span>Modules</span></a></li>
  35. <li><a href="annotated.html"><span>Classes</span></a></li>
  36. </ul>
  37. </div>
  38. </div><!-- top -->
  39. <div class="header">
  40. <div class="summary">
  41. <a href="#func-members">Functions</a> </div>
  42. <div class="headertitle">
  43. <div class="title">Font<div class="ingroups"><a class="el" href="group__TorqueScriptFunctions.html">Function Categories</a></div></div> </div>
  44. </div><!--header-->
  45. <div class="contents">
  46. <table class="memberdecls">
  47. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  48. Functions</h2></td></tr>
  49. <tr class="memitem:ga71d7d5188e69d6002f95b418e1ec564e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FontFunctions.html#ga71d7d5188e69d6002f95b418e1ec564e">dumpFontCacheStatus</a> ()</td></tr>
  50. <tr class="separator:ga71d7d5188e69d6002f95b418e1ec564e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  51. <tr class="memitem:ga9b953bb421f46ff8b77779a416a0b406"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FontFunctions.html#ga9b953bb421f46ff8b77779a416a0b406">duplicateCachedFont</a> (oldFontName, oldFontSize, newFontName)</td></tr>
  52. <tr class="separator:ga9b953bb421f46ff8b77779a416a0b406"><td class="memSeparator" colspan="2">&#160;</td></tr>
  53. <tr class="memitem:gab4f929b88f2764b49fe2856a2332efa4"><td class="memItemLeft" align="right" valign="top">void&#160;</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>
  54. <tr class="separator:gab4f929b88f2764b49fe2856a2332efa4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  55. <tr class="memitem:ga2f7a61ba13d4f92f4663e0756f488a11"><td class="memItemLeft" align="right" valign="top">void&#160;</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>
  56. <tr class="separator:ga2f7a61ba13d4f92f4663e0756f488a11"><td class="memSeparator" colspan="2">&#160;</td></tr>
  57. <tr class="memitem:gab2c5339f9bef52061989eda483ca860b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FontFunctions.html#gab2c5339f9bef52061989eda483ca860b">populateAllFontCacheRange</a> (rangeStart, rangeEnd)</td></tr>
  58. <tr class="separator:gab2c5339f9bef52061989eda483ca860b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  59. <tr class="memitem:ga17a30a4a1d0fdbeb8652a42ec113ce6d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FontFunctions.html#ga17a30a4a1d0fdbeb8652a42ec113ce6d">populateAllFontCacheString</a> (string inString)</td></tr>
  60. <tr class="separator:ga17a30a4a1d0fdbeb8652a42ec113ce6d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  61. <tr class="memitem:ga6653bfac817cd36a127884917b4036d4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FontFunctions.html#ga6653bfac817cd36a127884917b4036d4">populateFontCacheRange</a> (faceName, size, rangeStart, rangeEnd)</td></tr>
  62. <tr class="separator:ga6653bfac817cd36a127884917b4036d4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  63. <tr class="memitem:ga82a9ee22d4c2b4b220e336e78de1b438"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FontFunctions.html#ga82a9ee22d4c2b4b220e336e78de1b438">populateFontCacheString</a> (faceName, size, string)</td></tr>
  64. <tr class="separator:ga82a9ee22d4c2b4b220e336e78de1b438"><td class="memSeparator" colspan="2">&#160;</td></tr>
  65. <tr class="memitem:ga97e9cb8bcb1d93c4fffe93166341c79b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FontFunctions.html#ga97e9cb8bcb1d93c4fffe93166341c79b">writeFontCache</a> ()</td></tr>
  66. <tr class="separator:ga97e9cb8bcb1d93c4fffe93166341c79b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  67. </table>
  68. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  69. <h2 class="groupheader">Function Documentation</h2>
  70. <a class="anchor" id="ga71d7d5188e69d6002f95b418e1ec564e"></a>
  71. <div class="memitem">
  72. <div class="memproto">
  73. <table class="memname">
  74. <tr>
  75. <td class="memname">void dumpFontCacheStatus </td>
  76. <td>(</td>
  77. <td class="paramname"></td><td>)</td>
  78. <td></td>
  79. </tr>
  80. </table>
  81. </div><div class="memdoc">
  82. <p>Dump a full description of all cached fonts, along with info on the codepoints each contains. </p>
  83. <dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>
  84. </div>
  85. </div>
  86. <a class="anchor" id="ga9b953bb421f46ff8b77779a416a0b406"></a>
  87. <div class="memitem">
  88. <div class="memproto">
  89. <table class="memname">
  90. <tr>
  91. <td class="memname">void duplicateCachedFont </td>
  92. <td>(</td>
  93. <td class="paramtype">oldFontName&#160;</td>
  94. <td class="paramname">, </td>
  95. </tr>
  96. <tr>
  97. <td class="paramkey"></td>
  98. <td></td>
  99. <td class="paramtype">oldFontSize&#160;</td>
  100. <td class="paramname">, </td>
  101. </tr>
  102. <tr>
  103. <td class="paramkey"></td>
  104. <td></td>
  105. <td class="paramtype">newFontName&#160;</td>
  106. <td class="paramname">&#160;</td>
  107. </tr>
  108. <tr>
  109. <td></td>
  110. <td>)</td>
  111. <td></td><td></td>
  112. </tr>
  113. </table>
  114. </div><div class="memdoc">
  115. <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>
  116. <dl class="params"><dt>Parameters</dt><dd>
  117. <table class="params">
  118. <tr><td class="paramname">oldFontName</td><td>The original font. </td></tr>
  119. <tr><td class="paramname">oldFontSize</td><td>The original font's size property. </td></tr>
  120. <tr><td class="paramname">newFontName</td><td>The name to set the copy to. </td></tr>
  121. </table>
  122. </dd>
  123. </dl>
  124. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  125. </div>
  126. </div>
  127. <a class="anchor" id="gab4f929b88f2764b49fe2856a2332efa4"></a>
  128. <div class="memitem">
  129. <div class="memproto">
  130. <table class="memname">
  131. <tr>
  132. <td class="memname">void exportCachedFont </td>
  133. <td>(</td>
  134. <td class="paramtype">fontName&#160;</td>
  135. <td class="paramname">, </td>
  136. </tr>
  137. <tr>
  138. <td class="paramkey"></td>
  139. <td></td>
  140. <td class="paramtype">size&#160;</td>
  141. <td class="paramname">, </td>
  142. </tr>
  143. <tr>
  144. <td class="paramkey"></td>
  145. <td></td>
  146. <td class="paramtype"><a class="el" href="group__FileSystemFunctions.html#ga4ea5109dc203259fb3c01292345bc0ee">fileName</a>&#160;</td>
  147. <td class="paramname">, </td>
  148. </tr>
  149. <tr>
  150. <td class="paramkey"></td>
  151. <td></td>
  152. <td class="paramtype">padding&#160;</td>
  153. <td class="paramname">, </td>
  154. </tr>
  155. <tr>
  156. <td class="paramkey"></td>
  157. <td></td>
  158. <td class="paramtype">kerning&#160;</td>
  159. <td class="paramname">&#160;</td>
  160. </tr>
  161. <tr>
  162. <td></td>
  163. <td>)</td>
  164. <td></td><td></td>
  165. </tr>
  166. </table>
  167. </div><div class="memdoc">
  168. <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>
  169. <dl class="params"><dt>Parameters</dt><dd>
  170. <table class="params">
  171. <tr><td class="paramname">fontName</td><td>The name of the font to export. </td></tr>
  172. <tr><td class="paramname">size</td><td>The size of the font </td></tr>
  173. <tr><td class="paramname">fileName</td><td>The export file name. </td></tr>
  174. <tr><td class="paramname">padding</td><td>Desired padding settings. </td></tr>
  175. <tr><td class="paramname">kerning</td><td>Kerning settings (space between elements) </td></tr>
  176. </table>
  177. </dd>
  178. </dl>
  179. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  180. </div>
  181. </div>
  182. <a class="anchor" id="ga2f7a61ba13d4f92f4663e0756f488a11"></a>
  183. <div class="memitem">
  184. <div class="memproto">
  185. <table class="memname">
  186. <tr>
  187. <td class="memname">void importCachedFont </td>
  188. <td>(</td>
  189. <td class="paramtype">fontName&#160;</td>
  190. <td class="paramname">, </td>
  191. </tr>
  192. <tr>
  193. <td class="paramkey"></td>
  194. <td></td>
  195. <td class="paramtype">size&#160;</td>
  196. <td class="paramname">, </td>
  197. </tr>
  198. <tr>
  199. <td class="paramkey"></td>
  200. <td></td>
  201. <td class="paramtype"><a class="el" href="group__FileSystemFunctions.html#ga4ea5109dc203259fb3c01292345bc0ee">fileName</a>&#160;</td>
  202. <td class="paramname">, </td>
  203. </tr>
  204. <tr>
  205. <td class="paramkey"></td>
  206. <td></td>
  207. <td class="paramtype">padding&#160;</td>
  208. <td class="paramname">, </td>
  209. </tr>
  210. <tr>
  211. <td class="paramkey"></td>
  212. <td></td>
  213. <td class="paramtype">kerning&#160;</td>
  214. <td class="paramname">&#160;</td>
  215. </tr>
  216. <tr>
  217. <td></td>
  218. <td>)</td>
  219. <td></td><td></td>
  220. </tr>
  221. </table>
  222. </div><div class="memdoc">
  223. <p>Import an image strip from exportCachedFont. Call with the same parameters you called exportCachedFont. </p>
  224. <dl class="params"><dt>Parameters</dt><dd>
  225. <table class="params">
  226. <tr><td class="paramname">fontName</td><td>The name of the font to import. </td></tr>
  227. <tr><td class="paramname">size</td><td>The size of the font </td></tr>
  228. <tr><td class="paramname">fileName</td><td>The imported file name. </td></tr>
  229. <tr><td class="paramname">padding</td><td>Desired padding settings. </td></tr>
  230. <tr><td class="paramname">kerning</td><td>Kerning settings (space between elements) </td></tr>
  231. </table>
  232. </dd>
  233. </dl>
  234. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  235. </div>
  236. </div>
  237. <a class="anchor" id="gab2c5339f9bef52061989eda483ca860b"></a>
  238. <div class="memitem">
  239. <div class="memproto">
  240. <table class="memname">
  241. <tr>
  242. <td class="memname">void populateAllFontCacheRange </td>
  243. <td>(</td>
  244. <td class="paramtype">rangeStart&#160;</td>
  245. <td class="paramname">, </td>
  246. </tr>
  247. <tr>
  248. <td class="paramkey"></td>
  249. <td></td>
  250. <td class="paramtype">rangeEnd&#160;</td>
  251. <td class="paramname">&#160;</td>
  252. </tr>
  253. <tr>
  254. <td></td>
  255. <td>)</td>
  256. <td></td><td></td>
  257. </tr>
  258. </table>
  259. </div><div class="memdoc">
  260. <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>
  261. <dl class="params"><dt>Parameters</dt><dd>
  262. <table class="params">
  263. <tr><td class="paramname">rangeStart,rangeEnd</td><td>The range of the unicode points to populate caches with </td></tr>
  264. </table>
  265. </dd>
  266. </dl>
  267. <dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>
  268. </div>
  269. </div>
  270. <a class="anchor" id="ga17a30a4a1d0fdbeb8652a42ec113ce6d"></a>
  271. <div class="memitem">
  272. <div class="memproto">
  273. <table class="memname">
  274. <tr>
  275. <td class="memname">void populateAllFontCacheString </td>
  276. <td>(</td>
  277. <td class="paramtype">string&#160;</td>
  278. <td class="paramname"><em>inString</em></td><td>)</td>
  279. <td></td>
  280. </tr>
  281. </table>
  282. </div><div class="memdoc">
  283. <p>Populate the font cache for all fonts with characters from the specified string. </p>
  284. <dl class="params"><dt>Parameters</dt><dd>
  285. <table class="params">
  286. <tr><td class="paramname">inString</td><td>The string to use to set the font caches </td></tr>
  287. </table>
  288. </dd>
  289. </dl>
  290. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  291. </div>
  292. </div>
  293. <a class="anchor" id="ga6653bfac817cd36a127884917b4036d4"></a>
  294. <div class="memitem">
  295. <div class="memproto">
  296. <table class="memname">
  297. <tr>
  298. <td class="memname">void populateFontCacheRange </td>
  299. <td>(</td>
  300. <td class="paramtype">faceName&#160;</td>
  301. <td class="paramname">, </td>
  302. </tr>
  303. <tr>
  304. <td class="paramkey"></td>
  305. <td></td>
  306. <td class="paramtype">size&#160;</td>
  307. <td class="paramname">, </td>
  308. </tr>
  309. <tr>
  310. <td class="paramkey"></td>
  311. <td></td>
  312. <td class="paramtype">rangeStart&#160;</td>
  313. <td class="paramname">, </td>
  314. </tr>
  315. <tr>
  316. <td class="paramkey"></td>
  317. <td></td>
  318. <td class="paramtype">rangeEnd&#160;</td>
  319. <td class="paramname">&#160;</td>
  320. </tr>
  321. <tr>
  322. <td></td>
  323. <td>)</td>
  324. <td></td><td></td>
  325. </tr>
  326. </table>
  327. </div><div class="memdoc">
  328. <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>
  329. <dl class="params"><dt>Parameters</dt><dd>
  330. <table class="params">
  331. <tr><td class="paramname">faceName</td><td>The name of the font </td></tr>
  332. <tr><td class="paramname">size</td><td>The size of the font. </td></tr>
  333. <tr><td class="paramname">rangeStart</td><td>The initial Unicode point </td></tr>
  334. <tr><td class="paramname">rangeEnd</td><td>The final Unicode point in range </td></tr>
  335. </table>
  336. </dd>
  337. </dl>
  338. <dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>
  339. </div>
  340. </div>
  341. <a class="anchor" id="ga82a9ee22d4c2b4b220e336e78de1b438"></a>
  342. <div class="memitem">
  343. <div class="memproto">
  344. <table class="memname">
  345. <tr>
  346. <td class="memname">void populateFontCacheString </td>
  347. <td>(</td>
  348. <td class="paramtype">faceName&#160;</td>
  349. <td class="paramname">, </td>
  350. </tr>
  351. <tr>
  352. <td class="paramkey"></td>
  353. <td></td>
  354. <td class="paramtype">size&#160;</td>
  355. <td class="paramname">, </td>
  356. </tr>
  357. <tr>
  358. <td class="paramkey"></td>
  359. <td></td>
  360. <td class="paramtype">string&#160;</td>
  361. <td class="paramname">&#160;</td>
  362. </tr>
  363. <tr>
  364. <td></td>
  365. <td>)</td>
  366. <td></td><td></td>
  367. </tr>
  368. </table>
  369. </div><div class="memdoc">
  370. <p>Populate the font cache for the specified font with characters from the specified string. </p>
  371. <dl class="params"><dt>Parameters</dt><dd>
  372. <table class="params">
  373. <tr><td class="paramname">faceName</td><td>The font's name </td></tr>
  374. <tr><td class="paramname">size</td><td>The size of the font. </td></tr>
  375. <tr><td class="paramname">string</td><td>The string to use to fill font cache </td></tr>
  376. </table>
  377. </dd>
  378. </dl>
  379. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  380. </div>
  381. </div>
  382. <a class="anchor" id="ga97e9cb8bcb1d93c4fffe93166341c79b"></a>
  383. <div class="memitem">
  384. <div class="memproto">
  385. <table class="memname">
  386. <tr>
  387. <td class="memname">void writeFontCache </td>
  388. <td>(</td>
  389. <td class="paramname"></td><td>)</td>
  390. <td></td>
  391. </tr>
  392. </table>
  393. </div><div class="memdoc">
  394. <p>force all cached fonts to serialize themselves to the cache. </p>
  395. <dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>
  396. </div>
  397. </div>
  398. </div><!-- contents -->
  399. <!-- start footer part -->
  400. <hr class="footer"/><address class="footer"><small>
  401. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  402. <img class="footer" src="doxygen.png" alt="doxygen"/>
  403. </a> 1.8.3.1
  404. </small></address>
  405. </body>
  406. </html>