mirror of
https://github.com/Ryujinx/Opentk.git
synced 2024-12-27 09:25:40 +00:00
85 lines
3.7 KiB
XML
85 lines
3.7 KiB
XML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"
|
|
"http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">
|
|
<refentry id="glDepthMask">
|
|
<refmeta>
|
|
<refmetainfo>
|
|
<copyright>
|
|
<year>1991-2006</year>
|
|
<holder>Silicon Graphics, Inc.</holder>
|
|
</copyright>
|
|
</refmetainfo>
|
|
<refentrytitle>glDepthMask</refentrytitle>
|
|
<manvolnum>3G</manvolnum>
|
|
</refmeta>
|
|
<refnamediv>
|
|
<refname>glDepthMask</refname>
|
|
<refpurpose>enable or disable writing into the depth buffer</refpurpose>
|
|
</refnamediv>
|
|
<refsynopsisdiv><title>C Specification</title>
|
|
<funcsynopsis>
|
|
<funcprototype>
|
|
<funcdef>void <function>glDepthMask</function></funcdef>
|
|
<paramdef>GLboolean <parameter>flag</parameter></paramdef>
|
|
</funcprototype>
|
|
</funcsynopsis>
|
|
</refsynopsisdiv>
|
|
<refsect1 id="parameters"><title>Parameters</title>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>flag</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Specifies whether the depth buffer is enabled for writing.
|
|
If <parameter>flag</parameter> is <constant>GL_FALSE</constant>,
|
|
depth buffer writing is disabled.
|
|
Otherwise, it is enabled.
|
|
Initially, depth buffer writing is enabled.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</refsect1>
|
|
<refsect1 id="description"><title>Description</title>
|
|
<para>
|
|
<function>glDepthMask</function> specifies whether the depth buffer is enabled for writing.
|
|
If <parameter>flag</parameter> is <constant>GL_FALSE</constant>,
|
|
depth buffer writing is disabled.
|
|
Otherwise, it is enabled.
|
|
Initially, depth buffer writing is enabled.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 id="associatedgets"><title>Associated Gets</title>
|
|
<para>
|
|
<citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument <constant>GL_DEPTH_WRITEMASK</constant>
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 id="notes"><title>Notes</title>
|
|
<para>
|
|
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 <constant>GL_ALWAYS</constant> (see <citerefentry><refentrytitle>glDepthFunc</refentrytitle></citerefentry>).
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 id="seealso"><title>See Also</title>
|
|
<para>
|
|
<citerefentry><refentrytitle>glColorMask</refentrytitle></citerefentry>,
|
|
<citerefentry><refentrytitle>glDepthFunc</refentrytitle></citerefentry>,
|
|
<citerefentry><refentrytitle>glDepthRange</refentrytitle></citerefentry>,
|
|
<citerefentry><refentrytitle>glStencilMask</refentrytitle></citerefentry>
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 id="Copyright"><title>Copyright</title>
|
|
<para>
|
|
Copyright <trademark class="copyright"></trademark> 1991-2006
|
|
Silicon Graphics, Inc.
|
|
Copyright <trademark class="copyright"></trademark> 2012
|
|
Khronos Group.
|
|
This document is licensed under the SGI
|
|
Free Software B License. For details, see
|
|
<ulink url="http://oss.sgi.com/projects/FreeB/">http://oss.sgi.com/projects/FreeB/</ulink>.
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|