| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332 |
- <!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: Viewing Volume 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">Viewing Volume 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:gadb0c70482b61aa4381a6040663788762" id="r_gadb0c70482b61aa4381a6040663788762"><td class="memItemLeft" align="right" valign="top">void </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> &aViewPort)</td></tr>
- <tr class="memdesc:gadb0c70482b61aa4381a6040663788762"><td class="mdescLeft"> </td><td class="mdescRight">sets the viewport for the window <br /></td></tr>
- <tr class="separator:gadb0c70482b61aa4381a6040663788762"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga70a567a2fe3fc2bd4a618093ee1c898c" id="r_ga70a567a2fe3fc2bd4a618093ee1c898c"><td class="memItemLeft" align="right" valign="top">void </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>
- <tr class="memdesc:ga70a567a2fe3fc2bd4a618093ee1c898c"><td class="mdescLeft"> </td><td class="mdescRight">gets the current viewport of the window <br /></td></tr>
- <tr class="separator:ga70a567a2fe3fc2bd4a618093ee1c898c"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga5251de394c75ef3b0cf9e093b6781bf0" id="r_ga5251de394c75ef3b0cf9e093b6781bf0"><td class="memItemLeft" align="right" valign="top">void </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>
- <tr class="separator:ga5251de394c75ef3b0cf9e093b6781bf0"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga95c31cf33faf364251a2c795bff15433" id="r_ga95c31cf33faf364251a2c795bff15433"><td class="memItemLeft" align="right" valign="top">void </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>
- <tr class="separator:ga95c31cf33faf364251a2c795bff15433"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga56a3acd126f34f224d00149c11de63e3" id="r_ga56a3acd126f34f224d00149c11de63e3"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dgl__view.html#ga56a3acd126f34f224d00149c11de63e3">dglIsOrtho</a> ()</td></tr>
- <tr class="memdesc:ga56a3acd126f34f224d00149c11de63e3"><td class="mdescLeft"> </td><td class="mdescRight">returns whether or not the coordinate system is orthographic (if it is not projected) <br /></td></tr>
- <tr class="separator:ga56a3acd126f34f224d00149c11de63e3"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga7ff9b9e0ffdc54c7b4a10d68237e81b4" id="r_ga7ff9b9e0ffdc54c7b4a10d68237e81b4"><td class="memItemLeft" align="right" valign="top">void </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> &clipRect)</td></tr>
- <tr class="separator:ga7ff9b9e0ffdc54c7b4a10d68237e81b4"><td class="memSeparator" colspan="2"> </td></tr>
- <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> & </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dgl__view.html#ga0d6259d74774253b2cc97ba8cee8323b">dglGetClipRect</a> ()</td></tr>
- <tr class="separator:ga0d6259d74774253b2cc97ba8cee8323b"><td class="memSeparator" colspan="2"> </td></tr>
- </table>
- <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
- <p>These functions set up the view cube of the window. </p>
- <h2 class="groupheader">Function Documentation</h2>
- <a id="ga0d6259d74774253b2cc97ba8cee8323b" name="ga0d6259d74774253b2cc97ba8cee8323b"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ga0d6259d74774253b2cc97ba8cee8323b">◆ </a></span>dglGetClipRect()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">const <a class="el" href="class_rect_i.html">RectI</a> & dglGetClipRect </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <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>
- </div>
- </div>
- <a id="ga95c31cf33faf364251a2c795bff15433" name="ga95c31cf33faf364251a2c795bff15433"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ga95c31cf33faf364251a2c795bff15433">◆ </a></span>dglGetFrustum()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void dglGetFrustum </td>
- <td>(</td>
- <td class="paramtype">F64 * </td>
- <td class="paramname"><em>left</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">F64 * </td>
- <td class="paramname"><em>right</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">F64 * </td>
- <td class="paramname"><em>bottom</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">F64 * </td>
- <td class="paramname"><em>top</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">F64 * </td>
- <td class="paramname"><em>nearDist</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">F64 * </td>
- <td class="paramname"><em>farDist</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Returns the parameters for the current viewing frustrum </p><dl class="section see"><dt>See also</dt><dd>dglSetFrustrum </dd></dl>
- </div>
- </div>
- <a id="ga70a567a2fe3fc2bd4a618093ee1c898c" name="ga70a567a2fe3fc2bd4a618093ee1c898c"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ga70a567a2fe3fc2bd4a618093ee1c898c">◆ </a></span>dglGetViewport()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void dglGetViewport </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="class_rect_i.html">RectI</a> * </td>
- <td class="paramname"><em>outViewport</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>gets the current viewport of the window </p>
- </div>
- </div>
- <a id="ga56a3acd126f34f224d00149c11de63e3" name="ga56a3acd126f34f224d00149c11de63e3"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ga56a3acd126f34f224d00149c11de63e3">◆ </a></span>dglIsOrtho()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">bool dglIsOrtho </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>returns whether or not the coordinate system is orthographic (if it is not projected) </p>
- </div>
- </div>
- <a id="ga7ff9b9e0ffdc54c7b4a10d68237e81b4" name="ga7ff9b9e0ffdc54c7b4a10d68237e81b4"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ga7ff9b9e0ffdc54c7b4a10d68237e81b4">◆ </a></span>dglSetClipRect()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void dglSetClipRect </td>
- <td>(</td>
- <td class="paramtype">const <a class="el" href="class_rect_i.html">RectI</a> & </td>
- <td class="paramname"><em>clipRect</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Sets up an orthographical viewport and clipping region. This is best used for guis </p><dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">clipRect</td><td>The bounds of the coordinate system </td></tr>
- </table>
- </dd>
- </dl>
- </div>
- </div>
- <a id="ga5251de394c75ef3b0cf9e093b6781bf0" name="ga5251de394c75ef3b0cf9e093b6781bf0"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ga5251de394c75ef3b0cf9e093b6781bf0">◆ </a></span>dglSetFrustum()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void dglSetFrustum </td>
- <td>(</td>
- <td class="paramtype">F64 </td>
- <td class="paramname"><em>left</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">F64 </td>
- <td class="paramname"><em>right</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">F64 </td>
- <td class="paramname"><em>bottom</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">F64 </td>
- <td class="paramname"><em>top</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">F64 </td>
- <td class="paramname"><em>nearDist</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">F64 </td>
- <td class="paramname"><em>farDist</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">bool </td>
- <td class="paramname"><em>ortho</em> = <code>false</code> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <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>
- <table class="params">
- <tr><td class="paramname">left</td><td>This is the position of the left vertical clipping plane </td></tr>
- <tr><td class="paramname">right</td><td>This is the position of the right vertical clipping plane </td></tr>
- <tr><td class="paramname">top</td><td>This is the position of the top horizontal clipping plane </td></tr>
- <tr><td class="paramname">bottom</td><td>This is the position of the bottom horizontal clipping plane </td></tr>
- <tr><td class="paramname">nearDist</td><td>This is the distance between the eye and the near clipping plane </td></tr>
- <tr><td class="paramname">farDist</td><td>This is the distance between the eye and the far clipping plane </td></tr>
- <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>
- </table>
- </dd>
- </dl>
- </div>
- </div>
- <a id="gadb0c70482b61aa4381a6040663788762" name="gadb0c70482b61aa4381a6040663788762"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#gadb0c70482b61aa4381a6040663788762">◆ </a></span>dglSetViewport()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void dglSetViewport </td>
- <td>(</td>
- <td class="paramtype">const <a class="el" href="class_rect_i.html">RectI</a> & </td>
- <td class="paramname"><em>aViewPort</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>sets the viewport for the window </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>
|