Updated API doc

This commit is contained in:
Christophe Riccio
2017-08-17 19:53:21 +02:00
parent e9f210c85f
commit 8a8a6c2b76
474 changed files with 68476 additions and 69444 deletions

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.9 API documenation: integer.hpp Source File</title>
<title>0.9.9 API documenation: mat2x3.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>
@@ -79,58 +79,37 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<div id="nav-path" class="navpath">
<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_7997edb062bdde9a99cb6835d42b0d9d.html">gtc</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> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">gtc/integer.hpp</div> </div>
<div class="title">mat2x3.hpp</div> </div>
</div><!--header-->
<div class="contents">
<a href="a00047.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="l00014"></a><span class="lineno"> 14</span>&#160;<span class="preprocessor">#pragma once</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;</div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment">// Dependencies</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="preprocessor">#include &quot;../detail/setup.hpp&quot;</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="preprocessor">#include &quot;../detail/qualifier.hpp&quot;</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="preprocessor">#include &quot;../detail/func_common.hpp&quot;</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#include &quot;../detail/func_integer.hpp&quot;</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="preprocessor">#include &quot;../detail/func_exponential.hpp&quot;</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="preprocessor">#include &lt;limits&gt;</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;</div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="preprocessor">#if GLM_MESSAGES == GLM_MESSAGES_ENABLED &amp;&amp; !defined(GLM_EXT_INCLUDED)</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="preprocessor"># pragma message(&quot;GLM: GLM_GTC_integer extension included&quot;)</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<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>&#160;{</div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="a00094.html">detail/setup.hpp</a>&quot;</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;</div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="preprocessor">#pragma once</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;</div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="a00109.html">detail/type_mat2x3.hpp</a>&quot;</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;</div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="keyword">namespace </span><a class="code" href="a00135.html">glm</a></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;{</div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160; <span class="keyword">typedef</span> mat&lt;2, 3, float, lowp&gt; <a class="code" href="a00145.html#ga083089177b89ae9166d8d251a90f4b8b">lowp_mat2x3</a>;</div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;</div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; <span class="keyword">typedef</span> mat&lt;2, 3, float, mediump&gt; <a class="code" href="a00145.html#ga0bda8ba50fa930ef29d4fa91a85f229a">mediump_mat2x3</a>;</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; <span class="keyword">typedef</span> mat&lt;2, 3, float, highp&gt; <a class="code" href="a00145.html#ga441b8e3402eefca108b40f3d22a1baa9">highp_mat2x3</a>;</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> genIUType&gt;</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; GLM_FUNC_DECL genIUType <a class="code" href="a00167.html#ga9bd682e74bfacb005c735305207ec417">log2</a>(genIUType x);</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> genIUType&gt;</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; GLM_FUNC_DECL genIUType <a class="code" href="a00167.html#ga75c6fd2a143fc44e5f7b871abad539e0">mod</a>(genIUType x, genIUType y);</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; <span class="keyword">template</span>&lt;length_t L, <span class="keyword">typename</span> T, qualifier P&gt;</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; GLM_FUNC_DECL vec&lt;L, T, P&gt; <a class="code" href="a00167.html#ga75c6fd2a143fc44e5f7b871abad539e0">mod</a>(vec&lt;L, T, P&gt; <span class="keyword">const</span>&amp; x, T y);</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; <span class="keyword">template</span>&lt;length_t L, <span class="keyword">typename</span> T, qualifier P&gt;</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; GLM_FUNC_DECL vec&lt;L, T, P&gt; <a class="code" href="a00167.html#ga75c6fd2a143fc44e5f7b871abad539e0">mod</a>(vec&lt;L, T, P&gt; <span class="keyword">const</span>&amp; x, vec&lt;L, T, P&gt; <span class="keyword">const</span>&amp; y);</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160;</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; <span class="keyword">template</span>&lt;length_t L, <span class="keyword">typename</span> T, qualifier P&gt;</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; GLM_FUNC_DECL vec&lt;L, int, P&gt; <a class="code" href="a00167.html#gac8ed39459ac0506ff45c633d5ce481e5">iround</a>(vec&lt;L, T, P&gt; <span class="keyword">const</span>&amp; x);</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160;</div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; <span class="keyword">template</span>&lt;length_t L, <span class="keyword">typename</span> T, qualifier P&gt;</div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160; GLM_FUNC_DECL vec&lt;L, uint, P&gt; <a class="code" href="a00167.html#gafd8a7555520f33fa102cbdad46d6bbac">uround</a>(vec&lt;L, T, P&gt; <span class="keyword">const</span>&amp; x);</div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160;</div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160;} <span class="comment">//namespace glm</span></div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160;</div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160;<span class="preprocessor">#include &quot;integer.inl&quot;</span></div>
<div class="ttc" id="a00167_html_ga9bd682e74bfacb005c735305207ec417"><div class="ttname"><a href="a00167.html#ga9bd682e74bfacb005c735305207ec417">glm::log2</a></div><div class="ttdeci">GLM_FUNC_DECL genIUType log2(genIUType x)</div><div class="ttdoc">Returns the log2 of x for integer values. </div></div>
<div class="ttc" id="a00167_html_gafd8a7555520f33fa102cbdad46d6bbac"><div class="ttname"><a href="a00167.html#gafd8a7555520f33fa102cbdad46d6bbac">glm::uround</a></div><div class="ttdeci">GLM_FUNC_DECL vec&lt; L, uint, P &gt; uround(vec&lt; L, T, P &gt; const &amp;x)</div><div class="ttdoc">Returns a value equal to the nearest integer to x. </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="a00167_html_gac8ed39459ac0506ff45c633d5ce481e5"><div class="ttname"><a href="a00167.html#gac8ed39459ac0506ff45c633d5ce481e5">glm::iround</a></div><div class="ttdeci">GLM_FUNC_DECL vec&lt; L, int, P &gt; iround(vec&lt; L, T, P &gt; const &amp;x)</div><div class="ttdoc">Returns a value equal to the nearest integer to x. </div></div>
<div class="ttc" id="a00167_html_ga75c6fd2a143fc44e5f7b871abad539e0"><div class="ttname"><a href="a00167.html#ga75c6fd2a143fc44e5f7b871abad539e0">glm::mod</a></div><div class="ttdeci">GLM_FUNC_DECL genIUType mod(genIUType x, genIUType y)</div><div class="ttdoc">Modulus. </div></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;}<span class="comment">//namespace glm</span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;</div>
<div class="ttc" id="a00145_html_ga0bda8ba50fa930ef29d4fa91a85f229a"><div class="ttname"><a href="a00145.html#ga0bda8ba50fa930ef29d4fa91a85f229a">glm::mediump_mat2x3</a></div><div class="ttdeci">mat&lt; 2, 3, float, mediump &gt; mediump_mat2x3</div><div class="ttdoc">2 columns of 3 components matrix of medium qualifier floating-point numbers. </div><div class="ttdef"><b>Definition:</b> <a href="a00107_source.html#l00092">type_mat.hpp:92</a></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="a00109_html"><div class="ttname"><a href="a00109.html">type_mat2x3.hpp</a></div><div class="ttdoc">Core features </div></div>
<div class="ttc" id="a00145_html_ga441b8e3402eefca108b40f3d22a1baa9"><div class="ttname"><a href="a00145.html#ga441b8e3402eefca108b40f3d22a1baa9">glm::highp_mat2x3</a></div><div class="ttdeci">mat&lt; 2, 3, float, highp &gt; highp_mat2x3</div><div class="ttdoc">2 columns of 3 components matrix of high qualifier floating-point numbers. </div><div class="ttdef"><b>Definition:</b> <a href="a00107_source.html#l00099">type_mat.hpp:99</a></div></div>
<div class="ttc" id="a00145_html_ga083089177b89ae9166d8d251a90f4b8b"><div class="ttname"><a href="a00145.html#ga083089177b89ae9166d8d251a90f4b8b">glm::lowp_mat2x3</a></div><div class="ttdeci">mat&lt; 2, 3, float, lowp &gt; lowp_mat2x3</div><div class="ttdoc">2 columns of 3 components matrix of low qualifier floating-point numbers. </div><div class="ttdef"><b>Definition:</b> <a href="a00107_source.html#l00085">type_mat.hpp:85</a></div></div>
<div class="ttc" id="a00094_html"><div class="ttname"><a href="a00094.html">setup.hpp</a></div><div class="ttdoc">Core features </div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>