upstream-doc/man4/xhtml/glClearDepth.xml

   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>glClearDepth - 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="glClearDepth"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glClearDepth — specify the clear value for the depth buffer</p></div><div class="refsynopsisdiv"><h2>C Specification</h2><div class="funcsynopsis"><p><code class="funcdef">void <b class="fsfunc">glClearDepth</b>(</code>GLdouble <var class="pdparam">depth</var><code>)</code>;</p><p><code class="funcdef">void <b class="fsfunc">glClearDepthf</b>(</code>GLfloat <var class="pdparam">depth</var><code>)</code>;</p></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>depth</code></em></span></dt><dd><p>
   5                     Specifies the depth value used when the depth buffer is cleared. The
   6                     initial value is 1.
   7                 </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p>
   8             <code class="function">glClearDepth</code> specifies the depth value used by <a href="glClear.xml"><span class="citerefentry"><span class="refentrytitle">glClear</span></span></a> to clear the depth buffer.
   9             Values specified by <code class="function">glClearDepth</code> are clamped to the range
  10             <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll">
  11
  12                 <mml:mfenced open="[" close="]">
  13                     <mml:mn>0</mml:mn>
  14                     <mml:mn>1</mml:mn>
  15                 </mml:mfenced>
  16             </mml:math>.
  17         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="notes"></a><h2>Notes</h2><p>
  18             The type of the <em class="parameter"><code>depth</code></em> parameter was
  19             changed from GLclampf to GLfloat for
  20             <code class="function">glClearDepthf</code> and from GLclampd to
  21             GLdouble for <code class="function">glClearDepth</code>. This change
  22             is transparent to user code and is described in detail on
  23             the
  24             <a href="removedTypes.xml"><span class="citerefentry"><span class="refentrytitle">removedTypes</span></span></a>
  25             page.
  26         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="associatedgets"></a><h2>Associated Gets</h2><p>
  27             <a href="glGet.xml"><span class="citerefentry"><span class="refentrytitle">glGet</span></span></a> with argument <code class="constant">GL_DEPTH_CLEAR_VALUE</code>
  28         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p>
  29             <a href="glClear.xml"><span class="citerefentry"><span class="refentrytitle">glClear</span></span></a>,
  30             <a href="removedTypes.xml"><span class="citerefentry"><span class="refentrytitle">removedTypes</span></span></a>
  31         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p>
  32             Copyright <span class="trademark"></span>© 1991-2006
  33             Silicon Graphics, Inc. This document is licensed under the SGI
  34             Free Software B License. For details, see
  35             <a href="http://oss.sgi.com/projects/FreeB/" target="_top">http://oss.sgi.com/projects/FreeB/</a>.
  36         </p></div></div></body></html>