1 <?xml version=
"1.0" encoding=
"UTF-8"?>
2 <!DOCTYPE html PUBLIC
"-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd">
3 <!-- saved from url=(0013)about:internet -->
4 <?xml-stylesheet type=
"text/xsl" href=
"mathml.xsl"?><html xmlns=
"http://www.w3.org/1999/xhtml" xmlns:
pref=
"http://www.w3.org/2002/Math/preference" pref:
renderer=
"mathplayer-dl"><head><meta http-equiv=
"Content-Type" content=
"text/html; charset=UTF-8" /><link rel=
"stylesheet" type=
"text/css" href=
"opengl-man.css" /><title>clamp - OpenGL Shading Language (GLSL)
</title><meta name=
"generator" content=
"DocBook XSL Stylesheets V1.69.1" /></head><body><div class=
"refentry" lang=
"en" xml:
lang=
"en"><a id=
"clamp"></a><div class=
"titlepage"></div><div class=
"refnamediv"><h2>Name
</h2><p>clamp — constrain a value to lie between two further values
</p></div><div class=
"refsynopsisdiv"><h2>Declaration
</h2><div class=
"funcsynopsis"><table border=
"0" summary=
"Function synopsis" cellspacing=
"0" cellpadding=
"0"><tr><td><code class=
"funcdef">genType
<b class=
"fsfunc">clamp
</b>(
</code></td><td>genType
</td><td><var class=
"pdparam">x
</var>,
</td></tr><tr><td> </td><td>genType
</td><td><var class=
"pdparam">minVal
</var>,
</td></tr><tr><td> </td><td>genType
</td><td><var class=
"pdparam">maxVal
</var><code>)
</code>;
</td></tr></table></div><div class=
"funcsynopsis"><table border=
"0" summary=
"Function synopsis" cellspacing=
"0" cellpadding=
"0"><tr><td><code class=
"funcdef">genType
<b class=
"fsfunc">clamp
</b>(
</code></td><td>genType
</td><td><var class=
"pdparam">x
</var>,
</td></tr><tr><td> </td><td>float
</td><td><var class=
"pdparam">minVal
</var>,
</td></tr><tr><td> </td><td>float
</td><td><var class=
"pdparam">maxVal
</var><code>)
</code>;
</td></tr></table></div><div class=
"funcsynopsis"><table border=
"0" summary=
"Function synopsis" cellspacing=
"0" cellpadding=
"0"><tr><td><code class=
"funcdef">genDType
<b class=
"fsfunc">clamp
</b>(
</code></td><td>genDType
</td><td><var class=
"pdparam">x
</var>,
</td></tr><tr><td> </td><td>genDType
</td><td><var class=
"pdparam">minVal
</var>,
</td></tr><tr><td> </td><td>genDType
</td><td><var class=
"pdparam">maxVal
</var><code>)
</code>;
</td></tr></table></div><div class=
"funcsynopsis"><table border=
"0" summary=
"Function synopsis" cellspacing=
"0" cellpadding=
"0"><tr><td><code class=
"funcdef">genDType
<b class=
"fsfunc">clamp
</b>(
</code></td><td>genDType
</td><td><var class=
"pdparam">x
</var>,
</td></tr><tr><td> </td><td>double
</td><td><var class=
"pdparam">minVal
</var>,
</td></tr><tr><td> </td><td>double
</td><td><var class=
"pdparam">maxVal
</var><code>)
</code>;
</td></tr></table></div><div class=
"funcsynopsis"><table border=
"0" summary=
"Function synopsis" cellspacing=
"0" cellpadding=
"0"><tr><td><code class=
"funcdef">genIType
<b class=
"fsfunc">clamp
</b>(
</code></td><td>genIType
</td><td><var class=
"pdparam">x
</var>,
</td></tr><tr><td> </td><td>genIType
</td><td><var class=
"pdparam">minVal
</var>,
</td></tr><tr><td> </td><td>genIType
</td><td><var class=
"pdparam">maxVal
</var><code>)
</code>;
</td></tr></table></div><div class=
"funcsynopsis"><table border=
"0" summary=
"Function synopsis" cellspacing=
"0" cellpadding=
"0"><tr><td><code class=
"funcdef">genIType
<b class=
"fsfunc">clamp
</b>(
</code></td><td>genIType
</td><td><var class=
"pdparam">x
</var>,
</td></tr><tr><td> </td><td>int
</td><td><var class=
"pdparam">minVal
</var>,
</td></tr><tr><td> </td><td>int
</td><td><var class=
"pdparam">maxVal
</var><code>)
</code>;
</td></tr></table></div><div class=
"funcsynopsis"><table border=
"0" summary=
"Function synopsis" cellspacing=
"0" cellpadding=
"0"><tr><td><code class=
"funcdef">genUType
<b class=
"fsfunc">clamp
</b>(
</code></td><td>genUType
</td><td><var class=
"pdparam">x
</var>,
</td></tr><tr><td> </td><td>genUType
</td><td><var class=
"pdparam">minVal
</var>,
</td></tr><tr><td> </td><td>genUType
</td><td><var class=
"pdparam">maxVal
</var><code>)
</code>;
</td></tr></table></div><div class=
"funcsynopsis"><table border=
"0" summary=
"Function synopsis" cellspacing=
"0" cellpadding=
"0"><tr><td><code class=
"funcdef">genUType
<b class=
"fsfunc">clamp
</b>(
</code></td><td>genUType
</td><td><var class=
"pdparam">x
</var>,
</td></tr><tr><td> </td><td>uint
</td><td><var class=
"pdparam">minVal
</var>,
</td></tr><tr><td> </td><td>uint
</td><td><var class=
"pdparam">maxVal
</var><code>)
</code>;
</td></tr></table></div></div><div class=
"refsect1" lang=
"en" xml:
lang=
"en"><a id=
"parameters"></a><h2>Parameters
</h2><div class=
"variablelist"><dl><dt><span class=
"term"><em class=
"parameter"><code>x
</code></em></span></dt><dd><p>
5 Specify the value to constrain.
6 </p></dd><dt><span class=
"term"><em class=
"parameter"><code>minVal
</code></em></span></dt><dd><p>
7 Specify the lower end of the range into which to constrain
<em class=
"parameter"><code>x
</code></em>.
8 </p></dd><dt><span class=
"term"><em class=
"parameter"><code>maxVal
</code></em></span></dt><dd><p>
9 Specify the upper end of the range into which to constrain
<em class=
"parameter"><code>x
</code></em>.
10 </p></dd></dl></div></div><div class=
"refsect1" lang=
"en" xml:
lang=
"en"><a id=
"description"></a><h2>Description
</h2><p>
11 <code class=
"function">clamp
</code> returns the value of
<em class=
"parameter"><code>x
</code></em> constrained to the
12 range
<em class=
"parameter"><code>minVal
</code></em> to
<em class=
"parameter"><code>maxVal
</code></em>. The returned value is
14 <a href=
"min.xml"><span class=
"citerefentry"><span class=
"refentrytitle">min
</span></span></a>(
<a href=
"max.xml"><span class=
"citerefentry"><span class=
"refentrytitle">max
</span></span></a>(
<em class=
"parameter"><code>x
</code></em>,
15 <em class=
"parameter"><code>minVal
</code></em>),
<em class=
"parameter"><code>maxVal
</code></em>).
16 </p></div><div class=
"refsect1" lang=
"en" xml:
lang=
"en"><a id=
"versions"></a><h2>Version Support
</h2><div class=
"informaltable"><table border=
"1"><colgroup><col align=
"left" /><col align=
"center" /><col align=
"center" /><col align=
"center" /><col align=
"center" /><col align=
"center" /><col align=
"center" /><col align=
"center" /><col align=
"center" /><col align=
"center" /><col align=
"center" /></colgroup><thead><tr><th align=
"left"><span class=
"bold"><strong>Function
</strong></span></th><th align=
"left"><span class=
"bold"><strong>Version
1.10</strong></span></th><th align=
"left"><span class=
"bold"><strong>Version
1.20</strong></span></th><th align=
"left"><span class=
"bold"><strong>Version
1.30</strong></span></th><th align=
"left"><span class=
"bold"><strong>Version
1.40</strong></span></th><th align=
"left"><span class=
"bold"><strong>Version
1.50</strong></span></th><th align=
"left"><span class=
"bold"><strong>Version
3.30</strong></span></th><th align=
"left"><span class=
"bold"><strong>Version
4.00</strong></span></th><th align=
"left"><span class=
"bold"><strong>Version
4.10</strong></span></th><th align=
"left"><span class=
"bold"><strong>Version
4.20</strong></span></th><th align=
"center"><span class=
"bold"><strong>Version
4.30</strong></span></th></tr><tr><th align=
"left">clamp (genType)
</th><th align=
"center"><span class=
"emphasis"><em>Y
</em></span></th><th align=
"center"><span class=
"emphasis"><em>Y
</em></span></th><th align=
"center"><span class=
"emphasis"><em>Y
</em></span></th><th align=
"center"><span class=
"emphasis"><em>Y
</em></span></th><th align=
"center"><span class=
"emphasis"><em>Y
</em></span></th><th align=
"center"><span class=
"emphasis"><em>Y
</em></span></th><th align=
"center"><span class=
"emphasis"><em>Y
</em></span></th><th align=
"center"><span class=
"emphasis"><em>Y
</em></span></th><th align=
"center"><span class=
"emphasis"><em>Y
</em></span></th><th align=
"center"><span class=
"emphasis"><em>Y
</em></span></th></tr><tr><th align=
"left">clamp (genIType)
</th><th align=
"center"><span class=
"emphasis"><em>-
</em></span></th><th align=
"center"><span class=
"emphasis"><em>-
</em></span></th><th align=
"center"><span class=
"emphasis"><em>Y
</em></span></th><th align=
"center"><span class=
"emphasis"><em>Y
</em></span></th><th align=
"center"><span class=
"emphasis"><em>Y
</em></span></th><th align=
"center"><span class=
"emphasis"><em>Y
</em></span></th><th align=
"center"><span class=
"emphasis"><em>Y
</em></span></th><th align=
"center"><span class=
"emphasis"><em>Y
</em></span></th><th align=
"center"><span class=
"emphasis"><em>Y
</em></span></th><th align=
"center"><span class=
"emphasis"><em>Y
</em></span></th></tr><tr><th align=
"left">clamp (genUType)
</th><th align=
"center"><span class=
"emphasis"><em>-
</em></span></th><th align=
"center"><span class=
"emphasis"><em>-
</em></span></th><th align=
"center"><span class=
"emphasis"><em>Y
</em></span></th><th align=
"center"><span class=
"emphasis"><em>Y
</em></span></th><th align=
"center"><span class=
"emphasis"><em>Y
</em></span></th><th align=
"center"><span class=
"emphasis"><em>Y
</em></span></th><th align=
"center"><span class=
"emphasis"><em>Y
</em></span></th><th align=
"center"><span class=
"emphasis"><em>Y
</em></span></th><th align=
"center"><span class=
"emphasis"><em>Y
</em></span></th><th align=
"center"><span class=
"emphasis"><em>Y
</em></span></th></tr><tr><th align=
"left">clamp (genDType)
</th><th align=
"center"><span class=
"emphasis"><em>-
</em></span></th><th align=
"center"><span class=
"emphasis"><em>-
</em></span></th><th align=
"center"><span class=
"emphasis"><em>-
</em></span></th><th align=
"center"><span class=
"emphasis"><em>-
</em></span></th><th align=
"center"><span class=
"emphasis"><em>-
</em></span></th><th align=
"center"><span class=
"emphasis"><em>-
</em></span></th><th align=
"center"><span class=
"emphasis"><em>Y
</em></span></th><th align=
"center"><span class=
"emphasis"><em>Y
</em></span></th><th align=
"center"><span class=
"emphasis"><em>Y
</em></span></th><th align=
"center"><span class=
"emphasis"><em>Y
</em></span></th></tr></thead></table></div></div><div class=
"refsect1" lang=
"en" xml:
lang=
"en"><a id=
"seealso"></a><h2>See Also
</h2><p>
17 <a href=
"min.xml"><span class=
"citerefentry"><span class=
"refentrytitle">min
</span></span></a>,
18 <a href=
"max.xml"><span class=
"citerefentry"><span class=
"refentrytitle">max
</span></span></a>
19 </p></div><div class=
"refsect1" lang=
"en" xml:
lang=
"en"><a id=
"Copyright"></a><h2>Copyright
</h2><p>
20 Copyright
<span class=
"trademark"></span>©
2011 Khronos Group.
21 This material may be distributed subject to the terms and conditions set forth in
22 the Open Publication License, v
1.0,
8 June
1999.
23 <a href=
"http://opencontent.org/openpub/" target=
"_top">http://opencontent.org/openpub/
</a>.
24 </p></div></div></body></html>
HCoop / clinton / guile-figl.git / blob