upstream-doc/man2/glClearDepth.xml

   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>GLclampd <parameter>depth</parameter></paramdef>
  24             </funcprototype>
  25         </funcsynopsis>
  26     </refsynopsisdiv>
  27     <refsect1 id="parameters"><title>Parameters</title>
  28         <variablelist>
  29         <varlistentry>
  30             <term><parameter>depth</parameter></term>
  31             <listitem>
  32                 <para>
  33                     Specifies the depth value used when the depth buffer is cleared. The
  34                     initial value is 1.
  35                 </para>
  36             </listitem>
  37         </varlistentry>
  38         </variablelist>
  39     </refsect1>
  40     <refsect1 id="description"><title>Description</title>
  41         <para>
  42             <function>glClearDepth</function> specifies the depth value used by <citerefentry><refentrytitle>glClear</refentrytitle></citerefentry> to clear the depth buffer.
  43             Values specified by <function>glClearDepth</function> are clamped to the range
  44             <inlineequation><mml:math>
  45                 <!-- eqn: [0,1]:-->
  46                 <mml:mfenced open="[" close="]">
  47                     <mml:mn>0</mml:mn>
  48                     <mml:mn>1</mml:mn>
  49                 </mml:mfenced>
  50             </mml:math></inlineequation>.
  51         </para>
  52     </refsect1>
  53     <refsect1 id="errors"><title>Errors</title>
  54         <para>
  55             <constant>GL_INVALID_OPERATION</constant> is generated if <function>glClearDepth</function>
  56             is executed between the execution of <citerefentry><refentrytitle>glBegin</refentrytitle></citerefentry>
  57             and the corresponding execution of <citerefentry><refentrytitle>glEnd</refentrytitle></citerefentry>.
  58         </para>
  59     </refsect1>
  60     <refsect1 id="associatedgets"><title>Associated Gets</title>
  61         <para>
  62             <citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument <constant>GL_DEPTH_CLEAR_VALUE</constant>
  63         </para>
  64     </refsect1>
  65     <refsect1 id="seealso"><title>See Also</title>
  66         <para>
  67             <citerefentry><refentrytitle>glClear</refentrytitle></citerefentry>
  68         </para>
  69     </refsect1>
  70     <refsect1 id="Copyright"><title>Copyright</title>
  71         <para>
  72             Copyright <trademark class="copyright"></trademark> 1991-2006
  73             Silicon Graphics, Inc. This document is licensed under the SGI
  74             Free Software B License. For details, see
  75             <ulink url="http://oss.sgi.com/projects/FreeB/">http://oss.sgi.com/projects/FreeB/</ulink>.
  76         </para>
  77     </refsect1>
  78 </refentry>