<div class="refentry" lang="en" xml:lang="en"><a id="glColorPointer"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glColorPointer — define an array of colors</p></div><div class="refsynopsisdiv"><h2>C Specification</h2><div class="funcsynopsis"><table><tr><td><code class="funcdef">void <b class="fsfunc">glColorPointer</b>(</code></td><td>GLint  </td><td><var class="pdparam">size</var>, </td></tr><tr><td> </td><td>GLenum  </td><td><var class="pdparam">type</var>, </td></tr><tr><td> </td><td>GLsizei  </td><td><var class="pdparam">stride</var>, </td></tr><tr><td> </td><td>const GLvoid *  </td><td><var class="pdparam">pointer</var><code>)</code>;</td></tr></table></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>size</code></em></span></dt><dd><p>

Specifies the number of components per color. Must be 3 or 4.

The initial value is 4.

</p></dd><dt><span class="term"><em class="parameter"><code>type</code></em></span></dt><dd><p>

Specifies the data type of each color component in the array.

Symbolic constants

<code class="constant">GL_BYTE</code>,

<code class="constant">GL_UNSIGNED_BYTE</code>,

<code class="constant">GL_SHORT</code>,

<code class="constant">GL_UNSIGNED_SHORT</code>,

<code class="constant">GL_INT</code>,

<code class="constant">GL_UNSIGNED_INT</code>,

<code class="constant">GL_FLOAT</code>,

and

<code class="constant">GL_DOUBLE</code>

are accepted.

The initial value is <code class="constant">GL_FLOAT</code>.

</p></dd><dt><span class="term"><em class="parameter"><code>stride</code></em></span></dt><dd><p>

Specifies the byte offset between consecutive colors.

If <em class="parameter"><code>stride</code></em> is 0, the colors are understood to be

tightly packed in the array. The initial value is 0.

</p></dd><dt><span class="term"><em class="parameter"><code>pointer</code></em></span></dt><dd><p>

Specifies a pointer to the first component of the first color element

in the array. The initial value is 0.

</p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p>

<code class="function">glColorPointer</code> specifies the location and data format of an array of color components

to use when rendering.

<em class="parameter"><code>size</code></em> specifies the number of components per color, and must be 3 or 4.

<em class="parameter"><code>type</code></em> specifies the data type of each color component, and <em class="parameter"><code>stride</code></em>

specifies the byte stride from one color to the next, allowing vertices and

attributes to be packed into a single array or stored in separate arrays.

(Single-array storage may be more efficient on some implementations;

see <a class="citerefentry" href="glInterleavedArrays"><span class="citerefentry"><span class="refentrytitle">glInterleavedArrays</span></span></a>.)

</p><p>

If a non-zero named buffer object is bound to the <code class="constant">GL_ARRAY_BUFFER</code> target

(see <a class="citerefentry" href="glBindBuffer"><span class="citerefentry"><span class="refentrytitle">glBindBuffer</span></span></a>) while a color array is

specified, <em class="parameter"><code>pointer</code></em> is treated as a byte offset into the buffer object's data store.

Also, the buffer object binding (<code class="constant">GL_ARRAY_BUFFER_BINDING</code>) is saved as color vertex array

client-side state (<code class="constant">GL_COLOR_ARRAY_BUFFER_BINDING</code>).

</p><p>

When a color array is specified,

<em class="parameter"><code>size</code></em>, <em class="parameter"><code>type</code></em>, <em class="parameter"><code>stride</code></em>, and <em class="parameter"><code>pointer</code></em> are saved as client-side

state, in addition to the current vertex array buffer object binding.

</p><p>

To enable and disable the color array, call

<a class="citerefentry" href="glEnableClientState"><span class="citerefentry"><span class="refentrytitle">glEnableClientState</span></span></a> and <a class="citerefentry" href="glDisableClientState"><span class="citerefentry"><span class="refentrytitle">glDisableClientState</span></span></a> with the argument

<code class="constant">GL_COLOR_ARRAY</code>. If

enabled, the color array is used

when <a class="citerefentry" href="glDrawArrays"><span class="citerefentry"><span class="refentrytitle">glDrawArrays</span></span></a>, <a class="citerefentry" href="glMultiDrawArrays"><span class="citerefentry"><span class="refentrytitle">glMultiDrawArrays</span></span></a>, <a class="citerefentry" href="glDrawElements"><span class="citerefentry"><span class="refentrytitle">glDrawElements</span></span></a>,

