You cannot select more than 25 topics
			Topics must start with a letter or number, can include dashes ('-') and dots ('.'), can be up to 35 characters long. Letters must be lowercase.
		
		
		
		
		
			
		
			
				
					
					
						
							620 lines
						
					
					
						
							33 KiB
						
					
					
				
			
		
		
	
	
							620 lines
						
					
					
						
							33 KiB
						
					
					
				| <!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"/> | |
| <meta http-equiv="X-UA-Compatible" content="IE=9"/> | |
| <meta name="generator" content="Doxygen 1.8.14"/> | |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> | |
| <title>0.9.9 API documenation: Angle and Trigonometry 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" /> | |
| </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 style="height: 56px;"> | |
|   <td id="projectlogo"><img alt="Logo" src="logo-mini.png"/></td> | |
|   <td id="projectalign" style="padding-left: 0.5em;"> | |
|    <div id="projectname">0.9.9 API documenation | |
|    </div> | |
|   </td> | |
|  </tr> | |
|  </tbody> | |
| </table> | |
| </div> | |
| <!-- end header part --> | |
| <!-- Generated by Doxygen 1.8.14 --> | |
| <script type="text/javascript"> | |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ | |
| var searchBox = new SearchBox("searchBox", "search",false,'Search'); | |
| /* @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:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ | |
| $(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"> | |
| <iframe src="javascript:void(0)" frameborder="0"  | |
|         name="MSearchResults" id="MSearchResults"> | |
| </iframe> | |
| </div> | |
| 
 | |
| <div class="header"> | |
|   <div class="summary"> | |
| <a href="#func-members">Functions</a>  </div> | |
|   <div class="headertitle"> | |
| <div class="title">Angle and Trigonometry Functions<div class="ingroups"><a class="el" href="a00698.html">Core features</a></div></div>  </div> | |
| </div><!--header--> | |
| <div class="contents"> | |
| <table class="memberdecls"> | |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> | |
| Functions</h2></td></tr> | |
| <tr class="memitem:gacc9b092df8257c68f19c9053703e2563"><td class="memTemplParams" colspan="2">template<length_t L, typename T , qualifier Q> </td></tr> | |
| <tr class="memitem:gacc9b092df8257c68f19c9053703e2563"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec< L, T, Q > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00790.html#gacc9b092df8257c68f19c9053703e2563">acos</a> (vec< L, T, Q > const &x)</td></tr> | |
| <tr class="separator:gacc9b092df8257c68f19c9053703e2563"><td class="memSeparator" colspan="2"> </td></tr> | |
| <tr class="memitem:ga858f35dc66fd2688f20c52b5f25be76a"><td class="memTemplParams" colspan="2">template<length_t L, typename T , qualifier Q> </td></tr> | |
| <tr class="memitem:ga858f35dc66fd2688f20c52b5f25be76a"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec< L, T, Q > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00790.html#ga858f35dc66fd2688f20c52b5f25be76a">acosh</a> (vec< L, T, Q > const &x)</td></tr> | |
| <tr class="separator:ga858f35dc66fd2688f20c52b5f25be76a"><td class="memSeparator" colspan="2"> </td></tr> | |
| <tr class="memitem:ga0552d2df4865fa8c3d7cfc3ec2caac73"><td class="memTemplParams" colspan="2">template<length_t L, typename T , qualifier Q> </td></tr> | |
| <tr class="memitem:ga0552d2df4865fa8c3d7cfc3ec2caac73"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec< L, T, Q > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00790.html#ga0552d2df4865fa8c3d7cfc3ec2caac73">asin</a> (vec< L, T, Q > const &x)</td></tr> | |
| <tr class="separator:ga0552d2df4865fa8c3d7cfc3ec2caac73"><td class="memSeparator" colspan="2"> </td></tr> | |
| <tr class="memitem:ga3ef16b501ee859fddde88e22192a5950"><td class="memTemplParams" colspan="2">template<length_t L, typename T , qualifier Q> </td></tr> | |
| <tr class="memitem:ga3ef16b501ee859fddde88e22192a5950"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec< L, T, Q > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00790.html#ga3ef16b501ee859fddde88e22192a5950">asinh</a> (vec< L, T, Q > const &x)</td></tr> | |
| <tr class="separator:ga3ef16b501ee859fddde88e22192a5950"><td class="memSeparator" colspan="2"> </td></tr> | |
| <tr class="memitem:gac61629f3a4aa14057e7a8cae002291db"><td class="memTemplParams" colspan="2">template<length_t L, typename T , qualifier Q> </td></tr> | |
| <tr class="memitem:gac61629f3a4aa14057e7a8cae002291db"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec< L, T, Q > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00790.html#gac61629f3a4aa14057e7a8cae002291db">atan</a> (vec< L, T, Q > const &y, vec< L, T, Q > const &x)</td></tr> | |
| <tr class="separator:gac61629f3a4aa14057e7a8cae002291db"><td class="memSeparator" colspan="2"> </td></tr> | |
| <tr class="memitem:ga5229f087eaccbc466f1c609ce3107b95"><td class="memTemplParams" colspan="2">template<length_t L, typename T , qualifier Q> </td></tr> | |
| <tr class="memitem:ga5229f087eaccbc466f1c609ce3107b95"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec< L, T, Q > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00790.html#ga5229f087eaccbc466f1c609ce3107b95">atan</a> (vec< L, T, Q > const &y_over_x)</td></tr> | |
| <tr class="separator:ga5229f087eaccbc466f1c609ce3107b95"><td class="memSeparator" colspan="2"> </td></tr> | |
| <tr class="memitem:gabc925650e618357d07da255531658b87"><td class="memTemplParams" colspan="2">template<length_t L, typename T , qualifier Q> </td></tr> | |
| <tr class="memitem:gabc925650e618357d07da255531658b87"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec< L, T, Q > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00790.html#gabc925650e618357d07da255531658b87">atanh</a> (vec< L, T, Q > const &x)</td></tr> | |
| <tr class="separator:gabc925650e618357d07da255531658b87"><td class="memSeparator" colspan="2"> </td></tr> | |
| <tr class="memitem:ga6a41efc740e3b3c937447d3a6284130e"><td class="memTemplParams" colspan="2">template<length_t L, typename T , qualifier Q> </td></tr> | |
| <tr class="memitem:ga6a41efc740e3b3c937447d3a6284130e"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec< L, T, Q > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00790.html#ga6a41efc740e3b3c937447d3a6284130e">cos</a> (vec< L, T, Q > const &angle)</td></tr> | |
| <tr class="separator:ga6a41efc740e3b3c937447d3a6284130e"><td class="memSeparator" colspan="2"> </td></tr> | |
| <tr class="memitem:ga4e260e372742c5f517aca196cf1e62b3"><td class="memTemplParams" colspan="2">template<length_t L, typename T , qualifier Q> </td></tr> | |
| <tr class="memitem:ga4e260e372742c5f517aca196cf1e62b3"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec< L, T, Q > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00790.html#ga4e260e372742c5f517aca196cf1e62b3">cosh</a> (vec< L, T, Q > const &angle)</td></tr> | |
| <tr class="separator:ga4e260e372742c5f517aca196cf1e62b3"><td class="memSeparator" colspan="2"> </td></tr> | |
| <tr class="memitem:ga8faec9e303538065911ba8b3caf7326b"><td class="memTemplParams" colspan="2">template<length_t L, typename T , qualifier Q> </td></tr> | |
| <tr class="memitem:ga8faec9e303538065911ba8b3caf7326b"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL GLM_CONSTEXPR vec< L, T, Q > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00790.html#ga8faec9e303538065911ba8b3caf7326b">degrees</a> (vec< L, T, Q > const &radians)</td></tr> | |
| <tr class="separator:ga8faec9e303538065911ba8b3caf7326b"><td class="memSeparator" colspan="2"> </td></tr> | |
| <tr class="memitem:ga6e1db4862c5e25afd553930e2fdd6a68"><td class="memTemplParams" colspan="2">template<length_t L, typename T , qualifier Q> </td></tr> | |
| <tr class="memitem:ga6e1db4862c5e25afd553930e2fdd6a68"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL GLM_CONSTEXPR vec< L, T, Q > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00790.html#ga6e1db4862c5e25afd553930e2fdd6a68">radians</a> (vec< L, T, Q > const &degrees)</td></tr> | |
| <tr class="separator:ga6e1db4862c5e25afd553930e2fdd6a68"><td class="memSeparator" colspan="2"> </td></tr> | |
| <tr class="memitem:ga29747fd108cb7292ae5a284f69691a69"><td class="memTemplParams" colspan="2">template<length_t L, typename T , qualifier Q> </td></tr> | |
| <tr class="memitem:ga29747fd108cb7292ae5a284f69691a69"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec< L, T, Q > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00790.html#ga29747fd108cb7292ae5a284f69691a69">sin</a> (vec< L, T, Q > const &angle)</td></tr> | |
| <tr class="separator:ga29747fd108cb7292ae5a284f69691a69"><td class="memSeparator" colspan="2"> </td></tr> | |
| <tr class="memitem:gac7c39ff21809e281552b4dbe46f4a39d"><td class="memTemplParams" colspan="2">template<length_t L, typename T , qualifier Q> </td></tr> | |
| <tr class="memitem:gac7c39ff21809e281552b4dbe46f4a39d"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec< L, T, Q > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00790.html#gac7c39ff21809e281552b4dbe46f4a39d">sinh</a> (vec< L, T, Q > const &angle)</td></tr> | |
| <tr class="separator:gac7c39ff21809e281552b4dbe46f4a39d"><td class="memSeparator" colspan="2"> </td></tr> | |
| <tr class="memitem:ga293a34cfb9f0115cc606b4a97c84f11f"><td class="memTemplParams" colspan="2">template<length_t L, typename T , qualifier Q> </td></tr> | |
| <tr class="memitem:ga293a34cfb9f0115cc606b4a97c84f11f"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec< L, T, Q > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00790.html#ga293a34cfb9f0115cc606b4a97c84f11f">tan</a> (vec< L, T, Q > const &angle)</td></tr> | |
| <tr class="separator:ga293a34cfb9f0115cc606b4a97c84f11f"><td class="memSeparator" colspan="2"> </td></tr> | |
| <tr class="memitem:gaa1bccbfdcbe40ed2ffcddc2aa8bfd0f1"><td class="memTemplParams" colspan="2">template<length_t L, typename T , qualifier Q> </td></tr> | |
| <tr class="memitem:gaa1bccbfdcbe40ed2ffcddc2aa8bfd0f1"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec< L, T, Q > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00790.html#gaa1bccbfdcbe40ed2ffcddc2aa8bfd0f1">tanh</a> (vec< L, T, Q > const &angle)</td></tr> | |
| <tr class="separator:gaa1bccbfdcbe40ed2ffcddc2aa8bfd0f1"><td class="memSeparator" colspan="2"> </td></tr> | |
| </table> | |
| <a name="details" id="details"></a><h2 class="groupheader">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> | |
| <p>Include <<a class="el" href="a00647.html" title="Core features ">glm/trigonometric.hpp</a>> to use these core features.</p> | |
| <dl class="section see"><dt>See also</dt><dd>ext_vector_trigonometric </dd></dl> | |
| <h2 class="groupheader">Function Documentation</h2> | |
| <a id="gacc9b092df8257c68f19c9053703e2563"></a> | |
| <h2 class="memtitle"><span class="permalink"><a href="#gacc9b092df8257c68f19c9053703e2563">◆ </a></span>acos()</h2> | |
| 
 | |
| <div class="memitem"> | |
| <div class="memproto"> | |
|       <table class="memname"> | |
|         <tr> | |
|           <td class="memname">GLM_FUNC_DECL vec<L, T, Q> glm::acos </td> | |
|           <td>(</td> | |
|           <td class="paramtype">vec< L, T, Q > const & </td> | |
|           <td class="paramname"><em>x</em></td><td>)</td> | |
|           <td></td> | |
|         </tr> | |
|       </table> | |
| </div><div class="memdoc"> | |
| 
 | |
| <p>Arc cosine. </p> | |
| <p>Returns an angle whose sine is x. The range of values returned by this function is [0, PI]. Results are undefined if |x| > 1.</p> | |
| <dl class="tparams"><dt>Template Parameters</dt><dd> | |
|   <table class="tparams"> | |
|     <tr><td class="paramname">L</td><td>Integer between 1 and 4 included that qualify the dimension of the vector </td></tr> | |
|     <tr><td class="paramname">T</td><td>Floating-point scalar types </td></tr> | |
|     <tr><td class="paramname">Q</td><td>Value from qualifier enum</td></tr> | |
|   </table> | |
|   </dd> | |
| </dl> | |
| <dl class="section see"><dt>See also</dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/acos.xml">GLSL acos man page</a> </dd> | |
| <dd> | |
| <a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.1 Angle and Trigonometry Functions</a> </dd></dl> | |
| 
 | |
| </div> | |
| </div> | |
| <a id="ga858f35dc66fd2688f20c52b5f25be76a"></a> | |
| <h2 class="memtitle"><span class="permalink"><a href="#ga858f35dc66fd2688f20c52b5f25be76a">◆ </a></span>acosh()</h2> | |
| 
 | |
| <div class="memitem"> | |
| <div class="memproto"> | |
|       <table class="memname"> | |
|         <tr> | |
|           <td class="memname">GLM_FUNC_DECL vec<L, T, Q> glm::acosh </td> | |
|           <td>(</td> | |
|           <td class="paramtype">vec< L, T, Q > const & </td> | |
|           <td class="paramname"><em>x</em></td><td>)</td> | |
|           <td></td> | |
|         </tr> | |
|       </table> | |
| </div><div class="memdoc"> | |
| 
 | |
| <p>Arc hyperbolic cosine; returns the non-negative inverse of cosh. </p> | |
| <p>Results are undefined if x < 1.</p> | |
| <dl class="tparams"><dt>Template Parameters</dt><dd> | |
|   <table class="tparams"> | |
|     <tr><td class="paramname">L</td><td>Integer between 1 and 4 included that qualify the dimension of the vector </td></tr> | |
|     <tr><td class="paramname">T</td><td>Floating-point scalar types </td></tr> | |
|     <tr><td class="paramname">Q</td><td>Value from qualifier enum</td></tr> | |
|   </table> | |
|   </dd> | |
| </dl> | |
| <dl class="section see"><dt>See also</dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/acosh.xml">GLSL acosh man page</a> </dd> | |
| <dd> | |
| <a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.1 Angle and Trigonometry Functions</a> </dd></dl> | |
| 
 | |
| </div> | |
| </div> | |
| <a id="ga0552d2df4865fa8c3d7cfc3ec2caac73"></a> | |
| <h2 class="memtitle"><span class="permalink"><a href="#ga0552d2df4865fa8c3d7cfc3ec2caac73">◆ </a></span>asin()</h2> | |
| 
 | |
| <div class="memitem"> | |
| <div class="memproto"> | |
|       <table class="memname"> | |
|         <tr> | |
|           <td class="memname">GLM_FUNC_DECL vec<L, T, Q> glm::asin </td> | |
|           <td>(</td> | |
|           <td class="paramtype">vec< L, T, Q > const & </td> | |
|           <td class="paramname"><em>x</em></td><td>)</td> | |
|           <td></td> | |
|         </tr> | |
|       </table> | |
| </div><div class="memdoc"> | |
| 
 | |
| <p>Arc sine. </p> | |
| <p>Returns an angle whose sine is x. The range of values returned by this function is [-PI/2, PI/2]. Results are undefined if |x| > 1.</p> | |
| <dl class="tparams"><dt>Template Parameters</dt><dd> | |
|   <table class="tparams"> | |
|     <tr><td class="paramname">L</td><td>Integer between 1 and 4 included that qualify the dimension of the vector </td></tr> | |
|     <tr><td class="paramname">T</td><td>Floating-point scalar types </td></tr> | |
|     <tr><td class="paramname">Q</td><td>Value from qualifier enum</td></tr> | |
|   </table> | |
|   </dd> | |
| </dl> | |
| <dl class="section see"><dt>See also</dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/asin.xml">GLSL asin man page</a> </dd> | |
| <dd> | |
| <a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.1 Angle and Trigonometry Functions</a> </dd></dl> | |
| 
 | |
| </div> | |
| </div> | |
| <a id="ga3ef16b501ee859fddde88e22192a5950"></a> | |
| <h2 class="memtitle"><span class="permalink"><a href="#ga3ef16b501ee859fddde88e22192a5950">◆ </a></span>asinh()</h2> | |
| 
 | |
| <div class="memitem"> | |
| <div class="memproto"> | |
|       <table class="memname"> | |
|         <tr> | |
|           <td class="memname">GLM_FUNC_DECL vec<L, T, Q> glm::asinh </td> | |
|           <td>(</td> | |
|           <td class="paramtype">vec< L, T, Q > const & </td> | |
|           <td class="paramname"><em>x</em></td><td>)</td> | |
|           <td></td> | |
|         </tr> | |
|       </table> | |
| </div><div class="memdoc"> | |
| 
 | |
| <p>Arc hyperbolic sine; returns the inverse of sinh. </p> | |
| <dl class="tparams"><dt>Template Parameters</dt><dd> | |
|   <table class="tparams"> | |
|     <tr><td class="paramname">L</td><td>Integer between 1 and 4 included that qualify the dimension of the vector </td></tr> | |
|     <tr><td class="paramname">T</td><td>Floating-point scalar types </td></tr> | |
|     <tr><td class="paramname">Q</td><td>Value from qualifier enum</td></tr> | |
|   </table> | |
|   </dd> | |
| </dl> | |
| <dl class="section see"><dt>See also</dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/asinh.xml">GLSL asinh man page</a> </dd> | |
| <dd> | |
| <a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.1 Angle and Trigonometry Functions</a> </dd></dl> | |
| 
 | |
| </div> | |
| </div> | |
| <a id="gac61629f3a4aa14057e7a8cae002291db"></a> | |
| <h2 class="memtitle"><span class="permalink"><a href="#gac61629f3a4aa14057e7a8cae002291db">◆ </a></span>atan() <span class="overload">[1/2]</span></h2> | |
| 
 | |
| <div class="memitem"> | |
| <div class="memproto"> | |
|       <table class="memname"> | |
|         <tr> | |
|           <td class="memname">GLM_FUNC_DECL vec<L, T, Q> glm::atan </td> | |
|           <td>(</td> | |
|           <td class="paramtype">vec< L, T, Q > const & </td> | |
|           <td class="paramname"><em>y</em>, </td> | |
|         </tr> | |
|         <tr> | |
|           <td class="paramkey"></td> | |
|           <td></td> | |
|           <td class="paramtype">vec< L, T, Q > const & </td> | |
|           <td class="paramname"><em>x</em> </td> | |
|         </tr> | |
|         <tr> | |
|           <td></td> | |
|           <td>)</td> | |
|           <td></td><td></td> | |
|         </tr> | |
|       </table> | |
| </div><div class="memdoc"> | |
| 
 | |
| <p>Arc tangent. </p> | |
| <p>Returns an angle whose tangent is y/x. The signs of x and y are used to determine what quadrant the angle is in. The range of values returned by this function is [-PI, PI]. Results are undefined if x and y are both 0.</p> | |
| <dl class="tparams"><dt>Template Parameters</dt><dd> | |
|   <table class="tparams"> | |
|     <tr><td class="paramname">L</td><td>Integer between 1 and 4 included that qualify the dimension of the vector </td></tr> | |
|     <tr><td class="paramname">T</td><td>Floating-point scalar types </td></tr> | |
|     <tr><td class="paramname">Q</td><td>Value from qualifier enum</td></tr> | |
|   </table> | |
|   </dd> | |
| </dl> | |
| <dl class="section see"><dt>See also</dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/atan.xml">GLSL atan man page</a> </dd> | |
| <dd> | |
| <a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.1 Angle and Trigonometry Functions</a> </dd></dl> | |
| 
 | |
| <p class="reference">Referenced by <a class="el" href="a00461_source.html#l00055">glm::atan2()</a>.</p> | |
| 
 | |
| </div> | |
| </div> | |
| <a id="ga5229f087eaccbc466f1c609ce3107b95"></a> | |
| <h2 class="memtitle"><span class="permalink"><a href="#ga5229f087eaccbc466f1c609ce3107b95">◆ </a></span>atan() <span class="overload">[2/2]</span></h2> | |
| 
 | |
| <div class="memitem"> | |
| <div class="memproto"> | |
|       <table class="memname"> | |
|         <tr> | |
|           <td class="memname">GLM_FUNC_DECL vec<L, T, Q> glm::atan </td> | |
|           <td>(</td> | |
|           <td class="paramtype">vec< L, T, Q > const & </td> | |
|           <td class="paramname"><em>y_over_x</em></td><td>)</td> | |
|           <td></td> | |
|         </tr> | |
|       </table> | |
| </div><div class="memdoc"> | |
| 
 | |
| <p>Arc tangent. </p> | |
| <p>Returns an angle whose tangent is y_over_x. The range of values returned by this function is [-PI/2, PI/2].</p> | |
| <dl class="tparams"><dt>Template Parameters</dt><dd> | |
|   <table class="tparams"> | |
|     <tr><td class="paramname">L</td><td>Integer between 1 and 4 included that qualify the dimension of the vector </td></tr> | |
|     <tr><td class="paramname">T</td><td>Floating-point scalar types </td></tr> | |
|     <tr><td class="paramname">Q</td><td>Value from qualifier enum</td></tr> | |
|   </table> | |
|   </dd> | |
| </dl> | |
| <dl class="section see"><dt>See also</dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/atan.xml">GLSL atan man page</a> </dd> | |
| <dd> | |
| <a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.1 Angle and Trigonometry Functions</a> </dd></dl> | |
| 
 | |
| </div> | |
| </div> | |
| <a id="gabc925650e618357d07da255531658b87"></a> | |
| <h2 class="memtitle"><span class="permalink"><a href="#gabc925650e618357d07da255531658b87">◆ </a></span>atanh()</h2> | |
| 
 | |
| <div class="memitem"> | |
| <div class="memproto"> | |
|       <table class="memname"> | |
|         <tr> | |
|           <td class="memname">GLM_FUNC_DECL vec<L, T, Q> glm::atanh </td> | |
|           <td>(</td> | |
|           <td class="paramtype">vec< L, T, Q > const & </td> | |
|           <td class="paramname"><em>x</em></td><td>)</td> | |
|           <td></td> | |
|         </tr> | |
|       </table> | |
| </div><div class="memdoc"> | |
| 
 | |
| <p>Arc hyperbolic tangent; returns the inverse of tanh. </p> | |
| <p>Results are undefined if abs(x) >= 1.</p> | |
| <dl class="tparams"><dt>Template Parameters</dt><dd> | |
|   <table class="tparams"> | |
|     <tr><td class="paramname">L</td><td>Integer between 1 and 4 included that qualify the dimension of the vector </td></tr> | |
|     <tr><td class="paramname">T</td><td>Floating-point scalar types </td></tr> | |
|     <tr><td class="paramname">Q</td><td>Value from qualifier enum</td></tr> | |
|   </table> | |
|   </dd> | |
| </dl> | |
| <dl class="section see"><dt>See also</dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/atanh.xml">GLSL atanh man page</a> </dd> | |
| <dd> | |
| <a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.1 Angle and Trigonometry Functions</a> </dd></dl> | |
| 
 | |
| </div> | |
| </div> | |
| <a id="ga6a41efc740e3b3c937447d3a6284130e"></a> | |
| <h2 class="memtitle"><span class="permalink"><a href="#ga6a41efc740e3b3c937447d3a6284130e">◆ </a></span>cos()</h2> | |
| 
 | |
| <div class="memitem"> | |
| <div class="memproto"> | |
|       <table class="memname"> | |
|         <tr> | |
|           <td class="memname">GLM_FUNC_DECL vec<L, T, Q> glm::cos </td> | |
|           <td>(</td> | |
|           <td class="paramtype">vec< L, T, Q > const & </td> | |
|           <td class="paramname"><em>angle</em></td><td>)</td> | |
|           <td></td> | |
|         </tr> | |
|       </table> | |
| </div><div class="memdoc"> | |
| 
 | |
| <p>The standard trigonometric cosine function. </p> | |
| <p>The values returned by this function will range from [-1, 1].</p> | |
| <dl class="tparams"><dt>Template Parameters</dt><dd> | |
|   <table class="tparams"> | |
|     <tr><td class="paramname">L</td><td>Integer between 1 and 4 included that qualify the dimension of the vector </td></tr> | |
|     <tr><td class="paramname">T</td><td>Floating-point scalar types </td></tr> | |
|     <tr><td class="paramname">Q</td><td>Value from qualifier enum</td></tr> | |
|   </table> | |
|   </dd> | |
| </dl> | |
| <dl class="section see"><dt>See also</dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/cos.xml">GLSL cos man page</a> </dd> | |
| <dd> | |
| <a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.1 Angle and Trigonometry Functions</a> </dd></dl> | |
| 
 | |
| </div> | |
| </div> | |
| <a id="ga4e260e372742c5f517aca196cf1e62b3"></a> | |
| <h2 class="memtitle"><span class="permalink"><a href="#ga4e260e372742c5f517aca196cf1e62b3">◆ </a></span>cosh()</h2> | |
| 
 | |
| <div class="memitem"> | |
| <div class="memproto"> | |
|       <table class="memname"> | |
|         <tr> | |
|           <td class="memname">GLM_FUNC_DECL vec<L, T, Q> glm::cosh </td> | |
|           <td>(</td> | |
|           <td class="paramtype">vec< L, T, Q > const & </td> | |
|           <td class="paramname"><em>angle</em></td><td>)</td> | |
|           <td></td> | |
|         </tr> | |
|       </table> | |
| </div><div class="memdoc"> | |
| 
 | |
| <p>Returns the hyperbolic cosine function, (exp(x) + exp(-x)) / 2. </p> | |
| <dl class="tparams"><dt>Template Parameters</dt><dd> | |
|   <table class="tparams"> | |
|     <tr><td class="paramname">L</td><td>Integer between 1 and 4 included that qualify the dimension of the vector </td></tr> | |
|     <tr><td class="paramname">T</td><td>Floating-point scalar types </td></tr> | |
|     <tr><td class="paramname">Q</td><td>Value from qualifier enum</td></tr> | |
|   </table> | |
|   </dd> | |
| </dl> | |
| <dl class="section see"><dt>See also</dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/cosh.xml">GLSL cosh man page</a> </dd> | |
| <dd> | |
| <a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.1 Angle and Trigonometry Functions</a> </dd></dl> | |
| 
 | |
| </div> | |
| </div> | |
| <a id="ga8faec9e303538065911ba8b3caf7326b"></a> | |
| <h2 class="memtitle"><span class="permalink"><a href="#ga8faec9e303538065911ba8b3caf7326b">◆ </a></span>degrees()</h2> | |
| 
 | |
| <div class="memitem"> | |
| <div class="memproto"> | |
|       <table class="memname"> | |
|         <tr> | |
|           <td class="memname">GLM_FUNC_DECL GLM_CONSTEXPR vec<L, T, Q> glm::degrees </td> | |
|           <td>(</td> | |
|           <td class="paramtype">vec< L, T, Q > const & </td> | |
|           <td class="paramname"><em>radians</em></td><td>)</td> | |
|           <td></td> | |
|         </tr> | |
|       </table> | |
| </div><div class="memdoc"> | |
| 
 | |
| <p>Converts radians to degrees and returns the result. </p> | |
| <dl class="tparams"><dt>Template Parameters</dt><dd> | |
|   <table class="tparams"> | |
|     <tr><td class="paramname">L</td><td>Integer between 1 and 4 included that qualify the dimension of the vector </td></tr> | |
|     <tr><td class="paramname">T</td><td>Floating-point scalar types </td></tr> | |
|     <tr><td class="paramname">Q</td><td>Value from qualifier enum</td></tr> | |
|   </table> | |
|   </dd> | |
| </dl> | |
| <dl class="section see"><dt>See also</dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/degrees.xml">GLSL degrees man page</a> </dd> | |
| <dd> | |
| <a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.1 Angle and Trigonometry Functions</a> </dd></dl> | |
| 
 | |
| </div> | |
| </div> | |
| <a id="ga6e1db4862c5e25afd553930e2fdd6a68"></a> | |
| <h2 class="memtitle"><span class="permalink"><a href="#ga6e1db4862c5e25afd553930e2fdd6a68">◆ </a></span>radians()</h2> | |
| 
 | |
| <div class="memitem"> | |
| <div class="memproto"> | |
|       <table class="memname"> | |
|         <tr> | |
|           <td class="memname">GLM_FUNC_DECL GLM_CONSTEXPR vec<L, T, Q> glm::radians </td> | |
|           <td>(</td> | |
|           <td class="paramtype">vec< L, T, Q > const & </td> | |
|           <td class="paramname"><em>degrees</em></td><td>)</td> | |
|           <td></td> | |
|         </tr> | |
|       </table> | |
| </div><div class="memdoc"> | |
| 
 | |
| <p>Converts degrees to radians and returns the result. </p> | |
| <dl class="tparams"><dt>Template Parameters</dt><dd> | |
|   <table class="tparams"> | |
|     <tr><td class="paramname">L</td><td>Integer between 1 and 4 included that qualify the dimension of the vector </td></tr> | |
|     <tr><td class="paramname">T</td><td>Floating-point scalar types </td></tr> | |
|     <tr><td class="paramname">Q</td><td>Value from qualifier enum</td></tr> | |
|   </table> | |
|   </dd> | |
| </dl> | |
| <dl class="section see"><dt>See also</dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/radians.xml">GLSL radians man page</a> </dd> | |
| <dd> | |
| <a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.1 Angle and Trigonometry Functions</a> </dd></dl> | |
| 
 | |
| </div> | |
| </div> | |
| <a id="ga29747fd108cb7292ae5a284f69691a69"></a> | |
| <h2 class="memtitle"><span class="permalink"><a href="#ga29747fd108cb7292ae5a284f69691a69">◆ </a></span>sin()</h2> | |
| 
 | |
| <div class="memitem"> | |
| <div class="memproto"> | |
|       <table class="memname"> | |
|         <tr> | |
|           <td class="memname">GLM_FUNC_DECL vec<L, T, Q> glm::sin </td> | |
|           <td>(</td> | |
|           <td class="paramtype">vec< L, T, Q > const & </td> | |
|           <td class="paramname"><em>angle</em></td><td>)</td> | |
|           <td></td> | |
|         </tr> | |
|       </table> | |
| </div><div class="memdoc"> | |
| 
 | |
| <p>The standard trigonometric sine function. </p> | |
| <p>The values returned by this function will range from [-1, 1].</p> | |
| <dl class="tparams"><dt>Template Parameters</dt><dd> | |
|   <table class="tparams"> | |
|     <tr><td class="paramname">L</td><td>Integer between 1 and 4 included that qualify the dimension of the vector </td></tr> | |
|     <tr><td class="paramname">T</td><td>Floating-point scalar types </td></tr> | |
|     <tr><td class="paramname">Q</td><td>Value from qualifier enum</td></tr> | |
|   </table> | |
|   </dd> | |
| </dl> | |
| <dl class="section see"><dt>See also</dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/sin.xml">GLSL sin man page</a> </dd> | |
| <dd> | |
| <a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.1 Angle and Trigonometry Functions</a> </dd></dl> | |
| 
 | |
| </div> | |
| </div> | |
| <a id="gac7c39ff21809e281552b4dbe46f4a39d"></a> | |
| <h2 class="memtitle"><span class="permalink"><a href="#gac7c39ff21809e281552b4dbe46f4a39d">◆ </a></span>sinh()</h2> | |
| 
 | |
| <div class="memitem"> | |
| <div class="memproto"> | |
|       <table class="memname"> | |
|         <tr> | |
|           <td class="memname">GLM_FUNC_DECL vec<L, T, Q> glm::sinh </td> | |
|           <td>(</td> | |
|           <td class="paramtype">vec< L, T, Q > const & </td> | |
|           <td class="paramname"><em>angle</em></td><td>)</td> | |
|           <td></td> | |
|         </tr> | |
|       </table> | |
| </div><div class="memdoc"> | |
| 
 | |
| <p>Returns the hyperbolic sine function, (exp(x) - exp(-x)) / 2. </p> | |
| <dl class="tparams"><dt>Template Parameters</dt><dd> | |
|   <table class="tparams"> | |
|     <tr><td class="paramname">L</td><td>Integer between 1 and 4 included that qualify the dimension of the vector </td></tr> | |
|     <tr><td class="paramname">T</td><td>Floating-point scalar types </td></tr> | |
|     <tr><td class="paramname">Q</td><td>Value from qualifier enum</td></tr> | |
|   </table> | |
|   </dd> | |
| </dl> | |
| <dl class="section see"><dt>See also</dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/sinh.xml">GLSL sinh man page</a> </dd> | |
| <dd> | |
| <a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.1 Angle and Trigonometry Functions</a> </dd></dl> | |
| 
 | |
| </div> | |
| </div> | |
| <a id="ga293a34cfb9f0115cc606b4a97c84f11f"></a> | |
| <h2 class="memtitle"><span class="permalink"><a href="#ga293a34cfb9f0115cc606b4a97c84f11f">◆ </a></span>tan()</h2> | |
| 
 | |
| <div class="memitem"> | |
| <div class="memproto"> | |
|       <table class="memname"> | |
|         <tr> | |
|           <td class="memname">GLM_FUNC_DECL vec<L, T, Q> glm::tan </td> | |
|           <td>(</td> | |
|           <td class="paramtype">vec< L, T, Q > const & </td> | |
|           <td class="paramname"><em>angle</em></td><td>)</td> | |
|           <td></td> | |
|         </tr> | |
|       </table> | |
| </div><div class="memdoc"> | |
| 
 | |
| <p>The standard trigonometric tangent function. </p> | |
| <dl class="tparams"><dt>Template Parameters</dt><dd> | |
|   <table class="tparams"> | |
|     <tr><td class="paramname">L</td><td>Integer between 1 and 4 included that qualify the dimension of the vector </td></tr> | |
|     <tr><td class="paramname">T</td><td>Floating-point scalar types </td></tr> | |
|     <tr><td class="paramname">Q</td><td>Value from qualifier enum</td></tr> | |
|   </table> | |
|   </dd> | |
| </dl> | |
| <dl class="section see"><dt>See also</dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/tan.xml">GLSL tan man page</a> </dd> | |
| <dd> | |
| <a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.1 Angle and Trigonometry Functions</a> </dd></dl> | |
| 
 | |
| </div> | |
| </div> | |
| <a id="gaa1bccbfdcbe40ed2ffcddc2aa8bfd0f1"></a> | |
| <h2 class="memtitle"><span class="permalink"><a href="#gaa1bccbfdcbe40ed2ffcddc2aa8bfd0f1">◆ </a></span>tanh()</h2> | |
| 
 | |
| <div class="memitem"> | |
| <div class="memproto"> | |
|       <table class="memname"> | |
|         <tr> | |
|           <td class="memname">GLM_FUNC_DECL vec<L, T, Q> glm::tanh </td> | |
|           <td>(</td> | |
|           <td class="paramtype">vec< L, T, Q > const & </td> | |
|           <td class="paramname"><em>angle</em></td><td>)</td> | |
|           <td></td> | |
|         </tr> | |
|       </table> | |
| </div><div class="memdoc"> | |
| 
 | |
| <p>Returns the hyperbolic tangent function, sinh(angle) / cosh(angle) </p> | |
| <dl class="tparams"><dt>Template Parameters</dt><dd> | |
|   <table class="tparams"> | |
|     <tr><td class="paramname">L</td><td>Integer between 1 and 4 included that qualify the dimension of the vector </td></tr> | |
|     <tr><td class="paramname">T</td><td>Floating-point scalar types </td></tr> | |
|     <tr><td class="paramname">Q</td><td>Value from qualifier enum</td></tr> | |
|   </table> | |
|   </dd> | |
| </dl> | |
| <dl class="section see"><dt>See also</dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/tanh.xml">GLSL tanh man page</a> </dd> | |
| <dd> | |
| <a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.1 Angle and Trigonometry Functions</a> </dd></dl> | |
| 
 | |
| </div> | |
| </div> | |
| </div><!-- contents --> | |
| <!-- start footer part --> | |
| <hr class="footer"/><address class="footer"><small> | |
| Generated by  <a href="http://www.doxygen.org/index.html"> | |
| <img class="footer" src="doxygen.png" alt="doxygen"/> | |
| </a> 1.8.14 | |
| </small></address> | |
| </body> | |
| </html>
 | |
| 
 |