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="glClientActiveTexture"> | |
5 | <refmeta> | |
6 | <refmetainfo> | |
7 | <copyright> | |
8 | <year>1991-2006</year> | |
9 | <holder>Silicon Graphics, Inc.</holder> | |
10 | </copyright> | |
11 | </refmetainfo> | |
12 | <refentrytitle>glClientActiveTexture</refentrytitle> | |
13 | <manvolnum>3G</manvolnum> | |
14 | </refmeta> | |
15 | <refnamediv> | |
16 | <refname>glClientActiveTexture</refname> | |
17 | <refpurpose>select active texture unit</refpurpose> | |
18 | </refnamediv> | |
19 | <refsynopsisdiv><title>C Specification</title> | |
20 | <funcsynopsis> | |
21 | <funcprototype> | |
22 | <funcdef>void <function>glClientActiveTexture</function></funcdef> | |
23 | <paramdef>GLenum <parameter>texture</parameter></paramdef> | |
24 | </funcprototype> | |
25 | </funcsynopsis> | |
26 | </refsynopsisdiv> | |
27 | <!-- eqn: ignoring delim $$ --> | |
28 | <refsect1 id="parameters"><title>Parameters</title> | |
29 | <variablelist> | |
30 | <varlistentry> | |
31 | <term><parameter>texture</parameter></term> | |
32 | <listitem> | |
33 | <para> | |
34 | Specifies which texture unit to make active. The number | |
35 | of texture units is implementation dependent, but must be at least | |
36 | two. <parameter>texture</parameter> must be one of | |
37 | <constant>GL_TEXTURE</constant><inlineequation><mml:math><mml:mi mathvariant="italic">i</mml:mi></mml:math></inlineequation>, | |
38 | where i ranges from 0 to the value of <constant>GL_MAX_TEXTURE_COORDS</constant> - 1, which is an | |
39 | implementation-dependent value. The initial value is | |
40 | <constant>GL_TEXTURE0</constant>. | |
41 | </para> | |
42 | </listitem> | |
43 | </varlistentry> | |
44 | </variablelist> | |
45 | </refsect1> | |
46 | <refsect1 id="description"><title>Description</title> | |
47 | <para> | |
48 | <function>glClientActiveTexture</function> selects the vertex array client state parameters to be modified by | |
49 | <citerefentry><refentrytitle>glTexCoordPointer</refentrytitle></citerefentry>, and enabled or disabled with | |
50 | <citerefentry><refentrytitle>glEnableClientState</refentrytitle></citerefentry> or <citerefentry><refentrytitle>glDisableClientState</refentrytitle></citerefentry>, respectively, | |
51 | when called with a parameter of <constant>GL_TEXTURE_COORD_ARRAY</constant>. | |
52 | </para> | |
53 | </refsect1> | |
54 | <refsect1 id="notes"><title>Notes</title> | |
55 | <para> | |
56 | <function>glClientActiveTexture</function> is supported only if the GL version is 1.3 or greater, or | |
57 | <code>ARB_multitexture</code> is included in the string returned by | |
58 | <citerefentry><refentrytitle>glGetString</refentrytitle></citerefentry> when called with the argument <constant>GL_EXTENSIONS</constant>. | |
59 | </para> | |
60 | </refsect1> | |
61 | <refsect1 id="errors"><title>Errors</title> | |
62 | <para> | |
63 | <constant>GL_INVALID_ENUM</constant> is generated if <parameter>texture</parameter> is not one of | |
64 | <constant>GL_TEXTURE</constant><inlineequation><mml:math><mml:mi mathvariant="italic">i</mml:mi></mml:math></inlineequation>, | |
65 | where | |
66 | i ranges from 0 to the value of <constant>GL_MAX_TEXTURE_COORDS</constant> - 1. | |
67 | </para> | |
68 | </refsect1> | |
69 | <refsect1 id="associatedgets"><title>Associated Gets</title> | |
70 | <para> | |
71 | <citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument <constant>GL_CLIENT_ACTIVE_TEXTURE</constant> or <constant>GL_MAX_TEXTURE_COORDS</constant> | |
72 | </para> | |
73 | </refsect1> | |
74 | <refsect1 id="seealso"><title>See Also</title> | |
75 | <para> | |
76 | <citerefentry><refentrytitle>glActiveTexture</refentrytitle></citerefentry>, | |
77 | <citerefentry><refentrytitle>glDisableClientState</refentrytitle></citerefentry>, | |
78 | <citerefentry><refentrytitle>glEnableClientState</refentrytitle></citerefentry>, | |
79 | <citerefentry><refentrytitle>glMultiTexCoord</refentrytitle></citerefentry>, | |
80 | <citerefentry><refentrytitle>glTexCoordPointer</refentrytitle></citerefentry> | |
81 | </para> | |
82 | </refsect1> | |
83 | <refsect1 id="Copyright"><title>Copyright</title> | |
84 | <para> | |
85 | Copyright <trademark class="copyright"></trademark> 1991-2006 | |
86 | Silicon Graphics, Inc. This document is licensed under the SGI | |
87 | Free Software B License. For details, see | |
88 | <ulink url="http://oss.sgi.com/projects/FreeB/">http://oss.sgi.com/projects/FreeB/</ulink>. | |
89 | </para> | |
90 | </refsect1> | |
91 | </refentry> |