glm/doc/api/a00167.html

215 lines
9.7 KiB
HTML
Raw Permalink Normal View History

<!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"/>
2012-11-18 13:05:52 +00:00
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
2014-11-25 00:28:32 +00:00
<meta name="generator" content="Doxygen 1.8.8"/>
2014-11-30 20:57:58 +00:00
<title>0.9.6: GLM_GTC_integer</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
2012-11-18 13:05:52 +00:00
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
2012-11-18 13:05:52 +00:00
<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;">
2014-11-25 00:28:32 +00:00
<td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
2013-12-25 22:48:55 +00:00
<td style="padding-left: 0.5em;">
2014-11-25 00:28:32 +00:00
<div id="projectname">0.9.6
2013-12-25 22:48:55 +00:00
</div>
</td>
</tr>
</tbody>
</table>
</div>
2012-11-18 13:05:52 +00:00
<!-- end header part -->
2014-11-25 00:28:32 +00:00
<!-- Generated by Doxygen 1.8.8 -->
<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><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
2012-11-18 13:05:52 +00:00
</div><!-- top -->
<div class="header">
<div class="summary">
2014-11-25 00:28:32 +00:00
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
2014-11-30 20:57:58 +00:00
<div class="title">GLM_GTC_integer<div class="ingroups"><a class="el" href="a00158.html">GTC Extensions (Stable)</a></div></div> </div>
2013-12-25 22:48:55 +00:00
</div><!--header-->
<div class="contents">
<table class="memberdecls">
2014-11-25 00:28:32 +00:00
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
2014-11-30 20:57:58 +00:00
<tr class="memitem:ga9bd682e74bfacb005c735305207ec417"><td class="memTemplParams" colspan="2">template&lt;typename genIUType &gt; </td></tr>
<tr class="memitem:ga9bd682e74bfacb005c735305207ec417"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genIUType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00167.html#ga9bd682e74bfacb005c735305207ec417">log2</a> (genIUType x)</td></tr>
<tr class="separator:ga9bd682e74bfacb005c735305207ec417"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga75c6fd2a143fc44e5f7b871abad539e0"><td class="memTemplParams" colspan="2">template&lt;typename genIUType &gt; </td></tr>
<tr class="memitem:ga75c6fd2a143fc44e5f7b871abad539e0"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genIUType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00167.html#ga75c6fd2a143fc44e5f7b871abad539e0">mod</a> (genIUType x, genIUType y)</td></tr>
<tr class="separator:ga75c6fd2a143fc44e5f7b871abad539e0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac76ae7d82ff22526bcf6d6a1b51af6c3"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P, template&lt; typename, precision &gt; class vecType&gt; </td></tr>
<tr class="memitem:gac76ae7d82ff22526bcf6d6a1b51af6c3"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vecType&lt; T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00167.html#gac76ae7d82ff22526bcf6d6a1b51af6c3">mod</a> (vecType&lt; T, P &gt; const &amp;x, T y)</td></tr>
<tr class="separator:gac76ae7d82ff22526bcf6d6a1b51af6c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf5ae5330f6b30b4a35fb95f9a73d6134"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P, template&lt; typename, precision &gt; class vecType&gt; </td></tr>
<tr class="memitem:gaf5ae5330f6b30b4a35fb95f9a73d6134"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vecType&lt; T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00167.html#gaf5ae5330f6b30b4a35fb95f9a73d6134">mod</a> (vecType&lt; T, P &gt; const &amp;x, vecType&lt; T, P &gt; const &amp;y)</td></tr>
<tr class="separator:gaf5ae5330f6b30b4a35fb95f9a73d6134"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
2012-11-18 13:05:52 +00:00
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
2014-11-30 20:57:58 +00:00
<p>Allow to perform bit operations on integer values. </p>
<p>&lt;<a class="el" href="a00042.html" title="OpenGL Mathematics (glm.g-truc.net) ">glm/gtc/integer.hpp</a>&gt; need to be included to use these functionalities. </p>
2014-11-25 00:28:32 +00:00
<h2 class="groupheader">Function Documentation</h2>
2014-11-30 20:57:58 +00:00
<a class="anchor" id="ga9bd682e74bfacb005c735305207ec417"></a>
2014-11-25 00:28:32 +00:00
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
2014-11-30 20:57:58 +00:00
<td class="memname">GLM_FUNC_DECL genIUType glm::log2 </td>
2014-11-25 00:28:32 +00:00
<td>(</td>
2014-11-30 20:57:58 +00:00
<td class="paramtype">genIUType&#160;</td>
<td class="paramname"><em>x</em></td><td>)</td>
2014-11-25 00:28:32 +00:00
<td></td>
</tr>
</table>
</div><div class="memdoc">
2014-11-30 20:57:58 +00:00
<p>Returns the log2 of x for integer values. </p>
<p>Can be reliably using to compute mipmap count from the texture size. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="a00167.html" title="Allow to perform bit operations on integer values. ">GLM_GTC_integer</a> </dd></dl>
2014-11-25 00:28:32 +00:00
</div>
</div>
2014-11-30 20:57:58 +00:00
<a class="anchor" id="ga75c6fd2a143fc44e5f7b871abad539e0"></a>
2014-11-25 00:28:32 +00:00
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
2014-11-30 20:57:58 +00:00
<td class="memname">GLM_FUNC_DECL genIUType glm::mod </td>
2014-11-25 00:28:32 +00:00
<td>(</td>
2014-11-30 20:57:58 +00:00
<td class="paramtype">genIUType&#160;</td>
2014-11-25 00:28:32 +00:00
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
2014-11-30 20:57:58 +00:00
<td class="paramtype">genIUType&#160;</td>
<td class="paramname"><em>y</em>&#160;</td>
2014-11-25 00:28:32 +00:00
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
2014-11-30 20:57:58 +00:00
<p>Modulus. </p>
<p>Returns x % y for each component in x using the floating point value y.</p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">genIUType</td><td>Integer-point scalar or vector types.</td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00167.html" title="Allow to perform bit operations on integer values. ">GLM_GTC_integer</a> </dd>
<dd>
<a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/mod.xml">GLSL mod man page</a> </dd>
<dd>
<a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.3 Common Functions</a> </dd></dl>
2014-11-25 00:28:32 +00:00
</div>
</div>
2014-11-30 20:57:58 +00:00
<a class="anchor" id="gac76ae7d82ff22526bcf6d6a1b51af6c3"></a>
2014-11-25 00:28:32 +00:00
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
2014-11-30 20:57:58 +00:00
<td class="memname">GLM_FUNC_DECL vecType&lt; T, P &gt; mod </td>
2014-11-25 00:28:32 +00:00
<td>(</td>
2014-11-30 20:57:58 +00:00
<td class="paramtype">vecType&lt; T, P &gt; const &amp;&#160;</td>
2014-11-25 00:28:32 +00:00
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
2014-11-30 20:57:58 +00:00
<td class="paramtype">T&#160;</td>
<td class="paramname"><em>y</em>&#160;</td>
2014-11-25 00:28:32 +00:00
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
2014-11-30 20:57:58 +00:00
<p>Modulus. </p>
<p>Returns x % y for each component in x using the floating point value y.</p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">T</td><td>Integer scalar types. </td></tr>
<tr><td class="paramname">vecType</td><td>vector types.</td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00167.html" title="Allow to perform bit operations on integer values. ">GLM_GTC_integer</a> </dd>
<dd>
<a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/mod.xml">GLSL mod man page</a> </dd>
<dd>
<a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.3 Common Functions</a> </dd></dl>
2014-11-25 00:28:32 +00:00
</div>
</div>
2014-11-30 20:57:58 +00:00
<a class="anchor" id="gaf5ae5330f6b30b4a35fb95f9a73d6134"></a>
2014-11-25 00:28:32 +00:00
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
2014-11-30 20:57:58 +00:00
<td class="memname">GLM_FUNC_DECL vecType&lt; T, P &gt; mod </td>
2014-11-25 00:28:32 +00:00
<td>(</td>
2014-11-30 20:57:58 +00:00
<td class="paramtype">vecType&lt; T, P &gt; const &amp;&#160;</td>
2014-11-25 00:28:32 +00:00
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
2014-11-30 20:57:58 +00:00
<td class="paramtype">vecType&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>y</em>&#160;</td>
2014-11-25 00:28:32 +00:00
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
2014-11-30 20:57:58 +00:00
<p>Modulus. </p>
<p>Returns x % y for each component in x using the floating point value y.</p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">T</td><td>Integer scalar types. </td></tr>
<tr><td class="paramname">vecType</td><td>vector types.</td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00167.html" title="Allow to perform bit operations on integer values. ">GLM_GTC_integer</a> </dd>
<dd>
<a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/mod.xml">GLSL mod man page</a> </dd>
<dd>
<a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.3 Common Functions</a> </dd></dl>
2014-11-25 00:28:32 +00:00
</div>
</div>
2012-11-18 13:05:52 +00:00
</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"/>
2014-11-25 00:28:32 +00:00
</a> 1.8.8
</small></address>
</body>
</html>