a00917.html 33 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.18"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>1.0.2 API documentation: GLM_GTC_quaternion</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  13. <script type="text/javascript" src="search/searchdata.js"></script>
  14. <script type="text/javascript" src="search/search.js"></script>
  15. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  16. </head>
  17. <body>
  18. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  19. <div id="titlearea">
  20. <table cellspacing="0" cellpadding="0">
  21. <tbody>
  22. <tr style="height: 56px;">
  23. <td id="projectlogo"><img alt="Logo" src="logo-mini.png"/></td>
  24. <td id="projectalign" style="padding-left: 0.5em;">
  25. <div id="projectname">1.0.2 API documentation
  26. </div>
  27. </td>
  28. </tr>
  29. </tbody>
  30. </table>
  31. </div>
  32. <!-- end header part -->
  33. <!-- Generated by Doxygen 1.8.18 -->
  34. <script type="text/javascript">
  35. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  36. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  37. /* @license-end */
  38. </script>
  39. <script type="text/javascript" src="menudata.js"></script>
  40. <script type="text/javascript" src="menu.js"></script>
  41. <script type="text/javascript">
  42. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  43. $(function() {
  44. initMenu('',true,false,'search.php','Search');
  45. $(document).ready(function() { init_search(); });
  46. });
  47. /* @license-end */</script>
  48. <div id="main-nav"></div>
  49. </div><!-- top -->
  50. <!-- window showing the filter options -->
  51. <div id="MSearchSelectWindow"
  52. onmouseover="return searchBox.OnSearchSelectShow()"
  53. onmouseout="return searchBox.OnSearchSelectHide()"
  54. onkeydown="return searchBox.OnSearchSelectKey(event)">
  55. </div>
  56. <!-- iframe showing the search results (closed by default) -->
  57. <div id="MSearchResultsWindow">
  58. <iframe src="javascript:void(0)" frameborder="0"
  59. name="MSearchResults" id="MSearchResults">
  60. </iframe>
  61. </div>
  62. <div class="header">
  63. <div class="summary">
  64. <a href="#func-members">Functions</a> </div>
  65. <div class="headertitle">
  66. <div class="title">GLM_GTC_quaternion<div class="ingroups"><a class="el" href="a00904.html">Recommended extensions</a></div></div> </div>
  67. </div><!--header-->
  68. <div class="contents">
  69. <table class="memberdecls">
  70. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  71. Functions</h2></td></tr>
  72. <tr class="memitem:gaf4dd967dead22dd932fc7460ceecb03f"><td class="memTemplParams" colspan="2">template&lt;typename T , qualifier Q&gt; </td></tr>
  73. <tr class="memitem:gaf4dd967dead22dd932fc7460ceecb03f"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec&lt; 3, T, Q &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00917.html#gaf4dd967dead22dd932fc7460ceecb03f">eulerAngles</a> (qua&lt; T, Q &gt; const &amp;x)</td></tr>
  74. <tr class="memdesc:gaf4dd967dead22dd932fc7460ceecb03f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns euler angles, pitch as x, yaw as y, roll as z. <a href="a00917.html#gaf4dd967dead22dd932fc7460ceecb03f">More...</a><br /></td></tr>
  75. <tr class="separator:gaf4dd967dead22dd932fc7460ceecb03f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  76. <tr class="memitem:gab52513c338f90e9ba249faabdc115b67"><td class="memTemplParams" colspan="2">template&lt;typename T , qualifier Q&gt; </td></tr>
  77. <tr class="memitem:gab52513c338f90e9ba249faabdc115b67"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL GLM_CONSTEXPR vec&lt; 4, bool, Q &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00917.html#gab52513c338f90e9ba249faabdc115b67">greaterThan</a> (qua&lt; T, Q &gt; const &amp;x, qua&lt; T, Q &gt; const &amp;y)</td></tr>
  78. <tr class="memdesc:gab52513c338f90e9ba249faabdc115b67"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the component-wise comparison of result x &gt; y. <a href="a00917.html#gab52513c338f90e9ba249faabdc115b67">More...</a><br /></td></tr>
  79. <tr class="separator:gab52513c338f90e9ba249faabdc115b67"><td class="memSeparator" colspan="2">&#160;</td></tr>
  80. <tr class="memitem:gaa71814c544f0ed99ba6d141b17e026ae"><td class="memTemplParams" colspan="2">template&lt;typename T , qualifier Q&gt; </td></tr>
  81. <tr class="memitem:gaa71814c544f0ed99ba6d141b17e026ae"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL GLM_CONSTEXPR vec&lt; 4, bool, Q &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00917.html#gaa71814c544f0ed99ba6d141b17e026ae">greaterThanEqual</a> (qua&lt; T, Q &gt; const &amp;x, qua&lt; T, Q &gt; const &amp;y)</td></tr>
  82. <tr class="memdesc:gaa71814c544f0ed99ba6d141b17e026ae"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the component-wise comparison of result x &gt;= y. <a href="a00917.html#gaa71814c544f0ed99ba6d141b17e026ae">More...</a><br /></td></tr>
  83. <tr class="separator:gaa71814c544f0ed99ba6d141b17e026ae"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84. <tr class="memitem:gae0ed978b5c2588d53b220e9ceebaca0b"><td class="memTemplParams" colspan="2">template&lt;typename T , qualifier Q&gt; </td></tr>
  85. <tr class="memitem:gae0ed978b5c2588d53b220e9ceebaca0b"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL GLM_CONSTEXPR vec&lt; 4, bool, Q &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00917.html#gae0ed978b5c2588d53b220e9ceebaca0b">lessThan</a> (qua&lt; T, Q &gt; const &amp;x, qua&lt; T, Q &gt; const &amp;y)</td></tr>
  86. <tr class="memdesc:gae0ed978b5c2588d53b220e9ceebaca0b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the component-wise comparison result of x &lt; y. <a href="a00917.html#gae0ed978b5c2588d53b220e9ceebaca0b">More...</a><br /></td></tr>
  87. <tr class="separator:gae0ed978b5c2588d53b220e9ceebaca0b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  88. <tr class="memitem:ga3ee1ffe56e5428f659c51a5bfd67ab33"><td class="memTemplParams" colspan="2">template&lt;typename T , qualifier Q&gt; </td></tr>
  89. <tr class="memitem:ga3ee1ffe56e5428f659c51a5bfd67ab33"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL GLM_CONSTEXPR vec&lt; 4, bool, Q &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00917.html#ga3ee1ffe56e5428f659c51a5bfd67ab33">lessThanEqual</a> (qua&lt; T, Q &gt; const &amp;x, qua&lt; T, Q &gt; const &amp;y)</td></tr>
  90. <tr class="memdesc:ga3ee1ffe56e5428f659c51a5bfd67ab33"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the component-wise comparison of result x &lt;= y. <a href="a00917.html#ga3ee1ffe56e5428f659c51a5bfd67ab33">More...</a><br /></td></tr>
  91. <tr class="separator:ga3ee1ffe56e5428f659c51a5bfd67ab33"><td class="memSeparator" colspan="2">&#160;</td></tr>
  92. <tr class="memitem:ga333ab70047fbe4132406100c292dbc89"><td class="memTemplParams" colspan="2">template&lt;typename T , qualifier Q&gt; </td></tr>
  93. <tr class="memitem:ga333ab70047fbe4132406100c292dbc89"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL mat&lt; 3, 3, T, Q &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00917.html#ga333ab70047fbe4132406100c292dbc89">mat3_cast</a> (qua&lt; T, Q &gt; const &amp;x)</td></tr>
  94. <tr class="memdesc:ga333ab70047fbe4132406100c292dbc89"><td class="mdescLeft">&#160;</td><td class="mdescRight">Converts a quaternion to a 3 * 3 matrix. <a href="a00917.html#ga333ab70047fbe4132406100c292dbc89">More...</a><br /></td></tr>
  95. <tr class="separator:ga333ab70047fbe4132406100c292dbc89"><td class="memSeparator" colspan="2">&#160;</td></tr>
  96. <tr class="memitem:ga1113212d9bdefc2e31ad40e5bbb506f3"><td class="memTemplParams" colspan="2">template&lt;typename T , qualifier Q&gt; </td></tr>
  97. <tr class="memitem:ga1113212d9bdefc2e31ad40e5bbb506f3"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL mat&lt; 4, 4, T, Q &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00917.html#ga1113212d9bdefc2e31ad40e5bbb506f3">mat4_cast</a> (qua&lt; T, Q &gt; const &amp;x)</td></tr>
  98. <tr class="memdesc:ga1113212d9bdefc2e31ad40e5bbb506f3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Converts a quaternion to a 4 * 4 matrix. <a href="a00917.html#ga1113212d9bdefc2e31ad40e5bbb506f3">More...</a><br /></td></tr>
  99. <tr class="separator:ga1113212d9bdefc2e31ad40e5bbb506f3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  100. <tr class="memitem:ga7603e81477b46ddb448896909bc04928"><td class="memTemplParams" colspan="2">template&lt;typename T , qualifier Q&gt; </td></tr>
  101. <tr class="memitem:ga7603e81477b46ddb448896909bc04928"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00917.html#ga7603e81477b46ddb448896909bc04928">pitch</a> (qua&lt; T, Q &gt; const &amp;x)</td></tr>
  102. <tr class="memdesc:ga7603e81477b46ddb448896909bc04928"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns pitch value of euler angles expressed in radians. <a href="a00917.html#ga7603e81477b46ddb448896909bc04928">More...</a><br /></td></tr>
  103. <tr class="separator:ga7603e81477b46ddb448896909bc04928"><td class="memSeparator" colspan="2">&#160;</td></tr>
  104. <tr class="memitem:ga1108a4ab88ca87bac321454eea7702f8"><td class="memTemplParams" colspan="2">template&lt;typename T , qualifier Q&gt; </td></tr>
  105. <tr class="memitem:ga1108a4ab88ca87bac321454eea7702f8"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL qua&lt; T, Q &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00917.html#ga1108a4ab88ca87bac321454eea7702f8">quat_cast</a> (mat&lt; 3, 3, T, Q &gt; const &amp;x)</td></tr>
  106. <tr class="memdesc:ga1108a4ab88ca87bac321454eea7702f8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Converts a pure rotation 3 * 3 matrix to a quaternion. <a href="a00917.html#ga1108a4ab88ca87bac321454eea7702f8">More...</a><br /></td></tr>
  107. <tr class="separator:ga1108a4ab88ca87bac321454eea7702f8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  108. <tr class="memitem:ga4524810f07f72e8c7bdc7764fa11cb58"><td class="memTemplParams" colspan="2">template&lt;typename T , qualifier Q&gt; </td></tr>
  109. <tr class="memitem:ga4524810f07f72e8c7bdc7764fa11cb58"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL qua&lt; T, Q &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00917.html#ga4524810f07f72e8c7bdc7764fa11cb58">quat_cast</a> (mat&lt; 4, 4, T, Q &gt; const &amp;x)</td></tr>
  110. <tr class="memdesc:ga4524810f07f72e8c7bdc7764fa11cb58"><td class="mdescLeft">&#160;</td><td class="mdescRight">Converts a pure rotation 4 * 4 matrix to a quaternion. <a href="a00917.html#ga4524810f07f72e8c7bdc7764fa11cb58">More...</a><br /></td></tr>
  111. <tr class="separator:ga4524810f07f72e8c7bdc7764fa11cb58"><td class="memSeparator" colspan="2">&#160;</td></tr>
  112. <tr class="memitem:gabe7fc5ec5feb41ab234d5d2b6254697f"><td class="memTemplParams" colspan="2">template&lt;typename T , qualifier Q&gt; </td></tr>
  113. <tr class="memitem:gabe7fc5ec5feb41ab234d5d2b6254697f"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL qua&lt; T, Q &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00917.html#gabe7fc5ec5feb41ab234d5d2b6254697f">quatLookAt</a> (vec&lt; 3, T, Q &gt; const &amp;direction, vec&lt; 3, T, Q &gt; const &amp;up)</td></tr>
  114. <tr class="memdesc:gabe7fc5ec5feb41ab234d5d2b6254697f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Build a look at quaternion based on the default handedness. <a href="a00917.html#gabe7fc5ec5feb41ab234d5d2b6254697f">More...</a><br /></td></tr>
  115. <tr class="separator:gabe7fc5ec5feb41ab234d5d2b6254697f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  116. <tr class="memitem:ga2da350c73411be3bb19441b226b81a74"><td class="memTemplParams" colspan="2">template&lt;typename T , qualifier Q&gt; </td></tr>
  117. <tr class="memitem:ga2da350c73411be3bb19441b226b81a74"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL qua&lt; T, Q &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00917.html#ga2da350c73411be3bb19441b226b81a74">quatLookAtLH</a> (vec&lt; 3, T, Q &gt; const &amp;direction, vec&lt; 3, T, Q &gt; const &amp;up)</td></tr>
  118. <tr class="memdesc:ga2da350c73411be3bb19441b226b81a74"><td class="mdescLeft">&#160;</td><td class="mdescRight">Build a left-handed look at quaternion. <a href="a00917.html#ga2da350c73411be3bb19441b226b81a74">More...</a><br /></td></tr>
  119. <tr class="separator:ga2da350c73411be3bb19441b226b81a74"><td class="memSeparator" colspan="2">&#160;</td></tr>
  120. <tr class="memitem:gaf6529ac8c04a57fcc35865b5c9437cc8"><td class="memTemplParams" colspan="2">template&lt;typename T , qualifier Q&gt; </td></tr>
  121. <tr class="memitem:gaf6529ac8c04a57fcc35865b5c9437cc8"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL qua&lt; T, Q &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00917.html#gaf6529ac8c04a57fcc35865b5c9437cc8">quatLookAtRH</a> (vec&lt; 3, T, Q &gt; const &amp;direction, vec&lt; 3, T, Q &gt; const &amp;up)</td></tr>
  122. <tr class="memdesc:gaf6529ac8c04a57fcc35865b5c9437cc8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Build a right-handed look at quaternion. <a href="a00917.html#gaf6529ac8c04a57fcc35865b5c9437cc8">More...</a><br /></td></tr>
  123. <tr class="separator:gaf6529ac8c04a57fcc35865b5c9437cc8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  124. <tr class="memitem:ga0cc5ad970d0b00829b139fe0fe5a1e13"><td class="memTemplParams" colspan="2">template&lt;typename T , qualifier Q&gt; </td></tr>
  125. <tr class="memitem:ga0cc5ad970d0b00829b139fe0fe5a1e13"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00917.html#ga0cc5ad970d0b00829b139fe0fe5a1e13">roll</a> (qua&lt; T, Q &gt; const &amp;x)</td></tr>
  126. <tr class="memdesc:ga0cc5ad970d0b00829b139fe0fe5a1e13"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns roll value of euler angles expressed in radians. <a href="a00917.html#ga0cc5ad970d0b00829b139fe0fe5a1e13">More...</a><br /></td></tr>
  127. <tr class="separator:ga0cc5ad970d0b00829b139fe0fe5a1e13"><td class="memSeparator" colspan="2">&#160;</td></tr>
  128. <tr class="memitem:ga8da38cdfdc452dafa660c2f46506bad5"><td class="memTemplParams" colspan="2">template&lt;typename T , qualifier Q&gt; </td></tr>
  129. <tr class="memitem:ga8da38cdfdc452dafa660c2f46506bad5"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00917.html#ga8da38cdfdc452dafa660c2f46506bad5">yaw</a> (qua&lt; T, Q &gt; const &amp;x)</td></tr>
  130. <tr class="memdesc:ga8da38cdfdc452dafa660c2f46506bad5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns yaw value of euler angles expressed in radians. <a href="a00917.html#ga8da38cdfdc452dafa660c2f46506bad5">More...</a><br /></td></tr>
  131. <tr class="separator:ga8da38cdfdc452dafa660c2f46506bad5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  132. </table>
  133. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  134. <p>Include &lt;<a class="el" href="a01711.html" title="GLM_GTC_quaternion">glm/gtc/quaternion.hpp</a>&gt; to use the features of this extension.</p>
  135. <p>Defines a templated quaternion type and several quaternion operations. </p>
  136. <h2 class="groupheader">Function Documentation</h2>
  137. <a id="gaf4dd967dead22dd932fc7460ceecb03f"></a>
  138. <h2 class="memtitle"><span class="permalink"><a href="#gaf4dd967dead22dd932fc7460ceecb03f">&#9670;&nbsp;</a></span>eulerAngles()</h2>
  139. <div class="memitem">
  140. <div class="memproto">
  141. <table class="memname">
  142. <tr>
  143. <td class="memname">GLM_FUNC_DECL vec&lt;3, T, Q&gt; glm::eulerAngles </td>
  144. <td>(</td>
  145. <td class="paramtype">qua&lt; T, Q &gt; const &amp;&#160;</td>
  146. <td class="paramname"><em>x</em></td><td>)</td>
  147. <td></td>
  148. </tr>
  149. </table>
  150. </div><div class="memdoc">
  151. <p>Returns euler angles, pitch as x, yaw as y, roll as z. </p>
  152. <p>The result is expressed in radians.</p>
  153. <dl class="tparams"><dt>Template Parameters</dt><dd>
  154. <table class="tparams">
  155. <tr><td class="paramname">T</td><td>Floating-point scalar types.</td></tr>
  156. </table>
  157. </dd>
  158. </dl>
  159. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00917.html">GLM_GTC_quaternion</a> </dd></dl>
  160. </div>
  161. </div>
  162. <a id="gab52513c338f90e9ba249faabdc115b67"></a>
  163. <h2 class="memtitle"><span class="permalink"><a href="#gab52513c338f90e9ba249faabdc115b67">&#9670;&nbsp;</a></span>greaterThan()</h2>
  164. <div class="memitem">
  165. <div class="memproto">
  166. <table class="memname">
  167. <tr>
  168. <td class="memname">GLM_FUNC_DECL GLM_CONSTEXPR vec&lt;4, bool, Q&gt; glm::greaterThan </td>
  169. <td>(</td>
  170. <td class="paramtype">qua&lt; T, Q &gt; const &amp;&#160;</td>
  171. <td class="paramname"><em>x</em>, </td>
  172. </tr>
  173. <tr>
  174. <td class="paramkey"></td>
  175. <td></td>
  176. <td class="paramtype">qua&lt; T, Q &gt; const &amp;&#160;</td>
  177. <td class="paramname"><em>y</em>&#160;</td>
  178. </tr>
  179. <tr>
  180. <td></td>
  181. <td>)</td>
  182. <td></td><td></td>
  183. </tr>
  184. </table>
  185. </div><div class="memdoc">
  186. <p>Returns the component-wise comparison of result x &gt; y. </p>
  187. <dl class="tparams"><dt>Template Parameters</dt><dd>
  188. <table class="tparams">
  189. <tr><td class="paramname">T</td><td>Floating-point scalar types </td></tr>
  190. <tr><td class="paramname">Q</td><td>Value from qualifier enum</td></tr>
  191. </table>
  192. </dd>
  193. </dl>
  194. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00863.html">GLM_EXT_quaternion_relational</a> </dd></dl>
  195. </div>
  196. </div>
  197. <a id="gaa71814c544f0ed99ba6d141b17e026ae"></a>
  198. <h2 class="memtitle"><span class="permalink"><a href="#gaa71814c544f0ed99ba6d141b17e026ae">&#9670;&nbsp;</a></span>greaterThanEqual()</h2>
  199. <div class="memitem">
  200. <div class="memproto">
  201. <table class="memname">
  202. <tr>
  203. <td class="memname">GLM_FUNC_DECL GLM_CONSTEXPR vec&lt;4, bool, Q&gt; glm::greaterThanEqual </td>
  204. <td>(</td>
  205. <td class="paramtype">qua&lt; T, Q &gt; const &amp;&#160;</td>
  206. <td class="paramname"><em>x</em>, </td>
  207. </tr>
  208. <tr>
  209. <td class="paramkey"></td>
  210. <td></td>
  211. <td class="paramtype">qua&lt; T, Q &gt; const &amp;&#160;</td>
  212. <td class="paramname"><em>y</em>&#160;</td>
  213. </tr>
  214. <tr>
  215. <td></td>
  216. <td>)</td>
  217. <td></td><td></td>
  218. </tr>
  219. </table>
  220. </div><div class="memdoc">
  221. <p>Returns the component-wise comparison of result x &gt;= y. </p>
  222. <dl class="tparams"><dt>Template Parameters</dt><dd>
  223. <table class="tparams">
  224. <tr><td class="paramname">T</td><td>Floating-point scalar types </td></tr>
  225. <tr><td class="paramname">Q</td><td>Value from qualifier enum</td></tr>
  226. </table>
  227. </dd>
  228. </dl>
  229. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00863.html">GLM_EXT_quaternion_relational</a> </dd></dl>
  230. </div>
  231. </div>
  232. <a id="gae0ed978b5c2588d53b220e9ceebaca0b"></a>
  233. <h2 class="memtitle"><span class="permalink"><a href="#gae0ed978b5c2588d53b220e9ceebaca0b">&#9670;&nbsp;</a></span>lessThan()</h2>
  234. <div class="memitem">
  235. <div class="memproto">
  236. <table class="memname">
  237. <tr>
  238. <td class="memname">GLM_FUNC_DECL GLM_CONSTEXPR vec&lt;4, bool, Q&gt; glm::lessThan </td>
  239. <td>(</td>
  240. <td class="paramtype">qua&lt; T, Q &gt; const &amp;&#160;</td>
  241. <td class="paramname"><em>x</em>, </td>
  242. </tr>
  243. <tr>
  244. <td class="paramkey"></td>
  245. <td></td>
  246. <td class="paramtype">qua&lt; T, Q &gt; const &amp;&#160;</td>
  247. <td class="paramname"><em>y</em>&#160;</td>
  248. </tr>
  249. <tr>
  250. <td></td>
  251. <td>)</td>
  252. <td></td><td></td>
  253. </tr>
  254. </table>
  255. </div><div class="memdoc">
  256. <p>Returns the component-wise comparison result of x &lt; y. </p>
  257. <dl class="tparams"><dt>Template Parameters</dt><dd>
  258. <table class="tparams">
  259. <tr><td class="paramname">T</td><td>Floating-point scalar types </td></tr>
  260. <tr><td class="paramname">Q</td><td>Value from qualifier enum</td></tr>
  261. </table>
  262. </dd>
  263. </dl>
  264. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00863.html">GLM_EXT_quaternion_relational</a> </dd></dl>
  265. </div>
  266. </div>
  267. <a id="ga3ee1ffe56e5428f659c51a5bfd67ab33"></a>
  268. <h2 class="memtitle"><span class="permalink"><a href="#ga3ee1ffe56e5428f659c51a5bfd67ab33">&#9670;&nbsp;</a></span>lessThanEqual()</h2>
  269. <div class="memitem">
  270. <div class="memproto">
  271. <table class="memname">
  272. <tr>
  273. <td class="memname">GLM_FUNC_DECL GLM_CONSTEXPR vec&lt;4, bool, Q&gt; glm::lessThanEqual </td>
  274. <td>(</td>
  275. <td class="paramtype">qua&lt; T, Q &gt; const &amp;&#160;</td>
  276. <td class="paramname"><em>x</em>, </td>
  277. </tr>
  278. <tr>
  279. <td class="paramkey"></td>
  280. <td></td>
  281. <td class="paramtype">qua&lt; T, Q &gt; const &amp;&#160;</td>
  282. <td class="paramname"><em>y</em>&#160;</td>
  283. </tr>
  284. <tr>
  285. <td></td>
  286. <td>)</td>
  287. <td></td><td></td>
  288. </tr>
  289. </table>
  290. </div><div class="memdoc">
  291. <p>Returns the component-wise comparison of result x &lt;= y. </p>
  292. <dl class="tparams"><dt>Template Parameters</dt><dd>
  293. <table class="tparams">
  294. <tr><td class="paramname">T</td><td>Floating-point scalar types </td></tr>
  295. <tr><td class="paramname">Q</td><td>Value from qualifier enum</td></tr>
  296. </table>
  297. </dd>
  298. </dl>
  299. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00863.html">GLM_EXT_quaternion_relational</a> </dd></dl>
  300. </div>
  301. </div>
  302. <a id="ga333ab70047fbe4132406100c292dbc89"></a>
  303. <h2 class="memtitle"><span class="permalink"><a href="#ga333ab70047fbe4132406100c292dbc89">&#9670;&nbsp;</a></span>mat3_cast()</h2>
  304. <div class="memitem">
  305. <div class="memproto">
  306. <table class="memname">
  307. <tr>
  308. <td class="memname">GLM_FUNC_DECL mat&lt;3, 3, T, Q&gt; glm::mat3_cast </td>
  309. <td>(</td>
  310. <td class="paramtype">qua&lt; T, Q &gt; const &amp;&#160;</td>
  311. <td class="paramname"><em>x</em></td><td>)</td>
  312. <td></td>
  313. </tr>
  314. </table>
  315. </div><div class="memdoc">
  316. <p>Converts a quaternion to a 3 * 3 matrix. </p>
  317. <dl class="tparams"><dt>Template Parameters</dt><dd>
  318. <table class="tparams">
  319. <tr><td class="paramname">T</td><td>Floating-point scalar types.</td></tr>
  320. </table>
  321. </dd>
  322. </dl>
  323. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00917.html">GLM_GTC_quaternion</a> </dd></dl>
  324. <p class="reference">Referenced by <a class="el" href="a01714_source.html#l00111">glm::toMat3()</a>.</p>
  325. </div>
  326. </div>
  327. <a id="ga1113212d9bdefc2e31ad40e5bbb506f3"></a>
  328. <h2 class="memtitle"><span class="permalink"><a href="#ga1113212d9bdefc2e31ad40e5bbb506f3">&#9670;&nbsp;</a></span>mat4_cast()</h2>
  329. <div class="memitem">
  330. <div class="memproto">
  331. <table class="memname">
  332. <tr>
  333. <td class="memname">GLM_FUNC_DECL mat&lt;4, 4, T, Q&gt; glm::mat4_cast </td>
  334. <td>(</td>
  335. <td class="paramtype">qua&lt; T, Q &gt; const &amp;&#160;</td>
  336. <td class="paramname"><em>x</em></td><td>)</td>
  337. <td></td>
  338. </tr>
  339. </table>
  340. </div><div class="memdoc">
  341. <p>Converts a quaternion to a 4 * 4 matrix. </p>
  342. <dl class="tparams"><dt>Template Parameters</dt><dd>
  343. <table class="tparams">
  344. <tr><td class="paramname">T</td><td>Floating-point scalar types.</td></tr>
  345. </table>
  346. </dd>
  347. </dl>
  348. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00917.html">GLM_GTC_quaternion</a> </dd></dl>
  349. <p class="reference">Referenced by <a class="el" href="a01714_source.html#l00118">glm::toMat4()</a>.</p>
  350. </div>
  351. </div>
  352. <a id="ga7603e81477b46ddb448896909bc04928"></a>
  353. <h2 class="memtitle"><span class="permalink"><a href="#ga7603e81477b46ddb448896909bc04928">&#9670;&nbsp;</a></span>pitch()</h2>
  354. <div class="memitem">
  355. <div class="memproto">
  356. <table class="memname">
  357. <tr>
  358. <td class="memname">GLM_FUNC_DECL T glm::pitch </td>
  359. <td>(</td>
  360. <td class="paramtype">qua&lt; T, Q &gt; const &amp;&#160;</td>
  361. <td class="paramname"><em>x</em></td><td>)</td>
  362. <td></td>
  363. </tr>
  364. </table>
  365. </div><div class="memdoc">
  366. <p>Returns pitch value of euler angles expressed in radians. </p>
  367. <dl class="tparams"><dt>Template Parameters</dt><dd>
  368. <table class="tparams">
  369. <tr><td class="paramname">T</td><td>Floating-point scalar types.</td></tr>
  370. </table>
  371. </dd>
  372. </dl>
  373. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00917.html">GLM_GTC_quaternion</a> </dd></dl>
  374. </div>
  375. </div>
  376. <a id="ga1108a4ab88ca87bac321454eea7702f8"></a>
  377. <h2 class="memtitle"><span class="permalink"><a href="#ga1108a4ab88ca87bac321454eea7702f8">&#9670;&nbsp;</a></span>quat_cast() <span class="overload">[1/2]</span></h2>
  378. <div class="memitem">
  379. <div class="memproto">
  380. <table class="memname">
  381. <tr>
  382. <td class="memname">GLM_FUNC_DECL qua&lt;T, Q&gt; glm::quat_cast </td>
  383. <td>(</td>
  384. <td class="paramtype">mat&lt; 3, 3, T, Q &gt; const &amp;&#160;</td>
  385. <td class="paramname"><em>x</em></td><td>)</td>
  386. <td></td>
  387. </tr>
  388. </table>
  389. </div><div class="memdoc">
  390. <p>Converts a pure rotation 3 * 3 matrix to a quaternion. </p>
  391. <dl class="tparams"><dt>Template Parameters</dt><dd>
  392. <table class="tparams">
  393. <tr><td class="paramname">T</td><td>Floating-point scalar types.</td></tr>
  394. </table>
  395. </dd>
  396. </dl>
  397. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00917.html">GLM_GTC_quaternion</a> </dd></dl>
  398. <p class="reference">Referenced by <a class="el" href="a01714_source.html#l00125">glm::toQuat()</a>.</p>
  399. </div>
  400. </div>
  401. <a id="ga4524810f07f72e8c7bdc7764fa11cb58"></a>
  402. <h2 class="memtitle"><span class="permalink"><a href="#ga4524810f07f72e8c7bdc7764fa11cb58">&#9670;&nbsp;</a></span>quat_cast() <span class="overload">[2/2]</span></h2>
  403. <div class="memitem">
  404. <div class="memproto">
  405. <table class="memname">
  406. <tr>
  407. <td class="memname">GLM_FUNC_DECL qua&lt;T, Q&gt; glm::quat_cast </td>
  408. <td>(</td>
  409. <td class="paramtype">mat&lt; 4, 4, T, Q &gt; const &amp;&#160;</td>
  410. <td class="paramname"><em>x</em></td><td>)</td>
  411. <td></td>
  412. </tr>
  413. </table>
  414. </div><div class="memdoc">
  415. <p>Converts a pure rotation 4 * 4 matrix to a quaternion. </p>
  416. <dl class="tparams"><dt>Template Parameters</dt><dd>
  417. <table class="tparams">
  418. <tr><td class="paramname">T</td><td>Floating-point scalar types.</td></tr>
  419. </table>
  420. </dd>
  421. </dl>
  422. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00917.html">GLM_GTC_quaternion</a> </dd></dl>
  423. </div>
  424. </div>
  425. <a id="gabe7fc5ec5feb41ab234d5d2b6254697f"></a>
  426. <h2 class="memtitle"><span class="permalink"><a href="#gabe7fc5ec5feb41ab234d5d2b6254697f">&#9670;&nbsp;</a></span>quatLookAt()</h2>
  427. <div class="memitem">
  428. <div class="memproto">
  429. <table class="memname">
  430. <tr>
  431. <td class="memname">GLM_FUNC_DECL qua&lt;T, Q&gt; glm::quatLookAt </td>
  432. <td>(</td>
  433. <td class="paramtype">vec&lt; 3, T, Q &gt; const &amp;&#160;</td>
  434. <td class="paramname"><em>direction</em>, </td>
  435. </tr>
  436. <tr>
  437. <td class="paramkey"></td>
  438. <td></td>
  439. <td class="paramtype">vec&lt; 3, T, Q &gt; const &amp;&#160;</td>
  440. <td class="paramname"><em>up</em>&#160;</td>
  441. </tr>
  442. <tr>
  443. <td></td>
  444. <td>)</td>
  445. <td></td><td></td>
  446. </tr>
  447. </table>
  448. </div><div class="memdoc">
  449. <p>Build a look at quaternion based on the default handedness. </p>
  450. <dl class="params"><dt>Parameters</dt><dd>
  451. <table class="params">
  452. <tr><td class="paramname">direction</td><td>Desired forward direction. Needs to be normalized. </td></tr>
  453. <tr><td class="paramname">up</td><td>Up vector, how the camera is oriented. Typically (0, 1, 0). </td></tr>
  454. </table>
  455. </dd>
  456. </dl>
  457. </div>
  458. </div>
  459. <a id="ga2da350c73411be3bb19441b226b81a74"></a>
  460. <h2 class="memtitle"><span class="permalink"><a href="#ga2da350c73411be3bb19441b226b81a74">&#9670;&nbsp;</a></span>quatLookAtLH()</h2>
  461. <div class="memitem">
  462. <div class="memproto">
  463. <table class="memname">
  464. <tr>
  465. <td class="memname">GLM_FUNC_DECL qua&lt;T, Q&gt; glm::quatLookAtLH </td>
  466. <td>(</td>
  467. <td class="paramtype">vec&lt; 3, T, Q &gt; const &amp;&#160;</td>
  468. <td class="paramname"><em>direction</em>, </td>
  469. </tr>
  470. <tr>
  471. <td class="paramkey"></td>
  472. <td></td>
  473. <td class="paramtype">vec&lt; 3, T, Q &gt; const &amp;&#160;</td>
  474. <td class="paramname"><em>up</em>&#160;</td>
  475. </tr>
  476. <tr>
  477. <td></td>
  478. <td>)</td>
  479. <td></td><td></td>
  480. </tr>
  481. </table>
  482. </div><div class="memdoc">
  483. <p>Build a left-handed look at quaternion. </p>
  484. <dl class="params"><dt>Parameters</dt><dd>
  485. <table class="params">
  486. <tr><td class="paramname">direction</td><td>Desired forward direction onto which the +z-axis gets mapped. Needs to be normalized. </td></tr>
  487. <tr><td class="paramname">up</td><td>Up vector, how the camera is oriented. Typically (0, 1, 0). </td></tr>
  488. </table>
  489. </dd>
  490. </dl>
  491. </div>
  492. </div>
  493. <a id="gaf6529ac8c04a57fcc35865b5c9437cc8"></a>
  494. <h2 class="memtitle"><span class="permalink"><a href="#gaf6529ac8c04a57fcc35865b5c9437cc8">&#9670;&nbsp;</a></span>quatLookAtRH()</h2>
  495. <div class="memitem">
  496. <div class="memproto">
  497. <table class="memname">
  498. <tr>
  499. <td class="memname">GLM_FUNC_DECL qua&lt;T, Q&gt; glm::quatLookAtRH </td>
  500. <td>(</td>
  501. <td class="paramtype">vec&lt; 3, T, Q &gt; const &amp;&#160;</td>
  502. <td class="paramname"><em>direction</em>, </td>
  503. </tr>
  504. <tr>
  505. <td class="paramkey"></td>
  506. <td></td>
  507. <td class="paramtype">vec&lt; 3, T, Q &gt; const &amp;&#160;</td>
  508. <td class="paramname"><em>up</em>&#160;</td>
  509. </tr>
  510. <tr>
  511. <td></td>
  512. <td>)</td>
  513. <td></td><td></td>
  514. </tr>
  515. </table>
  516. </div><div class="memdoc">
  517. <p>Build a right-handed look at quaternion. </p>
  518. <dl class="params"><dt>Parameters</dt><dd>
  519. <table class="params">
  520. <tr><td class="paramname">direction</td><td>Desired forward direction onto which the -z-axis gets mapped. Needs to be normalized. </td></tr>
  521. <tr><td class="paramname">up</td><td>Up vector, how the camera is oriented. Typically (0, 1, 0). </td></tr>
  522. </table>
  523. </dd>
  524. </dl>
  525. </div>
  526. </div>
  527. <a id="ga0cc5ad970d0b00829b139fe0fe5a1e13"></a>
  528. <h2 class="memtitle"><span class="permalink"><a href="#ga0cc5ad970d0b00829b139fe0fe5a1e13">&#9670;&nbsp;</a></span>roll()</h2>
  529. <div class="memitem">
  530. <div class="memproto">
  531. <table class="memname">
  532. <tr>
  533. <td class="memname">GLM_FUNC_DECL T glm::roll </td>
  534. <td>(</td>
  535. <td class="paramtype">qua&lt; T, Q &gt; const &amp;&#160;</td>
  536. <td class="paramname"><em>x</em></td><td>)</td>
  537. <td></td>
  538. </tr>
  539. </table>
  540. </div><div class="memdoc">
  541. <p>Returns roll value of euler angles expressed in radians. </p>
  542. <dl class="tparams"><dt>Template Parameters</dt><dd>
  543. <table class="tparams">
  544. <tr><td class="paramname">T</td><td>Floating-point scalar types.</td></tr>
  545. </table>
  546. </dd>
  547. </dl>
  548. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00917.html">GLM_GTC_quaternion</a> </dd></dl>
  549. </div>
  550. </div>
  551. <a id="ga8da38cdfdc452dafa660c2f46506bad5"></a>
  552. <h2 class="memtitle"><span class="permalink"><a href="#ga8da38cdfdc452dafa660c2f46506bad5">&#9670;&nbsp;</a></span>yaw()</h2>
  553. <div class="memitem">
  554. <div class="memproto">
  555. <table class="memname">
  556. <tr>
  557. <td class="memname">GLM_FUNC_DECL T glm::yaw </td>
  558. <td>(</td>
  559. <td class="paramtype">qua&lt; T, Q &gt; const &amp;&#160;</td>
  560. <td class="paramname"><em>x</em></td><td>)</td>
  561. <td></td>
  562. </tr>
  563. </table>
  564. </div><div class="memdoc">
  565. <p>Returns yaw value of euler angles expressed in radians. </p>
  566. <dl class="tparams"><dt>Template Parameters</dt><dd>
  567. <table class="tparams">
  568. <tr><td class="paramname">T</td><td>Floating-point scalar types.</td></tr>
  569. </table>
  570. </dd>
  571. </dl>
  572. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00917.html">GLM_GTC_quaternion</a> </dd></dl>
  573. </div>
  574. </div>
  575. </div><!-- contents -->
  576. <!-- start footer part -->
  577. <hr class="footer"/><address class="footer"><small>
  578. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  579. <img class="footer" src="doxygen.png" alt="doxygen"/>
  580. </a> 1.8.18
  581. </small></address>
  582. </body>
  583. </html>