rename upstream-man-pages to upstream-doc
[clinton/guile-figl.git] / upstream-doc / man4 / xhtml / glDepthMask.xml
CommitLineData
7faf1d71
AW
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>glDepthMask - 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="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>
5 Specifies whether the depth buffer is enabled for writing.
6 If <em class="parameter"><code>flag</code></em> is <code class="constant">GL_FALSE</code>,
7 depth buffer writing is disabled.
8 Otherwise, it is enabled.
9 Initially, depth buffer writing is enabled.
10 </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p>
11 <code class="function">glDepthMask</code> specifies whether the depth buffer is enabled for writing.
12 If <em class="parameter"><code>flag</code></em> is <code class="constant">GL_FALSE</code>,
13 depth buffer writing is disabled.
14 Otherwise, it is enabled.
15 Initially, depth buffer writing is enabled.
16 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="associatedgets"></a><h2>Associated Gets</h2><p>
17 <a href="glGet.xml"><span class="citerefentry"><span class="refentrytitle">glGet</span></span></a> with argument <code class="constant">GL_DEPTH_WRITEMASK</code>
18 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="notes"></a><h2>Notes</h2><p>
19 Even if the depth buffer exists and the depth mask is non-zero, the
20 depth buffer is not updated if the depth test is disabled. In order to
21 unconditionally write to the depth buffer, the depth test should be enabled
22 and set to <code class="constant">GL_ALWAYS</code> (see <a href="glDepthFunc.xml"><span class="citerefentry"><span class="refentrytitle">glDepthFunc</span></span></a>).
23 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p>
24 <a href="glColorMask.xml"><span class="citerefentry"><span class="refentrytitle">glColorMask</span></span></a>,
25 <a href="glDepthFunc.xml"><span class="citerefentry"><span class="refentrytitle">glDepthFunc</span></span></a>,
26 <a href="glDepthRange.xml"><span class="citerefentry"><span class="refentrytitle">glDepthRange</span></span></a>,
27 <a href="glStencilMask.xml"><span class="citerefentry"><span class="refentrytitle">glStencilMask</span></span></a>
28 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p>
29 Copyright <span class="trademark"></span>© 1991-2006
30 Silicon Graphics, Inc.
31 Copyright <span class="trademark"></span>© 2012
32 Khronos Group.
33 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>