diff options
Diffstat (limited to '3rdparty/glm/doc/api/a00152.html')
| -rw-r--r-- | 3rdparty/glm/doc/api/a00152.html | 460 |
1 files changed, 274 insertions, 186 deletions
diff --git a/3rdparty/glm/doc/api/a00152.html b/3rdparty/glm/doc/api/a00152.html index 6b61073fc6f..a7cc702f739 100644 --- a/3rdparty/glm/doc/api/a00152.html +++ b/3rdparty/glm/doc/api/a00152.html @@ -4,16 +4,10 @@ <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.10"/> -<title>0.9.9 API documenation: Vector Relational Functions</title> +<title>0.9.8: 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> -<script type="text/javascript"> - $(document).ready(function() { init_search(); }); -</script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> @@ -22,9 +16,9 @@ <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.png"/></td> <td id="projectalign" style="padding-left: 0.5em;"> - <div id="projectname">0.9.9 API documenation + <div id="projectname">0.9.8 </div> </td> </tr> @@ -33,208 +27,201 @@ </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.10 --> -<script type="text/javascript"> -var searchBox = new SearchBox("searchBox", "search",false,'Search'); -</script> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="modules.html"><span>Modules</span></a></li> <li><a href="files.html"><span>Files</span></a></li> - <li> - <div id="MSearchBox" class="MSearchBoxInactive"> - <span class="left"> - <img id="MSearchSelect" src="search/mag_sel.png" - onmouseover="return searchBox.OnSearchSelectShow()" - onmouseout="return searchBox.OnSearchSelectHide()" - alt=""/> - <input type="text" id="MSearchField" value="Search" accesskey="S" - onfocus="searchBox.OnSearchFieldFocus(true)" - onblur="searchBox.OnSearchFieldFocus(false)" - onkeyup="searchBox.OnSearchFieldChange(event)"/> - </span><span class="right"> - <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> - </span> - </div> - </li> </ul> </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">Vector Relational Functions<div class="ingroups"><a class="el" href="a00155.html">GLM Core</a></div></div> </div> +<div class="title">Angle and Trigonometry Functions<div class="ingroups"><a class="el" href="a00156.html">GLM Core</a></div></div> </div> </div><!--header--> <div class="contents"> - -<p>Relational and equality operators (<, <=, >, >=, ==, !=) are defined to operate on scalars and produce scalar Boolean results. -<a href="#details">More...</a></p> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> Functions</h2></td></tr> -<tr class="memitem:ga14bbc94f2ae2774a1d64d91f8767773e"><td class="memTemplParams" colspan="2">template<precision P, template< typename, precision > class vecType> </td></tr> -<tr class="memitem:ga14bbc94f2ae2774a1d64d91f8767773e"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00152.html#ga14bbc94f2ae2774a1d64d91f8767773e">all</a> (vecType< bool, P > const &v)</td></tr> -<tr class="memdesc:ga14bbc94f2ae2774a1d64d91f8767773e"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if all components of x are true. <a href="a00152.html#ga14bbc94f2ae2774a1d64d91f8767773e">More...</a><br /></td></tr> -<tr class="separator:ga14bbc94f2ae2774a1d64d91f8767773e"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga632a2644532d9332011c8860400d30b2"><td class="memTemplParams" colspan="2">template<precision P, template< typename, precision > class vecType> </td></tr> -<tr class="memitem:ga632a2644532d9332011c8860400d30b2"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00152.html#ga632a2644532d9332011c8860400d30b2">any</a> (vecType< bool, P > const &v)</td></tr> -<tr class="memdesc:ga632a2644532d9332011c8860400d30b2"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if any component of x is true. <a href="a00152.html#ga632a2644532d9332011c8860400d30b2">More...</a><br /></td></tr> -<tr class="separator:ga632a2644532d9332011c8860400d30b2"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga39c80d8baf49b0ce69f2bb22d45b3801"><td class="memTemplParams" colspan="2">template<typename T , precision P, template< typename, precision > class vecType> </td></tr> -<tr class="memitem:ga39c80d8baf49b0ce69f2bb22d45b3801"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vecType< bool, P > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00152.html#ga39c80d8baf49b0ce69f2bb22d45b3801">equal</a> (vecType< T, P > const &x, vecType< T, P > const &y)</td></tr> -<tr class="memdesc:ga39c80d8baf49b0ce69f2bb22d45b3801"><td class="mdescLeft"> </td><td class="mdescRight">Returns the component-wise comparison of result x == y. <a href="a00152.html#ga39c80d8baf49b0ce69f2bb22d45b3801">More...</a><br /></td></tr> -<tr class="separator:ga39c80d8baf49b0ce69f2bb22d45b3801"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:gadd80263161a308462d3e3e287e79cccd"><td class="memTemplParams" colspan="2">template<typename T , precision P, template< typename, precision > class vecType> </td></tr> -<tr class="memitem:gadd80263161a308462d3e3e287e79cccd"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vecType< bool, P > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00152.html#gadd80263161a308462d3e3e287e79cccd">greaterThan</a> (vecType< T, P > const &x, vecType< T, P > const &y)</td></tr> -<tr class="memdesc:gadd80263161a308462d3e3e287e79cccd"><td class="mdescLeft"> </td><td class="mdescRight">Returns the component-wise comparison of result x > y. <a href="a00152.html#gadd80263161a308462d3e3e287e79cccd">More...</a><br /></td></tr> -<tr class="separator:gadd80263161a308462d3e3e287e79cccd"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:gaee7e101f8cc4ea43924f14dcdeb2ef26"><td class="memTemplParams" colspan="2">template<typename T , precision P, template< typename, precision > class vecType> </td></tr> -<tr class="memitem:gaee7e101f8cc4ea43924f14dcdeb2ef26"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vecType< bool, P > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00152.html#gaee7e101f8cc4ea43924f14dcdeb2ef26">greaterThanEqual</a> (vecType< T, P > const &x, vecType< T, P > const &y)</td></tr> -<tr class="memdesc:gaee7e101f8cc4ea43924f14dcdeb2ef26"><td class="mdescLeft"> </td><td class="mdescRight">Returns the component-wise comparison of result x >= y. <a href="a00152.html#gaee7e101f8cc4ea43924f14dcdeb2ef26">More...</a><br /></td></tr> -<tr class="separator:gaee7e101f8cc4ea43924f14dcdeb2ef26"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga6261970937a70b0b747ae0d3ade1c188"><td class="memTemplParams" colspan="2">template<typename T , precision P, template< typename, precision > class vecType> </td></tr> -<tr class="memitem:ga6261970937a70b0b747ae0d3ade1c188"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vecType< bool, P > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00152.html#ga6261970937a70b0b747ae0d3ade1c188">lessThan</a> (vecType< T, P > const &x, vecType< T, P > const &y)</td></tr> -<tr class="memdesc:ga6261970937a70b0b747ae0d3ade1c188"><td class="mdescLeft"> </td><td class="mdescRight">Returns the component-wise comparison result of x < y. <a href="a00152.html#ga6261970937a70b0b747ae0d3ade1c188">More...</a><br /></td></tr> -<tr class="separator:ga6261970937a70b0b747ae0d3ade1c188"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:gaaf1d88119f11200c32011de7c5ec0102"><td class="memTemplParams" colspan="2">template<typename T , precision P, template< typename, precision > class vecType> </td></tr> -<tr class="memitem:gaaf1d88119f11200c32011de7c5ec0102"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vecType< bool, P > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00152.html#gaaf1d88119f11200c32011de7c5ec0102">lessThanEqual</a> (vecType< T, P > const &x, vecType< T, P > const &y)</td></tr> -<tr class="memdesc:gaaf1d88119f11200c32011de7c5ec0102"><td class="mdescLeft"> </td><td class="mdescRight">Returns the component-wise comparison of result x <= y. <a href="a00152.html#gaaf1d88119f11200c32011de7c5ec0102">More...</a><br /></td></tr> -<tr class="separator:gaaf1d88119f11200c32011de7c5ec0102"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga4329ecbc2ef012c9ec704bd09da1f177"><td class="memTemplParams" colspan="2">template<precision P, template< typename, precision > class vecType> </td></tr> -<tr class="memitem:ga4329ecbc2ef012c9ec704bd09da1f177"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vecType< bool, P > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00152.html#ga4329ecbc2ef012c9ec704bd09da1f177">not_</a> (vecType< bool, P > const &v)</td></tr> -<tr class="memdesc:ga4329ecbc2ef012c9ec704bd09da1f177"><td class="mdescLeft"> </td><td class="mdescRight">Returns the component-wise logical complement of x. <a href="a00152.html#ga4329ecbc2ef012c9ec704bd09da1f177">More...</a><br /></td></tr> -<tr class="separator:ga4329ecbc2ef012c9ec704bd09da1f177"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga5aca2b745e5eb0096716bbc394846309"><td class="memTemplParams" colspan="2">template<typename T , precision P, template< typename, precision > class vecType> </td></tr> -<tr class="memitem:ga5aca2b745e5eb0096716bbc394846309"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vecType< bool, P > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00152.html#ga5aca2b745e5eb0096716bbc394846309">notEqual</a> (vecType< T, P > const &x, vecType< T, P > const &y)</td></tr> -<tr class="memdesc:ga5aca2b745e5eb0096716bbc394846309"><td class="mdescLeft"> </td><td class="mdescRight">Returns the component-wise comparison of result x != y. <a href="a00152.html#ga5aca2b745e5eb0096716bbc394846309">More...</a><br /></td></tr> -<tr class="separator:ga5aca2b745e5eb0096716bbc394846309"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga58ad259b788528fe0a4bd2eeb5e381cc"><td class="memTemplParams" colspan="2">template<typename T , precision P, template< typename, precision > class vecType> </td></tr> +<tr class="memitem:ga58ad259b788528fe0a4bd2eeb5e381cc"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vecType< T, P > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00152.html#ga58ad259b788528fe0a4bd2eeb5e381cc">acos</a> (vecType< T, P > const &x)</td></tr> +<tr class="separator:ga58ad259b788528fe0a4bd2eeb5e381cc"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga3f368ad3e1883b60748ca2634d816104"><td class="memTemplParams" colspan="2">template<typename T , precision P, template< typename, precision > class vecType> </td></tr> +<tr class="memitem:ga3f368ad3e1883b60748ca2634d816104"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vecType< T, P > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00152.html#ga3f368ad3e1883b60748ca2634d816104">acosh</a> (vecType< T, P > const &x)</td></tr> +<tr class="separator:ga3f368ad3e1883b60748ca2634d816104"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga88e29b8289e882859d76a25798dd9490"><td class="memTemplParams" colspan="2">template<typename T , precision P, template< typename, precision > class vecType> </td></tr> +<tr class="memitem:ga88e29b8289e882859d76a25798dd9490"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vecType< T, P > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00152.html#ga88e29b8289e882859d76a25798dd9490">asin</a> (vecType< T, P > const &x)</td></tr> +<tr class="separator:ga88e29b8289e882859d76a25798dd9490"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga72bf44c1984e1afb63acf821ba33cac7"><td class="memTemplParams" colspan="2">template<typename T , precision P, template< typename, precision > class vecType> </td></tr> +<tr class="memitem:ga72bf44c1984e1afb63acf821ba33cac7"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vecType< T, P > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00152.html#ga72bf44c1984e1afb63acf821ba33cac7">asinh</a> (vecType< T, P > const &x)</td></tr> +<tr class="separator:ga72bf44c1984e1afb63acf821ba33cac7"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga461e769acb8b8cb695a5a89334546611"><td class="memTemplParams" colspan="2">template<typename T , precision P, template< typename, precision > class vecType> </td></tr> +<tr class="memitem:ga461e769acb8b8cb695a5a89334546611"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vecType< T, P > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00152.html#ga461e769acb8b8cb695a5a89334546611">atan</a> (vecType< T, P > const &y, vecType< T, P > const &x)</td></tr> +<tr class="separator:ga461e769acb8b8cb695a5a89334546611"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gae8f22458bba8f2321ceb1bfc4a543216"><td class="memTemplParams" colspan="2">template<typename T , precision P, template< typename, precision > class vecType> </td></tr> +<tr class="memitem:gae8f22458bba8f2321ceb1bfc4a543216"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vecType< T, P > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00152.html#gae8f22458bba8f2321ceb1bfc4a543216">atan</a> (vecType< T, P > const &y_over_x)</td></tr> +<tr class="separator:gae8f22458bba8f2321ceb1bfc4a543216"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaffa8decdd8620759f4e6fe4834768b87"><td class="memTemplParams" colspan="2">template<typename T , precision P, template< typename, precision > class vecType> </td></tr> +<tr class="memitem:gaffa8decdd8620759f4e6fe4834768b87"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vecType< T, P > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00152.html#gaffa8decdd8620759f4e6fe4834768b87">atanh</a> (vecType< T, P > const &x)</td></tr> +<tr class="separator:gaffa8decdd8620759f4e6fe4834768b87"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga728fd86f14609e37d83f82429995b7b3"><td class="memTemplParams" colspan="2">template<typename T , precision P, template< typename, precision > class vecType> </td></tr> +<tr class="memitem:ga728fd86f14609e37d83f82429995b7b3"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vecType< T, P > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00152.html#ga728fd86f14609e37d83f82429995b7b3">cos</a> (vecType< T, P > const &angle)</td></tr> +<tr class="separator:ga728fd86f14609e37d83f82429995b7b3"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga660582a4e5e843b6c1cd535777e8c295"><td class="memTemplParams" colspan="2">template<typename T , precision P, template< typename, precision > class vecType> </td></tr> +<tr class="memitem:ga660582a4e5e843b6c1cd535777e8c295"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vecType< T, P > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00152.html#ga660582a4e5e843b6c1cd535777e8c295">cosh</a> (vecType< T, P > const &angle)</td></tr> +<tr class="separator:ga660582a4e5e843b6c1cd535777e8c295"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gabccdcc282134fd62af0ff3d6e4bb21f1"><td class="memTemplParams" colspan="2">template<typename T , precision P, template< typename, precision > class vecType> </td></tr> +<tr class="memitem:gabccdcc282134fd62af0ff3d6e4bb21f1"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL GLM_CONSTEXPR vecType< T, P > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00152.html#gabccdcc282134fd62af0ff3d6e4bb21f1">degrees</a> (vecType< T, P > const &radians)</td></tr> +<tr class="separator:gabccdcc282134fd62af0ff3d6e4bb21f1"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gafffb5e533f75318bdf4e0967d8a6c05c"><td class="memTemplParams" colspan="2">template<typename T , precision P, template< typename, precision > class vecType> </td></tr> +<tr class="memitem:gafffb5e533f75318bdf4e0967d8a6c05c"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL GLM_CONSTEXPR vecType< T, P > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00152.html#gafffb5e533f75318bdf4e0967d8a6c05c">radians</a> (vecType< T, P > const &degrees)</td></tr> +<tr class="separator:gafffb5e533f75318bdf4e0967d8a6c05c"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga4a0ddceb6b1e64ce0e4da209dcb021d5"><td class="memTemplParams" colspan="2">template<typename T , precision P, template< typename, precision > class vecType> </td></tr> +<tr class="memitem:ga4a0ddceb6b1e64ce0e4da209dcb021d5"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vecType< T, P > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00152.html#ga4a0ddceb6b1e64ce0e4da209dcb021d5">sin</a> (vecType< T, P > const &angle)</td></tr> +<tr class="separator:ga4a0ddceb6b1e64ce0e4da209dcb021d5"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gad8f89c12efe6f8d3ae8046625b266254"><td class="memTemplParams" colspan="2">template<typename T , precision P, template< typename, precision > class vecType> </td></tr> +<tr class="memitem:gad8f89c12efe6f8d3ae8046625b266254"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vecType< T, P > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00152.html#gad8f89c12efe6f8d3ae8046625b266254">sinh</a> (vecType< T, P > const &angle)</td></tr> +<tr class="separator:gad8f89c12efe6f8d3ae8046625b266254"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gab3ae890c38b7d3aa4d5e00998fd296b2"><td class="memTemplParams" colspan="2">template<typename T , precision P, template< typename, precision > class vecType> </td></tr> +<tr class="memitem:gab3ae890c38b7d3aa4d5e00998fd296b2"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vecType< T, P > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00152.html#gab3ae890c38b7d3aa4d5e00998fd296b2">tan</a> (vecType< T, P > const &angle)</td></tr> +<tr class="separator:gab3ae890c38b7d3aa4d5e00998fd296b2"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga234e904a0075f88654a594b5f837711f"><td class="memTemplParams" colspan="2">template<typename T , precision P, template< typename, precision > class vecType> </td></tr> +<tr class="memitem:ga234e904a0075f88654a594b5f837711f"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vecType< T, P > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00152.html#ga234e904a0075f88654a594b5f837711f">tanh</a> (vecType< T, P > const &angle)</td></tr> +<tr class="separator:ga234e904a0075f88654a594b5f837711f"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> -<p>Relational and equality operators (<, <=, >, >=, ==, !=) are defined to operate on scalars and produce scalar Boolean results. </p> -<p>For vector results, use the following built-in functions.</p> -<p>In all cases, the sizes of all the input and return vectors for any particular call must match. </p> +<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> <h2 class="groupheader">Function Documentation</h2> -<a class="anchor" id="ga14bbc94f2ae2774a1d64d91f8767773e"></a> +<a class="anchor" id="ga58ad259b788528fe0a4bd2eeb5e381cc"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">GLM_FUNC_DECL bool glm::all </td> + <td class="memname">GLM_FUNC_DECL vecType<T, P> glm::acos </td> <td>(</td> - <td class="paramtype">vecType< bool, P > const & </td> - <td class="paramname"><em>v</em></td><td>)</td> + <td class="paramtype">vecType< T, P > const & </td> + <td class="paramname"><em>x</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> -<p>Returns true if all components of x are true. </p> +<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">vecType</td><td>Boolean vector types.</td></tr> + <tr><td class="paramname">genType</td><td>Floating-point scalar or vector types.</td></tr> </table> </dd> </dl> -<dl class="section see"><dt>See also</dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/all.xml">GLSL all man page</a> </dd> +<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.7 Vector Relational Functions</a> </dd></dl> +<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 class="anchor" id="ga632a2644532d9332011c8860400d30b2"></a> +<a class="anchor" id="ga3f368ad3e1883b60748ca2634d816104"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">GLM_FUNC_DECL bool glm::any </td> + <td class="memname">GLM_FUNC_DECL vecType<T, P> glm::acosh </td> <td>(</td> - <td class="paramtype">vecType< bool, P > const & </td> - <td class="paramname"><em>v</em></td><td>)</td> + <td class="paramtype">vecType< T, P > const & </td> + <td class="paramname"><em>x</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> -<p>Returns true if any component of x is true. </p> +<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">vecType</td><td>Boolean vector types.</td></tr> + <tr><td class="paramname">genType</td><td>Floating-point scalar or vector types.</td></tr> </table> </dd> </dl> -<dl class="section see"><dt>See also</dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/any.xml">GLSL any man page</a> </dd> +<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.7 Vector Relational Functions</a> </dd></dl> +<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 class="anchor" id="ga39c80d8baf49b0ce69f2bb22d45b3801"></a> +<a class="anchor" id="ga88e29b8289e882859d76a25798dd9490"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">GLM_FUNC_DECL vecType<bool, P> glm::equal </td> + <td class="memname">GLM_FUNC_DECL vecType<T, P> glm::asin </td> <td>(</td> <td class="paramtype">vecType< T, P > const & </td> - <td class="paramname"><em>x</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> + <td class="paramname"><em>x</em></td><td>)</td> <td></td> - <td class="paramtype">vecType< T, P > const & </td> - <td class="paramname"><em>y</em> </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">genType</td><td>Floating-point scalar or vector types.</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 class="anchor" id="ga72bf44c1984e1afb63acf821ba33cac7"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> <tr> + <td class="memname">GLM_FUNC_DECL vecType<T, P> glm::asinh </td> + <td>(</td> + <td class="paramtype">vecType< T, P > const & </td> + <td class="paramname"><em>x</em></td><td>)</td> <td></td> - <td>)</td> - <td></td><td></td> </tr> </table> </div><div class="memdoc"> -<p>Returns the component-wise comparison of result x == y. </p> +<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">vecType</td><td>Floating-point, integer or boolean vector types.</td></tr> + <tr><td class="paramname">genType</td><td>Floating-point scalar or vector types.</td></tr> </table> </dd> </dl> -<dl class="section see"><dt>See also</dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/equal.xml">GLSL equal man page</a> </dd> +<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.7 Vector Relational Functions</a> </dd></dl> +<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 class="anchor" id="gadd80263161a308462d3e3e287e79cccd"></a> +<a class="anchor" id="ga461e769acb8b8cb695a5a89334546611"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">GLM_FUNC_DECL vecType<bool, P> glm::greaterThan </td> + <td class="memname">GLM_FUNC_DECL vecType<T, P> glm::atan </td> <td>(</td> <td class="paramtype">vecType< T, P > const & </td> - <td class="paramname"><em>x</em>, </td> + <td class="paramname"><em>y</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">vecType< T, P > const & </td> - <td class="paramname"><em>y</em> </td> + <td class="paramname"><em>x</em> </td> </tr> <tr> <td></td> @@ -244,192 +231,293 @@ Functions</h2></td></tr> </table> </div><div class="memdoc"> -<p>Returns the component-wise comparison of result x > y. </p> +<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">vecType</td><td>Floating-point or integer vector types.</td></tr> + <tr><td class="paramname">genType</td><td>Floating-point scalar or vector types.</td></tr> </table> </dd> </dl> -<dl class="section see"><dt>See also</dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/greaterThan.xml">GLSL greaterThan man page</a> </dd> +<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.7 Vector Relational Functions</a> </dd></dl> +<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>Referenced by <a class="el" href="a00016_source.html#l00052">glm::atan2()</a>.</p> </div> </div> -<a class="anchor" id="gaee7e101f8cc4ea43924f14dcdeb2ef26"></a> +<a class="anchor" id="gae8f22458bba8f2321ceb1bfc4a543216"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">GLM_FUNC_DECL vecType<bool, P> glm::greaterThanEqual </td> + <td class="memname">GLM_FUNC_DECL vecType<T, P> glm::atan </td> <td>(</td> <td class="paramtype">vecType< T, P > const & </td> - <td class="paramname"><em>x</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> + <td class="paramname"><em>y_over_x</em></td><td>)</td> <td></td> - <td class="paramtype">vecType< T, P > const & </td> - <td class="paramname"><em>y</em> </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">genType</td><td>Floating-point scalar or vector types.</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 class="anchor" id="gaffa8decdd8620759f4e6fe4834768b87"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> <tr> + <td class="memname">GLM_FUNC_DECL vecType<T, P> glm::atanh </td> + <td>(</td> + <td class="paramtype">vecType< T, P > const & </td> + <td class="paramname"><em>x</em></td><td>)</td> <td></td> - <td>)</td> - <td></td><td></td> </tr> </table> </div><div class="memdoc"> -<p>Returns the component-wise comparison of result x >= y. </p> +<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">vecType</td><td>Floating-point or integer vector types.</td></tr> + <tr><td class="paramname">genType</td><td>Floating-point scalar or vector types.</td></tr> </table> </dd> </dl> -<dl class="section see"><dt>See also</dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/greaterThanEqual.xml">GLSL greaterThanEqual man page</a> </dd> +<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.7 Vector Relational Functions</a> </dd></dl> +<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 class="anchor" id="ga6261970937a70b0b747ae0d3ade1c188"></a> +<a class="anchor" id="ga728fd86f14609e37d83f82429995b7b3"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">GLM_FUNC_DECL vecType<bool, P> glm::lessThan </td> + <td class="memname">GLM_FUNC_DECL vecType<T, P> glm::cos </td> <td>(</td> <td class="paramtype">vecType< T, P > const & </td> - <td class="paramname"><em>x</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> + <td class="paramname"><em>angle</em></td><td>)</td> <td></td> - <td class="paramtype">vecType< T, P > const & </td> - <td class="paramname"><em>y</em> </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">genType</td><td>Floating-point scalar or vector types.</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 class="anchor" id="ga660582a4e5e843b6c1cd535777e8c295"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> <tr> + <td class="memname">GLM_FUNC_DECL vecType<T, P> glm::cosh </td> + <td>(</td> + <td class="paramtype">vecType< T, P > const & </td> + <td class="paramname"><em>angle</em></td><td>)</td> <td></td> - <td>)</td> - <td></td><td></td> </tr> </table> </div><div class="memdoc"> -<p>Returns the component-wise comparison result of x < y. </p> +<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">vecType</td><td>Floating-point or integer vector types.</td></tr> + <tr><td class="paramname">genType</td><td>Floating-point scalar or vector types.</td></tr> </table> </dd> </dl> -<dl class="section see"><dt>See also</dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/lessThan.xml">GLSL lessThan man page</a> </dd> +<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.7 Vector Relational Functions</a> </dd></dl> +<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 class="anchor" id="gaaf1d88119f11200c32011de7c5ec0102"></a> +<a class="anchor" id="gabccdcc282134fd62af0ff3d6e4bb21f1"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">GLM_FUNC_DECL vecType<bool, P> glm::lessThanEqual </td> + <td class="memname">GLM_FUNC_DECL GLM_CONSTEXPR vecType<T, P> glm::degrees </td> <td>(</td> <td class="paramtype">vecType< T, P > const & </td> - <td class="paramname"><em>x</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> + <td class="paramname"><em>radians</em></td><td>)</td> <td></td> - <td class="paramtype">vecType< T, P > const & </td> - <td class="paramname"><em>y</em> </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">genType</td><td>Floating-point scalar or vector types.</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 class="anchor" id="gafffb5e533f75318bdf4e0967d8a6c05c"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> <tr> + <td class="memname">GLM_FUNC_DECL GLM_CONSTEXPR vecType<T, P> glm::radians </td> + <td>(</td> + <td class="paramtype">vecType< T, P > const & </td> + <td class="paramname"><em>degrees</em></td><td>)</td> <td></td> - <td>)</td> - <td></td><td></td> </tr> </table> </div><div class="memdoc"> -<p>Returns the component-wise comparison of result x <= y. </p> +<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">vecType</td><td>Floating-point or integer vector types.</td></tr> + <tr><td class="paramname">genType</td><td>Floating-point scalar or vector types.</td></tr> </table> </dd> </dl> -<dl class="section see"><dt>See also</dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/lessThanEqual.xml">GLSL lessThanEqual man page</a> </dd> +<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.7 Vector Relational Functions</a> </dd></dl> +<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 class="anchor" id="ga4329ecbc2ef012c9ec704bd09da1f177"></a> +<a class="anchor" id="ga4a0ddceb6b1e64ce0e4da209dcb021d5"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">GLM_FUNC_DECL vecType<bool, P> glm::not_ </td> + <td class="memname">GLM_FUNC_DECL vecType<T, P> glm::sin </td> <td>(</td> - <td class="paramtype">vecType< bool, P > const & </td> - <td class="paramname"><em>v</em></td><td>)</td> + <td class="paramtype">vecType< T, P > const & </td> + <td class="paramname"><em>angle</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> -<p>Returns the component-wise logical complement of x. </p> -<p>/!\ Because of language incompatibilities between C++ and GLSL, GLM defines the function not but not_ instead.</p> +<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">vecType</td><td>Boolean vector types.</td></tr> + <tr><td class="paramname">genType</td><td>Floating-point scalar or vector types.</td></tr> </table> </dd> </dl> -<dl class="section see"><dt>See also</dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/not.xml">GLSL not man page</a> </dd> +<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.7 Vector Relational Functions</a> </dd></dl> +<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 class="anchor" id="ga5aca2b745e5eb0096716bbc394846309"></a> +<a class="anchor" id="gad8f89c12efe6f8d3ae8046625b266254"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">GLM_FUNC_DECL vecType<bool, P> glm::notEqual </td> + <td class="memname">GLM_FUNC_DECL vecType<T, P> glm::sinh </td> <td>(</td> <td class="paramtype">vecType< T, P > const & </td> - <td class="paramname"><em>x</em>, </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">genType</td><td>Floating-point scalar or vector types.</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 class="anchor" id="gab3ae890c38b7d3aa4d5e00998fd296b2"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> <tr> - <td class="paramkey"></td> - <td></td> + <td class="memname">GLM_FUNC_DECL vecType<T, P> glm::tan </td> + <td>(</td> <td class="paramtype">vecType< T, P > const & </td> - <td class="paramname"><em>y</em> </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">genType</td><td>Floating-point scalar or vector types.</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 class="anchor" id="ga234e904a0075f88654a594b5f837711f"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> <tr> + <td class="memname">GLM_FUNC_DECL vecType<T, P> glm::tanh </td> + <td>(</td> + <td class="paramtype">vecType< T, P > const & </td> + <td class="paramname"><em>angle</em></td><td>)</td> <td></td> - <td>)</td> - <td></td><td></td> </tr> </table> </div><div class="memdoc"> -<p>Returns the component-wise comparison of result x != y. </p> +<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">vecType</td><td>Floating-point, integer or boolean vector types.</td></tr> + <tr><td class="paramname">genType</td><td>Floating-point scalar or vector types.</td></tr> </table> </dd> </dl> -<dl class="section see"><dt>See also</dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/notEqual.xml">GLSL notEqual man page</a> </dd> +<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.7 Vector Relational Functions</a> </dd></dl> +<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> |
