mewin/glm
1
0
Fork 0
Code Releases Activity

Updated doxygen documentation

Browse Source
This commit is contained in:
Christophe Riccio
2011-12-07 14:50:15 +00:00
parent a3b5034d4e
commit f18ad6bf2e
389 changed files with 27429 additions and 14460 deletions
Download Patch File Download Diff File Expand all files Collapse all files

100
doc/api-0.9.3/a00149.html
View File

@@ -2,22 +2,36 @@
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Angle and Trigonometry Functions</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<!-- Generated by Doxygen 1.7.3 -->
<div id="top">
<div id="top"><!-- do not remove this div! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="logo-mini.png"></td>
<td id="projectlogo"><img alt="Logo" src="logo-mini.png"/></td>
</tr>
</tbody>
</table>
</div>
<!-- Generated by Doxygen 1.7.5 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
@@ -32,52 +46,49 @@
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<h1>Angle and Trigonometry Functions</h1> </div>
<div class="title">Angle and Trigonometry Functions</div> </div>
<div class="ingroups"><a class="el" href="a00154.html">GLM Core</a></div></div>
<div class="contents">
<p>Function parameters specified as angle are assumed to be in units of radians.
<a href="#_details">More...</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00149.html#ga33272ee0c449d56ab93ff999edde9007">acos</a> (genType const &amp;x)</td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00149.html#gafef7954b5fa3228f4aaabde8dfa862a1">acos</a> (genType const &amp;x)</td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00149.html#ga827e72f8342ee6e9b37ad8781a9cf96b">acosh</a> (genType const &amp;x)</td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00149.html#ga0f37ff6b6878a0169cd41249e5377e09">acosh</a> (genType const &amp;x)</td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00149.html#ga42595a0c8ad51101941eee5f3f611fce">asin</a> (genType const &amp;x)</td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00149.html#ga76b6422e62c99fa0849abdf21fcef5cf">asin</a> (genType const &amp;x)</td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00149.html#ga5f937e3160aa3c8e692a608e08c6a2f9">asinh</a> (genType const &amp;x)</td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00149.html#ga615d386dcfb41cdbbca2609c53113aac">asinh</a> (genType const &amp;x)</td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00149.html#ga6c015e14cbcdb6ec0c39649a11fe65fb">atan</a> (genType const &amp;y, genType const &amp;x)</td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00149.html#ga2394d11075a74869cd88473c76722bc8">atan</a> (genType const &amp;y, genType const &amp;x)</td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00149.html#ga42b12ef7b8286cd82f1ab01024e8f3ed">atan</a> (genType const &amp;y_over_x)</td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00149.html#ga5db83034488156692939acb4f4e46fa6">atan</a> (genType const &amp;y_over_x)</td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00149.html#gaf0a48950eb811f675a0d128d13c79110">atanh</a> (genType const &amp;x)</td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00149.html#gadeda850d5dff43d4d069854b1b6a623c">atanh</a> (genType const &amp;x)</td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00149.html#ga6805306f226985dc7811981f26805af8">cos</a> (genType const &amp;angle)</td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00149.html#gace62d5d164def52455aeff19e1bccd88">cos</a> (genType const &amp;angle)</td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00149.html#ga78334e0ac183eb5dfd53c6f3347a21da">cosh</a> (genType const &amp;angle)</td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00149.html#gaf1b20113fe439fa48524e8c35ea2c1d0">cosh</a> (genType const &amp;angle)</td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00149.html#ga09225aec06af6c985ab811f53aebdcb8">degrees</a> (genType const &amp;radians)</td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00149.html#ga034bdb53d458242c506e4d830c7df3aa">degrees</a> (genType const &amp;radians)</td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00149.html#gae2d4a72c55c46a8ef56b61d16a6534a9">radians</a> (genType const &amp;degrees)</td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00149.html#ga4fb76e28851c9ff6653532566084e091">radians</a> (genType const &amp;degrees)</td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00149.html#ga03b5b3713bb07416c65ddc7c59c2082d">sin</a> (genType const &amp;angle)</td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00149.html#ga4fcd05daafb008f20e121e727c0196c7">sin</a> (genType const &amp;angle)</td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00149.html#ga6324dac58b5ebc549eac5746d8447eac">sinh</a> (genType const &amp;angle)</td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00149.html#ga6f38bb1a343b5d73ac71ddd53baa3375">sinh</a> (genType const &amp;angle)</td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00149.html#ga23bfe4460cf1d2391de4ff2b59d64486">tan</a> (genType const &amp;angle)</td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00149.html#ga43860bed05c85587e2d931b26d765640">tan</a> (genType const &amp;angle)</td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00149.html#ga9afc7bd03a65a2d77bc25971cc166b11">tanh</a> (genType const &amp;angle)</td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00149.html#ga5315f571fd52f30d368abc056c4aea13">tanh</a> (genType const &amp;angle)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<p>Function parameters specified as angle are assumed to be in units of radians. </p>
<p>In no case will any of these functions result in a divide by zero error. If the divisor of a ratio is 0, then results will be undefined.</p>
<p>These all operate component-wise. The description is per component. </p>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="ga33272ee0c449d56ab93ff999edde9007"></a><!-- doxytag: member="glm::acos" ref="ga33272ee0c449d56ab93ff999edde9007" args="(genType const &amp;x)" -->
<a class="anchor" id="gafef7954b5fa3228f4aaabde8dfa862a1"></a><!-- doxytag: member="glm::acos" ref="gafef7954b5fa3228f4aaabde8dfa862a1" args="(genType const &amp;x)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
@@ -106,7 +117,7 @@ Functions</h2></td></tr>
</div>
</div>
<a class="anchor" id="ga827e72f8342ee6e9b37ad8781a9cf96b"></a><!-- doxytag: member="glm::acosh" ref="ga827e72f8342ee6e9b37ad8781a9cf96b" args="(genType const &amp;x)" -->
<a class="anchor" id="ga0f37ff6b6878a0169cd41249e5377e09"></a><!-- doxytag: member="glm::acosh" ref="ga0f37ff6b6878a0169cd41249e5377e09" args="(genType const &amp;x)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
@@ -135,7 +146,7 @@ Functions</h2></td></tr>
</div>
</div>
<a class="anchor" id="ga42595a0c8ad51101941eee5f3f611fce"></a><!-- doxytag: member="glm::asin" ref="ga42595a0c8ad51101941eee5f3f611fce" args="(genType const &amp;x)" -->
<a class="anchor" id="ga76b6422e62c99fa0849abdf21fcef5cf"></a><!-- doxytag: member="glm::asin" ref="ga76b6422e62c99fa0849abdf21fcef5cf" args="(genType const &amp;x)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
@@ -164,7 +175,7 @@ Functions</h2></td></tr>
</div>
</div>
<a class="anchor" id="ga5f937e3160aa3c8e692a608e08c6a2f9"></a><!-- doxytag: member="glm::asinh" ref="ga5f937e3160aa3c8e692a608e08c6a2f9" args="(genType const &amp;x)" -->
<a class="anchor" id="ga615d386dcfb41cdbbca2609c53113aac"></a><!-- doxytag: member="glm::asinh" ref="ga615d386dcfb41cdbbca2609c53113aac" args="(genType const &amp;x)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
@@ -192,7 +203,7 @@ Functions</h2></td></tr>
</div>
</div>
<a class="anchor" id="ga6c015e14cbcdb6ec0c39649a11fe65fb"></a><!-- doxytag: member="glm::atan" ref="ga6c015e14cbcdb6ec0c39649a11fe65fb" args="(genType const &amp;y, genType const &amp;x)" -->
<a class="anchor" id="ga2394d11075a74869cd88473c76722bc8"></a><!-- doxytag: member="glm::atan" ref="ga2394d11075a74869cd88473c76722bc8" args="(genType const &amp;y, genType const &amp;x)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
@@ -233,7 +244,7 @@ Functions</h2></td></tr>
</div>
</div>
<a class="anchor" id="ga42b12ef7b8286cd82f1ab01024e8f3ed"></a><!-- doxytag: member="glm::atan" ref="ga42b12ef7b8286cd82f1ab01024e8f3ed" args="(genType const &amp;y_over_x)" -->
<a class="anchor" id="ga5db83034488156692939acb4f4e46fa6"></a><!-- doxytag: member="glm::atan" ref="ga5db83034488156692939acb4f4e46fa6" args="(genType const &amp;y_over_x)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
@@ -262,7 +273,7 @@ Functions</h2></td></tr>
</div>
</div>
<a class="anchor" id="gaf0a48950eb811f675a0d128d13c79110"></a><!-- doxytag: member="glm::atanh" ref="gaf0a48950eb811f675a0d128d13c79110" args="(genType const &amp;x)" -->
<a class="anchor" id="gadeda850d5dff43d4d069854b1b6a623c"></a><!-- doxytag: member="glm::atanh" ref="gadeda850d5dff43d4d069854b1b6a623c" args="(genType const &amp;x)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
@@ -291,7 +302,7 @@ Functions</h2></td></tr>
</div>
</div>
<a class="anchor" id="ga6805306f226985dc7811981f26805af8"></a><!-- doxytag: member="glm::cos" ref="ga6805306f226985dc7811981f26805af8" args="(genType const &amp;angle)" -->
<a class="anchor" id="gace62d5d164def52455aeff19e1bccd88"></a><!-- doxytag: member="glm::cos" ref="gace62d5d164def52455aeff19e1bccd88" args="(genType const &amp;angle)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
@@ -320,7 +331,7 @@ Functions</h2></td></tr>
</div>
</div>
<a class="anchor" id="ga78334e0ac183eb5dfd53c6f3347a21da"></a><!-- doxytag: member="glm::cosh" ref="ga78334e0ac183eb5dfd53c6f3347a21da" args="(genType const &amp;angle)" -->
<a class="anchor" id="gaf1b20113fe439fa48524e8c35ea2c1d0"></a><!-- doxytag: member="glm::cosh" ref="gaf1b20113fe439fa48524e8c35ea2c1d0" args="(genType const &amp;angle)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
@@ -348,7 +359,7 @@ Functions</h2></td></tr>
</div>
</div>
<a class="anchor" id="ga09225aec06af6c985ab811f53aebdcb8"></a><!-- doxytag: member="glm::degrees" ref="ga09225aec06af6c985ab811f53aebdcb8" args="(genType const &amp;radians)" -->
<a class="anchor" id="ga034bdb53d458242c506e4d830c7df3aa"></a><!-- doxytag: member="glm::degrees" ref="ga034bdb53d458242c506e4d830c7df3aa" args="(genType const &amp;radians)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
@@ -376,7 +387,7 @@ Functions</h2></td></tr>
</div>
</div>
<a class="anchor" id="gae2d4a72c55c46a8ef56b61d16a6534a9"></a><!-- doxytag: member="glm::radians" ref="gae2d4a72c55c46a8ef56b61d16a6534a9" args="(genType const &amp;degrees)" -->
<a class="anchor" id="ga4fb76e28851c9ff6653532566084e091"></a><!-- doxytag: member="glm::radians" ref="ga4fb76e28851c9ff6653532566084e091" args="(genType const &amp;degrees)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
@@ -404,7 +415,7 @@ Functions</h2></td></tr>
</div>
</div>
<a class="anchor" id="ga03b5b3713bb07416c65ddc7c59c2082d"></a><!-- doxytag: member="glm::sin" ref="ga03b5b3713bb07416c65ddc7c59c2082d" args="(genType const &amp;angle)" -->
<a class="anchor" id="ga4fcd05daafb008f20e121e727c0196c7"></a><!-- doxytag: member="glm::sin" ref="ga4fcd05daafb008f20e121e727c0196c7" args="(genType const &amp;angle)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
@@ -433,7 +444,7 @@ Functions</h2></td></tr>
</div>
</div>
<a class="anchor" id="ga6324dac58b5ebc549eac5746d8447eac"></a><!-- doxytag: member="glm::sinh" ref="ga6324dac58b5ebc549eac5746d8447eac" args="(genType const &amp;angle)" -->
<a class="anchor" id="ga6f38bb1a343b5d73ac71ddd53baa3375"></a><!-- doxytag: member="glm::sinh" ref="ga6f38bb1a343b5d73ac71ddd53baa3375" args="(genType const &amp;angle)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
@@ -461,7 +472,7 @@ Functions</h2></td></tr>
</div>
</div>
<a class="anchor" id="ga23bfe4460cf1d2391de4ff2b59d64486"></a><!-- doxytag: member="glm::tan" ref="ga23bfe4460cf1d2391de4ff2b59d64486" args="(genType const &amp;angle)" -->
<a class="anchor" id="ga43860bed05c85587e2d931b26d765640"></a><!-- doxytag: member="glm::tan" ref="ga43860bed05c85587e2d931b26d765640" args="(genType const &amp;angle)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
@@ -489,7 +500,7 @@ Functions</h2></td></tr>
</div>
</div>
<a class="anchor" id="ga9afc7bd03a65a2d77bc25971cc166b11"></a><!-- doxytag: member="glm::tanh" ref="ga9afc7bd03a65a2d77bc25971cc166b11" args="(genType const &amp;angle)" -->
<a class="anchor" id="ga5315f571fd52f30d368abc056c4aea13"></a><!-- doxytag: member="glm::tanh" ref="ga5315f571fd52f30d368abc056c4aea13" args="(genType const &amp;angle)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
@@ -518,8 +529,13 @@ Functions</h2></td></tr>
</div>
</div>
</div>
<hr class="footer"/><address class="footer"><small>Generated by&#160;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </small></address>
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.7.5
</small></address>
</body>
</html>