mewin/glm
1
0
Fork 0
Code Releases Activity

Updated doxygen API doc

Browse Source
This commit is contained in:
Christophe Riccio
2016-11-13 00:39:32 +01:00
parent 83d14ee411
commit d8ca117cb6
394 changed files with 48595 additions and 40958 deletions
Download Patch File Download Diff File Expand all files Collapse all files

85
doc/api/a00103_source.html
View File

@@ -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.8: std_based_type.hpp Source File</title>
<title>0.9.8 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>
@@ -18,7 +18,7 @@
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">0.9.8
<div id="projectname">0.9.8 API documenation
</div>
</td>
</tr>
@@ -41,56 +41,53 @@
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_275089585c7fc1b5fd5d7d42c69cb1da.html">D:</a></li><li class="navelem"><a class="el" href="dir_7b98f88bffbed4b390b5f8f520d9c08e.html">Source</a></li><li class="navelem"><a class="el" href="dir_1f76e953200861345293ade84ac7fb6c.html">G-Truc</a></li><li class="navelem"><a class="el" href="dir_e29b03b892e0e25920d021a614d4db9b.html">glm</a></li><li class="navelem"><a class="el" href="dir_5ce58d942b2d0776e17a9a58abc01e04.html">glm</a></li><li class="navelem"><a class="el" href="dir_8d176b5b7dd0ae42ea6876078f2bde49.html">gtx</a></li> </ul>
<li class="navelem"><a class="el" href="dir_934f46a345653ef2b3014a1b37a162c1.html">G:</a></li><li class="navelem"><a class="el" href="dir_98f7f9d41f9d3029bd68cf237526a774.html">Source</a></li><li class="navelem"><a class="el" href="dir_9344afb825aed5e2f5be1d2015dde43c.html">G-Truc</a></li><li class="navelem"><a class="el" href="dir_45973f864e07b2505003ae343b7c8af7.html">glm</a></li><li class="navelem"><a class="el" href="dir_304be5dfae1339a7705426c0b536faf2.html">glm</a></li><li class="navelem"><a class="el" href="dir_e8f3c1046ba4b357711397765359cd18.html">gtx</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">std_based_type.hpp</div> </div>
<div class="title">transform.hpp</div> </div>
</div><!--header-->
<div class="contents">
<a href="a00103.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;</div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="preprocessor">#pragma once</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;</div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment">// Dependency:</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="preprocessor">#include &quot;../glm.hpp&quot;</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="preprocessor">#include &lt;cstdlib&gt;</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;</div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="preprocessor">#if GLM_MESSAGES == GLM_MESSAGES_ENABLED &amp;&amp; !defined(GLM_EXT_INCLUDED)</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor"># pragma message(&quot;GLM: GLM_GTX_std_based_type extension included&quot;)</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;</div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="keyword">namespace </span><a class="code" href="a00141.html">glm</a></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;{</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;</div>
<div class="line"><a name="l00030"></a><span class="lineno"><a class="line" href="a00230.html#ga47c940f279a6b97ffc301eb4526a445a"> 30</a></span>&#160; <span class="keyword">typedef</span> tvec1&lt;std::size_t, defaultp&gt; <a class="code" href="a00230.html#ga47c940f279a6b97ffc301eb4526a445a">size1</a>;</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;</div>
<div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="a00230.html#gac0ef172641a1555684da0beb735c2a79"> 34</a></span>&#160; <span class="keyword">typedef</span> tvec2&lt;std::size_t, defaultp&gt; <a class="code" href="a00230.html#gac0ef172641a1555684da0beb735c2a79">size2</a>;</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;</div>
<div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="a00230.html#ga51b5e9650c459973134ffb4236ae88b6"> 38</a></span>&#160; <span class="keyword">typedef</span> tvec3&lt;std::size_t, defaultp&gt; <a class="code" href="a00230.html#ga51b5e9650c459973134ffb4236ae88b6">size3</a>;</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;</div>
<div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="a00230.html#gaf07a3f432e328c99d35637225c988121"> 42</a></span>&#160; <span class="keyword">typedef</span> tvec4&lt;std::size_t, defaultp&gt; <a class="code" href="a00230.html#gaf07a3f432e328c99d35637225c988121">size4</a>;</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;</div>
<div class="line"><a name="l00046"></a><span class="lineno"><a class="line" href="a00230.html#ga77d0b061efa41cb2ed2285d09294314e"> 46</a></span>&#160; <span class="keyword">typedef</span> tvec1&lt;std::size_t, defaultp&gt; <a class="code" href="a00230.html#ga77d0b061efa41cb2ed2285d09294314e">size1_t</a>;</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;</div>
<div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="a00230.html#gaa7d72bbe318d27da9d30f27095e4c75e"> 50</a></span>&#160; <span class="keyword">typedef</span> tvec2&lt;std::size_t, defaultp&gt; <a class="code" href="a00230.html#gaa7d72bbe318d27da9d30f27095e4c75e">size2_t</a>;</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;</div>
<div class="line"><a name="l00054"></a><span class="lineno"><a class="line" href="a00230.html#gad364e6c302642e3bb89d756df5d0c8c6"> 54</a></span>&#160; <span class="keyword">typedef</span> tvec3&lt;std::size_t, defaultp&gt; <a class="code" href="a00230.html#gad364e6c302642e3bb89d756df5d0c8c6">size3_t</a>;</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;</div>
<div class="line"><a name="l00058"></a><span class="lineno"><a class="line" href="a00230.html#ga06862b7d59094244025d34407b2cb796"> 58</a></span>&#160; <span class="keyword">typedef</span> tvec4&lt;std::size_t, defaultp&gt; <a class="code" href="a00230.html#ga06862b7d59094244025d34407b2cb796">size4_t</a>;</div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="preprocessor">#pragma once</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;</div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="comment">// Dependency:</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="preprocessor">#include &quot;../glm.hpp&quot;</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#include &quot;../gtc/matrix_transform.hpp&quot;</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;</div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="preprocessor">#ifndef GLM_ENABLE_EXPERIMENTAL</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="preprocessor"># error &quot;GLM: GLM_GTX_transform is an experimetal extension and may change in the future. Use #define GLM_ENABLE_EXPERIMENTAL before including it, if you really want to use it.&quot;</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="preprocessor">#if GLM_MESSAGES == GLM_MESSAGES_ENABLED &amp;&amp; !defined(GLM_EXT_INCLUDED)</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="preprocessor"># pragma message(&quot;GLM: GLM_GTX_transform extension included&quot;)</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="keyword">namespace </span><a class="code" href="a00140.html">glm</a></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;{</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, precision P&gt;</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; GLM_FUNC_DECL tmat4x4&lt;T, P&gt; <a class="code" href="a00229.html#ga838c4505ef7f254ed05117b1ac9691fb">translate</a>(</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; tvec3&lt;T, P&gt; <span class="keyword">const</span> &amp; v);</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, precision P&gt;</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; GLM_FUNC_DECL tmat4x4&lt;T, P&gt; <a class="code" href="a00229.html#ga2020c91bf61e050882b3a5c18eada700">rotate</a>(</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; T <a class="code" href="a00172.html#gad4a4448baedb198b2b1e7880d2544dc9">angle</a>, </div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; tvec3&lt;T, P&gt; <span class="keyword">const</span> &amp; v);</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, precision P&gt;</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; GLM_FUNC_DECL tmat4x4&lt;T, P&gt; <a class="code" href="a00229.html#ga1972d4a66a2e92637c8aaee598417a71">scale</a>(</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; tvec3&lt;T, P&gt; <span class="keyword">const</span> &amp; v);</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160;}<span class="comment">// namespace glm</span></div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160;}<span class="comment">//namespace glm</span></div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160;</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160;<span class="preprocessor">#include &quot;std_based_type.inl&quot;</span></div>
<div class="ttc" id="a00230_html_ga06862b7d59094244025d34407b2cb796"><div class="ttname"><a href="a00230.html#ga06862b7d59094244025d34407b2cb796">glm::size4_t</a></div><div class="ttdeci">tvec4&lt; std::size_t, defaultp &gt; size4_t</div><div class="ttdoc">Vector type based of four std::size_t components. </div><div class="ttdef"><b>Definition:</b> <a href="a00103_source.html#l00058">std_based_type.hpp:58</a></div></div>
<div class="ttc" id="a00230_html_gac0ef172641a1555684da0beb735c2a79"><div class="ttname"><a href="a00230.html#gac0ef172641a1555684da0beb735c2a79">glm::size2</a></div><div class="ttdeci">tvec2&lt; std::size_t, defaultp &gt; size2</div><div class="ttdoc">Vector type based of two std::size_t components. </div><div class="ttdef"><b>Definition:</b> <a href="a00103_source.html#l00034">std_based_type.hpp:34</a></div></div>
<div class="ttc" id="a00230_html_ga77d0b061efa41cb2ed2285d09294314e"><div class="ttname"><a href="a00230.html#ga77d0b061efa41cb2ed2285d09294314e">glm::size1_t</a></div><div class="ttdeci">tvec1&lt; std::size_t, defaultp &gt; size1_t</div><div class="ttdoc">Vector type based of one std::size_t component. </div><div class="ttdef"><b>Definition:</b> <a href="a00103_source.html#l00046">std_based_type.hpp:46</a></div></div>
<div class="ttc" id="a00141_html"><div class="ttname"><a href="a00141.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="a00230_html_ga47c940f279a6b97ffc301eb4526a445a"><div class="ttname"><a href="a00230.html#ga47c940f279a6b97ffc301eb4526a445a">glm::size1</a></div><div class="ttdeci">tvec1&lt; std::size_t, defaultp &gt; size1</div><div class="ttdoc">Vector type based of one std::size_t component. </div><div class="ttdef"><b>Definition:</b> <a href="a00103_source.html#l00030">std_based_type.hpp:30</a></div></div>
<div class="ttc" id="a00230_html_gaf07a3f432e328c99d35637225c988121"><div class="ttname"><a href="a00230.html#gaf07a3f432e328c99d35637225c988121">glm::size4</a></div><div class="ttdeci">tvec4&lt; std::size_t, defaultp &gt; size4</div><div class="ttdoc">Vector type based of four std::size_t components. </div><div class="ttdef"><b>Definition:</b> <a href="a00103_source.html#l00042">std_based_type.hpp:42</a></div></div>
<div class="ttc" id="a00230_html_ga51b5e9650c459973134ffb4236ae88b6"><div class="ttname"><a href="a00230.html#ga51b5e9650c459973134ffb4236ae88b6">glm::size3</a></div><div class="ttdeci">tvec3&lt; std::size_t, defaultp &gt; size3</div><div class="ttdoc">Vector type based of three std::size_t components. </div><div class="ttdef"><b>Definition:</b> <a href="a00103_source.html#l00038">std_based_type.hpp:38</a></div></div>
<div class="ttc" id="a00230_html_gaa7d72bbe318d27da9d30f27095e4c75e"><div class="ttname"><a href="a00230.html#gaa7d72bbe318d27da9d30f27095e4c75e">glm::size2_t</a></div><div class="ttdeci">tvec2&lt; std::size_t, defaultp &gt; size2_t</div><div class="ttdoc">Vector type based of two std::size_t components. </div><div class="ttdef"><b>Definition:</b> <a href="a00103_source.html#l00050">std_based_type.hpp:50</a></div></div>
<div class="ttc" id="a00230_html_gad364e6c302642e3bb89d756df5d0c8c6"><div class="ttname"><a href="a00230.html#gad364e6c302642e3bb89d756df5d0c8c6">glm::size3_t</a></div><div class="ttdeci">tvec3&lt; std::size_t, defaultp &gt; size3_t</div><div class="ttdoc">Vector type based of three std::size_t components. </div><div class="ttdef"><b>Definition:</b> <a href="a00103_source.html#l00054">std_based_type.hpp:54</a></div></div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160;<span class="preprocessor">#include &quot;transform.inl&quot;</span></div>
<div class="ttc" id="a00229_html_ga2020c91bf61e050882b3a5c18eada700"><div class="ttname"><a href="a00229.html#ga2020c91bf61e050882b3a5c18eada700">glm::rotate</a></div><div class="ttdeci">GLM_FUNC_DECL tmat4x4&lt; T, P &gt; rotate(T angle, tvec3&lt; T, P &gt; const &amp;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_ga1972d4a66a2e92637c8aaee598417a71"><div class="ttname"><a href="a00229.html#ga1972d4a66a2e92637c8aaee598417a71">glm::scale</a></div><div class="ttdeci">GLM_FUNC_DECL tmat4x4&lt; T, P &gt; scale(tvec3&lt; T, P &gt; const &amp;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_ga838c4505ef7f254ed05117b1ac9691fb"><div class="ttname"><a href="a00229.html#ga838c4505ef7f254ed05117b1ac9691fb">glm::translate</a></div><div class="ttdeci">GLM_FUNC_DECL tmat4x4&lt; T, P &gt; translate(tvec3&lt; T, P &gt; const &amp;v)</div><div class="ttdoc">Transforms a matrix with a translation 4 * 4 matrix created from 3 scalars. </div></div>
<div class="ttc" id="a00140_html"><div class="ttname"><a href="a00140.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="a00172_html_gad4a4448baedb198b2b1e7880d2544dc9"><div class="ttname"><a href="a00172.html#gad4a4448baedb198b2b1e7880d2544dc9">glm::angle</a></div><div class="ttdeci">GLM_FUNC_DECL T angle(tquat&lt; T, P &gt; const &amp;x)</div><div class="ttdoc">Returns the quaternion rotation angle. </div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>