Updated API doc
This commit is contained in:
Christophe Riccio
@@ -4,7 +4,7 @@
|
||||
<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: GLM_GTX_rotate_normalized_axis</title>
|
||||
<title>0.9.9 API documenation: GLM_GTX_wrap</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>
|
||||
@@ -77,123 +77,109 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||
<div class="summary">
|
||||
<a href="#func-members">Functions</a> </div>
|
||||
<div class="headertitle">
|
||||
<div class="title">GLM_GTX_rotate_normalized_axis<div class="ingroups"><a class="el" href="a00157.html">GTX Extensions (Experimental)</a></div></div> </div>
|
||||
<div class="title">GLM_GTX_wrap<div class="ingroups"><a class="el" href="a00148.html">Experimental extensions</a></div></div> </div>
|
||||
</div><!--header-->
|
||||
<div class="contents">
|
||||
|
||||
<p>Quaternions and matrices rotations around normalized axis.
|
||||
<p>Include <<a class="el" href="a00134.html" title="GLM_GTX_wrap ">glm/gtx/wrap.hpp</a>> to use the features of this extension.
|
||||
<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:ga90cde825f60859ebf14f3e294fe9cff1"><td class="memTemplParams" colspan="2">template<typename T , qualifier P> </td></tr>
|
||||
<tr class="memitem:ga90cde825f60859ebf14f3e294fe9cff1"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL mat< 4, 4, T, P > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00228.html#ga90cde825f60859ebf14f3e294fe9cff1">rotateNormalizedAxis</a> (mat< 4, 4, T, P > const &m, T const &angle, vec< 3, T, P > const &axis)</td></tr>
|
||||
<tr class="memdesc:ga90cde825f60859ebf14f3e294fe9cff1"><td class="mdescLeft"> </td><td class="mdescRight">Builds a rotation 4 * 4 matrix created from a normalized axis and an angle. <a href="a00228.html#ga90cde825f60859ebf14f3e294fe9cff1">More...</a><br /></td></tr>
|
||||
<tr class="separator:ga90cde825f60859ebf14f3e294fe9cff1"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ga2d90d33e38df823443823f4dd0d0d8e6"><td class="memTemplParams" colspan="2">template<typename T , qualifier P> </td></tr>
|
||||
<tr class="memitem:ga2d90d33e38df823443823f4dd0d0d8e6"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL tquat< T, P > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00228.html#ga2d90d33e38df823443823f4dd0d0d8e6">rotateNormalizedAxis</a> (tquat< T, P > const &q, T const &angle, vec< 3, T, P > const &axis)</td></tr>
|
||||
<tr class="memdesc:ga2d90d33e38df823443823f4dd0d0d8e6"><td class="mdescLeft"> </td><td class="mdescRight">Rotates a quaternion from a vector of 3 components normalized axis and an angle. <a href="a00228.html#ga2d90d33e38df823443823f4dd0d0d8e6">More...</a><br /></td></tr>
|
||||
<tr class="separator:ga2d90d33e38df823443823f4dd0d0d8e6"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ga6c0cc6bd1d67ea1008d2592e998bad33"><td class="memTemplParams" colspan="2">template<typename genType > </td></tr>
|
||||
<tr class="memitem:ga6c0cc6bd1d67ea1008d2592e998bad33"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00228.html#ga6c0cc6bd1d67ea1008d2592e998bad33">clamp</a> (genType const &Texcoord)</td></tr>
|
||||
<tr class="memdesc:ga6c0cc6bd1d67ea1008d2592e998bad33"><td class="mdescLeft"> </td><td class="mdescRight">Simulate GL_CLAMP OpenGL wrap mode. <a href="a00228.html#ga6c0cc6bd1d67ea1008d2592e998bad33">More...</a><br /></td></tr>
|
||||
<tr class="separator:ga6c0cc6bd1d67ea1008d2592e998bad33"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:gaa6856a0a048d2749252848da35e10c8b"><td class="memTemplParams" colspan="2">template<typename genType > </td></tr>
|
||||
<tr class="memitem:gaa6856a0a048d2749252848da35e10c8b"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00228.html#gaa6856a0a048d2749252848da35e10c8b">mirrorClamp</a> (genType const &Texcoord)</td></tr>
|
||||
<tr class="memdesc:gaa6856a0a048d2749252848da35e10c8b"><td class="mdescLeft"> </td><td class="mdescRight">Simulate GL_MIRRORED_REPEAT OpenGL wrap mode. <a href="a00228.html#gaa6856a0a048d2749252848da35e10c8b">More...</a><br /></td></tr>
|
||||
<tr class="separator:gaa6856a0a048d2749252848da35e10c8b"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ga16a89b0661b60d5bea85137bbae74d73"><td class="memTemplParams" colspan="2">template<typename genType > </td></tr>
|
||||
<tr class="memitem:ga16a89b0661b60d5bea85137bbae74d73"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00228.html#ga16a89b0661b60d5bea85137bbae74d73">mirrorRepeat</a> (genType const &Texcoord)</td></tr>
|
||||
<tr class="memdesc:ga16a89b0661b60d5bea85137bbae74d73"><td class="mdescLeft"> </td><td class="mdescRight">Simulate GL_MIRROR_REPEAT OpenGL wrap mode. <a href="a00228.html#ga16a89b0661b60d5bea85137bbae74d73">More...</a><br /></td></tr>
|
||||
<tr class="separator:ga16a89b0661b60d5bea85137bbae74d73"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ga809650c6310ea7c42666e918c117fb6f"><td class="memTemplParams" colspan="2">template<typename genType > </td></tr>
|
||||
<tr class="memitem:ga809650c6310ea7c42666e918c117fb6f"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00228.html#ga809650c6310ea7c42666e918c117fb6f">repeat</a> (genType const &Texcoord)</td></tr>
|
||||
<tr class="memdesc:ga809650c6310ea7c42666e918c117fb6f"><td class="mdescLeft"> </td><td class="mdescRight">Simulate GL_REPEAT OpenGL wrap mode. <a href="a00228.html#ga809650c6310ea7c42666e918c117fb6f">More...</a><br /></td></tr>
|
||||
<tr class="separator:ga809650c6310ea7c42666e918c117fb6f"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
</table>
|
||||
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||||
<p>Quaternions and matrices rotations around normalized axis. </p>
|
||||
<p><<a class="el" href="a00097.html" title="GLM_GTX_rotate_normalized_axis ">glm/gtx/rotate_normalized_axis.hpp</a>> need to be included to use these functionalities. </p>
|
||||
<p>Include <<a class="el" href="a00134.html" title="GLM_GTX_wrap ">glm/gtx/wrap.hpp</a>> to use the features of this extension. </p>
|
||||
<p>Wrapping mode of texture coordinates. </p>
|
||||
<h2 class="groupheader">Function Documentation</h2>
|
||||
<a class="anchor" id="ga90cde825f60859ebf14f3e294fe9cff1"></a>
|
||||
<a class="anchor" id="ga6c0cc6bd1d67ea1008d2592e998bad33"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">GLM_FUNC_DECL mat<4, 4, T, P> glm::rotateNormalizedAxis </td>
|
||||
<td class="memname">GLM_FUNC_DECL genType glm::clamp </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">mat< 4, 4, T, P > const & </td>
|
||||
<td class="paramname"><em>m</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td class="paramtype">genType const & </td>
|
||||
<td class="paramname"><em>Texcoord</em></td><td>)</td>
|
||||
<td></td>
|
||||
<td class="paramtype">T const & </td>
|
||||
<td class="paramname"><em>angle</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">vec< 3, T, P > const & </td>
|
||||
<td class="paramname"><em>axis</em> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>)</td>
|
||||
<td></td><td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Builds a rotation 4 * 4 matrix created from a normalized axis and an angle. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">m</td><td>Input matrix multiplied by this rotation matrix. </td></tr>
|
||||
<tr><td class="paramname">angle</td><td>Rotation angle expressed in radians. </td></tr>
|
||||
<tr><td class="paramname">axis</td><td>Rotation axis, must be normalized. </td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
||||
<table class="tparams">
|
||||
<tr><td class="paramname">T</td><td>Value type used to build the matrix. Currently supported: half (not recommanded), float or double.</td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00228.html" title="Quaternions and matrices rotations around normalized axis. ">GLM_GTX_rotate_normalized_axis</a> </dd>
|
||||
<dd>
|
||||
- rotate(T angle, T x, T y, T z) </dd>
|
||||
<dd>
|
||||
- rotate(mat<4, 4, T, P> const & m, T angle, T x, T y, T z) </dd>
|
||||
<dd>
|
||||
- rotate(T angle, vec<3, T, P> const & v) </dd></dl>
|
||||
<p>Simulate GL_CLAMP OpenGL wrap mode. </p>
|
||||
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00228.html" title="Include <glm/gtx/wrap.hpp> to use the features of this extension. ">GLM_GTX_wrap</a> extension. </dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="ga2d90d33e38df823443823f4dd0d0d8e6"></a>
|
||||
<a class="anchor" id="gaa6856a0a048d2749252848da35e10c8b"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">GLM_FUNC_DECL tquat<T, P> glm::rotateNormalizedAxis </td>
|
||||
<td class="memname">GLM_FUNC_DECL genType glm::mirrorClamp </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">tquat< T, P > const & </td>
|
||||
<td class="paramname"><em>q</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td class="paramtype">genType const & </td>
|
||||
<td class="paramname"><em>Texcoord</em></td><td>)</td>
|
||||
<td></td>
|
||||
<td class="paramtype">T const & </td>
|
||||
<td class="paramname"><em>angle</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">vec< 3, T, P > const & </td>
|
||||
<td class="paramname"><em>axis</em> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>)</td>
|
||||
<td></td><td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Rotates a quaternion from a vector of 3 components normalized axis and an angle. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">q</td><td>Source orientation </td></tr>
|
||||
<tr><td class="paramname">angle</td><td>Angle expressed in radians. </td></tr>
|
||||
<tr><td class="paramname">axis</td><td>Normalized axis of the rotation, must be normalized.</td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00228.html" title="Quaternions and matrices rotations around normalized axis. ">GLM_GTX_rotate_normalized_axis</a> </dd></dl>
|
||||
<p>Simulate GL_MIRRORED_REPEAT OpenGL wrap mode. </p>
|
||||
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00228.html" title="Include <glm/gtx/wrap.hpp> to use the features of this extension. ">GLM_GTX_wrap</a> extension. </dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="ga16a89b0661b60d5bea85137bbae74d73"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">GLM_FUNC_DECL genType glm::mirrorRepeat </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">genType const & </td>
|
||||
<td class="paramname"><em>Texcoord</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Simulate GL_MIRROR_REPEAT OpenGL wrap mode. </p>
|
||||
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00228.html" title="Include <glm/gtx/wrap.hpp> to use the features of this extension. ">GLM_GTX_wrap</a> extension. </dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="ga809650c6310ea7c42666e918c117fb6f"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">GLM_FUNC_DECL genType glm::repeat </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">genType const & </td>
|
||||
<td class="paramname"><em>Texcoord</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Simulate GL_REPEAT OpenGL wrap mode. </p>
|
||||
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00228.html" title="Include <glm/gtx/wrap.hpp> to use the features of this extension. ">GLM_GTX_wrap</a> extension. </dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
Reference in New Issue
Block a user