rename upstream-man-pages to upstream-doc
[clinton/guile-figl.git] / upstream-doc / man4 / xhtml / glClampColor.xml
CommitLineData
7faf1d71
AW
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>glClampColor - OpenGL 4 Reference Pages</title><meta name="generator" content="DocBook XSL Stylesheets V1.69.1" /></head><body><div class="refentry" lang="en" xml:lang="en"><a id="glClampColor"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glClampColor — specify whether data read via <a href="glReadPixels.xml"><span class="citerefentry"><span class="refentrytitle">glReadPixels</span></span></a> should be clamped</p></div><div class="refsynopsisdiv"><h2>C Specification</h2><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"><tr><td><code class="funcdef">void <b class="fsfunc">glClampColor</b>(</code></td><td>GLenum  </td><td><var class="pdparam">target</var>, </td></tr><tr><td> </td><td>GLenum  </td><td><var class="pdparam">clamp</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>target</code></em></span></dt><dd><p>
5 Target for color clamping. <em class="parameter"><code>target</code></em> must be <code class="constant">GL_CLAMP_READ_COLOR</code>.
6 </p></dd><dt><span class="term"><em class="parameter"><code>clamp</code></em></span></dt><dd><p>
7 Specifies whether to apply color clamping. <em class="parameter"><code>clamp</code></em> must be <code class="constant">GL_TRUE</code> or <code class="constant">GL_FALSE</code>.
8 </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p>
9 <code class="function">glClampColor</code> controls color clamping that is performed during <a href="glReadPixels.xml"><span class="citerefentry"><span class="refentrytitle">glReadPixels</span></span></a>.
10 <em class="parameter"><code>target</code></em> must be <code class="constant">GL_CLAMP_READ_COLOR</code>. If <em class="parameter"><code>clamp</code></em> is <code class="constant">GL_TRUE</code>,
11 read color clamping is enabled; if <em class="parameter"><code>clamp</code></em> is <code class="constant">GL_FALSE</code>, read color clamping is disabled. If
12 <em class="parameter"><code>clamp</code></em> is <code class="constant">GL_FIXED_ONLY</code>, read color clamping is enabled only if the selected read buffer has
13 fixed point components and disabled otherwise.
14 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="errors"></a><h2>Errors</h2><p>
15 <code class="constant">GL_INVALID_ENUM</code> is generated if <em class="parameter"><code>target</code></em> is not
16 <code class="constant">GL_CLAMP_READ_COLOR</code>.
17 </p><p>
18 <code class="constant">GL_INVALID_ENUM</code> is generated if <em class="parameter"><code>clamp</code></em> is not <code class="constant">GL_TRUE</code> or <code class="constant">GL_FALSE</code>.
19 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="associatedgets"></a><h2>Associated Gets</h2><p>
20 <a href="glGet.xml"><span class="citerefentry"><span class="refentrytitle">glGet</span></span></a> with argument <code class="constant">GL_CLAMP_READ_COLOR</code>.
21 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p>
22 Copyright <span class="trademark"></span>© 2010 Khronos Group.
23 This material may be distributed subject to the terms and conditions set forth in
24 the Open Publication License, v 1.0, 8 June 1999.
25 <a href="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>.
26 </p></div></div></body></html>