rename upstream-man-pages to upstream-doc
[clinton/guile-figl.git] / upstream-doc / man3 / glClampColor.xml
CommitLineData
7faf1d71
AW
1<?xml version="1.0" encoding="UTF-8"?>\r
2<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"\r
3 "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">\r
4<refentry id="glClampColor">\r
5 <refmeta>\r
6 <refmetainfo>\r
7 <copyright>\r
8 <year>2010</year>\r
9 <holder>Khronos Group</holder>\r
10 </copyright>\r
11 </refmetainfo>\r
12 <refentrytitle>glClampColor</refentrytitle>\r
13 <manvolnum>3G</manvolnum>\r
14 </refmeta>\r
15 <refnamediv>\r
16 <refname>glClampColor</refname>\r
17 <refpurpose>specify whether data read via <citerefentry><refentrytitle>glReadPixels</refentrytitle></citerefentry> should be clamped</refpurpose>\r
18 </refnamediv>\r
19 <refsynopsisdiv><title>C Specification</title>\r
20 <funcsynopsis>\r
21 <funcprototype>\r
22 <funcdef>void <function>glClampColor</function></funcdef>\r
23 <paramdef>GLenum <parameter>target</parameter></paramdef>\r
24 <paramdef>GLenum <parameter>clamp</parameter></paramdef>\r
25 </funcprototype>\r
26 </funcsynopsis>\r
27 </refsynopsisdiv>\r
28 <refsect1 id="parameters"><title>Parameters</title>\r
29 <variablelist>\r
30 <varlistentry>\r
31 <term><parameter>target</parameter></term>\r
32 <listitem>\r
33 <para>\r
34 Target for color clamping. <parameter>target</parameter> must be <constant>GL_CLAMP_READ_COLOR</constant>.\r
35 </para>\r
36 </listitem>\r
37 </varlistentry>\r
38 <varlistentry>\r
39 <term><parameter>clamp</parameter></term>\r
40 <listitem>\r
41 <para>\r
42 Specifies whether to apply color clamping. <parameter>clamp</parameter> must be <constant>GL_TRUE</constant> or <constant>GL_FALSE</constant>.\r
43 </para>\r
44 </listitem>\r
45 </varlistentry>\r
46 </variablelist>\r
47 </refsect1>\r
48 <refsect1 id="description"><title>Description</title>\r
49 <para>\r
50 <function>glClampColor</function> controls color clamping that is performed during <citerefentry><refentrytitle>glReadPixels</refentrytitle></citerefentry>.\r
51 <parameter>target</parameter> must be <constant>GL_CLAMP_READ_COLOR</constant>. If <parameter>clamp</parameter> is <constant>GL_TRUE</constant>,\r
52 read color clamping is enabled; if <parameter>clamp</parameter> is <constant>GL_FALSE</constant>, read color clamping is disabled. If\r
53 <parameter>clamp</parameter> is <constant>GL_FIXED_ONLY</constant>, read color clamping is enabled only if the selected read buffer has\r
54 fixed point components and disabled otherwise.\r
55 </para>\r
56 </refsect1>\r
57 <refsect1 id="errors"><title>Errors</title>\r
58 <para>\r
59 <constant>GL_INVALID_ENUM</constant> is generated if <parameter>target</parameter> is not\r
60 <constant>GL_CLAMP_READ_COLOR</constant>.\r
61 </para>\r
62 <para>\r
63 <constant>GL_INVALID_ENUM</constant> is generated if <parameter>clamp</parameter> is not <constant>GL_TRUE</constant> or <constant>GL_FALSE</constant>.\r
64 </para>\r
65 </refsect1>\r
66 <refsect1 id="associatedgets"><title>Associated Gets</title>\r
67 <para>\r
68 <citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument <constant>GL_CLAMP_READ_COLOR</constant>.\r
69 </para>\r
70 </refsect1>\r
71 <refsect1 id="Copyright"><title>Copyright</title>\r
72 <para>\r
73 Copyright <trademark class="copyright"></trademark> 2010 Khronos Group. \r
74 This material may be distributed subject to the terms and conditions set forth in \r
75 the Open Publication License, v 1.0, 8 June 1999.\r
76 <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.\r
77 </para>\r
78 </refsect1>\r
79</refentry>\r