classfont_1_1_bitmap_font.html 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=11"/>
  6. <meta name="generator" content="Doxygen 1.9.8"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>Torque2D Reference: BitmapFont Class Reference</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  13. <script type="text/javascript" src="search/searchdata.js"></script>
  14. <script type="text/javascript" src="search/search.js"></script>
  15. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  16. <link href="t2d-stylesheet-extra.css" rel="stylesheet" type="text/css"/>
  17. </head>
  18. <body>
  19. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  20. <div id="titlearea">
  21. <table cellspacing="0" cellpadding="0">
  22. <tbody>
  23. <tr id="projectrow">
  24. <td id="projectalign">
  25. <div id="projectname">Torque2D Reference
  26. </div>
  27. </td>
  28. </tr>
  29. </tbody>
  30. </table>
  31. </div>
  32. <!-- end header part -->
  33. <!-- Generated by Doxygen 1.9.8 -->
  34. <script type="text/javascript">
  35. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  36. var searchBox = new SearchBox("searchBox", "search/",'.html');
  37. /* @license-end */
  38. </script>
  39. <script type="text/javascript" src="menudata.js"></script>
  40. <script type="text/javascript" src="menu.js"></script>
  41. <script type="text/javascript">
  42. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  43. $(function() {
  44. initMenu('',true,false,'search.php','Search');
  45. $(document).ready(function() { init_search(); });
  46. });
  47. /* @license-end */
  48. </script>
  49. <div id="main-nav"></div>
  50. <!-- window showing the filter options -->
  51. <div id="MSearchSelectWindow"
  52. onmouseover="return searchBox.OnSearchSelectShow()"
  53. onmouseout="return searchBox.OnSearchSelectHide()"
  54. onkeydown="return searchBox.OnSearchSelectKey(event)">
  55. </div>
  56. <!-- iframe showing the search results (closed by default) -->
  57. <div id="MSearchResultsWindow">
  58. <div id="MSearchResults">
  59. <div class="SRPage">
  60. <div id="SRIndex">
  61. <div id="SRResults"></div>
  62. <div class="SRStatus" id="Loading">Loading...</div>
  63. <div class="SRStatus" id="Searching">Searching...</div>
  64. <div class="SRStatus" id="NoMatches">No Matches</div>
  65. </div>
  66. </div>
  67. </div>
  68. </div>
  69. <div id="nav-path" class="navpath">
  70. <ul>
  71. <li class="navelem"><a class="el" href="namespacefont.html">font</a></li><li class="navelem"><a class="el" href="classfont_1_1_bitmap_font.html">BitmapFont</a></li> </ul>
  72. </div>
  73. </div><!-- top -->
  74. <div class="header">
  75. <div class="summary">
  76. <a href="#pub-methods">Public Member Functions</a> &#124;
  77. <a href="#pub-attribs">Public Attributes</a> &#124;
  78. <a href="classfont_1_1_bitmap_font-members.html">List of all members</a> </div>
  79. <div class="headertitle"><div class="title">BitmapFont Class Reference</div></div>
  80. </div><!--header-->
  81. <div class="contents">
  82. <p><code>#include &lt;BitmapFont.h&gt;</code></p>
  83. <table class="memberdecls">
  84. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
  85. Public Member Functions</h2></td></tr>
  86. <tr class="memitem:abde770f329bb02ec42cd1f6013ed845d" id="r_abde770f329bb02ec42cd1f6013ed845d"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfont_1_1_bitmap_font.html#abde770f329bb02ec42cd1f6013ed845d">BitmapFont</a> ()</td></tr>
  87. <tr class="separator:abde770f329bb02ec42cd1f6013ed845d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  88. <tr class="memitem:a49fc6ba9c297f817f0cef80364e3293e" id="r_a49fc6ba9c297f817f0cef80364e3293e"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfont_1_1_bitmap_font.html#a49fc6ba9c297f817f0cef80364e3293e">parseFont</a> (<a class="el" href="class_stream.html">Stream</a> &amp;io_rStream)</td></tr>
  89. <tr class="separator:a49fc6ba9c297f817f0cef80364e3293e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90. <tr class="memitem:a93ae44a27dc5bf39b58924b99a012f2e" id="r_a93ae44a27dc5bf39b58924b99a012f2e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_texture_handle.html">TextureHandle</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfont_1_1_bitmap_font.html#a93ae44a27dc5bf39b58924b99a012f2e">LoadTexture</a> (StringTableEntry fileName)</td></tr>
  91. <tr class="separator:a93ae44a27dc5bf39b58924b99a012f2e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  92. <tr class="memitem:a76007e4f02b445d0c9710ed1d9b0fd11" id="r_a76007e4f02b445d0c9710ed1d9b0fd11"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classfont_1_1_bitmap_font_character.html">BitmapFontCharacter</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfont_1_1_bitmap_font.html#a76007e4f02b445d0c9710ed1d9b0fd11">getCharacter</a> (const U16 charID)</td></tr>
  93. <tr class="separator:a76007e4f02b445d0c9710ed1d9b0fd11"><td class="memSeparator" colspan="2">&#160;</td></tr>
  94. <tr class="memitem:ad6aa84a8b9492f08b040576512e996bc" id="r_ad6aa84a8b9492f08b040576512e996bc"><td class="memItemLeft" align="right" valign="top">const F32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfont_1_1_bitmap_font.html#ad6aa84a8b9492f08b040576512e996bc">getSizeRatio</a> (const F32 size)</td></tr>
  95. <tr class="separator:ad6aa84a8b9492f08b040576512e996bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  96. <tr class="memitem:ad43dd302d9bdc6c37c3582910fdeb636" id="r_ad43dd302d9bdc6c37c3582910fdeb636"><td class="memItemLeft" align="right" valign="top">const S16&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfont_1_1_bitmap_font.html#ad43dd302d9bdc6c37c3582910fdeb636">getKerning</a> (U16 first, U16 second)</td></tr>
  97. <tr class="separator:ad43dd302d9bdc6c37c3582910fdeb636"><td class="memSeparator" colspan="2">&#160;</td></tr>
  98. </table><table class="memberdecls">
  99. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
  100. Public Attributes</h2></td></tr>
  101. <tr class="memitem:a01865e51bc33b04ac2df79182309a904" id="r_a01865e51bc33b04ac2df79182309a904"><td class="memItemLeft" align="right" valign="top">U16&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfont_1_1_bitmap_font.html#a01865e51bc33b04ac2df79182309a904">mLineHeight</a></td></tr>
  102. <tr class="separator:a01865e51bc33b04ac2df79182309a904"><td class="memSeparator" colspan="2">&#160;</td></tr>
  103. <tr class="memitem:aadf7a610b32411744941f7f9adf84375" id="r_aadf7a610b32411744941f7f9adf84375"><td class="memItemLeft" align="right" valign="top">U16&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfont_1_1_bitmap_font.html#aadf7a610b32411744941f7f9adf84375">mBaseline</a></td></tr>
  104. <tr class="separator:aadf7a610b32411744941f7f9adf84375"><td class="memSeparator" colspan="2">&#160;</td></tr>
  105. <tr class="memitem:a53a6fce03587efe040e83ea420e9d514" id="r_a53a6fce03587efe040e83ea420e9d514"><td class="memItemLeft" align="right" valign="top">U16&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfont_1_1_bitmap_font.html#a53a6fce03587efe040e83ea420e9d514">mSize</a></td></tr>
  106. <tr class="separator:a53a6fce03587efe040e83ea420e9d514"><td class="memSeparator" colspan="2">&#160;</td></tr>
  107. <tr class="memitem:a3bc1314f9985c6cb17fec0d3bdf8a038" id="r_a3bc1314f9985c6cb17fec0d3bdf8a038"><td class="memItemLeft" align="right" valign="top">std::vector&lt; StringTableEntry &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfont_1_1_bitmap_font.html#a3bc1314f9985c6cb17fec0d3bdf8a038">mPageName</a></td></tr>
  108. <tr class="separator:a3bc1314f9985c6cb17fec0d3bdf8a038"><td class="memSeparator" colspan="2">&#160;</td></tr>
  109. <tr class="memitem:a8057901a33a689a5811f1296fa17e68f" id="r_a8057901a33a689a5811f1296fa17e68f"><td class="memItemLeft" align="right" valign="top">std::vector&lt; <a class="el" href="class_texture_handle.html">TextureHandle</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfont_1_1_bitmap_font.html#a8057901a33a689a5811f1296fa17e68f">mTexture</a></td></tr>
  110. <tr class="separator:a8057901a33a689a5811f1296fa17e68f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  111. </table>
  112. <h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  113. <a id="abde770f329bb02ec42cd1f6013ed845d" name="abde770f329bb02ec42cd1f6013ed845d"></a>
  114. <h2 class="memtitle"><span class="permalink"><a href="#abde770f329bb02ec42cd1f6013ed845d">&#9670;&#160;</a></span>BitmapFont()</h2>
  115. <div class="memitem">
  116. <div class="memproto">
  117. <table class="memname">
  118. <tr>
  119. <td class="memname"><a class="el" href="classfont_1_1_bitmap_font.html">BitmapFont</a> </td>
  120. <td>(</td>
  121. <td class="paramname"></td><td>)</td>
  122. <td></td>
  123. </tr>
  124. </table>
  125. </div><div class="memdoc">
  126. </div>
  127. </div>
  128. <h2 class="groupheader">Member Function Documentation</h2>
  129. <a id="a76007e4f02b445d0c9710ed1d9b0fd11" name="a76007e4f02b445d0c9710ed1d9b0fd11"></a>
  130. <h2 class="memtitle"><span class="permalink"><a href="#a76007e4f02b445d0c9710ed1d9b0fd11">&#9670;&#160;</a></span>getCharacter()</h2>
  131. <div class="memitem">
  132. <div class="memproto">
  133. <table class="mlabels">
  134. <tr>
  135. <td class="mlabels-left">
  136. <table class="memname">
  137. <tr>
  138. <td class="memname">const <a class="el" href="classfont_1_1_bitmap_font_character.html">BitmapFontCharacter</a> &amp; getCharacter </td>
  139. <td>(</td>
  140. <td class="paramtype">const U16&#160;</td>
  141. <td class="paramname"><em>charID</em></td><td>)</td>
  142. <td></td>
  143. </tr>
  144. </table>
  145. </td>
  146. <td class="mlabels-right">
  147. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  148. </tr>
  149. </table>
  150. </div><div class="memdoc">
  151. </div>
  152. </div>
  153. <a id="ad43dd302d9bdc6c37c3582910fdeb636" name="ad43dd302d9bdc6c37c3582910fdeb636"></a>
  154. <h2 class="memtitle"><span class="permalink"><a href="#ad43dd302d9bdc6c37c3582910fdeb636">&#9670;&#160;</a></span>getKerning()</h2>
  155. <div class="memitem">
  156. <div class="memproto">
  157. <table class="mlabels">
  158. <tr>
  159. <td class="mlabels-left">
  160. <table class="memname">
  161. <tr>
  162. <td class="memname">const S16 getKerning </td>
  163. <td>(</td>
  164. <td class="paramtype">U16&#160;</td>
  165. <td class="paramname"><em>first</em>, </td>
  166. </tr>
  167. <tr>
  168. <td class="paramkey"></td>
  169. <td></td>
  170. <td class="paramtype">U16&#160;</td>
  171. <td class="paramname"><em>second</em>&#160;</td>
  172. </tr>
  173. <tr>
  174. <td></td>
  175. <td>)</td>
  176. <td></td><td></td>
  177. </tr>
  178. </table>
  179. </td>
  180. <td class="mlabels-right">
  181. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  182. </tr>
  183. </table>
  184. </div><div class="memdoc">
  185. </div>
  186. </div>
  187. <a id="ad6aa84a8b9492f08b040576512e996bc" name="ad6aa84a8b9492f08b040576512e996bc"></a>
  188. <h2 class="memtitle"><span class="permalink"><a href="#ad6aa84a8b9492f08b040576512e996bc">&#9670;&#160;</a></span>getSizeRatio()</h2>
  189. <div class="memitem">
  190. <div class="memproto">
  191. <table class="mlabels">
  192. <tr>
  193. <td class="mlabels-left">
  194. <table class="memname">
  195. <tr>
  196. <td class="memname">const F32 getSizeRatio </td>
  197. <td>(</td>
  198. <td class="paramtype">const F32&#160;</td>
  199. <td class="paramname"><em>size</em></td><td>)</td>
  200. <td></td>
  201. </tr>
  202. </table>
  203. </td>
  204. <td class="mlabels-right">
  205. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  206. </tr>
  207. </table>
  208. </div><div class="memdoc">
  209. </div>
  210. </div>
  211. <a id="a93ae44a27dc5bf39b58924b99a012f2e" name="a93ae44a27dc5bf39b58924b99a012f2e"></a>
  212. <h2 class="memtitle"><span class="permalink"><a href="#a93ae44a27dc5bf39b58924b99a012f2e">&#9670;&#160;</a></span>LoadTexture()</h2>
  213. <div class="memitem">
  214. <div class="memproto">
  215. <table class="memname">
  216. <tr>
  217. <td class="memname"><a class="el" href="class_texture_handle.html">TextureHandle</a> LoadTexture </td>
  218. <td>(</td>
  219. <td class="paramtype">StringTableEntry&#160;</td>
  220. <td class="paramname"><em>fileName</em></td><td>)</td>
  221. <td></td>
  222. </tr>
  223. </table>
  224. </div><div class="memdoc">
  225. </div>
  226. </div>
  227. <a id="a49fc6ba9c297f817f0cef80364e3293e" name="a49fc6ba9c297f817f0cef80364e3293e"></a>
  228. <h2 class="memtitle"><span class="permalink"><a href="#a49fc6ba9c297f817f0cef80364e3293e">&#9670;&#160;</a></span>parseFont()</h2>
  229. <div class="memitem">
  230. <div class="memproto">
  231. <table class="memname">
  232. <tr>
  233. <td class="memname">bool parseFont </td>
  234. <td>(</td>
  235. <td class="paramtype"><a class="el" href="class_stream.html">Stream</a> &amp;&#160;</td>
  236. <td class="paramname"><em>io_rStream</em></td><td>)</td>
  237. <td></td>
  238. </tr>
  239. </table>
  240. </div><div class="memdoc">
  241. </div>
  242. </div>
  243. <h2 class="groupheader">Member Data Documentation</h2>
  244. <a id="aadf7a610b32411744941f7f9adf84375" name="aadf7a610b32411744941f7f9adf84375"></a>
  245. <h2 class="memtitle"><span class="permalink"><a href="#aadf7a610b32411744941f7f9adf84375">&#9670;&#160;</a></span>mBaseline</h2>
  246. <div class="memitem">
  247. <div class="memproto">
  248. <table class="memname">
  249. <tr>
  250. <td class="memname">U16 mBaseline</td>
  251. </tr>
  252. </table>
  253. </div><div class="memdoc">
  254. </div>
  255. </div>
  256. <a id="a01865e51bc33b04ac2df79182309a904" name="a01865e51bc33b04ac2df79182309a904"></a>
  257. <h2 class="memtitle"><span class="permalink"><a href="#a01865e51bc33b04ac2df79182309a904">&#9670;&#160;</a></span>mLineHeight</h2>
  258. <div class="memitem">
  259. <div class="memproto">
  260. <table class="memname">
  261. <tr>
  262. <td class="memname">U16 mLineHeight</td>
  263. </tr>
  264. </table>
  265. </div><div class="memdoc">
  266. </div>
  267. </div>
  268. <a id="a3bc1314f9985c6cb17fec0d3bdf8a038" name="a3bc1314f9985c6cb17fec0d3bdf8a038"></a>
  269. <h2 class="memtitle"><span class="permalink"><a href="#a3bc1314f9985c6cb17fec0d3bdf8a038">&#9670;&#160;</a></span>mPageName</h2>
  270. <div class="memitem">
  271. <div class="memproto">
  272. <table class="memname">
  273. <tr>
  274. <td class="memname">std::vector&lt;StringTableEntry&gt; mPageName</td>
  275. </tr>
  276. </table>
  277. </div><div class="memdoc">
  278. </div>
  279. </div>
  280. <a id="a53a6fce03587efe040e83ea420e9d514" name="a53a6fce03587efe040e83ea420e9d514"></a>
  281. <h2 class="memtitle"><span class="permalink"><a href="#a53a6fce03587efe040e83ea420e9d514">&#9670;&#160;</a></span>mSize</h2>
  282. <div class="memitem">
  283. <div class="memproto">
  284. <table class="memname">
  285. <tr>
  286. <td class="memname">U16 mSize</td>
  287. </tr>
  288. </table>
  289. </div><div class="memdoc">
  290. </div>
  291. </div>
  292. <a id="a8057901a33a689a5811f1296fa17e68f" name="a8057901a33a689a5811f1296fa17e68f"></a>
  293. <h2 class="memtitle"><span class="permalink"><a href="#a8057901a33a689a5811f1296fa17e68f">&#9670;&#160;</a></span>mTexture</h2>
  294. <div class="memitem">
  295. <div class="memproto">
  296. <table class="memname">
  297. <tr>
  298. <td class="memname">std::vector&lt;<a class="el" href="class_texture_handle.html">TextureHandle</a>&gt; mTexture</td>
  299. </tr>
  300. </table>
  301. </div><div class="memdoc">
  302. </div>
  303. </div>
  304. <hr/>The documentation for this class was generated from the following files:<ul>
  305. <li>bitmapFont/<b>BitmapFont.h</b></li>
  306. <li>bitmapFont/<b>BitmapFont.cc</b></li>
  307. </ul>
  308. </div><!-- contents -->
  309. <!-- start footer part -->
  310. <hr class="footer"/><address class="footer"><small>
  311. Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
  312. </small></address>
  313. </body>
  314. </html>