HCoop / clinton / guile-figl.git / blame
| Commit | Line | Data |
|---|---|---|
| 7faf1d71 AW |
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="glClearDepth"> | |
| 5 | <refmeta> | |
| 6 | <refmetainfo> | |
| 7 | <copyright> | |
| 8 | <year>1991-2006</year> | |
| 9 | <holder>Silicon Graphics, Inc.</holder> | |
| 10 | </copyright> | |
| 11 | </refmetainfo> | |
| 12 | <refentrytitle>glClearDepth</refentrytitle> | |
| 13 | <manvolnum>3G</manvolnum> | |
| 14 | </refmeta> | |
| 15 | <refnamediv> | |
| 16 | <refname>glClearDepth</refname> | |
| 17 | <refpurpose>specify the clear value for the depth buffer</refpurpose> | |
| 18 | </refnamediv> | |
| 19 | <refsynopsisdiv><title>C Specification</title> | |
| 20 | <funcsynopsis> | |
| 21 | <funcprototype> | |
| 22 | <funcdef>void <function>glClearDepth</function></funcdef> | |
| 23 | <paramdef>GLdouble <parameter>depth</parameter></paramdef> | |
| 24 | </funcprototype> | |
| 25 | <funcprototype> | |
| 26 | <funcdef>void <function>glClearDepthf</function></funcdef> | |
| 27 | <paramdef>GLfloat <parameter>depth</parameter></paramdef> | |
| 28 | </funcprototype> | |
| 29 | </funcsynopsis> | |
| 30 | </refsynopsisdiv> | |
| 31 | <refsect1 id="parameters"><title>Parameters</title> | |
| 32 | <variablelist> | |
| 33 | <varlistentry> | |
| 34 | <term><parameter>depth</parameter></term> | |
| 35 | <listitem> | |
| 36 | <para> | |
| 37 | Specifies the depth value used when the depth buffer is cleared. The | |
| 38 | initial value is 1. | |
| 39 | </para> | |
| 40 | </listitem> | |
| 41 | </varlistentry> | |
| 42 | </variablelist> | |
| 43 | </refsect1> | |
| 44 | <refsect1 id="description"><title>Description</title> | |
| 45 | <para> | |
| 46 | <function>glClearDepth</function> specifies the depth value used by <citerefentry><refentrytitle>glClear</refentrytitle></citerefentry> to clear the depth buffer. | |
| 47 | Values specified by <function>glClearDepth</function> are clamped to the range | |
| 48 | <inlineequation><mml:math> | |
| 49 | <!-- eqn: [0,1]: --> | |
| 50 | <mml:mfenced open="[" close="]"> | |
| 51 | <mml:mn>0</mml:mn> | |
| 52 | <mml:mn>1</mml:mn> | |
| 53 | </mml:mfenced> | |
| 54 | </mml:math></inlineequation>. | |
| 55 | </para> | |
| 56 | </refsect1> | |
| 57 | <refsect1 id="notes"><title>Notes</title> | |
| 58 | <para> | |
| 59 | The type of the <parameter>depth</parameter> parameter was | |
| 60 | changed from GLclampf to GLfloat for | |
| 61 | <function>glClearDepthf</function> and from GLclampd to | |
| 62 | GLdouble for <function>glClearDepth</function>. This change | |
| 63 | is transparent to user code and is described in detail on | |
| 64 | the | |
| 65 | <citerefentry><refentrytitle>removedTypes</refentrytitle></citerefentry> | |
| 66 | page. | |
| 67 | </para> | |
| 68 | </refsect1> | |
| 69 | <refsect1 id="associatedgets"><title>Associated Gets</title> | |
| 70 | <para> | |
| 71 | <citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument <constant>GL_DEPTH_CLEAR_VALUE</constant> | |
| 72 | </para> | |
| 73 | </refsect1> | |
| 74 | <refsect1 id="seealso"><title>See Also</title> | |
| 75 | <para> | |
| 76 | <citerefentry><refentrytitle>glClear</refentrytitle></citerefentry>, | |
| 77 | <citerefentry><refentrytitle>removedTypes</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> |