Updated API documentation
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_matrix_transform_2d</title>
|
||||
<title>0.9.9 API documenation: GLM_GTX_matrix_cross_product</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>
|
||||
@@ -78,212 +78,63 @@ 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_matrix_transform_2d<div class="ingroups"><a class="el" href="a00148.html">Experimental extensions</a></div></div> </div>
|
||||
<div class="title">GLM_GTX_matrix_cross_product<div class="ingroups"><a class="el" href="a00154.html">Experimental extensions</a></div></div> </div>
|
||||
</div><!--header-->
|
||||
<div class="contents">
|
||||
|
||||
<p>Include <<a class="el" href="a00067.html" title="GLM_GTX_matrix_transform_2d ">glm/gtx/matrix_transform_2d.hpp</a>> to use the features of this extension.
|
||||
<p>Include <<a class="el" href="a00058.html" title="GLM_GTX_matrix_cross_product ">glm/gtx/matrix_cross_product.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:gad5c84a4932a758f385a87098ce1b1660"><td class="memTemplParams" colspan="2">template<typename T , qualifier Q> </td></tr>
|
||||
<tr class="memitem:gad5c84a4932a758f385a87098ce1b1660"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_QUALIFIER mat< 3, 3, T, Q > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00201.html#gad5c84a4932a758f385a87098ce1b1660">rotate</a> (mat< 3, 3, T, Q > const &m, T angle)</td></tr>
|
||||
<tr class="memdesc:gad5c84a4932a758f385a87098ce1b1660"><td class="mdescLeft"> </td><td class="mdescRight">Builds a rotation 3 * 3 matrix created from an angle. <a href="a00201.html#gad5c84a4932a758f385a87098ce1b1660">More...</a><br /></td></tr>
|
||||
<tr class="separator:gad5c84a4932a758f385a87098ce1b1660"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:gadb47d2ad2bd984b213e8ff7d9cd8154e"><td class="memTemplParams" colspan="2">template<typename T , qualifier Q> </td></tr>
|
||||
<tr class="memitem:gadb47d2ad2bd984b213e8ff7d9cd8154e"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_QUALIFIER mat< 3, 3, T, Q > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00201.html#gadb47d2ad2bd984b213e8ff7d9cd8154e">scale</a> (mat< 3, 3, T, Q > const &m, vec< 2, T, Q > const &v)</td></tr>
|
||||
<tr class="memdesc:gadb47d2ad2bd984b213e8ff7d9cd8154e"><td class="mdescLeft"> </td><td class="mdescRight">Builds a scale 3 * 3 matrix created from a vector of 2 components. <a href="a00201.html#gadb47d2ad2bd984b213e8ff7d9cd8154e">More...</a><br /></td></tr>
|
||||
<tr class="separator:gadb47d2ad2bd984b213e8ff7d9cd8154e"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ga2a118ece5db1e2022112b954846012af"><td class="memTemplParams" colspan="2">template<typename T , qualifier Q> </td></tr>
|
||||
<tr class="memitem:ga2a118ece5db1e2022112b954846012af"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_QUALIFIER mat< 3, 3, T, Q > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00201.html#ga2a118ece5db1e2022112b954846012af">shearX</a> (mat< 3, 3, T, Q > const &m, T y)</td></tr>
|
||||
<tr class="memdesc:ga2a118ece5db1e2022112b954846012af"><td class="mdescLeft"> </td><td class="mdescRight">Builds an horizontal (parallel to the x axis) shear 3 * 3 matrix. <a href="a00201.html#ga2a118ece5db1e2022112b954846012af">More...</a><br /></td></tr>
|
||||
<tr class="separator:ga2a118ece5db1e2022112b954846012af"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ga717f1833369c1ac4a40e4ac015af885e"><td class="memTemplParams" colspan="2">template<typename T , qualifier Q> </td></tr>
|
||||
<tr class="memitem:ga717f1833369c1ac4a40e4ac015af885e"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_QUALIFIER mat< 3, 3, T, Q > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00201.html#ga717f1833369c1ac4a40e4ac015af885e">shearY</a> (mat< 3, 3, T, Q > const &m, T x)</td></tr>
|
||||
<tr class="memdesc:ga717f1833369c1ac4a40e4ac015af885e"><td class="mdescLeft"> </td><td class="mdescRight">Builds a vertical (parallel to the y axis) shear 3 * 3 matrix. <a href="a00201.html#ga717f1833369c1ac4a40e4ac015af885e">More...</a><br /></td></tr>
|
||||
<tr class="separator:ga717f1833369c1ac4a40e4ac015af885e"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:gaf4573ae47c80938aa9053ef6a33755ab"><td class="memTemplParams" colspan="2">template<typename T , qualifier Q> </td></tr>
|
||||
<tr class="memitem:gaf4573ae47c80938aa9053ef6a33755ab"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_QUALIFIER mat< 3, 3, T, Q > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00201.html#gaf4573ae47c80938aa9053ef6a33755ab">translate</a> (mat< 3, 3, T, Q > const &m, vec< 2, T, Q > const &v)</td></tr>
|
||||
<tr class="memdesc:gaf4573ae47c80938aa9053ef6a33755ab"><td class="mdescLeft"> </td><td class="mdescRight">Builds a translation 3 * 3 matrix created from a vector of 2 components. <a href="a00201.html#gaf4573ae47c80938aa9053ef6a33755ab">More...</a><br /></td></tr>
|
||||
<tr class="separator:gaf4573ae47c80938aa9053ef6a33755ab"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ga5802386bb4c37b3332a3b6fd8b6960ff"><td class="memTemplParams" colspan="2">template<typename T , qualifier Q> </td></tr>
|
||||
<tr class="memitem:ga5802386bb4c37b3332a3b6fd8b6960ff"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL mat< 3, 3, T, Q > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00201.html#ga5802386bb4c37b3332a3b6fd8b6960ff">matrixCross3</a> (vec< 3, T, Q > const &x)</td></tr>
|
||||
<tr class="memdesc:ga5802386bb4c37b3332a3b6fd8b6960ff"><td class="mdescLeft"> </td><td class="mdescRight">Build a cross product matrix. <a href="a00201.html#ga5802386bb4c37b3332a3b6fd8b6960ff">More...</a><br /></td></tr>
|
||||
<tr class="separator:ga5802386bb4c37b3332a3b6fd8b6960ff"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ga20057fff91ddafa102934adb25458cde"><td class="memTemplParams" colspan="2">template<typename T , qualifier Q> </td></tr>
|
||||
<tr class="memitem:ga20057fff91ddafa102934adb25458cde"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL mat< 4, 4, T, Q > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00201.html#ga20057fff91ddafa102934adb25458cde">matrixCross4</a> (vec< 3, T, Q > const &x)</td></tr>
|
||||
<tr class="memdesc:ga20057fff91ddafa102934adb25458cde"><td class="mdescLeft"> </td><td class="mdescRight">Build a cross product matrix. <a href="a00201.html#ga20057fff91ddafa102934adb25458cde">More...</a><br /></td></tr>
|
||||
<tr class="separator:ga20057fff91ddafa102934adb25458cde"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
</table>
|
||||
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||||
<p>Include <<a class="el" href="a00067.html" title="GLM_GTX_matrix_transform_2d ">glm/gtx/matrix_transform_2d.hpp</a>> to use the features of this extension. </p>
|
||||
<p>Defines functions that generate common 2d transformation matrices. </p>
|
||||
<p>Include <<a class="el" href="a00058.html" title="GLM_GTX_matrix_cross_product ">glm/gtx/matrix_cross_product.hpp</a>> to use the features of this extension. </p>
|
||||
<p>Build cross product matrices </p>
|
||||
<h2 class="groupheader">Function Documentation</h2>
|
||||
<a class="anchor" id="gad5c84a4932a758f385a87098ce1b1660"></a>
|
||||
<a class="anchor" id="ga5802386bb4c37b3332a3b6fd8b6960ff"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">GLM_FUNC_QUALIFIER mat<3, 3, T, Q> glm::rotate </td>
|
||||
<td class="memname">GLM_FUNC_DECL mat<3, 3, T, Q> glm::matrixCross3 </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">mat< 3, 3, T, Q > const & </td>
|
||||
<td class="paramname"><em>m</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td class="paramtype">vec< 3, T, Q > const & </td>
|
||||
<td class="paramname"><em>x</em></td><td>)</td>
|
||||
<td></td>
|
||||
<td class="paramtype">T </td>
|
||||
<td class="paramname"><em>angle</em> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>)</td>
|
||||
<td></td><td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Builds a rotation 3 * 3 matrix created from 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 translation matrix. </td></tr>
|
||||
<tr><td class="paramname">angle</td><td>Rotation angle expressed in radians. </td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
<p>Build a cross product matrix. </p>
|
||||
<p>From GLM_GTX_matrix_cross_product extension. </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="gadb47d2ad2bd984b213e8ff7d9cd8154e"></a>
|
||||
<a class="anchor" id="ga20057fff91ddafa102934adb25458cde"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">GLM_FUNC_QUALIFIER mat<3, 3, T, Q> glm::scale </td>
|
||||
<td class="memname">GLM_FUNC_DECL mat<4, 4, T, Q> glm::matrixCross4 </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">mat< 3, 3, T, Q > const & </td>
|
||||
<td class="paramname"><em>m</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td class="paramtype">vec< 3, T, Q > const & </td>
|
||||
<td class="paramname"><em>x</em></td><td>)</td>
|
||||
<td></td>
|
||||
<td class="paramtype">vec< 2, T, Q > const & </td>
|
||||
<td class="paramname"><em>v</em> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>)</td>
|
||||
<td></td><td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Builds a scale 3 * 3 matrix created from a vector of 2 components. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">m</td><td>Input matrix multiplied by this translation matrix. </td></tr>
|
||||
<tr><td class="paramname">v</td><td>Coordinates of a scale vector. </td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="ga2a118ece5db1e2022112b954846012af"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">GLM_FUNC_QUALIFIER mat<3, 3, T, Q> glm::shearX </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">mat< 3, 3, T, Q > const & </td>
|
||||
<td class="paramname"><em>m</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">T </td>
|
||||
<td class="paramname"><em>y</em> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>)</td>
|
||||
<td></td><td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Builds an horizontal (parallel to the x axis) shear 3 * 3 matrix. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">m</td><td>Input matrix multiplied by this translation matrix. </td></tr>
|
||||
<tr><td class="paramname">y</td><td>Shear factor. </td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="ga717f1833369c1ac4a40e4ac015af885e"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">GLM_FUNC_QUALIFIER mat<3, 3, T, Q> glm::shearY </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">mat< 3, 3, T, Q > const & </td>
|
||||
<td class="paramname"><em>m</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">T </td>
|
||||
<td class="paramname"><em>x</em> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>)</td>
|
||||
<td></td><td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Builds a vertical (parallel to the y axis) shear 3 * 3 matrix. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">m</td><td>Input matrix multiplied by this translation matrix. </td></tr>
|
||||
<tr><td class="paramname">x</td><td>Shear factor. </td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="gaf4573ae47c80938aa9053ef6a33755ab"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">GLM_FUNC_QUALIFIER mat<3, 3, T, Q> glm::translate </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">mat< 3, 3, T, Q > const & </td>
|
||||
<td class="paramname"><em>m</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">vec< 2, T, Q > const & </td>
|
||||
<td class="paramname"><em>v</em> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>)</td>
|
||||
<td></td><td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Builds a translation 3 * 3 matrix created from a vector of 2 components. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">m</td><td>Input matrix multiplied by this translation matrix. </td></tr>
|
||||
<tr><td class="paramname">v</td><td>Coordinates of a translation vector. </td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
<p>Build a cross product matrix. </p>
|
||||
<p>From GLM_GTX_matrix_cross_product extension. </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
Reference in New Issue
Block a user