<div class="refentry" id="glDepthFunc">

<div class="titlepage"></div>

<div class="refnamediv">

<h2>Name</h2>

<p>glDepthFunc — specify the value used for depth buffer comparisons</p>

</div>

<div class="refsynopsisdiv">

<h2>C Specification</h2>

<div class="funcsynopsis">

<table style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table">

<tr>

<td>

<code class="funcdef">void <strong class="fsfunc">glDepthFunc</strong>(</code>

</td>

<td>GLenum <var class="pdparam">func</var><code>)</code>;</td>

</tr>

</table>

<div class="funcprototype-spacer"> </div>

</div>

</div>

<div class="refsect1" id="parameters">

<h2>Parameters</h2>

<div class="variablelist">

<dl class="variablelist">

<dt>

<span class="term">

<em class="parameter">

<code>func</code>

</em>

</span>

</dt>

<dd>

<p>

Specifies the depth comparison function.

Symbolic constants

<code class="constant">GL_NEVER</code>,

<code class="constant">GL_LESS</code>,

<code class="constant">GL_EQUAL</code>,

<code class="constant">GL_LEQUAL</code>,

<code class="constant">GL_GREATER</code>,

<code class="constant">GL_NOTEQUAL</code>,

<code class="constant">GL_GEQUAL</code>, and

<code class="constant">GL_ALWAYS</code> are accepted.

The initial value is <code class="constant">GL_LESS</code>.

</p>

</dd>

</dl>

</div>

</div>

<div class="refsect1" id="description">

<h2>Description</h2>

<p>

<code class="function">glDepthFunc</code> specifies the function used to compare each incoming pixel depth value

with the depth value present in the depth buffer.

The comparison is performed only if depth testing is enabled.

(See <a class="citerefentry" href="glEnable"><span class="citerefentry"><span class="refentrytitle">glEnable</span></span></a> and <a class="citerefentry" href="glDisable"><span class="citerefentry"><span class="refentrytitle">glDisable</span></span></a> of <code class="constant">GL_DEPTH_TEST</code>.)

</p>

<p>

<em class="parameter"><code>func</code></em> specifies the conditions under which the pixel will be drawn.

The comparison functions are as follows:

</p>

<div class="variablelist">

<dl class="variablelist">

<dt>

<span class="term">

<code class="constant">GL_NEVER</code>

</span>

</dt>

<dd>

<p>

Never passes.

</p>

</dd>

<dt>

<span class="term">

<code class="constant">GL_LESS</code>

</span>

</dt>

<dd>

<p>

Passes if the incoming depth value is less than the stored depth value.

</p>

</dd>

<dt>

<span class="term">

<code class="constant">GL_EQUAL</code>

</span>

</dt>

<dd>

<p>

Passes if the incoming depth value is equal to the stored depth value.

</p>

</dd>

<dt>

<span class="term">

<code class="constant">GL_LEQUAL</code>

</span>

</dt>

<dd>

<p>

Passes if the incoming depth value is less than or equal to

the stored depth value.

</p>

</dd>

<dt>

<span class="term">

<code class="constant">GL_GREATER</code>

</span>

</dt>

<dd>

<p>

Passes if the incoming depth value is greater than the stored depth value.

</p>

</dd>

<dt>

<span class="term">

<code class="constant">GL_NOTEQUAL</code>

</span>

</dt>

<dd>

<p>

Passes if the incoming depth value is not equal to the stored depth value.

</p>

</dd>

<dt>

<span class="term">

<code class="constant">GL_GEQUAL</code>

</span>

</dt>

<dd>

<p>

Passes if the incoming depth value is greater than or equal to

the stored depth value.

</p>

</dd>

<dt>

<span class="term">

<code class="constant">GL_ALWAYS</code>

</span>

</dt>

<dd>

<p>

Always passes.

</p>

</dd>

</dl>

</div>

<p>

