group__dgl__view.html 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332
  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: Viewing Volume 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">Viewing Volume 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:gadb0c70482b61aa4381a6040663788762" id="r_gadb0c70482b61aa4381a6040663788762"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dgl__view.html#gadb0c70482b61aa4381a6040663788762">dglSetViewport</a> (const <a class="el" href="class_rect_i.html">RectI</a> &amp;aViewPort)</td></tr>
  80. <tr class="memdesc:gadb0c70482b61aa4381a6040663788762"><td class="mdescLeft">&#160;</td><td class="mdescRight">sets the viewport for the window <br /></td></tr>
  81. <tr class="separator:gadb0c70482b61aa4381a6040663788762"><td class="memSeparator" colspan="2">&#160;</td></tr>
  82. <tr class="memitem:ga70a567a2fe3fc2bd4a618093ee1c898c" id="r_ga70a567a2fe3fc2bd4a618093ee1c898c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dgl__view.html#ga70a567a2fe3fc2bd4a618093ee1c898c">dglGetViewport</a> (<a class="el" href="class_rect_i.html">RectI</a> *outViewport)</td></tr>
  83. <tr class="memdesc:ga70a567a2fe3fc2bd4a618093ee1c898c"><td class="mdescLeft">&#160;</td><td class="mdescRight">gets the current viewport of the window <br /></td></tr>
  84. <tr class="separator:ga70a567a2fe3fc2bd4a618093ee1c898c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  85. <tr class="memitem:ga5251de394c75ef3b0cf9e093b6781bf0" id="r_ga5251de394c75ef3b0cf9e093b6781bf0"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dgl__view.html#ga5251de394c75ef3b0cf9e093b6781bf0">dglSetFrustum</a> (F64 left, F64 right, F64 bottom, F64 top, F64 nearDist, F64 farDist, bool ortho=false)</td></tr>
  86. <tr class="separator:ga5251de394c75ef3b0cf9e093b6781bf0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  87. <tr class="memitem:ga95c31cf33faf364251a2c795bff15433" id="r_ga95c31cf33faf364251a2c795bff15433"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dgl__view.html#ga95c31cf33faf364251a2c795bff15433">dglGetFrustum</a> (F64 *left, F64 *right, F64 *bottom, F64 *top, F64 *nearDist, F64 *farDist)</td></tr>
  88. <tr class="separator:ga95c31cf33faf364251a2c795bff15433"><td class="memSeparator" colspan="2">&#160;</td></tr>
  89. <tr class="memitem:ga56a3acd126f34f224d00149c11de63e3" id="r_ga56a3acd126f34f224d00149c11de63e3"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dgl__view.html#ga56a3acd126f34f224d00149c11de63e3">dglIsOrtho</a> ()</td></tr>
  90. <tr class="memdesc:ga56a3acd126f34f224d00149c11de63e3"><td class="mdescLeft">&#160;</td><td class="mdescRight">returns whether or not the coordinate system is orthographic (if it is not projected) <br /></td></tr>
  91. <tr class="separator:ga56a3acd126f34f224d00149c11de63e3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  92. <tr class="memitem:ga7ff9b9e0ffdc54c7b4a10d68237e81b4" id="r_ga7ff9b9e0ffdc54c7b4a10d68237e81b4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dgl__view.html#ga7ff9b9e0ffdc54c7b4a10d68237e81b4">dglSetClipRect</a> (const <a class="el" href="class_rect_i.html">RectI</a> &amp;clipRect)</td></tr>
  93. <tr class="separator:ga7ff9b9e0ffdc54c7b4a10d68237e81b4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  94. <tr class="memitem:ga0d6259d74774253b2cc97ba8cee8323b" id="r_ga0d6259d74774253b2cc97ba8cee8323b"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="class_rect_i.html">RectI</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dgl__view.html#ga0d6259d74774253b2cc97ba8cee8323b">dglGetClipRect</a> ()</td></tr>
  95. <tr class="separator:ga0d6259d74774253b2cc97ba8cee8323b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  96. </table>
  97. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  98. <p>These functions set up the view cube of the window. </p>
  99. <h2 class="groupheader">Function Documentation</h2>
  100. <a id="ga0d6259d74774253b2cc97ba8cee8323b" name="ga0d6259d74774253b2cc97ba8cee8323b"></a>
  101. <h2 class="memtitle"><span class="permalink"><a href="#ga0d6259d74774253b2cc97ba8cee8323b">&#9670;&#160;</a></span>dglGetClipRect()</h2>
  102. <div class="memitem">
  103. <div class="memproto">
  104. <table class="memname">
  105. <tr>
  106. <td class="memname">const <a class="el" href="class_rect_i.html">RectI</a> &amp; dglGetClipRect </td>
  107. <td>(</td>
  108. <td class="paramname"></td><td>)</td>
  109. <td></td>
  110. </tr>
  111. </table>
  112. </div><div class="memdoc">
  113. <p>Gets the last clip rect specified by a call to dglSetClipRect </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="group__dgl__view.html#ga7ff9b9e0ffdc54c7b4a10d68237e81b4">dglSetClipRect</a> </dd></dl>
  114. </div>
  115. </div>
  116. <a id="ga95c31cf33faf364251a2c795bff15433" name="ga95c31cf33faf364251a2c795bff15433"></a>
  117. <h2 class="memtitle"><span class="permalink"><a href="#ga95c31cf33faf364251a2c795bff15433">&#9670;&#160;</a></span>dglGetFrustum()</h2>
  118. <div class="memitem">
  119. <div class="memproto">
  120. <table class="memname">
  121. <tr>
  122. <td class="memname">void dglGetFrustum </td>
  123. <td>(</td>
  124. <td class="paramtype">F64 *&#160;</td>
  125. <td class="paramname"><em>left</em>, </td>
  126. </tr>
  127. <tr>
  128. <td class="paramkey"></td>
  129. <td></td>
  130. <td class="paramtype">F64 *&#160;</td>
  131. <td class="paramname"><em>right</em>, </td>
  132. </tr>
  133. <tr>
  134. <td class="paramkey"></td>
  135. <td></td>
  136. <td class="paramtype">F64 *&#160;</td>
  137. <td class="paramname"><em>bottom</em>, </td>
  138. </tr>
  139. <tr>
  140. <td class="paramkey"></td>
  141. <td></td>
  142. <td class="paramtype">F64 *&#160;</td>
  143. <td class="paramname"><em>top</em>, </td>
  144. </tr>
  145. <tr>
  146. <td class="paramkey"></td>
  147. <td></td>
  148. <td class="paramtype">F64 *&#160;</td>
  149. <td class="paramname"><em>nearDist</em>, </td>
  150. </tr>
  151. <tr>
  152. <td class="paramkey"></td>
  153. <td></td>
  154. <td class="paramtype">F64 *&#160;</td>
  155. <td class="paramname"><em>farDist</em>&#160;</td>
  156. </tr>
  157. <tr>
  158. <td></td>
  159. <td>)</td>
  160. <td></td><td></td>
  161. </tr>
  162. </table>
  163. </div><div class="memdoc">
  164. <p>Returns the parameters for the current viewing frustrum </p><dl class="section see"><dt>See also</dt><dd>dglSetFrustrum </dd></dl>
  165. </div>
  166. </div>
  167. <a id="ga70a567a2fe3fc2bd4a618093ee1c898c" name="ga70a567a2fe3fc2bd4a618093ee1c898c"></a>
  168. <h2 class="memtitle"><span class="permalink"><a href="#ga70a567a2fe3fc2bd4a618093ee1c898c">&#9670;&#160;</a></span>dglGetViewport()</h2>
  169. <div class="memitem">
  170. <div class="memproto">
  171. <table class="memname">
  172. <tr>
  173. <td class="memname">void dglGetViewport </td>
  174. <td>(</td>
  175. <td class="paramtype"><a class="el" href="class_rect_i.html">RectI</a> *&#160;</td>
  176. <td class="paramname"><em>outViewport</em></td><td>)</td>
  177. <td></td>
  178. </tr>
  179. </table>
  180. </div><div class="memdoc">
  181. <p>gets the current viewport of the window </p>
  182. </div>
  183. </div>
  184. <a id="ga56a3acd126f34f224d00149c11de63e3" name="ga56a3acd126f34f224d00149c11de63e3"></a>
  185. <h2 class="memtitle"><span class="permalink"><a href="#ga56a3acd126f34f224d00149c11de63e3">&#9670;&#160;</a></span>dglIsOrtho()</h2>
  186. <div class="memitem">
  187. <div class="memproto">
  188. <table class="memname">
  189. <tr>
  190. <td class="memname">bool dglIsOrtho </td>
  191. <td>(</td>
  192. <td class="paramname"></td><td>)</td>
  193. <td></td>
  194. </tr>
  195. </table>
  196. </div><div class="memdoc">
  197. <p>returns whether or not the coordinate system is orthographic (if it is not projected) </p>
  198. </div>
  199. </div>
  200. <a id="ga7ff9b9e0ffdc54c7b4a10d68237e81b4" name="ga7ff9b9e0ffdc54c7b4a10d68237e81b4"></a>
  201. <h2 class="memtitle"><span class="permalink"><a href="#ga7ff9b9e0ffdc54c7b4a10d68237e81b4">&#9670;&#160;</a></span>dglSetClipRect()</h2>
  202. <div class="memitem">
  203. <div class="memproto">
  204. <table class="memname">
  205. <tr>
  206. <td class="memname">void dglSetClipRect </td>
  207. <td>(</td>
  208. <td class="paramtype">const <a class="el" href="class_rect_i.html">RectI</a> &amp;&#160;</td>
  209. <td class="paramname"><em>clipRect</em></td><td>)</td>
  210. <td></td>
  211. </tr>
  212. </table>
  213. </div><div class="memdoc">
  214. <p>Sets up an orthographical viewport and clipping region. This is best used for guis </p><dl class="params"><dt>Parameters</dt><dd>
  215. <table class="params">
  216. <tr><td class="paramname">clipRect</td><td>The bounds of the coordinate system </td></tr>
  217. </table>
  218. </dd>
  219. </dl>
  220. </div>
  221. </div>
  222. <a id="ga5251de394c75ef3b0cf9e093b6781bf0" name="ga5251de394c75ef3b0cf9e093b6781bf0"></a>
  223. <h2 class="memtitle"><span class="permalink"><a href="#ga5251de394c75ef3b0cf9e093b6781bf0">&#9670;&#160;</a></span>dglSetFrustum()</h2>
  224. <div class="memitem">
  225. <div class="memproto">
  226. <table class="memname">
  227. <tr>
  228. <td class="memname">void dglSetFrustum </td>
  229. <td>(</td>
  230. <td class="paramtype">F64&#160;</td>
  231. <td class="paramname"><em>left</em>, </td>
  232. </tr>
  233. <tr>
  234. <td class="paramkey"></td>
  235. <td></td>
  236. <td class="paramtype">F64&#160;</td>
  237. <td class="paramname"><em>right</em>, </td>
  238. </tr>
  239. <tr>
  240. <td class="paramkey"></td>
  241. <td></td>
  242. <td class="paramtype">F64&#160;</td>
  243. <td class="paramname"><em>bottom</em>, </td>
  244. </tr>
  245. <tr>
  246. <td class="paramkey"></td>
  247. <td></td>
  248. <td class="paramtype">F64&#160;</td>
  249. <td class="paramname"><em>top</em>, </td>
  250. </tr>
  251. <tr>
  252. <td class="paramkey"></td>
  253. <td></td>
  254. <td class="paramtype">F64&#160;</td>
  255. <td class="paramname"><em>nearDist</em>, </td>
  256. </tr>
  257. <tr>
  258. <td class="paramkey"></td>
  259. <td></td>
  260. <td class="paramtype">F64&#160;</td>
  261. <td class="paramname"><em>farDist</em>, </td>
  262. </tr>
  263. <tr>
  264. <td class="paramkey"></td>
  265. <td></td>
  266. <td class="paramtype">bool&#160;</td>
  267. <td class="paramname"><em>ortho</em> = <code>false</code>&#160;</td>
  268. </tr>
  269. <tr>
  270. <td></td>
  271. <td>)</td>
  272. <td></td><td></td>
  273. </tr>
  274. </table>
  275. </div><div class="memdoc">
  276. <p>Sets the viewing frustrum. This effectively creates the view volume and sets up the 6 clipping planes (near, far, left, right, top, bottom) </p><dl class="params"><dt>Parameters</dt><dd>
  277. <table class="params">
  278. <tr><td class="paramname">left</td><td>This is the position of the left vertical clipping plane </td></tr>
  279. <tr><td class="paramname">right</td><td>This is the position of the right vertical clipping plane </td></tr>
  280. <tr><td class="paramname">top</td><td>This is the position of the top horizontal clipping plane </td></tr>
  281. <tr><td class="paramname">bottom</td><td>This is the position of the bottom horizontal clipping plane </td></tr>
  282. <tr><td class="paramname">nearDist</td><td>This is the distance between the eye and the near clipping plane </td></tr>
  283. <tr><td class="paramname">farDist</td><td>This is the distance between the eye and the far clipping plane </td></tr>
  284. <tr><td class="paramname">ortho</td><td>(optional, default is false) If left false, calling this function will create a projection viewing volume. If true, it will be orthographic </td></tr>
  285. </table>
  286. </dd>
  287. </dl>
  288. </div>
  289. </div>
  290. <a id="gadb0c70482b61aa4381a6040663788762" name="gadb0c70482b61aa4381a6040663788762"></a>
  291. <h2 class="memtitle"><span class="permalink"><a href="#gadb0c70482b61aa4381a6040663788762">&#9670;&#160;</a></span>dglSetViewport()</h2>
  292. <div class="memitem">
  293. <div class="memproto">
  294. <table class="memname">
  295. <tr>
  296. <td class="memname">void dglSetViewport </td>
  297. <td>(</td>
  298. <td class="paramtype">const <a class="el" href="class_rect_i.html">RectI</a> &amp;&#160;</td>
  299. <td class="paramname"><em>aViewPort</em></td><td>)</td>
  300. <td></td>
  301. </tr>
  302. </table>
  303. </div><div class="memdoc">
  304. <p>sets the viewport for the window </p>
  305. </div>
  306. </div>
  307. </div><!-- contents -->
  308. <!-- start footer part -->
  309. <hr class="footer"/><address class="footer"><small>
  310. 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
  311. </small></address>
  312. </body>
  313. </html>