Details | Last modification | View Log | RSS feed
| Rev | Author | Line No. | Line |
|---|---|---|---|
| 1452 | chris | 1 | <?xml version="1.0" encoding="UTF-8"?> |
| 2 | <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN" |
||
| 3 | "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd"> |
||
| 4 | <refentry id="glClearColor"> |
||
| 5 | <refmeta> |
||
| 6 | <refmetainfo> |
||
| 7 | <copyright> |
||
| 8 | <year>1991-2006</year> |
||
| 9 | <holder>Silicon Graphics, Inc.</holder> |
||
| 10 | </copyright> |
||
| 11 | </refmetainfo> |
||
| 12 | <refentrytitle>glClearColor</refentrytitle> |
||
| 13 | <manvolnum>3G</manvolnum> |
||
| 14 | </refmeta> |
||
| 15 | <refnamediv> |
||
| 16 | <refname>glClearColor</refname> |
||
| 17 | <refpurpose>specify clear values for the color buffers</refpurpose> |
||
| 18 | </refnamediv> |
||
| 19 | <refsynopsisdiv><title>C Specification</title> |
||
| 20 | <funcsynopsis> |
||
| 21 | <funcprototype> |
||
| 22 | <funcdef>void <function>glClearColor</function></funcdef> |
||
| 23 | <paramdef>GLclampf <parameter>red</parameter></paramdef> |
||
| 24 | <paramdef>GLclampf <parameter>green</parameter></paramdef> |
||
| 25 | <paramdef>GLclampf <parameter>blue</parameter></paramdef> |
||
| 26 | <paramdef>GLclampf <parameter>alpha</parameter></paramdef> |
||
| 27 | </funcprototype> |
||
| 28 | </funcsynopsis> |
||
| 29 | </refsynopsisdiv> |
||
| 30 | <refsect1 id="parameters"><title>Parameters</title> |
||
| 31 | <variablelist> |
||
| 32 | <varlistentry> |
||
| 33 | <term><parameter>red</parameter></term> |
||
| 34 | <term><parameter>green</parameter></term> |
||
| 35 | <term><parameter>blue</parameter></term> |
||
| 36 | <term><parameter>alpha</parameter></term> |
||
| 37 | <listitem> |
||
| 38 | <para> |
||
| 39 | Specify the red, green, blue, and alpha values used when the |
||
| 40 | color buffers are cleared. |
||
| 41 | The initial values are all 0. |
||
| 42 | </para> |
||
| 43 | </listitem> |
||
| 44 | </varlistentry> |
||
| 45 | </variablelist> |
||
| 46 | </refsect1> |
||
| 47 | <refsect1 id="description"><title>Description</title> |
||
| 48 | <para> |
||
| 49 | <function>glClearColor</function> specifies the red, |
||
| 50 | green, |
||
| 51 | blue, |
||
| 52 | and alpha values used by <citerefentry><refentrytitle>glClear</refentrytitle></citerefentry> to clear the color buffers. |
||
| 53 | Values specified by <function>glClearColor</function> are clamped to the range |
||
| 54 | <inlineequation><mml:math> |
||
| 55 | <!-- eqn: [0,1]:--> |
||
| 56 | <mml:mfenced open="[" close="]"> |
||
| 57 | <mml:mn>0</mml:mn> |
||
| 58 | <mml:mn>1</mml:mn> |
||
| 59 | </mml:mfenced> |
||
| 60 | </mml:math></inlineequation>. |
||
| 61 | </para> |
||
| 62 | </refsect1> |
||
| 63 | <refsect1 id="errors"><title>Errors</title> |
||
| 64 | <para> |
||
| 65 | <constant>GL_INVALID_OPERATION</constant> is generated if <function>glClearColor</function> |
||
| 66 | is executed between the execution of <citerefentry><refentrytitle>glBegin</refentrytitle></citerefentry> |
||
| 67 | and the corresponding execution of <citerefentry><refentrytitle>glEnd</refentrytitle></citerefentry>. |
||
| 68 | </para> |
||
| 69 | </refsect1> |
||
| 70 | <refsect1 id="associatedgets"><title>Associated Gets</title> |
||
| 71 | <para> |
||
| 72 | <citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument <constant>GL_COLOR_CLEAR_VALUE</constant> |
||
| 73 | </para> |
||
| 74 | </refsect1> |
||
| 75 | <refsect1 id="seealso"><title>See Also</title> |
||
| 76 | <para> |
||
| 77 | <citerefentry><refentrytitle>glClear</refentrytitle></citerefentry> |
||
| 78 | </para> |
||
| 79 | </refsect1> |
||
| 80 | <refsect1 id="Copyright"><title>Copyright</title> |
||
| 81 | <para> |
||
| 82 | Copyright <trademark class="copyright"></trademark> 1991-2006 |
||
| 83 | Silicon Graphics, Inc. This document is licensed under the SGI |
||
| 84 | Free Software B License. For details, see |
||
| 85 | <ulink url="http://oss.sgi.com/projects/FreeB/">http://oss.sgi.com/projects/FreeB/</ulink>. |
||
| 86 | </para> |
||
| 87 | </refsect1> |
||
| 88 | </refentry> |