glm/doc/api/a00099_source.html
Christophe Riccio a7b72ec5b2 Updated API doc
2017-08-15 21:22:51 +02:00

180 lines
20 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<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: round.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>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">0.9.9 API documenation
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.10 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File&#160;List</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<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>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">round.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>&#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/_vectorize.hpp&quot;</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#include &quot;../vector_relational.hpp&quot;</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="preprocessor">#include &quot;../common.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="l00032"></a><span class="lineno"> 32</span>&#160;</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> genIUType&gt;</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; GLM_FUNC_DECL <span class="keywordtype">bool</span> <a class="code" href="a00177.html#ga54a1f4178f145dc57239732473421f2c">isPowerOfTwo</a>(genIUType Value);</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</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="l00043"></a><span class="lineno"> 43</span>&#160; GLM_FUNC_DECL vec&lt;L, bool, P&gt; <a class="code" href="a00177.html#ga54a1f4178f145dc57239732473421f2c">isPowerOfTwo</a>(vec&lt;L, T, P&gt; <span class="keyword">const</span>&amp; value);</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> genIUType&gt;</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; GLM_FUNC_DECL genIUType <a class="code" href="a00177.html#gab96d6621f379126ac9e94619d72fb3c2">ceilPowerOfTwo</a>(genIUType Value);</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</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="l00057"></a><span class="lineno"> 57</span>&#160; GLM_FUNC_DECL vec&lt;L, T, P&gt; <a class="code" href="a00177.html#gab96d6621f379126ac9e94619d72fb3c2">ceilPowerOfTwo</a>(vec&lt;L, T, P&gt; <span class="keyword">const</span>&amp; value);</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160;</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> genIUType&gt;</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; GLM_FUNC_DECL genIUType <a class="code" href="a00177.html#gadcd07cdcbd366b917d147073633b0094">floorPowerOfTwo</a>(genIUType Value);</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160;</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</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="l00071"></a><span class="lineno"> 71</span>&#160; GLM_FUNC_DECL vec&lt;L, T, P&gt; <a class="code" href="a00177.html#gadcd07cdcbd366b917d147073633b0094">floorPowerOfTwo</a>(vec&lt;L, T, P&gt; <span class="keyword">const</span>&amp; value);</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160;</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> genIUType&gt;</div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; GLM_FUNC_DECL genIUType <a class="code" href="a00177.html#ga74eabb74ece6a03e9c0347a1cf6a045d">roundPowerOfTwo</a>(genIUType Value);</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160;</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</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="l00083"></a><span class="lineno"> 83</span>&#160; GLM_FUNC_DECL vec&lt;L, T, P&gt; <a class="code" href="a00177.html#ga74eabb74ece6a03e9c0347a1cf6a045d">roundPowerOfTwo</a>(vec&lt;L, T, P&gt; <span class="keyword">const</span>&amp; value);</div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160;</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> genIUType&gt;</div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; GLM_FUNC_DECL <span class="keywordtype">bool</span> <a class="code" href="a00177.html#gac8f2fac09b70d2132d83c9026ce8a1c4">isMultiple</a>(genIUType Value, genIUType Multiple);</div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160;</div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</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="l00095"></a><span class="lineno"> 95</span>&#160; GLM_FUNC_DECL vec&lt;L, bool, P&gt; <a class="code" href="a00177.html#gac8f2fac09b70d2132d83c9026ce8a1c4">isMultiple</a>(vec&lt;L, T, P&gt; <span class="keyword">const</span>&amp; Value, T Multiple);</div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160;</div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</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="l00101"></a><span class="lineno"> 101</span>&#160; GLM_FUNC_DECL vec&lt;L, bool, P&gt; <a class="code" href="a00177.html#gac8f2fac09b70d2132d83c9026ce8a1c4">isMultiple</a>(vec&lt;L, T, P&gt; <span class="keyword">const</span>&amp; Value, vec&lt;L, T, P&gt; <span class="keyword">const</span>&amp; Multiple);</div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160;</div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> genType&gt;</div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160; GLM_FUNC_DECL genType <a class="code" href="a00177.html#gad45973192fb6a37fc2ac4a4d11f50ed7">ceilMultiple</a>(genType Source, genType Multiple);</div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160;</div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</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="l00119"></a><span class="lineno"> 119</span>&#160; GLM_FUNC_DECL vec&lt;L, T, P&gt; <a class="code" href="a00177.html#gad45973192fb6a37fc2ac4a4d11f50ed7">ceilMultiple</a>(vec&lt;L, T, P&gt; <span class="keyword">const</span> &amp; Source, vec&lt;L, T, P&gt; <span class="keyword">const</span>&amp; Multiple);</div>
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span>&#160;</div>
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> genType&gt;</div>
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span>&#160; GLM_FUNC_DECL genType <a class="code" href="a00177.html#ga82343a05a66184e3a2e33f514e5980c9">floorMultiple</a>(genType Source, genType Multiple);</div>
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span>&#160;</div>
<div class="line"><a name="l00136"></a><span class="lineno"> 136</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="l00137"></a><span class="lineno"> 137</span>&#160; GLM_FUNC_DECL vec&lt;L, T, P&gt; <a class="code" href="a00177.html#ga82343a05a66184e3a2e33f514e5980c9">floorMultiple</a>(vec&lt;L, T, P&gt; <span class="keyword">const</span>&amp; Source, vec&lt;L, T, P&gt; <span class="keyword">const</span>&amp; Multiple);</div>
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span>&#160;</div>
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> genType&gt;</div>
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span>&#160; GLM_FUNC_DECL genType <a class="code" href="a00177.html#ga60f4ac8add99642616c4c49f128bd718">roundMultiple</a>(genType Source, genType Multiple);</div>
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span>&#160;</div>
<div class="line"><a name="l00154"></a><span class="lineno"> 154</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="l00155"></a><span class="lineno"> 155</span>&#160; GLM_FUNC_DECL vec&lt;L, T, P&gt; <a class="code" href="a00177.html#ga60f4ac8add99642616c4c49f128bd718">roundMultiple</a>(vec&lt;L, T, P&gt; <span class="keyword">const</span>&amp; Source, vec&lt;L, T, P&gt; <span class="keyword">const</span>&amp; Multiple);</div>
<div class="line"><a name="l00156"></a><span class="lineno"> 156</span>&#160;</div>
<div class="line"><a name="l00158"></a><span class="lineno"> 158</span>&#160;} <span class="comment">//namespace glm</span></div>
<div class="line"><a name="l00159"></a><span class="lineno"> 159</span>&#160;</div>
<div class="line"><a name="l00160"></a><span class="lineno"> 160</span>&#160;<span class="preprocessor">#include &quot;round.inl&quot;</span></div>
<div class="ttc" id="a00177_html_gad45973192fb6a37fc2ac4a4d11f50ed7"><div class="ttname"><a href="a00177.html#gad45973192fb6a37fc2ac4a4d11f50ed7">glm::ceilMultiple</a></div><div class="ttdeci">GLM_FUNC_DECL vec&lt; L, T, P &gt; ceilMultiple(vec&lt; L, T, P &gt; const &amp;Source, vec&lt; L, T, P &gt; const &amp;Multiple)</div><div class="ttdoc">Higher multiple number of Source. </div></div>
<div class="ttc" id="a00177_html_gac8f2fac09b70d2132d83c9026ce8a1c4"><div class="ttname"><a href="a00177.html#gac8f2fac09b70d2132d83c9026ce8a1c4">glm::isMultiple</a></div><div class="ttdeci">GLM_FUNC_DECL vec&lt; L, bool, P &gt; isMultiple(vec&lt; L, T, P &gt; const &amp;Value, vec&lt; L, T, P &gt; const &amp;Multiple)</div><div class="ttdoc">Return true if the &#39;Value&#39; is a multiple of &#39;Multiple&#39;. </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="a00177_html_ga54a1f4178f145dc57239732473421f2c"><div class="ttname"><a href="a00177.html#ga54a1f4178f145dc57239732473421f2c">glm::isPowerOfTwo</a></div><div class="ttdeci">GLM_FUNC_DECL vec&lt; L, bool, P &gt; isPowerOfTwo(vec&lt; L, T, P &gt; const &amp;value)</div><div class="ttdoc">Return true if the value is a power of two number. </div></div>
<div class="ttc" id="a00177_html_gab96d6621f379126ac9e94619d72fb3c2"><div class="ttname"><a href="a00177.html#gab96d6621f379126ac9e94619d72fb3c2">glm::ceilPowerOfTwo</a></div><div class="ttdeci">GLM_FUNC_DECL vec&lt; L, T, P &gt; ceilPowerOfTwo(vec&lt; L, T, P &gt; const &amp;value)</div><div class="ttdoc">Return the power of two number which value is just higher the input value, round up to a power of two...</div></div>
<div class="ttc" id="a00177_html_ga74eabb74ece6a03e9c0347a1cf6a045d"><div class="ttname"><a href="a00177.html#ga74eabb74ece6a03e9c0347a1cf6a045d">glm::roundPowerOfTwo</a></div><div class="ttdeci">GLM_FUNC_DECL vec&lt; L, T, P &gt; roundPowerOfTwo(vec&lt; L, T, P &gt; const &amp;value)</div><div class="ttdoc">Return the power of two number which value is the closet to the input value. </div></div>
<div class="ttc" id="a00177_html_ga60f4ac8add99642616c4c49f128bd718"><div class="ttname"><a href="a00177.html#ga60f4ac8add99642616c4c49f128bd718">glm::roundMultiple</a></div><div class="ttdeci">GLM_FUNC_DECL vec&lt; L, T, P &gt; roundMultiple(vec&lt; L, T, P &gt; const &amp;Source, vec&lt; L, T, P &gt; const &amp;Multiple)</div><div class="ttdoc">Lower multiple number of Source. </div></div>
<div class="ttc" id="a00177_html_ga82343a05a66184e3a2e33f514e5980c9"><div class="ttname"><a href="a00177.html#ga82343a05a66184e3a2e33f514e5980c9">glm::floorMultiple</a></div><div class="ttdeci">GLM_FUNC_DECL vec&lt; L, T, P &gt; floorMultiple(vec&lt; L, T, P &gt; const &amp;Source, vec&lt; L, T, P &gt; const &amp;Multiple)</div><div class="ttdoc">Lower multiple number of Source. </div></div>
<div class="ttc" id="a00177_html_gadcd07cdcbd366b917d147073633b0094"><div class="ttname"><a href="a00177.html#gadcd07cdcbd366b917d147073633b0094">glm::floorPowerOfTwo</a></div><div class="ttdeci">GLM_FUNC_DECL vec&lt; L, T, P &gt; floorPowerOfTwo(vec&lt; L, T, P &gt; const &amp;value)</div><div class="ttdoc">Return the power of two number which value is just lower the input value, round down to a power of tw...</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.10
</small></address>
</body>
</html>