group__dgl__text.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: Text Functions</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. </div><!-- top -->
  51. <!-- window showing the filter options -->
  52. <div id="MSearchSelectWindow"
  53. onmouseover="return searchBox.OnSearchSelectShow()"
  54. onmouseout="return searchBox.OnSearchSelectHide()"
  55. onkeydown="return searchBox.OnSearchSelectKey(event)">
  56. </div>
  57. <!-- iframe showing the search results (closed by default) -->
  58. <div id="MSearchResultsWindow">
  59. <div id="MSearchResults">
  60. <div class="SRPage">
  61. <div id="SRIndex">
  62. <div id="SRResults"></div>
  63. <div class="SRStatus" id="Loading">Loading...</div>
  64. <div class="SRStatus" id="Searching">Searching...</div>
  65. <div class="SRStatus" id="NoMatches">No Matches</div>
  66. </div>
  67. </div>
  68. </div>
  69. </div>
  70. <div class="header">
  71. <div class="summary">
  72. <a href="#func-members">Functions</a> </div>
  73. <div class="headertitle"><div class="title">Text Functions<div class="ingroups"><a class="el" href="group__dgl.html">Cross-Platform OpenGL Support</a></div></div></div>
  74. </div><!--header-->
  75. <div class="contents">
  76. <table class="memberdecls">
  77. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
  78. Functions</h2></td></tr>
  79. <tr class="memitem:ga97326a9db48d67db88ad2eba0b950715" id="r_ga97326a9db48d67db88ad2eba0b950715"><td class="memItemLeft" align="right" valign="top">U32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dgl__text.html#ga97326a9db48d67db88ad2eba0b950715">dglDrawText</a> (<a class="el" href="class_g_font.html">GFont</a> *font, const <a class="el" href="class_point2_i.html">Point2I</a> &amp;ptDraw, const UTF16 *in_string, const <a class="el" href="class_color_i.html">ColorI</a> *colorTable=NULL, const U32 maxColorIndex=9, F32 rot=0.f)</td></tr>
  80. <tr class="separator:ga97326a9db48d67db88ad2eba0b950715"><td class="memSeparator" colspan="2">&#160;</td></tr>
  81. <tr class="memitem:gaeb974ac0ea32f3b522eb5c7705a006ec" id="r_gaeb974ac0ea32f3b522eb5c7705a006ec"><td class="memItemLeft" align="right" valign="top">U32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dgl__text.html#gaeb974ac0ea32f3b522eb5c7705a006ec">dglDrawText</a> (<a class="el" href="class_g_font.html">GFont</a> *font, const <a class="el" href="class_point2_i.html">Point2I</a> &amp;ptDraw, const UTF8 *in_string, const <a class="el" href="class_color_i.html">ColorI</a> *colorTable=NULL, const U32 maxColorIndex=9, F32 rot=0.f)</td></tr>
  82. <tr class="memdesc:gaeb974ac0ea32f3b522eb5c7705a006ec"><td class="mdescLeft">&#160;</td><td class="mdescRight">Converts UTF8 text to UTF16, and calls the UTF16 version of dglDrawText. <br /></td></tr>
  83. <tr class="separator:gaeb974ac0ea32f3b522eb5c7705a006ec"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84. <tr class="memitem:ga38c1aeca2c44dd8e1abcf8a169c999d3" id="r_ga38c1aeca2c44dd8e1abcf8a169c999d3"><td class="memItemLeft" align="right" valign="top">U32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dgl__text.html#ga38c1aeca2c44dd8e1abcf8a169c999d3">dglDrawTextN</a> (<a class="el" href="class_g_font.html">GFont</a> *font, const <a class="el" href="class_point2_i.html">Point2I</a> &amp;ptDraw, const UTF16 *in_string, U32 n, const <a class="el" href="class_color_i.html">ColorI</a> *colorTable=NULL, const U32 maxColorIndex=9, F32 rot=0.f)</td></tr>
  85. <tr class="separator:ga38c1aeca2c44dd8e1abcf8a169c999d3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  86. <tr class="memitem:gad130fccb396e4f01f639576dc11b59ed" id="r_gad130fccb396e4f01f639576dc11b59ed"><td class="memItemLeft" align="right" valign="top">U32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dgl__text.html#gad130fccb396e4f01f639576dc11b59ed">dglDrawTextN</a> (<a class="el" href="class_g_font.html">GFont</a> *font, const <a class="el" href="class_point2_i.html">Point2I</a> &amp;ptDraw, const UTF8 *in_string, U32 n, const <a class="el" href="class_color_i.html">ColorI</a> *colorTable=NULL, const U32 maxColorIndex=9, F32 rot=0.f)</td></tr>
  87. <tr class="memdesc:gad130fccb396e4f01f639576dc11b59ed"><td class="mdescLeft">&#160;</td><td class="mdescRight">Converts UTF8 text to UTF16, and calls the UTF16 version of dglDrawTextN. <br /></td></tr>
  88. <tr class="separator:gad130fccb396e4f01f639576dc11b59ed"><td class="memSeparator" colspan="2">&#160;</td></tr>
  89. </table>
  90. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  91. <p>These functions draw a string on the string with a given font </p>
  92. <h2 class="groupheader">Function Documentation</h2>
  93. <a id="ga97326a9db48d67db88ad2eba0b950715" name="ga97326a9db48d67db88ad2eba0b950715"></a>
  94. <h2 class="memtitle"><span class="permalink"><a href="#ga97326a9db48d67db88ad2eba0b950715">&#9670;&#160;</a></span>dglDrawText() <span class="overload">[1/2]</span></h2>
  95. <div class="memitem">
  96. <div class="memproto">
  97. <table class="memname">
  98. <tr>
  99. <td class="memname">U32 dglDrawText </td>
  100. <td>(</td>
  101. <td class="paramtype"><a class="el" href="class_g_font.html">GFont</a> *&#160;</td>
  102. <td class="paramname"><em>font</em>, </td>
  103. </tr>
  104. <tr>
  105. <td class="paramkey"></td>
  106. <td></td>
  107. <td class="paramtype">const <a class="el" href="class_point2_i.html">Point2I</a> &amp;&#160;</td>
  108. <td class="paramname"><em>ptDraw</em>, </td>
  109. </tr>
  110. <tr>
  111. <td class="paramkey"></td>
  112. <td></td>
  113. <td class="paramtype">const UTF16 *&#160;</td>
  114. <td class="paramname"><em>in_string</em>, </td>
  115. </tr>
  116. <tr>
  117. <td class="paramkey"></td>
  118. <td></td>
  119. <td class="paramtype">const <a class="el" href="class_color_i.html">ColorI</a> *&#160;</td>
  120. <td class="paramname"><em>colorTable</em> = <code>NULL</code>, </td>
  121. </tr>
  122. <tr>
  123. <td class="paramkey"></td>
  124. <td></td>
  125. <td class="paramtype">const U32&#160;</td>
  126. <td class="paramname"><em>maxColorIndex</em> = <code>9</code>, </td>
  127. </tr>
  128. <tr>
  129. <td class="paramkey"></td>
  130. <td></td>
  131. <td class="paramtype">F32&#160;</td>
  132. <td class="paramname"><em>rot</em> = <code>0.f</code>&#160;</td>
  133. </tr>
  134. <tr>
  135. <td></td>
  136. <td>)</td>
  137. <td></td><td></td>
  138. </tr>
  139. </table>
  140. </div><div class="memdoc">
  141. <p>Draws text at a location in 2d gui coordinates Also supports color tags to modulate the given text </p><dl class="section return"><dt>Returns</dt><dd>the number of x-pixels traversed </dd></dl>
  142. <dl class="params"><dt>Parameters</dt><dd>
  143. <table class="params">
  144. <tr><td class="paramname">font</td><td>font to draw with, usually found in the profile </td></tr>
  145. <tr><td class="paramname">ptDraw</td><td>point where to start drawing text </td></tr>
  146. <tr><td class="paramname">in_string</td><td>string to be drawn </td></tr>
  147. <tr><td class="paramname">colorTable</td><td>lookups for the color tags </td></tr>
  148. <tr><td class="paramname">maxColorIndex</td><td>size of the colorTable </td></tr>
  149. <tr><td class="paramname">rot</td><td>rotation of text </td></tr>
  150. </table>
  151. </dd>
  152. </dl>
  153. </div>
  154. </div>
  155. <a id="gaeb974ac0ea32f3b522eb5c7705a006ec" name="gaeb974ac0ea32f3b522eb5c7705a006ec"></a>
  156. <h2 class="memtitle"><span class="permalink"><a href="#gaeb974ac0ea32f3b522eb5c7705a006ec">&#9670;&#160;</a></span>dglDrawText() <span class="overload">[2/2]</span></h2>
  157. <div class="memitem">
  158. <div class="memproto">
  159. <table class="memname">
  160. <tr>
  161. <td class="memname">U32 dglDrawText </td>
  162. <td>(</td>
  163. <td class="paramtype"><a class="el" href="class_g_font.html">GFont</a> *&#160;</td>
  164. <td class="paramname"><em>font</em>, </td>
  165. </tr>
  166. <tr>
  167. <td class="paramkey"></td>
  168. <td></td>
  169. <td class="paramtype">const <a class="el" href="class_point2_i.html">Point2I</a> &amp;&#160;</td>
  170. <td class="paramname"><em>ptDraw</em>, </td>
  171. </tr>
  172. <tr>
  173. <td class="paramkey"></td>
  174. <td></td>
  175. <td class="paramtype">const UTF8 *&#160;</td>
  176. <td class="paramname"><em>in_string</em>, </td>
  177. </tr>
  178. <tr>
  179. <td class="paramkey"></td>
  180. <td></td>
  181. <td class="paramtype">const <a class="el" href="class_color_i.html">ColorI</a> *&#160;</td>
  182. <td class="paramname"><em>colorTable</em> = <code>NULL</code>, </td>
  183. </tr>
  184. <tr>
  185. <td class="paramkey"></td>
  186. <td></td>
  187. <td class="paramtype">const U32&#160;</td>
  188. <td class="paramname"><em>maxColorIndex</em> = <code>9</code>, </td>
  189. </tr>
  190. <tr>
  191. <td class="paramkey"></td>
  192. <td></td>
  193. <td class="paramtype">F32&#160;</td>
  194. <td class="paramname"><em>rot</em> = <code>0.f</code>&#160;</td>
  195. </tr>
  196. <tr>
  197. <td></td>
  198. <td>)</td>
  199. <td></td><td></td>
  200. </tr>
  201. </table>
  202. </div><div class="memdoc">
  203. <p>Converts UTF8 text to UTF16, and calls the UTF16 version of dglDrawText. </p>
  204. </div>
  205. </div>
  206. <a id="ga38c1aeca2c44dd8e1abcf8a169c999d3" name="ga38c1aeca2c44dd8e1abcf8a169c999d3"></a>
  207. <h2 class="memtitle"><span class="permalink"><a href="#ga38c1aeca2c44dd8e1abcf8a169c999d3">&#9670;&#160;</a></span>dglDrawTextN() <span class="overload">[1/2]</span></h2>
  208. <div class="memitem">
  209. <div class="memproto">
  210. <table class="memname">
  211. <tr>
  212. <td class="memname">U32 dglDrawTextN </td>
  213. <td>(</td>
  214. <td class="paramtype"><a class="el" href="class_g_font.html">GFont</a> *&#160;</td>
  215. <td class="paramname"><em>font</em>, </td>
  216. </tr>
  217. <tr>
  218. <td class="paramkey"></td>
  219. <td></td>
  220. <td class="paramtype">const <a class="el" href="class_point2_i.html">Point2I</a> &amp;&#160;</td>
  221. <td class="paramname"><em>ptDraw</em>, </td>
  222. </tr>
  223. <tr>
  224. <td class="paramkey"></td>
  225. <td></td>
  226. <td class="paramtype">const UTF16 *&#160;</td>
  227. <td class="paramname"><em>in_string</em>, </td>
  228. </tr>
  229. <tr>
  230. <td class="paramkey"></td>
  231. <td></td>
  232. <td class="paramtype">U32&#160;</td>
  233. <td class="paramname"><em>n</em>, </td>
  234. </tr>
  235. <tr>
  236. <td class="paramkey"></td>
  237. <td></td>
  238. <td class="paramtype">const <a class="el" href="class_color_i.html">ColorI</a> *&#160;</td>
  239. <td class="paramname"><em>colorTable</em> = <code>NULL</code>, </td>
  240. </tr>
  241. <tr>
  242. <td class="paramkey"></td>
  243. <td></td>
  244. <td class="paramtype">const U32&#160;</td>
  245. <td class="paramname"><em>maxColorIndex</em> = <code>9</code>, </td>
  246. </tr>
  247. <tr>
  248. <td class="paramkey"></td>
  249. <td></td>
  250. <td class="paramtype">F32&#160;</td>
  251. <td class="paramname"><em>rot</em> = <code>0.f</code>&#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>Draws "n" number of characters from the string, in_string </p><dl class="section return"><dt>Returns</dt><dd>the number of x-pixels traversed </dd></dl>
  261. <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__dgl__text.html#ga97326a9db48d67db88ad2eba0b950715">dglDrawText</a> </dd></dl>
  262. </div>
  263. </div>
  264. <a id="gad130fccb396e4f01f639576dc11b59ed" name="gad130fccb396e4f01f639576dc11b59ed"></a>
  265. <h2 class="memtitle"><span class="permalink"><a href="#gad130fccb396e4f01f639576dc11b59ed">&#9670;&#160;</a></span>dglDrawTextN() <span class="overload">[2/2]</span></h2>
  266. <div class="memitem">
  267. <div class="memproto">
  268. <table class="memname">
  269. <tr>
  270. <td class="memname">U32 dglDrawTextN </td>
  271. <td>(</td>
  272. <td class="paramtype"><a class="el" href="class_g_font.html">GFont</a> *&#160;</td>
  273. <td class="paramname"><em>font</em>, </td>
  274. </tr>
  275. <tr>
  276. <td class="paramkey"></td>
  277. <td></td>
  278. <td class="paramtype">const <a class="el" href="class_point2_i.html">Point2I</a> &amp;&#160;</td>
  279. <td class="paramname"><em>ptDraw</em>, </td>
  280. </tr>
  281. <tr>
  282. <td class="paramkey"></td>
  283. <td></td>
  284. <td class="paramtype">const UTF8 *&#160;</td>
  285. <td class="paramname"><em>in_string</em>, </td>
  286. </tr>
  287. <tr>
  288. <td class="paramkey"></td>
  289. <td></td>
  290. <td class="paramtype">U32&#160;</td>
  291. <td class="paramname"><em>n</em>, </td>
  292. </tr>
  293. <tr>
  294. <td class="paramkey"></td>
  295. <td></td>
  296. <td class="paramtype">const <a class="el" href="class_color_i.html">ColorI</a> *&#160;</td>
  297. <td class="paramname"><em>colorTable</em> = <code>NULL</code>, </td>
  298. </tr>
  299. <tr>
  300. <td class="paramkey"></td>
  301. <td></td>
  302. <td class="paramtype">const U32&#160;</td>
  303. <td class="paramname"><em>maxColorIndex</em> = <code>9</code>, </td>
  304. </tr>
  305. <tr>
  306. <td class="paramkey"></td>
  307. <td></td>
  308. <td class="paramtype">F32&#160;</td>
  309. <td class="paramname"><em>rot</em> = <code>0.f</code>&#160;</td>
  310. </tr>
  311. <tr>
  312. <td></td>
  313. <td>)</td>
  314. <td></td><td></td>
  315. </tr>
  316. </table>
  317. </div><div class="memdoc">
  318. <p>Converts UTF8 text to UTF16, and calls the UTF16 version of dglDrawTextN. </p>
  319. </div>
  320. </div>
  321. </div><!-- contents -->
  322. <!-- start footer part -->
  323. <hr class="footer"/><address class="footer"><small>
  324. 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
  325. </small></address>
  326. </body>
  327. </html>