<a class="citerefentry" href="glMultiDrawElements"><span class="citerefentry"><span class="refentrytitle">glMultiDrawElements</span></span></a>, <a class="citerefentry" href="glDrawRangeElements"><span class="citerefentry"><span class="refentrytitle">glDrawRangeElements</span></span></a>, or

<a class="citerefentry" href="glArrayElement"><span class="citerefentry"><span class="refentrytitle">glArrayElement</span></span></a> is called.

</p></div><div class="refsect1" lang="en" xml:lang="en"><a id="notes"></a><h2>Notes</h2><p>

<code class="function">glColorPointer</code> is available only if the GL version is 1.1 or greater.

</p><p>

The color array is initially disabled and isn't accessed when

<a class="citerefentry" href="glArrayElement"><span class="citerefentry"><span class="refentrytitle">glArrayElement</span></span></a>, <a class="citerefentry" href="glDrawElements"><span class="citerefentry"><span class="refentrytitle">glDrawElements</span></span></a>, <a class="citerefentry" href="glDrawRangeElements"><span class="citerefentry"><span class="refentrytitle">glDrawRangeElements</span></span></a>,

<a class="citerefentry" href="glDrawArrays"><span class="citerefentry"><span class="refentrytitle">glDrawArrays</span></span></a>, <a class="citerefentry" href="glMultiDrawArrays"><span class="citerefentry"><span class="refentrytitle">glMultiDrawArrays</span></span></a>, or <a class="citerefentry" href="glMultiDrawElements"><span class="citerefentry"><span class="refentrytitle">glMultiDrawElements</span></span></a>

is called.

</p><p>

Execution of <code class="function">glColorPointer</code> is not allowed between the execution of

<a class="citerefentry" href="glBegin"><span class="citerefentry"><span class="refentrytitle">glBegin</span></span></a> and the corresponding execution of <a class="citerefentry" href="glEnd"><span class="citerefentry"><span class="refentrytitle">glEnd</span></span></a>,

but an error may or may not be generated. If no error is generated,

the operation is undefined.

</p><p>

<code class="function">glColorPointer</code> is typically implemented on the client side.

</p><p>

Color array parameters are client-side state and are therefore not saved

or restored by <a class="citerefentry" href="glPushAttrib"><span class="citerefentry"><span class="refentrytitle">glPushAttrib</span></span></a> and <a class="citerefentry" href="glPopAttrib"><span class="citerefentry"><span class="refentrytitle">glPopAttrib</span></span></a>.

Use <a class="citerefentry" href="glPushClientAttrib"><span class="citerefentry"><span class="refentrytitle">glPushClientAttrib</span></span></a> and <a class="citerefentry" href="glPopClientAttrib"><span class="citerefentry"><span class="refentrytitle">glPopClientAttrib</span></span></a> instead.

</p></div><div class="refsect1" lang="en" xml:lang="en"><a id="errors"></a><h2>Errors</h2><p>

<code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>size</code></em> is not 3 or 4.

</p><p>

<code class="constant">GL_INVALID_ENUM</code> is generated if <em class="parameter"><code>type</code></em> is not an accepted value.

</p><p>

<code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>stride</code></em> is negative.

</p></div><div class="refsect1" lang="en" xml:lang="en"><a id="associatedgets"></a><h2>Associated Gets</h2><p>

<a class="citerefentry" href="glIsEnabled"><span class="citerefentry"><span class="refentrytitle">glIsEnabled</span></span></a> with argument <code class="constant">GL_COLOR_ARRAY</code>

</p><p>

<a class="citerefentry" href="glGet"><span class="citerefentry"><span class="refentrytitle">glGet</span></span></a> with argument <code class="constant">GL_COLOR_ARRAY_SIZE</code>

</p><p>

<a class="citerefentry" href="glGet"><span class="citerefentry"><span class="refentrytitle">glGet</span></span></a> with argument <code class="constant">GL_COLOR_ARRAY_TYPE</code>

</p><p>

<a class="citerefentry" href="glGet"><span class="citerefentry"><span class="refentrytitle">glGet</span></span></a> with argument <code class="constant">GL_COLOR_ARRAY_STRIDE</code>

</p><p>

