Updated API doc
This commit is contained in:
@@ -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: matrix_transform_2d.hpp Source File</title>
|
||||
<title>0.9.9 API documenation: orthonormalize.hpp Source File</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>
|
||||
@@ -84,62 +84,39 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||
</div><!-- top -->
|
||||
<div class="header">
|
||||
<div class="headertitle">
|
||||
<div class="title">matrix_transform_2d.hpp</div> </div>
|
||||
<div class="title">orthonormalize.hpp</div> </div>
|
||||
</div><!--header-->
|
||||
<div class="contents">
|
||||
<a href="a00075.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> </div>
|
||||
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#pragma once</span></div>
|
||||
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> </div>
|
||||
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment">// Dependency:</span></div>
|
||||
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#include "../mat3x3.hpp"</span></div>
|
||||
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#include "../vec2.hpp"</span></div>
|
||||
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> </div>
|
||||
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#ifndef GLM_ENABLE_EXPERIMENTAL</span></div>
|
||||
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor"># error "GLM: GLM_GTX_matrix_transform_2d is an experimental extension and may change in the future. Use #define GLM_ENABLE_EXPERIMENTAL before including it, if you really want to use it."</span></div>
|
||||
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#endif</span></div>
|
||||
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> </div>
|
||||
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#if GLM_MESSAGES == GLM_MESSAGES_ENABLED && !defined(GLM_EXT_INCLUDED)</span></div>
|
||||
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor"># pragma message("GLM: GLM_GTX_matrix_transform_2d extension included")</span></div>
|
||||
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#endif</span></div>
|
||||
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> </div>
|
||||
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="keyword">namespace </span><a class="code" href="a00143.html">glm</a></div>
|
||||
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> {</div>
|
||||
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  </div>
|
||||
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T, qualifier P></div>
|
||||
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  GLM_FUNC_QUALIFIER mat<3, 3, T, P> <a class="code" href="a00214.html#ga1553c827dbe9648415611251535cfb05">translate</a>(</div>
|
||||
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  mat<3, 3, T, P> <span class="keyword">const</span>& m,</div>
|
||||
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  vec<2, T, P> <span class="keyword">const</span> & v);</div>
|
||||
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> </div>
|
||||
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T, qualifier P> </div>
|
||||
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  GLM_FUNC_QUALIFIER mat<3, 3, T, P> <a class="code" href="a00214.html#ga6f345617cd464e6132256255adbbf491">rotate</a>(</div>
|
||||
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  mat<3, 3, T, P> <span class="keyword">const</span>& m,</div>
|
||||
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  T <a class="code" href="a00174.html#gad4a4448baedb198b2b1e7880d2544dc9">angle</a>);</div>
|
||||
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> </div>
|
||||
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T, qualifier P> </div>
|
||||
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  GLM_FUNC_QUALIFIER mat<3, 3, T, P> <a class="code" href="a00214.html#ga6c6fc9d6df792dcebf6d81ae68982b1c">scale</a>(</div>
|
||||
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  mat<3, 3, T, P> <span class="keyword">const</span>& m,</div>
|
||||
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  vec<2, T, P> <span class="keyword">const</span> & v);</div>
|
||||
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> </div>
|
||||
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T, qualifier P> </div>
|
||||
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  GLM_FUNC_QUALIFIER mat<3, 3, T, P> <a class="code" href="a00214.html#gad2abda4d1b3cc6bf0c8d3d87741a376b">shearX</a>(</div>
|
||||
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  mat<3, 3, T, P> <span class="keyword">const</span>& m,</div>
|
||||
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  T y);</div>
|
||||
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> </div>
|
||||
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T, qualifier P> </div>
|
||||
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  GLM_FUNC_QUALIFIER mat<3, 3, T, P> <a class="code" href="a00214.html#ga149783af58949bc614258394b25e33de">shearY</a>(</div>
|
||||
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  mat<3, 3, T, P> <span class="keyword">const</span>& m,</div>
|
||||
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  T x);</div>
|
||||
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span> </div>
|
||||
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span> }<span class="comment">//namespace glm</span></div>
|
||||
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span> </div>
|
||||
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="preprocessor">#include "matrix_transform_2d.inl"</span></div>
|
||||
<div class="ttc" id="a00214_html_gad2abda4d1b3cc6bf0c8d3d87741a376b"><div class="ttname"><a href="a00214.html#gad2abda4d1b3cc6bf0c8d3d87741a376b">glm::shearX</a></div><div class="ttdeci">GLM_FUNC_QUALIFIER mat< 3, 3, T, P > shearX(mat< 3, 3, T, P > const &m, T y)</div><div class="ttdoc">Builds an horizontal (parallel to the x axis) shear 3 * 3 matrix. </div></div>
|
||||
<div class="ttc" id="a00143_html"><div class="ttname"><a href="a00143.html">glm</a></div><div class="ttdef"><b>Definition:</b> <a href="a00003_source.html#l00011">_noise.hpp:11</a></div></div>
|
||||
<div class="ttc" id="a00214_html_ga6c6fc9d6df792dcebf6d81ae68982b1c"><div class="ttname"><a href="a00214.html#ga6c6fc9d6df792dcebf6d81ae68982b1c">glm::scale</a></div><div class="ttdeci">GLM_FUNC_QUALIFIER mat< 3, 3, T, P > scale(mat< 3, 3, T, P > const &m, vec< 2, T, P > const &v)</div><div class="ttdoc">Builds a scale 3 * 3 matrix created from a vector of 2 components. </div></div>
|
||||
<div class="ttc" id="a00214_html_ga1553c827dbe9648415611251535cfb05"><div class="ttname"><a href="a00214.html#ga1553c827dbe9648415611251535cfb05">glm::translate</a></div><div class="ttdeci">GLM_FUNC_QUALIFIER mat< 3, 3, T, P > translate(mat< 3, 3, T, P > const &m, vec< 2, T, P > const &v)</div><div class="ttdoc">Builds a translation 3 * 3 matrix created from a vector of 2 components. </div></div>
|
||||
<div class="ttc" id="a00174_html_gad4a4448baedb198b2b1e7880d2544dc9"><div class="ttname"><a href="a00174.html#gad4a4448baedb198b2b1e7880d2544dc9">glm::angle</a></div><div class="ttdeci">GLM_FUNC_DECL T angle(tquat< T, P > const &x)</div><div class="ttdoc">Returns the quaternion rotation angle. </div></div>
|
||||
<div class="ttc" id="a00214_html_ga6f345617cd464e6132256255adbbf491"><div class="ttname"><a href="a00214.html#ga6f345617cd464e6132256255adbbf491">glm::rotate</a></div><div class="ttdeci">GLM_FUNC_QUALIFIER mat< 3, 3, T, P > rotate(mat< 3, 3, T, P > const &m, T angle)</div><div class="ttdoc">Builds a rotation 3 * 3 matrix created from an angle. </div></div>
|
||||
<div class="ttc" id="a00214_html_ga149783af58949bc614258394b25e33de"><div class="ttname"><a href="a00214.html#ga149783af58949bc614258394b25e33de">glm::shearY</a></div><div class="ttdeci">GLM_FUNC_QUALIFIER mat< 3, 3, T, P > shearY(mat< 3, 3, T, P > const &m, T x)</div><div class="ttdoc">Builds a vertical (parallel to the y axis) shear 3 * 3 matrix. </div></div>
|
||||
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#include "../vec3.hpp"</span></div>
|
||||
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#include "../mat3x3.hpp"</span></div>
|
||||
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#include "../geometric.hpp"</span></div>
|
||||
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> </div>
|
||||
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#ifndef GLM_ENABLE_EXPERIMENTAL</span></div>
|
||||
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor"># error "GLM: GLM_GTX_orthonormalize is an experimental extension and may change in the future. Use #define GLM_ENABLE_EXPERIMENTAL before including it, if you really want to use it."</span></div>
|
||||
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#endif</span></div>
|
||||
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> </div>
|
||||
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#if GLM_MESSAGES == GLM_MESSAGES_ENABLED && !defined(GLM_EXT_INCLUDED)</span></div>
|
||||
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor"># pragma message("GLM: GLM_GTX_orthonormalize extension included")</span></div>
|
||||
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#endif</span></div>
|
||||
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> </div>
|
||||
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="keyword">namespace </span><a class="code" href="a00135.html">glm</a></div>
|
||||
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> {</div>
|
||||
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> </div>
|
||||
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T, qualifier Q> </div>
|
||||
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  GLM_FUNC_DECL mat<3, 3, T, Q> <a class="code" href="a00208.html#gac3bc7ef498815026bc3d361ae0b7138e">orthonormalize</a>(mat<3, 3, T, Q> <span class="keyword">const</span>& m);</div>
|
||||
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  </div>
|
||||
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T, qualifier Q> </div>
|
||||
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  GLM_FUNC_DECL vec<3, T, Q> <a class="code" href="a00208.html#gac3bc7ef498815026bc3d361ae0b7138e">orthonormalize</a>(vec<3, T, Q> <span class="keyword">const</span>& x, vec<3, T, Q> <span class="keyword">const</span>& y);</div>
|
||||
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> </div>
|
||||
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> }<span class="comment">//namespace glm</span></div>
|
||||
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> </div>
|
||||
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="preprocessor">#include "orthonormalize.inl"</span></div>
|
||||
<div class="ttc" id="a00135_html"><div class="ttname"><a href="a00135.html">glm</a></div><div class="ttdef"><b>Definition:</b> <a href="a00015_source.html#l00020">common.hpp:20</a></div></div>
|
||||
<div class="ttc" id="a00208_html_gac3bc7ef498815026bc3d361ae0b7138e"><div class="ttname"><a href="a00208.html#gac3bc7ef498815026bc3d361ae0b7138e">glm::orthonormalize</a></div><div class="ttdeci">GLM_FUNC_DECL vec< 3, T, Q > orthonormalize(vec< 3, T, Q > const &x, vec< 3, T, Q > const &y)</div><div class="ttdoc">Orthonormalizes x according y. </div></div>
|
||||
</div><!-- fragment --></div><!-- contents -->
|
||||
<!-- start footer part -->
|
||||
<hr class="footer"/><address class="footer"><small>
|
||||
|
||||
Reference in New Issue
Block a user