Commit | Line | Data |
---|---|---|
7faf1d71 AW |
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="glDepthMask"> | |
5 | <refmeta> | |
6 | <refmetainfo> | |
7 | <copyright> | |
8 | <year>1991-2006</year> | |
9 | <holder>Silicon Graphics, Inc.</holder> | |
10 | </copyright> | |
11 | </refmetainfo> | |
12 | <refentrytitle>glDepthMask</refentrytitle> | |
13 | <manvolnum>3G</manvolnum> | |
14 | </refmeta> | |
15 | <refnamediv> | |
16 | <refname>glDepthMask</refname> | |
17 | <refpurpose>enable or disable writing into the depth buffer</refpurpose> | |
18 | </refnamediv> | |
19 | <refsynopsisdiv><title>C Specification</title> | |
20 | <funcsynopsis> | |
21 | <funcprototype> | |
22 | <funcdef>void <function>glDepthMask</function></funcdef> | |
23 | <paramdef>GLboolean <parameter>flag</parameter></paramdef> | |
24 | </funcprototype> | |
25 | </funcsynopsis> | |
26 | </refsynopsisdiv> | |
27 | <refsect1 id="parameters"><title>Parameters</title> | |
28 | <variablelist> | |
29 | <varlistentry> | |
30 | <term><parameter>flag</parameter></term> | |
31 | <listitem> | |
32 | <para> | |
33 | Specifies whether the depth buffer is enabled for writing. | |
34 | If <parameter>flag</parameter> is <constant>GL_FALSE</constant>, | |
35 | depth buffer writing is disabled. | |
36 | Otherwise, it is enabled. | |
37 | Initially, depth buffer writing is enabled. | |
38 | </para> | |
39 | </listitem> | |
40 | </varlistentry> | |
41 | </variablelist> | |
42 | </refsect1> | |
43 | <refsect1 id="description"><title>Description</title> | |
44 | <para> | |
45 | <function>glDepthMask</function> specifies whether the depth buffer is enabled for writing. | |
46 | If <parameter>flag</parameter> is <constant>GL_FALSE</constant>, | |
47 | depth buffer writing is disabled. | |
48 | Otherwise, it is enabled. | |
49 | Initially, depth buffer writing is enabled. | |
50 | </para> | |
51 | </refsect1> | |
52 | <refsect1 id="associatedgets"><title>Associated Gets</title> | |
53 | <para> | |
54 | <citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument <constant>GL_DEPTH_WRITEMASK</constant> | |
55 | </para> | |
56 | </refsect1> | |
57 | <refsect1 id="notes"><title>Notes</title> | |
58 | <para> | |
59 | Even if the depth buffer exists and the depth mask is non-zero, the | |
60 | depth buffer is not updated if the depth test is disabled. In order to | |
61 | unconditionally write to the depth buffer, the depth test should be enabled | |
62 | and set to <constant>GL_ALWAYS</constant> (see <citerefentry><refentrytitle>glDepthFunc</refentrytitle></citerefentry>). | |
63 | </para> | |
64 | </refsect1> | |
65 | <refsect1 id="seealso"><title>See Also</title> | |
66 | <para> | |
67 | <citerefentry><refentrytitle>glColorMask</refentrytitle></citerefentry>, | |
68 | <citerefentry><refentrytitle>glDepthFunc</refentrytitle></citerefentry>, | |
69 | <citerefentry><refentrytitle>glDepthRange</refentrytitle></citerefentry>, | |
70 | <citerefentry><refentrytitle>glStencilMask</refentrytitle></citerefentry> | |
71 | </para> | |
72 | </refsect1> | |
73 | <refsect1 id="Copyright"><title>Copyright</title> | |
74 | <para> | |
75 | Copyright <trademark class="copyright"></trademark> 1991-2006 | |
76 | Silicon Graphics, Inc. | |
77 | Copyright <trademark class="copyright"></trademark> 2012 | |
78 | Khronos Group. | |
79 | This document is licensed under the SGI | |
80 | Free Software B License. For details, see | |
81 | <ulink url="http://oss.sgi.com/projects/FreeB/">http://oss.sgi.com/projects/FreeB/</ulink>. | |
82 | </para> | |
83 | </refsect1> | |
84 | </refentry> |