The initial value of <em class="parameter"><code>func</code></em> is <code class="constant">GL_LESS</code>.

Initially, depth testing is disabled. If depth testing is disabled or if no

depth buffer exists, it is as if the depth test always passes.

</p>

</div>

<div class="refsect1" id="notes">

<h2>Notes</h2>

<p>

Even if the depth buffer exists and the depth mask is non-zero, the

depth buffer is not updated if the depth test is disabled. In order to

unconditionally write to the depth buffer, the depth test should be enabled

and set to <code class="constant">GL_ALWAYS</code>.

</p>

</div>

<div class="refsect1" id="errors">

<h2>Errors</h2>

<p>

<code class="constant">GL_INVALID_ENUM</code> is generated if <em class="parameter"><code>func</code></em> is not an accepted value.

</p>

</div>

<div class="refsect1" id="associatedgets">

<h2>Associated Gets</h2>

<p>

<a class="citerefentry" href="glGet"><span class="citerefentry"><span class="refentrytitle">glGet</span></span></a> with argument <code class="constant">GL_DEPTH_FUNC</code>

</p>

<p>

<a class="citerefentry" href="glIsEnabled"><span class="citerefentry"><span class="refentrytitle">glIsEnabled</span></span></a> with argument <code class="constant">GL_DEPTH_TEST</code>

</p>

</div>

{$pipelinestall}{$examples}

<div class="refsect1" id="versions">

<h2>API Version Support</h2>

<div class="informaltable">

<table style="border-collapse: collapse; border-top: 2px solid ; border-bottom: 2px solid ; border-left: 2px solid ; border-right: 2px solid ; ">

<colgroup>

<col style="text-align: left; "/>

<col style="text-align: center; " class="firstvers"/>

<col style="text-align: center; "/>

<col style="text-align: center; " class="lastvers"/>

</colgroup>

<thead>

<tr>

<th style="text-align: left; border-right: 2px solid ; ">

</th>

<th style="text-align: center; border-bottom: 2px solid ; " colspan="3">

<span class="bold"><strong>OpenGL ES API Version</strong></span>

</th>

</tr>

<tr>

<th style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; ">

<span class="bold"><strong>Function Name</strong></span>

</th>

<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">

<span class="bold"><strong>2.0</strong></span>

</th>

<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">

<span class="bold"><strong>3.0</strong></span>

</th>

<th style="text-align: center; border-bottom: 2px solid ; ">

<span class="bold"><strong>3.1</strong></span>

</th>

</tr>

</thead>

<tbody>

<tr>

<td style="text-align: left; border-right: 2px solid ; ">glDepthFunc</td>

<td style="text-align: center; border-right: 2px solid ; ">✔</td>

<td style="text-align: center; border-right: 2px solid ; ">✔</td>

<td style="text-align: center; ">✔</td>

</tr>

</tbody>

</table>

</div>

</div>

<div class="refsect1" id="seealso">

<h2>See Also</h2>

<p>

<a class="citerefentry" href="glDepthRangef"><span class="citerefentry"><span class="refentrytitle">glDepthRangef</span></span></a>,

<a class="citerefentry" href="glEnable"><span class="citerefentry"><span class="refentrytitle">glEnable</span></span></a>,

<a class="citerefentry" href="glPolygonOffset"><span class="citerefentry"><span class="refentrytitle">glPolygonOffset</span></span></a>

</p>

</div>

<div class="refsect1" id="Copyright">

<h2>Copyright</h2>

<p>

Copyright © 1991-2006 Silicon Graphics, Inc.

Copyright © 2010-2014 Khronos Group.

This document is licensed under the SGI Free Software B License.

For details, see

<a class="link" href="https://web.archive.org/web/20171022161616/http://oss.sgi.com/projects/FreeB/" target="_top">https://web.archive.org/web/20171022161616/http://oss.sgi.com/projects/FreeB/</a>.

</p>

</div>

</div>