forked from BSVino/docs.gl
-
Notifications
You must be signed in to change notification settings - Fork 0
/
glDepthMask.xhtml
35 lines (35 loc) · 3.42 KB
/
glDepthMask.xhtml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
<div class="refentry" lang="en" xml:lang="en"><a id="glDepthMask"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glDepthMask — enable or disable writing into the depth buffer</p></div><div class="refsynopsisdiv"><h2>C Specification</h2><div class="funcsynopsis"><p><code class="funcdef">void <b class="fsfunc">glDepthMask</b>(</code>GLboolean <var class="pdparam">flag</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>flag</code></em></span></dt><dd><p>
Specifies whether the depth buffer is enabled for writing.
If <em class="parameter"><code>flag</code></em> is <code class="constant">GL_FALSE</code>,
depth buffer writing is disabled.
Otherwise, it is enabled.
Initially, depth buffer writing is enabled.
</p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p>
<code class="function">glDepthMask</code> specifies whether the depth buffer is enabled for writing.
If <em class="parameter"><code>flag</code></em> is <code class="constant">GL_FALSE</code>,
depth buffer writing is disabled.
Otherwise, it is enabled.
Initially, depth buffer writing is enabled.
</p></div><div class="refsect1" lang="en" xml:lang="en"><a id="associatedgets"></a><h2>Associated Gets</h2><p>
<a href="glGet"><span class="citerefentry"><span class="refentrytitle">glGet</span></span></a> with argument <code class="constant">GL_DEPTH_WRITEMASK</code>
</p></div><div class="refsect1" lang="en" xml:lang="en"><a id="notes"></a><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> (see <a href="glDepthFunc"><span class="citerefentry"><span class="refentrytitle">glDepthFunc</span></span></a>).
</p></div>
{$pipelinestall}{$examples}
<div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p>
<a href="glColorMask"><span class="citerefentry"><span class="refentrytitle">glColorMask</span></span></a>,
<a href="glDepthFunc"><span class="citerefentry"><span class="refentrytitle">glDepthFunc</span></span></a>,
<a href="glDepthRange"><span class="citerefentry"><span class="refentrytitle">glDepthRange</span></span></a>,
<a href="glStencilMask"><span class="citerefentry"><span class="refentrytitle">glStencilMask</span></span></a>
</p></div><div class="refsect1" lang="en" xml:lang="en"><div id="Copyright"><h2>Copyright</h2><p>
Copyright © 1991-2006
Silicon Graphics, Inc.
Copyright © 2012
Khronos Group.
This document is licensed under the SGI
Free Software B License. For details, see
<a 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></div>