mirror of
https://github.com/Ryujinx/Opentk.git
synced 2024-12-26 01:15:38 +00:00
224 lines
14 KiB
XML
224 lines
14 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="glEnableClientState">
|
||
|
|
<refmeta>
|
||
|
|
<refmetainfo>
|
||
|
|
<copyright>
|
||
|
|
<year>1991-2006</year>
|
||
|
|
<holder>Silicon Graphics, Inc.</holder>
|
||
|
|
</copyright>
|
||
|
|
</refmetainfo>
|
||
|
|
<refentrytitle>glEnableClientState</refentrytitle>
|
||
|
|
<manvolnum>3G</manvolnum>
|
||
|
|
</refmeta>
|
||
|
|
<refnamediv>
|
||
|
|
<refname>glEnableClientState</refname>
|
||
|
|
<refpurpose>enable or disable client-side capability</refpurpose>
|
||
|
|
</refnamediv>
|
||
|
|
<refsynopsisdiv><title>C Specification</title>
|
||
|
|
<funcsynopsis>
|
||
|
|
<funcprototype>
|
||
|
|
<funcdef>void <function>glEnableClientState</function></funcdef>
|
||
|
|
<paramdef>GLenum <parameter>cap</parameter></paramdef>
|
||
|
|
</funcprototype>
|
||
|
|
</funcsynopsis>
|
||
|
|
</refsynopsisdiv>
|
||
|
|
<!-- eqn: ignoring delim $$ -->
|
||
|
|
<refsect1 id="parameters"><title>Parameters</title>
|
||
|
|
<variablelist>
|
||
|
|
<varlistentry>
|
||
|
|
<term><parameter>cap</parameter></term>
|
||
|
|
<listitem>
|
||
|
|
<para>
|
||
|
|
Specifies the capability to enable.
|
||
|
|
Symbolic constants
|
||
|
|
<constant>GL_COLOR_ARRAY</constant>,
|
||
|
|
<constant>GL_EDGE_FLAG_ARRAY</constant>,
|
||
|
|
<constant>GL_FOG_COORD_ARRAY</constant>,
|
||
|
|
<constant>GL_INDEX_ARRAY</constant>,
|
||
|
|
<constant>GL_NORMAL_ARRAY</constant>,
|
||
|
|
<constant>GL_SECONDARY_COLOR_ARRAY</constant>,
|
||
|
|
<constant>GL_TEXTURE_COORD_ARRAY</constant>, and
|
||
|
|
<constant>GL_VERTEX_ARRAY</constant>
|
||
|
|
are accepted.
|
||
|
|
</para>
|
||
|
|
</listitem>
|
||
|
|
</varlistentry>
|
||
|
|
</variablelist>
|
||
|
|
</refsect1>
|
||
|
|
<refsynopsisdiv><title>C Specification</title>
|
||
|
|
<funcsynopsis>
|
||
|
|
<funcprototype>
|
||
|
|
<funcdef>void <function>glDisableClientState</function></funcdef>
|
||
|
|
<paramdef>GLenum <parameter>cap</parameter></paramdef>
|
||
|
|
</funcprototype>
|
||
|
|
</funcsynopsis>
|
||
|
|
</refsynopsisdiv>
|
||
|
|
<refsect1 id="parameters2"><title>Parameters</title>
|
||
|
|
<variablelist>
|
||
|
|
<varlistentry>
|
||
|
|
<term><parameter>cap</parameter></term>
|
||
|
|
<listitem>
|
||
|
|
<para>
|
||
|
|
Specifies the capability to disable.
|
||
|
|
</para>
|
||
|
|
</listitem>
|
||
|
|
</varlistentry>
|
||
|
|
</variablelist>
|
||
|
|
</refsect1>
|
||
|
|
<refsect1 id="description"><title>Description</title>
|
||
|
|
<para>
|
||
|
|
<function>glEnableClientState</function> and <citerefentry><refentrytitle>glDisableClientState</refentrytitle></citerefentry>
|
||
|
|
enable or disable individual client-side capabilities. By default, all
|
||
|
|
client-side capabilities are disabled.
|
||
|
|
Both
|
||
|
|
<function>glEnableClientState</function> and <citerefentry><refentrytitle>glDisableClientState</refentrytitle></citerefentry> take a
|
||
|
|
single argument, <parameter>cap</parameter>, which can assume one of the following
|
||
|
|
values:
|
||
|
|
</para>
|
||
|
|
<variablelist>
|
||
|
|
<varlistentry>
|
||
|
|
<term><constant>GL_COLOR_ARRAY</constant></term>
|
||
|
|
<listitem>
|
||
|
|
<para>
|
||
|
|
If enabled, the color array is enabled for writing and used during
|
||
|
|
rendering when <citerefentry><refentrytitle>glArrayElement</refentrytitle></citerefentry>, <citerefentry><refentrytitle>glDrawArrays</refentrytitle></citerefentry>, <citerefentry><refentrytitle>glDrawElements</refentrytitle></citerefentry>,
|
||
|
|
<citerefentry><refentrytitle>glDrawRangeElements</refentrytitle></citerefentry> <citerefentry><refentrytitle>glMultiDrawArrays</refentrytitle></citerefentry>, or
|
||
|
|
<citerefentry><refentrytitle>glMultiDrawElements</refentrytitle></citerefentry> is called. See <citerefentry><refentrytitle>glColorPointer</refentrytitle></citerefentry>.
|
||
|
|
</para>
|
||
|
|
</listitem>
|
||
|
|
</varlistentry>
|
||
|
|
<varlistentry>
|
||
|
|
<term><constant>GL_EDGE_FLAG_ARRAY</constant></term>
|
||
|
|
<listitem>
|
||
|
|
<para>
|
||
|
|
If enabled, the edge flag array is enabled for writing and used during
|
||
|
|
rendering when <citerefentry><refentrytitle>glArrayElement</refentrytitle></citerefentry>, <citerefentry><refentrytitle>glDrawArrays</refentrytitle></citerefentry>, <citerefentry><refentrytitle>glDrawElements</refentrytitle></citerefentry>,
|
||
|
|
<citerefentry><refentrytitle>glDrawRangeElements</refentrytitle></citerefentry> <citerefentry><refentrytitle>glMultiDrawArrays</refentrytitle></citerefentry>, or
|
||
|
|
<citerefentry><refentrytitle>glMultiDrawElements</refentrytitle></citerefentry> is called. See <citerefentry><refentrytitle>glEdgeFlagPointer</refentrytitle></citerefentry>.
|
||
|
|
</para>
|
||
|
|
</listitem>
|
||
|
|
</varlistentry>
|
||
|
|
<varlistentry>
|
||
|
|
<term><constant>GL_FOG_COORD_ARRAY</constant></term>
|
||
|
|
<listitem>
|
||
|
|
<para>
|
||
|
|
If enabled, the fog coordinate array is enabled for writing and used during
|
||
|
|
rendering when <citerefentry><refentrytitle>glArrayElement</refentrytitle></citerefentry>, <citerefentry><refentrytitle>glDrawArrays</refentrytitle></citerefentry>, <citerefentry><refentrytitle>glDrawElements</refentrytitle></citerefentry>,
|
||
|
|
<citerefentry><refentrytitle>glDrawRangeElements</refentrytitle></citerefentry> <citerefentry><refentrytitle>glMultiDrawArrays</refentrytitle></citerefentry>, or
|
||
|
|
<citerefentry><refentrytitle>glMultiDrawElements</refentrytitle></citerefentry> is called. See <citerefentry><refentrytitle>glFogCoordPointer</refentrytitle></citerefentry>.
|
||
|
|
</para>
|
||
|
|
</listitem>
|
||
|
|
</varlistentry>
|
||
|
|
<varlistentry>
|
||
|
|
<term><constant>GL_INDEX_ARRAY</constant></term>
|
||
|
|
<listitem>
|
||
|
|
<para>
|
||
|
|
If enabled, the index array is enabled for writing and used during
|
||
|
|
rendering when <citerefentry><refentrytitle>glArrayElement</refentrytitle></citerefentry>, <citerefentry><refentrytitle>glDrawArrays</refentrytitle></citerefentry>, <citerefentry><refentrytitle>glDrawElements</refentrytitle></citerefentry>,
|
||
|
|
<citerefentry><refentrytitle>glDrawRangeElements</refentrytitle></citerefentry> <citerefentry><refentrytitle>glMultiDrawArrays</refentrytitle></citerefentry>, or
|
||
|
|
<citerefentry><refentrytitle>glMultiDrawElements</refentrytitle></citerefentry> is called. See <citerefentry><refentrytitle>glIndexPointer</refentrytitle></citerefentry>.
|
||
|
|
</para>
|
||
|
|
</listitem>
|
||
|
|
</varlistentry>
|
||
|
|
<varlistentry>
|
||
|
|
<term><constant>GL_NORMAL_ARRAY</constant></term>
|
||
|
|
<listitem>
|
||
|
|
<para>
|
||
|
|
If enabled, the normal array is enabled for writing and used during
|
||
|
|
rendering when <citerefentry><refentrytitle>glArrayElement</refentrytitle></citerefentry>, <citerefentry><refentrytitle>glDrawArrays</refentrytitle></citerefentry>, <citerefentry><refentrytitle>glDrawElements</refentrytitle></citerefentry>,
|
||
|
|
<citerefentry><refentrytitle>glDrawRangeElements</refentrytitle></citerefentry> <citerefentry><refentrytitle>glMultiDrawArrays</refentrytitle></citerefentry>, or
|
||
|
|
<citerefentry><refentrytitle>glMultiDrawElements</refentrytitle></citerefentry> is called. See <citerefentry><refentrytitle>glNormalPointer</refentrytitle></citerefentry>.
|
||
|
|
</para>
|
||
|
|
</listitem>
|
||
|
|
</varlistentry>
|
||
|
|
<varlistentry>
|
||
|
|
<term><constant>GL_SECONDARY_COLOR_ARRAY</constant></term>
|
||
|
|
<listitem>
|
||
|
|
<para>
|
||
|
|
If enabled, the secondary color array is enabled for writing and used
|
||
|
|
during rendering when <citerefentry><refentrytitle>glArrayElement</refentrytitle></citerefentry>, <citerefentry><refentrytitle>glDrawArrays</refentrytitle></citerefentry>,
|
||
|
|
<citerefentry><refentrytitle>glDrawElements</refentrytitle></citerefentry>, <citerefentry><refentrytitle>glDrawRangeElements</refentrytitle></citerefentry> <citerefentry><refentrytitle>glMultiDrawArrays</refentrytitle></citerefentry>, or
|
||
|
|
<citerefentry><refentrytitle>glMultiDrawElements</refentrytitle></citerefentry> is called. See <citerefentry><refentrytitle>glColorPointer</refentrytitle></citerefentry>.
|
||
|
|
</para>
|
||
|
|
</listitem>
|
||
|
|
</varlistentry>
|
||
|
|
<varlistentry>
|
||
|
|
<term><constant>GL_TEXTURE_COORD_ARRAY</constant></term>
|
||
|
|
<listitem>
|
||
|
|
<para>
|
||
|
|
If enabled, the texture coordinate array is enabled for writing and used
|
||
|
|
during rendering when <citerefentry><refentrytitle>glArrayElement</refentrytitle></citerefentry>, <citerefentry><refentrytitle>glDrawArrays</refentrytitle></citerefentry>,
|
||
|
|
<citerefentry><refentrytitle>glDrawElements</refentrytitle></citerefentry>, <citerefentry><refentrytitle>glDrawRangeElements</refentrytitle></citerefentry> <citerefentry><refentrytitle>glMultiDrawArrays</refentrytitle></citerefentry>, or
|
||
|
|
<citerefentry><refentrytitle>glMultiDrawElements</refentrytitle></citerefentry> is called. See <citerefentry><refentrytitle>glTexCoordPointer</refentrytitle></citerefentry>.
|
||
|
|
</para>
|
||
|
|
</listitem>
|
||
|
|
</varlistentry>
|
||
|
|
<varlistentry>
|
||
|
|
<term><constant>GL_VERTEX_ARRAY</constant></term>
|
||
|
|
<listitem>
|
||
|
|
<para>
|
||
|
|
If enabled, the vertex array is enabled for writing and used during
|
||
|
|
rendering when <citerefentry><refentrytitle>glArrayElement</refentrytitle></citerefentry>, <citerefentry><refentrytitle>glDrawArrays</refentrytitle></citerefentry>, <citerefentry><refentrytitle>glDrawElements</refentrytitle></citerefentry>,
|
||
|
|
<citerefentry><refentrytitle>glDrawRangeElements</refentrytitle></citerefentry> <citerefentry><refentrytitle>glMultiDrawArrays</refentrytitle></citerefentry>, or
|
||
|
|
<citerefentry><refentrytitle>glMultiDrawElements</refentrytitle></citerefentry> is called. See <citerefentry><refentrytitle>glVertexPointer</refentrytitle></citerefentry>.
|
||
|
|
</para>
|
||
|
|
</listitem>
|
||
|
|
</varlistentry>
|
||
|
|
</variablelist>
|
||
|
|
</refsect1>
|
||
|
|
<refsect1 id="notes"><title>Notes</title>
|
||
|
|
<para>
|
||
|
|
<function>glEnableClientState</function> is available only if the GL version is 1.1 or greater.
|
||
|
|
</para>
|
||
|
|
<para>
|
||
|
|
<constant>GL_FOG_COORD_ARRAY</constant> and <constant>GL_SECONDARY_COLOR_ARRAY</constant> are available only if the GL version is 1.4 or
|
||
|
|
greater.
|
||
|
|
</para>
|
||
|
|
<para>
|
||
|
|
For OpenGL versions 1.3 and greater, or when <code>ARB_multitexture</code> is supported, enabling and disabling
|
||
|
|
<constant>GL_TEXTURE_COORD_ARRAY</constant> affects the active client texture unit.
|
||
|
|
The active client texture unit is controlled with
|
||
|
|
<citerefentry><refentrytitle>glClientActiveTexture</refentrytitle></citerefentry>.
|
||
|
|
</para>
|
||
|
|
</refsect1>
|
||
|
|
<refsect1 id="errors"><title>Errors</title>
|
||
|
|
<para>
|
||
|
|
<constant>GL_INVALID_ENUM</constant> is generated if <parameter>cap</parameter> is not an accepted value.
|
||
|
|
</para>
|
||
|
|
<para>
|
||
|
|
<function>glEnableClientState</function> is not allowed between the execution of <citerefentry><refentrytitle>glBegin</refentrytitle></citerefentry> and the
|
||
|
|
corresponding <citerefentry><refentrytitle>glEnd</refentrytitle></citerefentry>, but an error may or may not be generated. If
|
||
|
|
no error is generated, the behavior is undefined.
|
||
|
|
</para>
|
||
|
|
</refsect1>
|
||
|
|
<refsect1 id="seealso"><title>See Also</title>
|
||
|
|
<para>
|
||
|
|
<citerefentry><refentrytitle>glArrayElement</refentrytitle></citerefentry>,
|
||
|
|
<citerefentry><refentrytitle>glClientActiveTexture</refentrytitle></citerefentry>,
|
||
|
|
<citerefentry><refentrytitle>glColorPointer</refentrytitle></citerefentry>,
|
||
|
|
<citerefentry><refentrytitle>glDrawArrays</refentrytitle></citerefentry>,
|
||
|
|
<citerefentry><refentrytitle>glDrawElements</refentrytitle></citerefentry>,
|
||
|
|
<citerefentry><refentrytitle>glEdgeFlagPointer</refentrytitle></citerefentry>,
|
||
|
|
<citerefentry><refentrytitle>glFogCoordPointer</refentrytitle></citerefentry>,
|
||
|
|
<citerefentry><refentrytitle>glEnable</refentrytitle></citerefentry>,
|
||
|
|
<citerefentry><refentrytitle>glGetPointerv</refentrytitle></citerefentry>,
|
||
|
|
<citerefentry><refentrytitle>glIndexPointer</refentrytitle></citerefentry>,
|
||
|
|
<citerefentry><refentrytitle>glInterleavedArrays</refentrytitle></citerefentry>,
|
||
|
|
<citerefentry><refentrytitle>glNormalPointer</refentrytitle></citerefentry>,
|
||
|
|
<citerefentry><refentrytitle>glSecondaryColorPointer</refentrytitle></citerefentry>,
|
||
|
|
<citerefentry><refentrytitle>glTexCoordPointer</refentrytitle></citerefentry>,
|
||
|
|
<citerefentry><refentrytitle>glVertexPointer</refentrytitle></citerefentry>
|
||
|
|
</para>
|
||
|
|
</refsect1>
|
||
|
|
<refsect1 id="Copyright"><title>Copyright</title>
|
||
|
|
<para>
|
||
|
|
Copyright <trademark class="copyright"></trademark> 1991-2006
|
||
|
|
Silicon Graphics, Inc. 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>
|