| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339 |
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
- <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
- <head>
- <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
- <meta http-equiv="X-UA-Compatible" content="IE=11"/>
- <meta name="generator" content="Doxygen 1.9.8"/>
- <meta name="viewport" content="width=device-width, initial-scale=1"/>
- <title>Torque2D Reference: Text Functions</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="search/search.css" rel="stylesheet" type="text/css"/>
- <script type="text/javascript" src="search/searchdata.js"></script>
- <script type="text/javascript" src="search/search.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 id="projectrow">
- <td id="projectalign">
- <div id="projectname">Torque2D Reference
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <!-- end header part -->
- <!-- Generated by Doxygen 1.9.8 -->
- <script type="text/javascript">
- /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
- var searchBox = new SearchBox("searchBox", "search/",'.html');
- /* @license-end */
- </script>
- <script type="text/javascript" src="menudata.js"></script>
- <script type="text/javascript" src="menu.js"></script>
- <script type="text/javascript">
- /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
- $(function() {
- initMenu('',true,false,'search.php','Search');
- $(document).ready(function() { init_search(); });
- });
- /* @license-end */
- </script>
- <div id="main-nav"></div>
- </div><!-- top -->
- <!-- window showing the filter options -->
- <div id="MSearchSelectWindow"
- onmouseover="return searchBox.OnSearchSelectShow()"
- onmouseout="return searchBox.OnSearchSelectHide()"
- onkeydown="return searchBox.OnSearchSelectKey(event)">
- </div>
- <!-- iframe showing the search results (closed by default) -->
- <div id="MSearchResultsWindow">
- <div id="MSearchResults">
- <div class="SRPage">
- <div id="SRIndex">
- <div id="SRResults"></div>
- <div class="SRStatus" id="Loading">Loading...</div>
- <div class="SRStatus" id="Searching">Searching...</div>
- <div class="SRStatus" id="NoMatches">No Matches</div>
- </div>
- </div>
- </div>
- </div>
- <div class="header">
- <div class="summary">
- <a href="#func-members">Functions</a> </div>
- <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>
- </div><!--header-->
- <div class="contents">
- <table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
- Functions</h2></td></tr>
- <tr class="memitem:ga97326a9db48d67db88ad2eba0b950715" id="r_ga97326a9db48d67db88ad2eba0b950715"><td class="memItemLeft" align="right" valign="top">U32 </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> &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>
- <tr class="separator:ga97326a9db48d67db88ad2eba0b950715"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:gaeb974ac0ea32f3b522eb5c7705a006ec" id="r_gaeb974ac0ea32f3b522eb5c7705a006ec"><td class="memItemLeft" align="right" valign="top">U32 </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> &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>
- <tr class="memdesc:gaeb974ac0ea32f3b522eb5c7705a006ec"><td class="mdescLeft"> </td><td class="mdescRight">Converts UTF8 text to UTF16, and calls the UTF16 version of dglDrawText. <br /></td></tr>
- <tr class="separator:gaeb974ac0ea32f3b522eb5c7705a006ec"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga38c1aeca2c44dd8e1abcf8a169c999d3" id="r_ga38c1aeca2c44dd8e1abcf8a169c999d3"><td class="memItemLeft" align="right" valign="top">U32 </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> &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>
- <tr class="separator:ga38c1aeca2c44dd8e1abcf8a169c999d3"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:gad130fccb396e4f01f639576dc11b59ed" id="r_gad130fccb396e4f01f639576dc11b59ed"><td class="memItemLeft" align="right" valign="top">U32 </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> &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>
- <tr class="memdesc:gad130fccb396e4f01f639576dc11b59ed"><td class="mdescLeft"> </td><td class="mdescRight">Converts UTF8 text to UTF16, and calls the UTF16 version of dglDrawTextN. <br /></td></tr>
- <tr class="separator:gad130fccb396e4f01f639576dc11b59ed"><td class="memSeparator" colspan="2"> </td></tr>
- </table>
- <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
- <p>These functions draw a string on the string with a given font </p>
- <h2 class="groupheader">Function Documentation</h2>
- <a id="ga97326a9db48d67db88ad2eba0b950715" name="ga97326a9db48d67db88ad2eba0b950715"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ga97326a9db48d67db88ad2eba0b950715">◆ </a></span>dglDrawText() <span class="overload">[1/2]</span></h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">U32 dglDrawText </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="class_g_font.html">GFont</a> * </td>
- <td class="paramname"><em>font</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const <a class="el" href="class_point2_i.html">Point2I</a> & </td>
- <td class="paramname"><em>ptDraw</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const UTF16 * </td>
- <td class="paramname"><em>in_string</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const <a class="el" href="class_color_i.html">ColorI</a> * </td>
- <td class="paramname"><em>colorTable</em> = <code>NULL</code>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const U32 </td>
- <td class="paramname"><em>maxColorIndex</em> = <code>9</code>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">F32 </td>
- <td class="paramname"><em>rot</em> = <code>0.f</code> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <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>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">font</td><td>font to draw with, usually found in the profile </td></tr>
- <tr><td class="paramname">ptDraw</td><td>point where to start drawing text </td></tr>
- <tr><td class="paramname">in_string</td><td>string to be drawn </td></tr>
- <tr><td class="paramname">colorTable</td><td>lookups for the color tags </td></tr>
- <tr><td class="paramname">maxColorIndex</td><td>size of the colorTable </td></tr>
- <tr><td class="paramname">rot</td><td>rotation of text </td></tr>
- </table>
- </dd>
- </dl>
- </div>
- </div>
- <a id="gaeb974ac0ea32f3b522eb5c7705a006ec" name="gaeb974ac0ea32f3b522eb5c7705a006ec"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#gaeb974ac0ea32f3b522eb5c7705a006ec">◆ </a></span>dglDrawText() <span class="overload">[2/2]</span></h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">U32 dglDrawText </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="class_g_font.html">GFont</a> * </td>
- <td class="paramname"><em>font</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const <a class="el" href="class_point2_i.html">Point2I</a> & </td>
- <td class="paramname"><em>ptDraw</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const UTF8 * </td>
- <td class="paramname"><em>in_string</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const <a class="el" href="class_color_i.html">ColorI</a> * </td>
- <td class="paramname"><em>colorTable</em> = <code>NULL</code>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const U32 </td>
- <td class="paramname"><em>maxColorIndex</em> = <code>9</code>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">F32 </td>
- <td class="paramname"><em>rot</em> = <code>0.f</code> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Converts UTF8 text to UTF16, and calls the UTF16 version of dglDrawText. </p>
- </div>
- </div>
- <a id="ga38c1aeca2c44dd8e1abcf8a169c999d3" name="ga38c1aeca2c44dd8e1abcf8a169c999d3"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ga38c1aeca2c44dd8e1abcf8a169c999d3">◆ </a></span>dglDrawTextN() <span class="overload">[1/2]</span></h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">U32 dglDrawTextN </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="class_g_font.html">GFont</a> * </td>
- <td class="paramname"><em>font</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const <a class="el" href="class_point2_i.html">Point2I</a> & </td>
- <td class="paramname"><em>ptDraw</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const UTF16 * </td>
- <td class="paramname"><em>in_string</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">U32 </td>
- <td class="paramname"><em>n</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const <a class="el" href="class_color_i.html">ColorI</a> * </td>
- <td class="paramname"><em>colorTable</em> = <code>NULL</code>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const U32 </td>
- <td class="paramname"><em>maxColorIndex</em> = <code>9</code>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">F32 </td>
- <td class="paramname"><em>rot</em> = <code>0.f</code> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <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>
- <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__dgl__text.html#ga97326a9db48d67db88ad2eba0b950715">dglDrawText</a> </dd></dl>
- </div>
- </div>
- <a id="gad130fccb396e4f01f639576dc11b59ed" name="gad130fccb396e4f01f639576dc11b59ed"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#gad130fccb396e4f01f639576dc11b59ed">◆ </a></span>dglDrawTextN() <span class="overload">[2/2]</span></h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">U32 dglDrawTextN </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="class_g_font.html">GFont</a> * </td>
- <td class="paramname"><em>font</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const <a class="el" href="class_point2_i.html">Point2I</a> & </td>
- <td class="paramname"><em>ptDraw</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const UTF8 * </td>
- <td class="paramname"><em>in_string</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">U32 </td>
- <td class="paramname"><em>n</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const <a class="el" href="class_color_i.html">ColorI</a> * </td>
- <td class="paramname"><em>colorTable</em> = <code>NULL</code>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const U32 </td>
- <td class="paramname"><em>maxColorIndex</em> = <code>9</code>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">F32 </td>
- <td class="paramname"><em>rot</em> = <code>0.f</code> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Converts UTF8 text to UTF16, and calls the UTF16 version of dglDrawTextN. </p>
- </div>
- </div>
- </div><!-- contents -->
- <!-- start footer part -->
- <hr class="footer"/><address class="footer"><small>
- Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
- </small></address>
- </body>
- </html>
|