glm/doc/html/a00146.html
Christophe Riccio 7c7b1d0b3d Added GLM 0.8.4
2010-04-29 11:54:07 +01:00

338 lines
16 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>GLM: glm::gtc::matrix_projection Namespace Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li class="current"><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="namespaces.html"><span>Namespace&nbsp;List</span></a></li>
<li><a href="namespacemembers.html"><span>Namespace&nbsp;Members</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="a00124.html">glm</a>::<a class="el" href="a00142.html">gtc</a>::<a class="el" href="a00146.html">matrix_projection</a>
</div>
</div>
<div class="contents">
<h1>glm::gtc::matrix_projection Namespace Reference</h1>
<p>GLM_GTC_matrix_projection: Varius ways to build and operate on projection matrices.
<a href="#_details">More...</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Functions</h2></td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;typename valType &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">detail::tmat4x4&lt; valType &gt;&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00146.html#a2768981d9e4c77432d862173962461a3">frustum</a> (valType const &amp;left, valType const &amp;right, valType const &amp;bottom, valType const &amp;top, valType const &amp;nearVal, valType const &amp;farVal)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Creates a frustum matrix. <a href="#a2768981d9e4c77432d862173962461a3"></a><br/></td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;typename valType &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">detail::tmat4x4&lt; valType &gt;&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00146.html#a63c655a72e82f8574ac412ad89815fa5">ortho</a> (valType const &amp;left, valType const &amp;right, valType const &amp;bottom, valType const &amp;top, valType const &amp;zNear, valType const &amp;zFar)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Creates a matrix for an orthographic parallel viewing volume. <a href="#a63c655a72e82f8574ac412ad89815fa5"></a><br/></td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;typename valType &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">detail::tmat4x4&lt; valType &gt;&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00146.html#a5876cb090446e96852d28d91b2a11845">ortho</a> (valType const &amp;left, valType const &amp;right, valType const &amp;bottom, valType const &amp;top)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Creates a matrix for projecting two-dimensional coordinates onto the screen. <a href="#a5876cb090446e96852d28d91b2a11845"></a><br/></td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;typename valType &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">detail::tmat4x4&lt; valType &gt;&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00146.html#a5a6ef082a2d34e5a048a3b3260bdb38d">perspective</a> (valType const &amp;fovy, valType const &amp;aspect, valType const &amp;zNear, valType const &amp;zFar)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Creates a matrix for a symetric perspective-view frustum. <a href="#a5a6ef082a2d34e5a048a3b3260bdb38d"></a><br/></td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;typename valTypeT , typename valTypeU &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">detail::tvec3&lt; valTypeT &gt;&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00146.html#a43f4cc5449cfc265575a8f840eae746f">project</a> (detail::tvec3&lt; valTypeT &gt; const &amp;obj, detail::tmat4x4&lt; valTypeT &gt; const &amp;model, detail::tmat4x4&lt; valTypeT &gt; const &amp;proj, detail::tvec4&lt; valTypeU &gt; const &amp;viewport)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Map the specified object coordinates (obj.x, obj.y, obj.z) into window coordinates. <a href="#a43f4cc5449cfc265575a8f840eae746f"></a><br/></td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;typename valTypeT , typename valTypeU &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">detail::tvec3&lt; valTypeT &gt;&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00146.html#a46841c68eb0fb92ee341308df60c125d">unProject</a> (detail::tvec3&lt; valTypeT &gt; const &amp;win, detail::tmat4x4&lt; valTypeT &gt; const &amp;model, detail::tmat4x4&lt; valTypeT &gt; const &amp;proj, detail::tvec4&lt; valTypeU &gt; const &amp;viewport)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Map the specified window coordinates (win.x, win.y, win.z) into object coordinates. <a href="#a46841c68eb0fb92ee341308df60c125d"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>GLM_GTC_matrix_projection: Varius ways to build and operate on projection matrices. </p>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="a2768981d9e4c77432d862173962461a3"></a><!-- doxytag: member="glm::gtc::matrix_projection::frustum" ref="a2768981d9e4c77432d862173962461a3" args="(valType const &amp;left, valType const &amp;right, valType const &amp;bottom, valType const &amp;top, valType const &amp;nearVal, valType const &amp;farVal)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">detail::tmat4x4&lt;valType&gt; glm::gtc::matrix_projection::frustum </td>
<td>(</td>
<td class="paramtype">valType const &amp;&nbsp;</td>
<td class="paramname"> <em>left</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">valType const &amp;&nbsp;</td>
<td class="paramname"> <em>right</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">valType const &amp;&nbsp;</td>
<td class="paramname"> <em>bottom</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">valType const &amp;&nbsp;</td>
<td class="paramname"> <em>top</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">valType const &amp;&nbsp;</td>
<td class="paramname"> <em>nearVal</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">valType const &amp;&nbsp;</td>
<td class="paramname"> <em>farVal</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Creates a frustum matrix. </p>
<p>From GLM_GTC_matrix_projection extension. </p>
</div>
</div>
<a class="anchor" id="a63c655a72e82f8574ac412ad89815fa5"></a><!-- doxytag: member="glm::gtc::matrix_projection::ortho" ref="a63c655a72e82f8574ac412ad89815fa5" args="(valType const &amp;left, valType const &amp;right, valType const &amp;bottom, valType const &amp;top, valType const &amp;zNear, valType const &amp;zFar)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">detail::tmat4x4&lt;valType&gt; glm::gtc::matrix_projection::ortho </td>
<td>(</td>
<td class="paramtype">valType const &amp;&nbsp;</td>
<td class="paramname"> <em>left</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">valType const &amp;&nbsp;</td>
<td class="paramname"> <em>right</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">valType const &amp;&nbsp;</td>
<td class="paramname"> <em>bottom</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">valType const &amp;&nbsp;</td>
<td class="paramname"> <em>top</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">valType const &amp;&nbsp;</td>
<td class="paramname"> <em>zNear</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">valType const &amp;&nbsp;</td>
<td class="paramname"> <em>zFar</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Creates a matrix for an orthographic parallel viewing volume. </p>
<p>From GLM_GTC_matrix_projection extension. </p>
</div>
</div>
<a class="anchor" id="a5876cb090446e96852d28d91b2a11845"></a><!-- doxytag: member="glm::gtc::matrix_projection::ortho" ref="a5876cb090446e96852d28d91b2a11845" args="(valType const &amp;left, valType const &amp;right, valType const &amp;bottom, valType const &amp;top)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">detail::tmat4x4&lt;valType&gt; glm::gtc::matrix_projection::ortho </td>
<td>(</td>
<td class="paramtype">valType const &amp;&nbsp;</td>
<td class="paramname"> <em>left</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">valType const &amp;&nbsp;</td>
<td class="paramname"> <em>right</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">valType const &amp;&nbsp;</td>
<td class="paramname"> <em>bottom</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">valType const &amp;&nbsp;</td>
<td class="paramname"> <em>top</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Creates a matrix for projecting two-dimensional coordinates onto the screen. </p>
<p>From GLM_GTC_matrix_projection extension. </p>
</div>
</div>
<a class="anchor" id="a5a6ef082a2d34e5a048a3b3260bdb38d"></a><!-- doxytag: member="glm::gtc::matrix_projection::perspective" ref="a5a6ef082a2d34e5a048a3b3260bdb38d" args="(valType const &amp;fovy, valType const &amp;aspect, valType const &amp;zNear, valType const &amp;zFar)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">detail::tmat4x4&lt;valType&gt; glm::gtc::matrix_projection::perspective </td>
<td>(</td>
<td class="paramtype">valType const &amp;&nbsp;</td>
<td class="paramname"> <em>fovy</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">valType const &amp;&nbsp;</td>
<td class="paramname"> <em>aspect</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">valType const &amp;&nbsp;</td>
<td class="paramname"> <em>zNear</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">valType const &amp;&nbsp;</td>
<td class="paramname"> <em>zFar</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Creates a matrix for a symetric perspective-view frustum. </p>
<p>From GLM_GTC_matrix_projection extension. </p>
</div>
</div>
<a class="anchor" id="a43f4cc5449cfc265575a8f840eae746f"></a><!-- doxytag: member="glm::gtc::matrix_projection::project" ref="a43f4cc5449cfc265575a8f840eae746f" args="(detail::tvec3&lt; valTypeT &gt; const &amp;obj, detail::tmat4x4&lt; valTypeT &gt; const &amp;model, detail::tmat4x4&lt; valTypeT &gt; const &amp;proj, detail::tvec4&lt; valTypeU &gt; const &amp;viewport)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">detail::tvec3&lt;valTypeT&gt; glm::gtc::matrix_projection::project </td>
<td>(</td>
<td class="paramtype">detail::tvec3&lt; valTypeT &gt; const &amp;&nbsp;</td>
<td class="paramname"> <em>obj</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">detail::tmat4x4&lt; valTypeT &gt; const &amp;&nbsp;</td>
<td class="paramname"> <em>model</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">detail::tmat4x4&lt; valTypeT &gt; const &amp;&nbsp;</td>
<td class="paramname"> <em>proj</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">detail::tvec4&lt; valTypeU &gt; const &amp;&nbsp;</td>
<td class="paramname"> <em>viewport</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Map the specified object coordinates (obj.x, obj.y, obj.z) into window coordinates. </p>
<p>From GLM_GTC_matrix_projection extension. </p>
</div>
</div>
<a class="anchor" id="a46841c68eb0fb92ee341308df60c125d"></a><!-- doxytag: member="glm::gtc::matrix_projection::unProject" ref="a46841c68eb0fb92ee341308df60c125d" args="(detail::tvec3&lt; valTypeT &gt; const &amp;win, detail::tmat4x4&lt; valTypeT &gt; const &amp;model, detail::tmat4x4&lt; valTypeT &gt; const &amp;proj, detail::tvec4&lt; valTypeU &gt; const &amp;viewport)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">detail::tvec3&lt;valTypeT&gt; glm::gtc::matrix_projection::unProject </td>
<td>(</td>
<td class="paramtype">detail::tvec3&lt; valTypeT &gt; const &amp;&nbsp;</td>
<td class="paramname"> <em>win</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">detail::tmat4x4&lt; valTypeT &gt; const &amp;&nbsp;</td>
<td class="paramname"> <em>model</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">detail::tmat4x4&lt; valTypeT &gt; const &amp;&nbsp;</td>
<td class="paramname"> <em>proj</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">detail::tvec4&lt; valTypeU &gt; const &amp;&nbsp;</td>
<td class="paramname"> <em>viewport</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Map the specified window coordinates (win.x, win.y, win.z) into object coordinates. </p>
<p>From GLM_GTC_matrix_projection extension. </p>
</div>
</div>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated on Mon Nov 16 11:23:24 2009 for GLM by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>