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: GLM_GTC_color_space</title>
<title>0.9.9 API documenation: GLM_GTC_round</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>
@@ -77,71 +77,103 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">GLM_GTC_color_space<div class="ingroups"><a class="el" href="a00156.html">GTC Extensions (Stable)</a></div></div> </div>
<div class="title">GLM_GTC_round<div class="ingroups"><a class="el" href="a00147.html">Stable extensions</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Allow to perform bit operations on integer values.
<p>Include &lt;<a class="el" href="a00091.html" title="GLM_GTC_round ">glm/gtc/round.hpp</a>&gt; to use the features of this extension.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gaee73ec7f5015b5d72887e84fb811a92a"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier P&gt; </td></tr>
<tr class="memitem:gaee73ec7f5015b5d72887e84fb811a92a"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec&lt; L, T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00163.html#gaee73ec7f5015b5d72887e84fb811a92a">convertLinearToSRGB</a> (vec&lt; L, T, P &gt; const &amp;ColorLinear)</td></tr>
<tr class="memdesc:gaee73ec7f5015b5d72887e84fb811a92a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convert a linear color to sRGB color using a standard gamma correction. <a href="a00163.html#gaee73ec7f5015b5d72887e84fb811a92a">More...</a><br /></td></tr>
<tr class="separator:gaee73ec7f5015b5d72887e84fb811a92a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga403a403dcb7fdf9c38d72c7df4e235cd"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier P&gt; </td></tr>
<tr class="memitem:ga403a403dcb7fdf9c38d72c7df4e235cd"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec&lt; L, T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00163.html#ga403a403dcb7fdf9c38d72c7df4e235cd">convertLinearToSRGB</a> (vec&lt; L, T, P &gt; const &amp;ColorLinear, T Gamma)</td></tr>
<tr class="memdesc:ga403a403dcb7fdf9c38d72c7df4e235cd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convert a linear color to sRGB color using a custom gamma correction. <a href="a00163.html#ga403a403dcb7fdf9c38d72c7df4e235cd">More...</a><br /></td></tr>
<tr class="separator:ga403a403dcb7fdf9c38d72c7df4e235cd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga660e6e26316f2b28fe23076ff07f8ceb"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier P&gt; </td></tr>
<tr class="memitem:ga660e6e26316f2b28fe23076ff07f8ceb"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec&lt; L, T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00163.html#ga660e6e26316f2b28fe23076ff07f8ceb">convertSRGBToLinear</a> (vec&lt; L, T, P &gt; const &amp;ColorSRGB)</td></tr>
<tr class="memdesc:ga660e6e26316f2b28fe23076ff07f8ceb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convert a sRGB color to linear color using a standard gamma correction. <a href="a00163.html#ga660e6e26316f2b28fe23076ff07f8ceb">More...</a><br /></td></tr>
<tr class="separator:ga660e6e26316f2b28fe23076ff07f8ceb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf9c2b6145d4825f98e40f649619379f1"><td class="memTemplParams" colspan="2"><a class="anchor" id="gaf9c2b6145d4825f98e40f649619379f1"></a>
template&lt;length_t L, typename T , qualifier P&gt; </td></tr>
<tr class="memitem:gaf9c2b6145d4825f98e40f649619379f1"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec&lt; L, T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00163.html#gaf9c2b6145d4825f98e40f649619379f1">convertSRGBToLinear</a> (vec&lt; L, T, P &gt; const &amp;ColorSRGB, T Gamma)</td></tr>
<tr class="memdesc:gaf9c2b6145d4825f98e40f649619379f1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convert a sRGB color to linear color using a custom gamma correction. <br /></td></tr>
<tr class="separator:gaf9c2b6145d4825f98e40f649619379f1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac84898c466e609cdd2e81d9ba907d9e8"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr class="memitem:gac84898c466e609cdd2e81d9ba907d9e8"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00163.html#gac84898c466e609cdd2e81d9ba907d9e8">ceilMultiple</a> (genType Source, genType Multiple)</td></tr>
<tr class="memdesc:gac84898c466e609cdd2e81d9ba907d9e8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Higher multiple number of Source. <a href="a00163.html#gac84898c466e609cdd2e81d9ba907d9e8">More...</a><br /></td></tr>
<tr class="separator:gac84898c466e609cdd2e81d9ba907d9e8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga073227936f36f9102cd3a8aa45871b26"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier Q&gt; </td></tr>
<tr class="memitem:ga073227936f36f9102cd3a8aa45871b26"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec&lt; L, T, Q &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00163.html#ga073227936f36f9102cd3a8aa45871b26">ceilMultiple</a> (vec&lt; L, T, Q &gt; const &amp;Source, vec&lt; L, T, Q &gt; const &amp;Multiple)</td></tr>
<tr class="memdesc:ga073227936f36f9102cd3a8aa45871b26"><td class="mdescLeft">&#160;</td><td class="mdescRight">Higher multiple number of Source. <a href="a00163.html#ga073227936f36f9102cd3a8aa45871b26">More...</a><br /></td></tr>
<tr class="separator:ga073227936f36f9102cd3a8aa45871b26"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa73c7690c787086fa3ac1c312264acab"><td class="memTemplParams" colspan="2">template&lt;typename genIUType &gt; </td></tr>
<tr class="memitem:gaa73c7690c787086fa3ac1c312264acab"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genIUType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00163.html#gaa73c7690c787086fa3ac1c312264acab">ceilPowerOfTwo</a> (genIUType Value)</td></tr>
<tr class="memdesc:gaa73c7690c787086fa3ac1c312264acab"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the power of two number which value is just higher the input value, round up to a power of two. <a href="a00163.html#gaa73c7690c787086fa3ac1c312264acab">More...</a><br /></td></tr>
<tr class="separator:gaa73c7690c787086fa3ac1c312264acab"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac46c061058771cb31c467ef673d12c80"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier Q&gt; </td></tr>
<tr class="memitem:gac46c061058771cb31c467ef673d12c80"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec&lt; L, T, Q &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00163.html#gac46c061058771cb31c467ef673d12c80">ceilPowerOfTwo</a> (vec&lt; L, T, Q &gt; const &amp;value)</td></tr>
<tr class="memdesc:gac46c061058771cb31c467ef673d12c80"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the power of two number which value is just higher the input value, round up to a power of two. <a href="a00163.html#gac46c061058771cb31c467ef673d12c80">More...</a><br /></td></tr>
<tr class="separator:gac46c061058771cb31c467ef673d12c80"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9eafb9dbedf84e5cece65c2fe9d5631d"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr class="memitem:ga9eafb9dbedf84e5cece65c2fe9d5631d"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00163.html#ga9eafb9dbedf84e5cece65c2fe9d5631d">floorMultiple</a> (genType Source, genType Multiple)</td></tr>
<tr class="memdesc:ga9eafb9dbedf84e5cece65c2fe9d5631d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Lower multiple number of Source. <a href="a00163.html#ga9eafb9dbedf84e5cece65c2fe9d5631d">More...</a><br /></td></tr>
<tr class="separator:ga9eafb9dbedf84e5cece65c2fe9d5631d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2b6d6bcdf0641b54cb539104c224885b"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier Q&gt; </td></tr>
<tr class="memitem:ga2b6d6bcdf0641b54cb539104c224885b"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec&lt; L, T, Q &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00163.html#ga2b6d6bcdf0641b54cb539104c224885b">floorMultiple</a> (vec&lt; L, T, Q &gt; const &amp;Source, vec&lt; L, T, Q &gt; const &amp;Multiple)</td></tr>
<tr class="memdesc:ga2b6d6bcdf0641b54cb539104c224885b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Lower multiple number of Source. <a href="a00163.html#ga2b6d6bcdf0641b54cb539104c224885b">More...</a><br /></td></tr>
<tr class="separator:ga2b6d6bcdf0641b54cb539104c224885b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac80f6519c31baae10d8d7bea6735d1fa"><td class="memTemplParams" colspan="2">template&lt;typename genIUType &gt; </td></tr>
<tr class="memitem:gac80f6519c31baae10d8d7bea6735d1fa"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genIUType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00163.html#gac80f6519c31baae10d8d7bea6735d1fa">floorPowerOfTwo</a> (genIUType Value)</td></tr>
<tr class="memdesc:gac80f6519c31baae10d8d7bea6735d1fa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the power of two number which value is just lower the input value, round down to a power of two. <a href="a00163.html#gac80f6519c31baae10d8d7bea6735d1fa">More...</a><br /></td></tr>
<tr class="separator:gac80f6519c31baae10d8d7bea6735d1fa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6ebfea889605abf6629c7589e0cb2e28"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier Q&gt; </td></tr>
<tr class="memitem:ga6ebfea889605abf6629c7589e0cb2e28"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec&lt; L, T, Q &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00163.html#ga6ebfea889605abf6629c7589e0cb2e28">floorPowerOfTwo</a> (vec&lt; L, T, Q &gt; const &amp;value)</td></tr>
<tr class="memdesc:ga6ebfea889605abf6629c7589e0cb2e28"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the power of two number which value is just lower the input value, round down to a power of two. <a href="a00163.html#ga6ebfea889605abf6629c7589e0cb2e28">More...</a><br /></td></tr>
<tr class="separator:ga6ebfea889605abf6629c7589e0cb2e28"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf7444a7b2eb524f373463ceba76b9326"><td class="memTemplParams" colspan="2">template&lt;typename genIUType &gt; </td></tr>
<tr class="memitem:gaf7444a7b2eb524f373463ceba76b9326"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00163.html#gaf7444a7b2eb524f373463ceba76b9326">isMultiple</a> (genIUType Value, genIUType Multiple)</td></tr>
<tr class="memdesc:gaf7444a7b2eb524f373463ceba76b9326"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return true if the 'Value' is a multiple of 'Multiple'. <a href="a00163.html#gaf7444a7b2eb524f373463ceba76b9326">More...</a><br /></td></tr>
<tr class="separator:gaf7444a7b2eb524f373463ceba76b9326"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga908a61945ecb235817a9a87b249d4b2d"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier Q&gt; </td></tr>
<tr class="memitem:ga908a61945ecb235817a9a87b249d4b2d"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec&lt; L, bool, Q &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00163.html#ga908a61945ecb235817a9a87b249d4b2d">isMultiple</a> (vec&lt; L, T, Q &gt; const &amp;Value, T Multiple)</td></tr>
<tr class="memdesc:ga908a61945ecb235817a9a87b249d4b2d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return true if the 'Value' is a multiple of 'Multiple'. <a href="a00163.html#ga908a61945ecb235817a9a87b249d4b2d">More...</a><br /></td></tr>
<tr class="separator:ga908a61945ecb235817a9a87b249d4b2d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga12b5f07c3ed46acc6838f159ca6ef368"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier Q&gt; </td></tr>
<tr class="memitem:ga12b5f07c3ed46acc6838f159ca6ef368"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec&lt; L, bool, Q &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00163.html#ga12b5f07c3ed46acc6838f159ca6ef368">isMultiple</a> (vec&lt; L, T, Q &gt; const &amp;Value, vec&lt; L, T, Q &gt; const &amp;Multiple)</td></tr>
<tr class="memdesc:ga12b5f07c3ed46acc6838f159ca6ef368"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return true if the 'Value' is a multiple of 'Multiple'. <a href="a00163.html#ga12b5f07c3ed46acc6838f159ca6ef368">More...</a><br /></td></tr>
<tr class="separator:ga12b5f07c3ed46acc6838f159ca6ef368"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaebf826fbb6e0a70eeaab0792d89b25ec"><td class="memTemplParams" colspan="2">template&lt;typename genIUType &gt; </td></tr>
<tr class="memitem:gaebf826fbb6e0a70eeaab0792d89b25ec"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00163.html#gaebf826fbb6e0a70eeaab0792d89b25ec">isPowerOfTwo</a> (genIUType Value)</td></tr>
<tr class="memdesc:gaebf826fbb6e0a70eeaab0792d89b25ec"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return true if the value is a power of two number. <a href="a00163.html#gaebf826fbb6e0a70eeaab0792d89b25ec">More...</a><br /></td></tr>
<tr class="separator:gaebf826fbb6e0a70eeaab0792d89b25ec"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga866a7bbd725d7d40b5d433d02bf70f17"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier Q&gt; </td></tr>
<tr class="memitem:ga866a7bbd725d7d40b5d433d02bf70f17"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec&lt; L, bool, Q &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00163.html#ga866a7bbd725d7d40b5d433d02bf70f17">isPowerOfTwo</a> (vec&lt; L, T, Q &gt; const &amp;value)</td></tr>
<tr class="memdesc:ga866a7bbd725d7d40b5d433d02bf70f17"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return true if the value is a power of two number. <a href="a00163.html#ga866a7bbd725d7d40b5d433d02bf70f17">More...</a><br /></td></tr>
<tr class="separator:ga866a7bbd725d7d40b5d433d02bf70f17"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6739d1de04b2cea7c78675b365644bce"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr class="memitem:ga6739d1de04b2cea7c78675b365644bce"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00163.html#ga6739d1de04b2cea7c78675b365644bce">roundMultiple</a> (genType Source, genType Multiple)</td></tr>
<tr class="memdesc:ga6739d1de04b2cea7c78675b365644bce"><td class="mdescLeft">&#160;</td><td class="mdescRight">Lower multiple number of Source. <a href="a00163.html#ga6739d1de04b2cea7c78675b365644bce">More...</a><br /></td></tr>
<tr class="separator:ga6739d1de04b2cea7c78675b365644bce"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga812d27fa1a60c48dc111d67da26b1455"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier Q&gt; </td></tr>
<tr class="memitem:ga812d27fa1a60c48dc111d67da26b1455"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec&lt; L, T, Q &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00163.html#ga812d27fa1a60c48dc111d67da26b1455">roundMultiple</a> (vec&lt; L, T, Q &gt; const &amp;Source, vec&lt; L, T, Q &gt; const &amp;Multiple)</td></tr>
<tr class="memdesc:ga812d27fa1a60c48dc111d67da26b1455"><td class="mdescLeft">&#160;</td><td class="mdescRight">Lower multiple number of Source. <a href="a00163.html#ga812d27fa1a60c48dc111d67da26b1455">More...</a><br /></td></tr>
<tr class="separator:ga812d27fa1a60c48dc111d67da26b1455"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6d24a9e3abe3e6a908661b43acb8efe0"><td class="memTemplParams" colspan="2">template&lt;typename genIUType &gt; </td></tr>
<tr class="memitem:ga6d24a9e3abe3e6a908661b43acb8efe0"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genIUType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00163.html#ga6d24a9e3abe3e6a908661b43acb8efe0">roundPowerOfTwo</a> (genIUType Value)</td></tr>
<tr class="memdesc:ga6d24a9e3abe3e6a908661b43acb8efe0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the power of two number which value is the closet to the input value. <a href="a00163.html#ga6d24a9e3abe3e6a908661b43acb8efe0">More...</a><br /></td></tr>
<tr class="separator:ga6d24a9e3abe3e6a908661b43acb8efe0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga31bea2d2e0b9bc62bd14b60fcb10f4e6"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier Q&gt; </td></tr>
<tr class="memitem:ga31bea2d2e0b9bc62bd14b60fcb10f4e6"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec&lt; L, T, Q &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00163.html#ga31bea2d2e0b9bc62bd14b60fcb10f4e6">roundPowerOfTwo</a> (vec&lt; L, T, Q &gt; const &amp;value)</td></tr>
<tr class="memdesc:ga31bea2d2e0b9bc62bd14b60fcb10f4e6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the power of two number which value is the closet to the input value. <a href="a00163.html#ga31bea2d2e0b9bc62bd14b60fcb10f4e6">More...</a><br /></td></tr>
<tr class="separator:ga31bea2d2e0b9bc62bd14b60fcb10f4e6"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Allow to perform bit operations on integer values. </p>
<p>&lt;<a class="el" href="a00012.html" title="GLM_GTC_color_space ">glm/gtc/color_space.hpp</a>&gt; need to be included to use these functionalities. </p>
<p>Include &lt;<a class="el" href="a00091.html" title="GLM_GTC_round ">glm/gtc/round.hpp</a>&gt; to use the features of this extension. </p>
<p>Rounding value to specific boundings </p>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="gaee73ec7f5015b5d72887e84fb811a92a"></a>
<a class="anchor" id="gac84898c466e609cdd2e81d9ba907d9e8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL vec&lt;L, T, P&gt; glm::convertLinearToSRGB </td>
<td class="memname">GLM_FUNC_DECL genType glm::ceilMultiple </td>
<td>(</td>
<td class="paramtype">vec&lt; L, T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>ColorLinear</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Convert a linear color to sRGB color using a standard gamma correction. </p>
<p>IEC 61966-2-1:1999 / Rec. 709 specification <a href="https://www.w3.org/Graphics/Color/srgb">https://www.w3.org/Graphics/Color/srgb</a> </p>
</div>
</div>
<a class="anchor" id="ga403a403dcb7fdf9c38d72c7df4e235cd"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL vec&lt;L, T, P&gt; glm::convertLinearToSRGB </td>
<td>(</td>
<td class="paramtype">vec&lt; L, T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>ColorLinear</em>, </td>
<td class="paramtype">genType&#160;</td>
<td class="paramname"><em>Source</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">T&#160;</td>
<td class="paramname"><em>Gamma</em>&#160;</td>
<td class="paramtype">genType&#160;</td>
<td class="paramname"><em>Multiple</em>&#160;</td>
</tr>
<tr>
<td></td>
@@ -151,27 +183,518 @@ template&lt;length_t L, typename T , qualifier P&gt; </td></tr>
</table>
</div><div class="memdoc">
<p>Convert a linear color to sRGB color using a custom gamma correction. </p>
<p>IEC 61966-2-1:1999 / Rec. 709 specification <a href="https://www.w3.org/Graphics/Color/srgb">https://www.w3.org/Graphics/Color/srgb</a> </p>
<p>Higher multiple number of Source. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">genType</td><td>Floating-point or integer scalar or vector types. </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">Multiple</td><td>Must be a null or positive value</td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00163.html" title="Include <glm/gtc/round.hpp> to use the features of this extension. ">GLM_GTC_round</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga660e6e26316f2b28fe23076ff07f8ceb"></a>
<a class="anchor" id="ga073227936f36f9102cd3a8aa45871b26"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL vec&lt;L, T, P&gt; glm::convertSRGBToLinear </td>
<td class="memname">GLM_FUNC_DECL vec&lt;L, T, Q&gt; glm::ceilMultiple </td>
<td>(</td>
<td class="paramtype">vec&lt; L, T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>ColorSRGB</em></td><td>)</td>
<td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
<td class="paramname"><em>Source</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
<td class="paramname"><em>Multiple</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Higher multiple number of Source. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">L</td><td>Integer between 1 and 4 included that qualify the dimension of the vector </td></tr>
<tr><td class="paramname">T</td><td>Floating-point or integer scalar types </td></tr>
<tr><td class="paramname">Q</td><td>Value from qualifier enum </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">Multiple</td><td>Must be a null or positive value</td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00163.html" title="Include <glm/gtc/round.hpp> to use the features of this extension. ">GLM_GTC_round</a> </dd></dl>
</div>
</div>
<a class="anchor" id="gaa73c7690c787086fa3ac1c312264acab"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL genIUType glm::ceilPowerOfTwo </td>
<td>(</td>
<td class="paramtype">genIUType&#160;</td>
<td class="paramname"><em>Value</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Convert a sRGB color to linear color using a standard gamma correction. </p>
<p>IEC 61966-2-1:1999 / Rec. 709 specification <a href="https://www.w3.org/Graphics/Color/srgb">https://www.w3.org/Graphics/Color/srgb</a> </p>
<p>Return the power of two number which value is just higher the input value, round up to a power of two. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00163.html" title="Include <glm/gtc/round.hpp> to use the features of this extension. ">GLM_GTC_round</a> </dd></dl>
</div>
</div>
<a class="anchor" id="gac46c061058771cb31c467ef673d12c80"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL vec&lt;L, T, Q&gt; glm::ceilPowerOfTwo </td>
<td>(</td>
<td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
<td class="paramname"><em>value</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the power of two number which value is just higher the input value, round up to a power of two. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">L</td><td>Integer between 1 and 4 included that qualify the dimension of the vector </td></tr>
<tr><td class="paramname">T</td><td>Floating-point or integer scalar types </td></tr>
<tr><td class="paramname">Q</td><td>Value from qualifier enum</td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00163.html" title="Include <glm/gtc/round.hpp> to use the features of this extension. ">GLM_GTC_round</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga9eafb9dbedf84e5cece65c2fe9d5631d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL genType glm::floorMultiple </td>
<td>(</td>
<td class="paramtype">genType&#160;</td>
<td class="paramname"><em>Source</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">genType&#160;</td>
<td class="paramname"><em>Multiple</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Lower multiple number of Source. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">genType</td><td>Floating-point or integer scalar or vector types. </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">Multiple</td><td>Must be a null or positive value</td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00163.html" title="Include <glm/gtc/round.hpp> to use the features of this extension. ">GLM_GTC_round</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga2b6d6bcdf0641b54cb539104c224885b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL vec&lt;L, T, Q&gt; glm::floorMultiple </td>
<td>(</td>
<td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
<td class="paramname"><em>Source</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
<td class="paramname"><em>Multiple</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Lower multiple number of Source. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">L</td><td>Integer between 1 and 4 included that qualify the dimension of the vector </td></tr>
<tr><td class="paramname">T</td><td>Floating-point or integer scalar types </td></tr>
<tr><td class="paramname">Q</td><td>Value from qualifier enum </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">Multiple</td><td>Must be a null or positive value</td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00163.html" title="Include <glm/gtc/round.hpp> to use the features of this extension. ">GLM_GTC_round</a> </dd></dl>
</div>
</div>
<a class="anchor" id="gac80f6519c31baae10d8d7bea6735d1fa"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL genIUType glm::floorPowerOfTwo </td>
<td>(</td>
<td class="paramtype">genIUType&#160;</td>
<td class="paramname"><em>Value</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the power of two number which value is just lower the input value, round down to a power of two. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00163.html" title="Include <glm/gtc/round.hpp> to use the features of this extension. ">GLM_GTC_round</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga6ebfea889605abf6629c7589e0cb2e28"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL vec&lt;L, T, Q&gt; glm::floorPowerOfTwo </td>
<td>(</td>
<td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
<td class="paramname"><em>value</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the power of two number which value is just lower the input value, round down to a power of two. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">L</td><td>Integer between 1 and 4 included that qualify the dimension of the vector </td></tr>
<tr><td class="paramname">T</td><td>Floating-point or integer scalar types </td></tr>
<tr><td class="paramname">Q</td><td>Value from qualifier enum</td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00163.html" title="Include <glm/gtc/round.hpp> to use the features of this extension. ">GLM_GTC_round</a> </dd></dl>
</div>
</div>
<a class="anchor" id="gaf7444a7b2eb524f373463ceba76b9326"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL bool glm::isMultiple </td>
<td>(</td>
<td class="paramtype">genIUType&#160;</td>
<td class="paramname"><em>Value</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">genIUType&#160;</td>
<td class="paramname"><em>Multiple</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return true if the 'Value' is a multiple of 'Multiple'. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00163.html" title="Include <glm/gtc/round.hpp> to use the features of this extension. ">GLM_GTC_round</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga908a61945ecb235817a9a87b249d4b2d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL vec&lt;L, bool, Q&gt; glm::isMultiple </td>
<td>(</td>
<td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
<td class="paramname"><em>Value</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">T&#160;</td>
<td class="paramname"><em>Multiple</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return true if the 'Value' is a multiple of 'Multiple'. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">L</td><td>Integer between 1 and 4 included that qualify the dimension of the vector </td></tr>
<tr><td class="paramname">T</td><td>Floating-point or integer scalar types </td></tr>
<tr><td class="paramname">Q</td><td>Value from qualifier enum</td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00163.html" title="Include <glm/gtc/round.hpp> to use the features of this extension. ">GLM_GTC_round</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga12b5f07c3ed46acc6838f159ca6ef368"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL vec&lt;L, bool, Q&gt; glm::isMultiple </td>
<td>(</td>
<td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
<td class="paramname"><em>Value</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
<td class="paramname"><em>Multiple</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return true if the 'Value' is a multiple of 'Multiple'. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">L</td><td>Integer between 1 and 4 included that qualify the dimension of the vector </td></tr>
<tr><td class="paramname">T</td><td>Floating-point or integer scalar types </td></tr>
<tr><td class="paramname">Q</td><td>Value from qualifier enum</td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00163.html" title="Include <glm/gtc/round.hpp> to use the features of this extension. ">GLM_GTC_round</a> </dd></dl>
</div>
</div>
<a class="anchor" id="gaebf826fbb6e0a70eeaab0792d89b25ec"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL bool glm::isPowerOfTwo </td>
<td>(</td>
<td class="paramtype">genIUType&#160;</td>
<td class="paramname"><em>Value</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return true if the value is a power of two number. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00163.html" title="Include <glm/gtc/round.hpp> to use the features of this extension. ">GLM_GTC_round</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga866a7bbd725d7d40b5d433d02bf70f17"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL vec&lt;L, bool, Q&gt; glm::isPowerOfTwo </td>
<td>(</td>
<td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
<td class="paramname"><em>value</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return true if the value is a power of two number. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">L</td><td>Integer between 1 and 4 included that qualify the dimension of the vector </td></tr>
<tr><td class="paramname">T</td><td>Floating-point or integer scalar types </td></tr>
<tr><td class="paramname">Q</td><td>Value from qualifier enum</td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00163.html" title="Include <glm/gtc/round.hpp> to use the features of this extension. ">GLM_GTC_round</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga6739d1de04b2cea7c78675b365644bce"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL genType glm::roundMultiple </td>
<td>(</td>
<td class="paramtype">genType&#160;</td>
<td class="paramname"><em>Source</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">genType&#160;</td>
<td class="paramname"><em>Multiple</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Lower multiple number of Source. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">genType</td><td>Floating-point or integer scalar or vector types. </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">Multiple</td><td>Must be a null or positive value</td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00163.html" title="Include <glm/gtc/round.hpp> to use the features of this extension. ">GLM_GTC_round</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga812d27fa1a60c48dc111d67da26b1455"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL vec&lt;L, T, Q&gt; glm::roundMultiple </td>
<td>(</td>
<td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
<td class="paramname"><em>Source</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
<td class="paramname"><em>Multiple</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Lower multiple number of Source. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">L</td><td>Integer between 1 and 4 included that qualify the dimension of the vector </td></tr>
<tr><td class="paramname">T</td><td>Floating-point or integer scalar types </td></tr>
<tr><td class="paramname">Q</td><td>Value from qualifier enum </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">Multiple</td><td>Must be a null or positive value</td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00163.html" title="Include <glm/gtc/round.hpp> to use the features of this extension. ">GLM_GTC_round</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga6d24a9e3abe3e6a908661b43acb8efe0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL genIUType glm::roundPowerOfTwo </td>
<td>(</td>
<td class="paramtype">genIUType&#160;</td>
<td class="paramname"><em>Value</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the power of two number which value is the closet to the input value. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00163.html" title="Include <glm/gtc/round.hpp> to use the features of this extension. ">GLM_GTC_round</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga31bea2d2e0b9bc62bd14b60fcb10f4e6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL vec&lt;L, T, Q&gt; glm::roundPowerOfTwo </td>
<td>(</td>
<td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
<td class="paramname"><em>value</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the power of two number which value is the closet to the input value. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">L</td><td>Integer between 1 and 4 included that qualify the dimension of the vector </td></tr>
<tr><td class="paramname">T</td><td>Floating-point or integer scalar types </td></tr>
<tr><td class="paramname">Q</td><td>Value from qualifier enum</td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00163.html" title="Include <glm/gtc/round.hpp> to use the features of this extension. ">GLM_GTC_round</a> </dd></dl>
</div>
</div>