<a class="citerefentry" href="glGet"><span class="citerefentry"><span class="refentrytitle">glGet</span></span></a> with argument <code class="constant">GL_COLOR_ARRAY_BUFFER_BINDING</code>

</p><p>

<a class="citerefentry" href="glGet"><span class="citerefentry"><span class="refentrytitle">glGet</span></span></a> with argument <code class="constant">GL_ARRAY_BUFFER_BINDING</code>

</p><p>

<a class="citerefentry" href="glGetPointerv"><span class="citerefentry"><span class="refentrytitle">glGetPointerv</span></span></a> with argument <code class="constant">GL_COLOR_ARRAY_POINTER</code>

</p></div>

{$pipelinestall}{$examples}

<div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p>

<a class="citerefentry" href="glArrayElement"><span class="citerefentry"><span class="refentrytitle">glArrayElement</span></span></a>,

<a class="citerefentry" href="glBindBuffer"><span class="citerefentry"><span class="refentrytitle">glBindBuffer</span></span></a>,

<a class="citerefentry" href="glColor"><span class="citerefentry"><span class="refentrytitle">glColor</span></span></a>,

<a class="citerefentry" href="glDisableClientState"><span class="citerefentry"><span class="refentrytitle">glDisableClientState</span></span></a>,

<a class="citerefentry" href="glDrawArrays"><span class="citerefentry"><span class="refentrytitle">glDrawArrays</span></span></a>,

<a class="citerefentry" href="glDrawElements"><span class="citerefentry"><span class="refentrytitle">glDrawElements</span></span></a>,

<a class="citerefentry" href="glDrawRangeElements"><span class="citerefentry"><span class="refentrytitle">glDrawRangeElements</span></span></a>,

<a class="citerefentry" href="glEdgeFlagPointer"><span class="citerefentry"><span class="refentrytitle">glEdgeFlagPointer</span></span></a>,

<a class="citerefentry" href="glEnableClientState"><span class="citerefentry"><span class="refentrytitle">glEnableClientState</span></span></a>,

<a class="citerefentry" href="glFogCoordPointer"><span class="citerefentry"><span class="refentrytitle">glFogCoordPointer</span></span></a>,

<a class="citerefentry" href="glIndexPointer"><span class="citerefentry"><span class="refentrytitle">glIndexPointer</span></span></a>,

<a class="citerefentry" href="glInterleavedArrays"><span class="citerefentry"><span class="refentrytitle">glInterleavedArrays</span></span></a>,

<a class="citerefentry" href="glMultiDrawArrays"><span class="citerefentry"><span class="refentrytitle">glMultiDrawArrays</span></span></a>,

<a class="citerefentry" href="glMultiDrawElements"><span class="citerefentry"><span class="refentrytitle">glMultiDrawElements</span></span></a>,

<a class="citerefentry" href="glNormalPointer"><span class="citerefentry"><span class="refentrytitle">glNormalPointer</span></span></a>,

<a class="citerefentry" href="glPopClientAttrib"><span class="citerefentry"><span class="refentrytitle">glPopClientAttrib</span></span></a>,

<a class="citerefentry" href="glPushClientAttrib"><span class="citerefentry"><span class="refentrytitle">glPushClientAttrib</span></span></a>,

<a class="citerefentry" href="glSecondaryColorPointer"><span class="citerefentry"><span class="refentrytitle">glSecondaryColorPointer</span></span></a>,

<a class="citerefentry" href="glTexCoordPointer"><span class="citerefentry"><span class="refentrytitle">glTexCoordPointer</span></span></a>,

<a class="citerefentry" href="glVertexAttribPointer"><span class="citerefentry"><span class="refentrytitle">glVertexAttribPointer</span></span></a>,

<a class="citerefentry" href="glVertexPointer"><span class="citerefentry"><span class="refentrytitle">glVertexPointer</span></span></a>

</p></div><div class="refsect1" lang="en" xml:lang="en"><div id="Copyright"><h2>Copyright</h2><p>

Copyright © 1991-2006

Silicon Graphics, Inc. This document is licensed under the SGI

Free Software B License. For details, see

<a class="ulink" href="https://web.archive.org/web/20171022161616/http://oss.sgi.com/projects/FreeB/" target="_top">https://web.archive.org/web/20171022161616/http://oss.sgi.com/projects/FreeB/</a>.

</p></div></div></div>