group__dgl__bitmap__draw.html 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361
  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: Bitmap Drawing 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">Bitmap Drawing 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:ga692e3779c55b71841ca83896b5fc167c" id="r_ga692e3779c55b71841ca83896b5fc167c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dgl__bitmap__draw.html#ga692e3779c55b71841ca83896b5fc167c">dglDrawBitmap</a> (<a class="el" href="class_texture_object.html">TextureObject</a> *texObject, const <a class="el" href="class_point2_i.html">Point2I</a> &amp;in_rAt, const U32 in_flip=GFlip_None)</td></tr>
  80. <tr class="separator:ga692e3779c55b71841ca83896b5fc167c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  81. <tr class="memitem:ga1543c6ed7f32bed07f87bbd8ddd24a36" id="r_ga1543c6ed7f32bed07f87bbd8ddd24a36"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dgl__bitmap__draw.html#ga1543c6ed7f32bed07f87bbd8ddd24a36">dglDrawBitmapTile</a> (<a class="el" href="class_texture_object.html">TextureObject</a> *texObject, const <a class="el" href="class_rect_i.html">RectI</a> &amp;in_rTile, const U32 in_flip=GFlip_None, F32 fSpin=0.0f, bool bSilhouette=false)</td></tr>
  82. <tr class="separator:ga1543c6ed7f32bed07f87bbd8ddd24a36"><td class="memSeparator" colspan="2">&#160;</td></tr>
  83. <tr class="memitem:gab0750d6b08029306213c6ca340e3ef57" id="r_gab0750d6b08029306213c6ca340e3ef57"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dgl__bitmap__draw.html#gab0750d6b08029306213c6ca340e3ef57">dglDrawBitmapStretch</a> (<a class="el" href="class_texture_object.html">TextureObject</a> *texObject, const <a class="el" href="class_rect_i.html">RectI</a> &amp;in_rStretch, const U32 in_flip=GFlip_None, F32 fSpin=0.0f, bool bSilhouette=false)</td></tr>
  84. <tr class="separator:gab0750d6b08029306213c6ca340e3ef57"><td class="memSeparator" colspan="2">&#160;</td></tr>
  85. <tr class="memitem:ga45c1e5189d9d9ef07c585ec683425bbf" id="r_ga45c1e5189d9d9ef07c585ec683425bbf"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dgl__bitmap__draw.html#ga45c1e5189d9d9ef07c585ec683425bbf">dglDrawBitmapSR</a> (<a class="el" href="class_texture_object.html">TextureObject</a> *texObject, const <a class="el" href="class_point2_i.html">Point2I</a> &amp;in_rAt, const <a class="el" href="class_rect_i.html">RectI</a> &amp;in_rSubRegion, const U32 in_flip=GFlip_None)</td></tr>
  86. <tr class="separator:ga45c1e5189d9d9ef07c585ec683425bbf"><td class="memSeparator" colspan="2">&#160;</td></tr>
  87. <tr class="memitem:gaf8c319111cce8c52b1f3b19b9df3bbc1" id="r_gaf8c319111cce8c52b1f3b19b9df3bbc1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dgl__bitmap__draw.html#gaf8c319111cce8c52b1f3b19b9df3bbc1">dglDrawBitmapStretchSR</a> (<a class="el" href="class_texture_object.html">TextureObject</a> *texObject, const <a class="el" href="class_rect_i.html">RectI</a> &amp;in_rStretch, const <a class="el" href="class_rect_i.html">RectI</a> &amp;in_rSubRegion, const U32 in_flip=GFlip_None, F32 fSpin=0.0f, bool bSilhouette=false)</td></tr>
  88. <tr class="separator:gaf8c319111cce8c52b1f3b19b9df3bbc1"><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 allow you to draw a bitmap. Each function will draw the bitmap in a specific way regarding stretching </p>
  92. <h2 class="groupheader">Function Documentation</h2>
  93. <a id="ga692e3779c55b71841ca83896b5fc167c" name="ga692e3779c55b71841ca83896b5fc167c"></a>
  94. <h2 class="memtitle"><span class="permalink"><a href="#ga692e3779c55b71841ca83896b5fc167c">&#9670;&#160;</a></span>dglDrawBitmap()</h2>
  95. <div class="memitem">
  96. <div class="memproto">
  97. <table class="memname">
  98. <tr>
  99. <td class="memname">void dglDrawBitmap </td>
  100. <td>(</td>
  101. <td class="paramtype"><a class="el" href="class_texture_object.html">TextureObject</a> *&#160;</td>
  102. <td class="paramname"><em>texObject</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>in_rAt</em>, </td>
  109. </tr>
  110. <tr>
  111. <td class="paramkey"></td>
  112. <td></td>
  113. <td class="paramtype">const U32&#160;</td>
  114. <td class="paramname"><em>in_flip</em> = <code>GFlip_None</code>&#160;</td>
  115. </tr>
  116. <tr>
  117. <td></td>
  118. <td>)</td>
  119. <td></td><td></td>
  120. </tr>
  121. </table>
  122. </div><div class="memdoc">
  123. <p>Draws a bitmap, starting from the lower left corner, going up and right </p><dl class="params"><dt>Parameters</dt><dd>
  124. <table class="params">
  125. <tr><td class="paramname">texObject</td><td>texture object to be drawn </td></tr>
  126. <tr><td class="paramname">in_rAt</td><td>where to draw the texture in 2d coordinates </td></tr>
  127. <tr><td class="paramname">in_flip</td><td>enumerated constant representing any flipping to be done about the x and/or y axis </td></tr>
  128. </table>
  129. </dd>
  130. </dl>
  131. </div>
  132. </div>
  133. <a id="ga45c1e5189d9d9ef07c585ec683425bbf" name="ga45c1e5189d9d9ef07c585ec683425bbf"></a>
  134. <h2 class="memtitle"><span class="permalink"><a href="#ga45c1e5189d9d9ef07c585ec683425bbf">&#9670;&#160;</a></span>dglDrawBitmapSR()</h2>
  135. <div class="memitem">
  136. <div class="memproto">
  137. <table class="memname">
  138. <tr>
  139. <td class="memname">void dglDrawBitmapSR </td>
  140. <td>(</td>
  141. <td class="paramtype"><a class="el" href="class_texture_object.html">TextureObject</a> *&#160;</td>
  142. <td class="paramname"><em>texObject</em>, </td>
  143. </tr>
  144. <tr>
  145. <td class="paramkey"></td>
  146. <td></td>
  147. <td class="paramtype">const <a class="el" href="class_point2_i.html">Point2I</a> &amp;&#160;</td>
  148. <td class="paramname"><em>in_rAt</em>, </td>
  149. </tr>
  150. <tr>
  151. <td class="paramkey"></td>
  152. <td></td>
  153. <td class="paramtype">const <a class="el" href="class_rect_i.html">RectI</a> &amp;&#160;</td>
  154. <td class="paramname"><em>in_rSubRegion</em>, </td>
  155. </tr>
  156. <tr>
  157. <td class="paramkey"></td>
  158. <td></td>
  159. <td class="paramtype">const U32&#160;</td>
  160. <td class="paramname"><em>in_flip</em> = <code>GFlip_None</code>&#160;</td>
  161. </tr>
  162. <tr>
  163. <td></td>
  164. <td>)</td>
  165. <td></td><td></td>
  166. </tr>
  167. </table>
  168. </div><div class="memdoc">
  169. <p>Draws a sub region of a texture </p><dl class="params"><dt>Parameters</dt><dd>
  170. <table class="params">
  171. <tr><td class="paramname">texObject</td><td>texture object to be drawn </td></tr>
  172. <tr><td class="paramname">in_rAt</td><td>point where the texture is to be drawn </td></tr>
  173. <tr><td class="paramname">in_rSubRegion</td><td>portion of the texture to be drawn </td></tr>
  174. <tr><td class="paramname">in_flip</td><td>enumerated constant representing any flipping to be done about the x and/or y axis </td></tr>
  175. </table>
  176. </dd>
  177. </dl>
  178. </div>
  179. </div>
  180. <a id="gab0750d6b08029306213c6ca340e3ef57" name="gab0750d6b08029306213c6ca340e3ef57"></a>
  181. <h2 class="memtitle"><span class="permalink"><a href="#gab0750d6b08029306213c6ca340e3ef57">&#9670;&#160;</a></span>dglDrawBitmapStretch()</h2>
  182. <div class="memitem">
  183. <div class="memproto">
  184. <table class="memname">
  185. <tr>
  186. <td class="memname">void dglDrawBitmapStretch </td>
  187. <td>(</td>
  188. <td class="paramtype"><a class="el" href="class_texture_object.html">TextureObject</a> *&#160;</td>
  189. <td class="paramname"><em>texObject</em>, </td>
  190. </tr>
  191. <tr>
  192. <td class="paramkey"></td>
  193. <td></td>
  194. <td class="paramtype">const <a class="el" href="class_rect_i.html">RectI</a> &amp;&#160;</td>
  195. <td class="paramname"><em>in_rStretch</em>, </td>
  196. </tr>
  197. <tr>
  198. <td class="paramkey"></td>
  199. <td></td>
  200. <td class="paramtype">const U32&#160;</td>
  201. <td class="paramname"><em>in_flip</em> = <code>GFlip_None</code>, </td>
  202. </tr>
  203. <tr>
  204. <td class="paramkey"></td>
  205. <td></td>
  206. <td class="paramtype">F32&#160;</td>
  207. <td class="paramname"><em>fSpin</em> = <code>0.0f</code>, </td>
  208. </tr>
  209. <tr>
  210. <td class="paramkey"></td>
  211. <td></td>
  212. <td class="paramtype">bool&#160;</td>
  213. <td class="paramname"><em>bSilhouette</em> = <code>false</code>&#160;</td>
  214. </tr>
  215. <tr>
  216. <td></td>
  217. <td>)</td>
  218. <td></td><td></td>
  219. </tr>
  220. </table>
  221. </div><div class="memdoc">
  222. <p>Draws a bitmap that is stretched </p><dl class="params"><dt>Parameters</dt><dd>
  223. <table class="params">
  224. <tr><td class="paramname">texObject</td><td>texture object to be drawn </td></tr>
  225. <tr><td class="paramname">in_rStretch</td><td>rectangle where the texture will be drawn in 2d coordinates </td></tr>
  226. <tr><td class="paramname">in_flip</td><td>enumerated constant representing any flipping to be done about the x and/or y axis </td></tr>
  227. </table>
  228. </dd>
  229. </dl>
  230. </div>
  231. </div>
  232. <a id="gaf8c319111cce8c52b1f3b19b9df3bbc1" name="gaf8c319111cce8c52b1f3b19b9df3bbc1"></a>
  233. <h2 class="memtitle"><span class="permalink"><a href="#gaf8c319111cce8c52b1f3b19b9df3bbc1">&#9670;&#160;</a></span>dglDrawBitmapStretchSR()</h2>
  234. <div class="memitem">
  235. <div class="memproto">
  236. <table class="memname">
  237. <tr>
  238. <td class="memname">void dglDrawBitmapStretchSR </td>
  239. <td>(</td>
  240. <td class="paramtype"><a class="el" href="class_texture_object.html">TextureObject</a> *&#160;</td>
  241. <td class="paramname"><em>texObject</em>, </td>
  242. </tr>
  243. <tr>
  244. <td class="paramkey"></td>
  245. <td></td>
  246. <td class="paramtype">const <a class="el" href="class_rect_i.html">RectI</a> &amp;&#160;</td>
  247. <td class="paramname"><em>in_rStretch</em>, </td>
  248. </tr>
  249. <tr>
  250. <td class="paramkey"></td>
  251. <td></td>
  252. <td class="paramtype">const <a class="el" href="class_rect_i.html">RectI</a> &amp;&#160;</td>
  253. <td class="paramname"><em>in_rSubRegion</em>, </td>
  254. </tr>
  255. <tr>
  256. <td class="paramkey"></td>
  257. <td></td>
  258. <td class="paramtype">const U32&#160;</td>
  259. <td class="paramname"><em>in_flip</em> = <code>GFlip_None</code>, </td>
  260. </tr>
  261. <tr>
  262. <td class="paramkey"></td>
  263. <td></td>
  264. <td class="paramtype">F32&#160;</td>
  265. <td class="paramname"><em>fSpin</em> = <code>0.0f</code>, </td>
  266. </tr>
  267. <tr>
  268. <td class="paramkey"></td>
  269. <td></td>
  270. <td class="paramtype">bool&#160;</td>
  271. <td class="paramname"><em>bSilhouette</em> = <code>false</code>&#160;</td>
  272. </tr>
  273. <tr>
  274. <td></td>
  275. <td>)</td>
  276. <td></td><td></td>
  277. </tr>
  278. </table>
  279. </div><div class="memdoc">
  280. <p>Draws a stretched sub region of a texture </p><dl class="params"><dt>Parameters</dt><dd>
  281. <table class="params">
  282. <tr><td class="paramname">texObject</td><td>texture object to be drawn </td></tr>
  283. <tr><td class="paramname">in_rStretch</td><td>rectangle where the texture object will be drawn </td></tr>
  284. <tr><td class="paramname">in_rSubRegion</td><td>sub region of the texture that will be applied over the stretch region of the screen </td></tr>
  285. <tr><td class="paramname">in_flip</td><td>enumerated constant representing any flipping to be done about the x and/or y axis </td></tr>
  286. </table>
  287. </dd>
  288. </dl>
  289. </div>
  290. </div>
  291. <a id="ga1543c6ed7f32bed07f87bbd8ddd24a36" name="ga1543c6ed7f32bed07f87bbd8ddd24a36"></a>
  292. <h2 class="memtitle"><span class="permalink"><a href="#ga1543c6ed7f32bed07f87bbd8ddd24a36">&#9670;&#160;</a></span>dglDrawBitmapTile()</h2>
  293. <div class="memitem">
  294. <div class="memproto">
  295. <table class="memname">
  296. <tr>
  297. <td class="memname">void dglDrawBitmapTile </td>
  298. <td>(</td>
  299. <td class="paramtype"><a class="el" href="class_texture_object.html">TextureObject</a> *&#160;</td>
  300. <td class="paramname"><em>texObject</em>, </td>
  301. </tr>
  302. <tr>
  303. <td class="paramkey"></td>
  304. <td></td>
  305. <td class="paramtype">const <a class="el" href="class_rect_i.html">RectI</a> &amp;&#160;</td>
  306. <td class="paramname"><em>in_rTile</em>, </td>
  307. </tr>
  308. <tr>
  309. <td class="paramkey"></td>
  310. <td></td>
  311. <td class="paramtype">const U32&#160;</td>
  312. <td class="paramname"><em>in_flip</em> = <code>GFlip_None</code>, </td>
  313. </tr>
  314. <tr>
  315. <td class="paramkey"></td>
  316. <td></td>
  317. <td class="paramtype">F32&#160;</td>
  318. <td class="paramname"><em>fSpin</em> = <code>0.0f</code>, </td>
  319. </tr>
  320. <tr>
  321. <td class="paramkey"></td>
  322. <td></td>
  323. <td class="paramtype">bool&#160;</td>
  324. <td class="paramname"><em>bSilhouette</em> = <code>false</code>&#160;</td>
  325. </tr>
  326. <tr>
  327. <td></td>
  328. <td>)</td>
  329. <td></td><td></td>
  330. </tr>
  331. </table>
  332. </div><div class="memdoc">
  333. <p>Draws a power-of-two bitmap that is tiled. Requires a POT bitmap to draw properly. </p><dl class="params"><dt>Parameters</dt><dd>
  334. <table class="params">
  335. <tr><td class="paramname">texObject</td><td>texture object to be drawn </td></tr>
  336. <tr><td class="paramname">in_rTile</td><td>rectangle where the texture will be drawn in 2d coordinates </td></tr>
  337. <tr><td class="paramname">in_flip</td><td>enumerated constant representing any flipping to be done about the x and/or y axis </td></tr>
  338. </table>
  339. </dd>
  340. </dl>
  341. </div>
  342. </div>
  343. </div><!-- contents -->
  344. <!-- start footer part -->
  345. <hr class="footer"/><address class="footer"><small>
  346. 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
  347. </small></address>
  348. </body>
  349. </html>