Updated API documentation
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: transform2.hpp Source File</title>
|
||||
<title>0.9.9 API documenation: transform.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>
|
||||
@@ -85,75 +85,48 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||
</div><!-- top -->
|
||||
<div class="header">
|
||||
<div class="headertitle">
|
||||
<div class="title">transform2.hpp</div> </div>
|
||||
<div class="title">transform.hpp</div> </div>
|
||||
</div><!--header-->
|
||||
<div class="contents">
|
||||
<a href="a00099.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 "../glm.hpp"</span></div>
|
||||
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#include "../gtx/transform.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_transform2 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_transform2 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="a00135.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="l00035"></a><span class="lineno"> 35</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T, qualifier Q></div>
|
||||
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  GLM_FUNC_DECL mat<3, 3, T, Q> <a class="code" href="a00222.html#gabf714b8a358181572b32a45555f71948">shearX2D</a>(mat<3, 3, T, Q> <span class="keyword">const</span>& m, T y);</div>
|
||||
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> </div>
|
||||
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T, qualifier Q> </div>
|
||||
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  GLM_FUNC_DECL mat<3, 3, T, Q> <a class="code" href="a00222.html#gac7998d0763d9181550c77e8af09a182c">shearY2D</a>(mat<3, 3, T, Q> <span class="keyword">const</span>& m, T x);</div>
|
||||
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> </div>
|
||||
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T, qualifier Q> </div>
|
||||
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  GLM_FUNC_DECL mat<4, 4, T, Q> <a class="code" href="a00222.html#ga73e867c6cd4d700fe2054437e56106c4">shearX3D</a>(mat<4, 4, T, Q> <span class="keyword">const</span>& m, T y, T z);</div>
|
||||
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> </div>
|
||||
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T, qualifier Q> </div>
|
||||
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  GLM_FUNC_DECL mat<4, 4, T, Q> <a class="code" href="a00222.html#gade5bb65ffcb513973db1a1314fb5cfac">shearY3D</a>(mat<4, 4, T, Q> <span class="keyword">const</span>& m, T x, T z);</div>
|
||||
<div class="line"><a name="l00052"></a><span class="lineno"> 52</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 Q> </div>
|
||||
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  GLM_FUNC_DECL mat<4, 4, T, Q> <a class="code" href="a00222.html#ga6591e0a3a9d2c9c0b6577bb4dace0255">shearZ3D</a>(mat<4, 4, T, Q> <span class="keyword">const</span>& m, T x, T y);</div>
|
||||
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> </div>
|
||||
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="comment">//template<typename T> GLM_FUNC_QUALIFIER mat<4, 4, T, Q> shear(const mat<4, 4, T, Q> & m, shearPlane, planePoint, angle)</span></div>
|
||||
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="comment">// Identity + tan(angle) * cross(Normal, OnPlaneVector) 0</span></div>
|
||||
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="comment">// - dot(PointOnPlane, normal) * OnPlaneVector 1</span></div>
|
||||
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> </div>
|
||||
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="comment">// Reflect functions seem to don't work</span></div>
|
||||
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="comment">//template<typename T> mat<3, 3, T, Q> reflect2D(const mat<3, 3, T, Q> & m, const vec<3, T, Q>& normal){return reflect2DGTX(m, normal);} //!< \brief Build a reflection matrix (from GLM_GTX_transform2 extension)</span></div>
|
||||
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="comment">//template<typename T> mat<4, 4, T, Q> reflect3D(const mat<4, 4, T, Q> & m, const vec<3, T, Q>& normal){return reflect3DGTX(m, normal);} //!< \brief Build a reflection matrix (from GLM_GTX_transform2 extension)</span></div>
|
||||
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  </div>
|
||||
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T, qualifier Q> </div>
|
||||
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  GLM_FUNC_DECL mat<3, 3, T, Q> <a class="code" href="a00222.html#ga5b992a0cdc8298054edb68e228f0d93e">proj2D</a>(mat<3, 3, T, Q> <span class="keyword">const</span>& m, vec<3, T, Q> <span class="keyword">const</span>& normal);</div>
|
||||
<div class="line"><a name="l00070"></a><span class="lineno"> 70</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 Q></div>
|
||||
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  GLM_FUNC_DECL mat<4, 4, T, Q> <a class="code" href="a00222.html#gaa2b7f4f15b98f697caede11bef50509e">proj3D</a>(mat<4, 4, T, Q> <span class="keyword">const</span> & m, vec<3, T, Q> <span class="keyword">const</span>& normal);</div>
|
||||
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span> </div>
|
||||
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T, qualifier Q></div>
|
||||
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  GLM_FUNC_DECL mat<4, 4, T, Q> <a class="code" href="a00222.html#gae2bdd91a76759fecfbaef97e3020aa8e">scaleBias</a>(T <a class="code" href="a00157.html#ga05051adbee603fb3c5095d8cf5cc229b">scale</a>, T bias);</div>
|
||||
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span> </div>
|
||||
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T, qualifier Q></div>
|
||||
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  GLM_FUNC_DECL mat<4, 4, T, Q> <a class="code" href="a00222.html#gae2bdd91a76759fecfbaef97e3020aa8e">scaleBias</a>(mat<4, 4, T, Q> <span class="keyword">const</span>& m, T <a class="code" href="a00157.html#ga05051adbee603fb3c5095d8cf5cc229b">scale</a>, T bias);</div>
|
||||
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span> </div>
|
||||
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span> }<span class="comment">// namespace glm</span></div>
|
||||
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span> </div>
|
||||
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="preprocessor">#include "transform2.inl"</span></div>
|
||||
<div class="ttc" id="a00222_html_gaa2b7f4f15b98f697caede11bef50509e"><div class="ttname"><a href="a00222.html#gaa2b7f4f15b98f697caede11bef50509e">glm::proj3D</a></div><div class="ttdeci">GLM_FUNC_DECL mat< 4, 4, T, Q > proj3D(mat< 4, 4, T, Q > const &m, vec< 3, T, Q > const &normal)</div><div class="ttdoc">Build planar projection matrix along normal axis. </div></div>
|
||||
<div class="ttc" id="a00222_html_gabf714b8a358181572b32a45555f71948"><div class="ttname"><a href="a00222.html#gabf714b8a358181572b32a45555f71948">glm::shearX2D</a></div><div class="ttdeci">GLM_FUNC_DECL mat< 3, 3, T, Q > shearX2D(mat< 3, 3, T, Q > const &m, T y)</div><div class="ttdoc">Transforms a matrix with a shearing on X axis. </div></div>
|
||||
<div class="ttc" id="a00222_html_ga73e867c6cd4d700fe2054437e56106c4"><div class="ttname"><a href="a00222.html#ga73e867c6cd4d700fe2054437e56106c4">glm::shearX3D</a></div><div class="ttdeci">GLM_FUNC_DECL mat< 4, 4, T, Q > shearX3D(mat< 4, 4, T, Q > const &m, T y, T z)</div><div class="ttdoc">Transforms a matrix with a shearing on X axis From GLM_GTX_transform2 extension. </div></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="a00222_html_gae2bdd91a76759fecfbaef97e3020aa8e"><div class="ttname"><a href="a00222.html#gae2bdd91a76759fecfbaef97e3020aa8e">glm::scaleBias</a></div><div class="ttdeci">GLM_FUNC_DECL mat< 4, 4, T, Q > scaleBias(mat< 4, 4, T, Q > const &m, T scale, T bias)</div><div class="ttdoc">Build a scale bias matrix. </div></div>
|
||||
<div class="ttc" id="a00157_html_ga05051adbee603fb3c5095d8cf5cc229b"><div class="ttname"><a href="a00157.html#ga05051adbee603fb3c5095d8cf5cc229b">glm::scale</a></div><div class="ttdeci">GLM_FUNC_DECL mat< 4, 4, T, Q > scale(mat< 4, 4, T, Q > const &m, vec< 3, T, Q > const &v)</div><div class="ttdoc">Builds a scale 4 * 4 matrix created from 3 scalars. </div></div>
|
||||
<div class="ttc" id="a00222_html_gade5bb65ffcb513973db1a1314fb5cfac"><div class="ttname"><a href="a00222.html#gade5bb65ffcb513973db1a1314fb5cfac">glm::shearY3D</a></div><div class="ttdeci">GLM_FUNC_DECL mat< 4, 4, T, Q > shearY3D(mat< 4, 4, T, Q > const &m, T x, T z)</div><div class="ttdoc">Transforms a matrix with a shearing on Y axis. </div></div>
|
||||
<div class="ttc" id="a00222_html_ga5b992a0cdc8298054edb68e228f0d93e"><div class="ttname"><a href="a00222.html#ga5b992a0cdc8298054edb68e228f0d93e">glm::proj2D</a></div><div class="ttdeci">GLM_FUNC_DECL mat< 3, 3, T, Q > proj2D(mat< 3, 3, T, Q > const &m, vec< 3, T, Q > const &normal)</div><div class="ttdoc">Build planar projection matrix along normal axis. </div></div>
|
||||
<div class="ttc" id="a00222_html_gac7998d0763d9181550c77e8af09a182c"><div class="ttname"><a href="a00222.html#gac7998d0763d9181550c77e8af09a182c">glm::shearY2D</a></div><div class="ttdeci">GLM_FUNC_DECL mat< 3, 3, T, Q > shearY2D(mat< 3, 3, T, Q > const &m, T x)</div><div class="ttdoc">Transforms a matrix with a shearing on Y axis. </div></div>
|
||||
<div class="ttc" id="a00222_html_ga6591e0a3a9d2c9c0b6577bb4dace0255"><div class="ttname"><a href="a00222.html#ga6591e0a3a9d2c9c0b6577bb4dace0255">glm::shearZ3D</a></div><div class="ttdeci">GLM_FUNC_DECL mat< 4, 4, T, Q > shearZ3D(mat< 4, 4, T, Q > const &m, T x, T y)</div><div class="ttdoc">Transforms a matrix with a shearing on Z axis. </div></div>
|
||||
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor">#pragma once</span></div>
|
||||
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> </div>
|
||||
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment">// Dependency:</span></div>
|
||||
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#include "../glm.hpp"</span></div>
|
||||
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#include "../gtc/matrix_transform.hpp"</span></div>
|
||||
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> </div>
|
||||
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#ifndef GLM_ENABLE_EXPERIMENTAL</span></div>
|
||||
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor"># error "GLM: GLM_GTX_transform 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="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#endif</span></div>
|
||||
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> </div>
|
||||
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#if GLM_MESSAGES == GLM_MESSAGES_ENABLED && !defined(GLM_EXT_INCLUDED)</span></div>
|
||||
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor"># pragma message("GLM: GLM_GTX_transform extension included")</span></div>
|
||||
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#endif</span></div>
|
||||
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> </div>
|
||||
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="keyword">namespace </span><a class="code" href="a00138.html">glm</a></div>
|
||||
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> {</div>
|
||||
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div>
|
||||
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T, qualifier Q></div>
|
||||
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  GLM_FUNC_DECL mat<4, 4, T, Q> <a class="code" href="a00229.html#ga309a30e652e58c396e2c3d4db3ee7658">translate</a>(</div>
|
||||
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  vec<3, T, Q> <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="l00045"></a><span class="lineno"> 45</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T, qualifier Q></div>
|
||||
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  GLM_FUNC_DECL mat<4, 4, T, Q> <a class="code" href="a00229.html#gaf599be4c0e9d99be1f9cddba79b6018b">rotate</a>(</div>
|
||||
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  T <a class="code" href="a00166.html#gaaee6c856cae3217d274a240238cb6373">angle</a>,</div>
|
||||
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  vec<3, T, Q> <span class="keyword">const</span>& v);</div>
|
||||
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> </div>
|
||||
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T, qualifier Q></div>
|
||||
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  GLM_FUNC_DECL mat<4, 4, T, Q> <a class="code" href="a00229.html#gafbeefee8fec884d566e4ada0049174d7">scale</a>(</div>
|
||||
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  vec<3, T, Q> <span class="keyword">const</span>& v);</div>
|
||||
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> </div>
|
||||
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> }<span class="comment">// namespace glm</span></div>
|
||||
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> </div>
|
||||
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="preprocessor">#include "transform.inl"</span></div>
|
||||
<div class="ttc" id="a00166_html_gaaee6c856cae3217d274a240238cb6373"><div class="ttname"><a href="a00166.html#gaaee6c856cae3217d274a240238cb6373">glm::angle</a></div><div class="ttdeci">GLM_FUNC_DECL T angle(tquat< T, Q > const &x)</div><div class="ttdoc">Returns the quaternion rotation angle. </div></div>
|
||||
<div class="ttc" id="a00138_html"><div class="ttname"><a href="a00138.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="a00229_html_gaf599be4c0e9d99be1f9cddba79b6018b"><div class="ttname"><a href="a00229.html#gaf599be4c0e9d99be1f9cddba79b6018b">glm::rotate</a></div><div class="ttdeci">GLM_FUNC_DECL mat< 4, 4, T, Q > rotate(T angle, vec< 3, T, Q > const &v)</div><div class="ttdoc">Builds a rotation 4 * 4 matrix created from an axis of 3 scalars and an angle expressed in radians...</div></div>
|
||||
<div class="ttc" id="a00229_html_gafbeefee8fec884d566e4ada0049174d7"><div class="ttname"><a href="a00229.html#gafbeefee8fec884d566e4ada0049174d7">glm::scale</a></div><div class="ttdeci">GLM_FUNC_DECL mat< 4, 4, T, Q > scale(vec< 3, T, Q > const &v)</div><div class="ttdoc">Transforms a matrix with a scale 4 * 4 matrix created from a vector of 3 components. </div></div>
|
||||
<div class="ttc" id="a00229_html_ga309a30e652e58c396e2c3d4db3ee7658"><div class="ttname"><a href="a00229.html#ga309a30e652e58c396e2c3d4db3ee7658">glm::translate</a></div><div class="ttdeci">GLM_FUNC_DECL mat< 4, 4, T, Q > translate(vec< 3, T, Q > const &v)</div><div class="ttdoc">Transforms a matrix with a translation 4 * 4 matrix created from 3 scalars. </div></div>
|
||||
</div><!-- fragment --></div><!-- contents -->
|
||||
<!-- start footer part -->
|
||||
<hr class="footer"/><address class="footer"><small>
|
||||
|
||||
Reference in New Issue
Block a user