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=
"glColor">
9 <holder>Silicon Graphics, Inc.
</holder>
12 <refentrytitle>glColor
</refentrytitle>
13 <manvolnum>3G
</manvolnum>
16 <refname>glColor
</refname>
17 <refpurpose>set the current color
</refpurpose>
19 <refsynopsisdiv><title>C Specification
</title>
22 <funcdef>void
<function>glColor3b
</function></funcdef>
23 <paramdef>GLbyte
<parameter>red
</parameter></paramdef>
24 <paramdef>GLbyte
<parameter>green
</parameter></paramdef>
25 <paramdef>GLbyte
<parameter>blue
</parameter></paramdef>
30 <funcdef>void
<function>glColor3s
</function></funcdef>
31 <paramdef>GLshort
<parameter>red
</parameter></paramdef>
32 <paramdef>GLshort
<parameter>green
</parameter></paramdef>
33 <paramdef>GLshort
<parameter>blue
</parameter></paramdef>
38 <funcdef>void
<function>glColor3i
</function></funcdef>
39 <paramdef>GLint
<parameter>red
</parameter></paramdef>
40 <paramdef>GLint
<parameter>green
</parameter></paramdef>
41 <paramdef>GLint
<parameter>blue
</parameter></paramdef>
46 <funcdef>void
<function>glColor3f
</function></funcdef>
47 <paramdef>GLfloat
<parameter>red
</parameter></paramdef>
48 <paramdef>GLfloat
<parameter>green
</parameter></paramdef>
49 <paramdef>GLfloat
<parameter>blue
</parameter></paramdef>
54 <funcdef>void
<function>glColor3d
</function></funcdef>
55 <paramdef>GLdouble
<parameter>red
</parameter></paramdef>
56 <paramdef>GLdouble
<parameter>green
</parameter></paramdef>
57 <paramdef>GLdouble
<parameter>blue
</parameter></paramdef>
62 <funcdef>void
<function>glColor3ub
</function></funcdef>
63 <paramdef>GLubyte
<parameter>red
</parameter></paramdef>
64 <paramdef>GLubyte
<parameter>green
</parameter></paramdef>
65 <paramdef>GLubyte
<parameter>blue
</parameter></paramdef>
70 <funcdef>void
<function>glColor3us
</function></funcdef>
71 <paramdef>GLushort
<parameter>red
</parameter></paramdef>
72 <paramdef>GLushort
<parameter>green
</parameter></paramdef>
73 <paramdef>GLushort
<parameter>blue
</parameter></paramdef>
78 <funcdef>void
<function>glColor3ui
</function></funcdef>
79 <paramdef>GLuint
<parameter>red
</parameter></paramdef>
80 <paramdef>GLuint
<parameter>green
</parameter></paramdef>
81 <paramdef>GLuint
<parameter>blue
</parameter></paramdef>
86 <funcdef>void
<function>glColor4b
</function></funcdef>
87 <paramdef>GLbyte
<parameter>red
</parameter></paramdef>
88 <paramdef>GLbyte
<parameter>green
</parameter></paramdef>
89 <paramdef>GLbyte
<parameter>blue
</parameter></paramdef>
90 <paramdef>GLbyte
<parameter>alpha
</parameter></paramdef>
95 <funcdef>void
<function>glColor4s
</function></funcdef>
96 <paramdef>GLshort
<parameter>red
</parameter></paramdef>
97 <paramdef>GLshort
<parameter>green
</parameter></paramdef>
98 <paramdef>GLshort
<parameter>blue
</parameter></paramdef>
99 <paramdef>GLshort
<parameter>alpha
</parameter></paramdef>
104 <funcdef>void
<function>glColor4i
</function></funcdef>
105 <paramdef>GLint
<parameter>red
</parameter></paramdef>
106 <paramdef>GLint
<parameter>green
</parameter></paramdef>
107 <paramdef>GLint
<parameter>blue
</parameter></paramdef>
108 <paramdef>GLint
<parameter>alpha
</parameter></paramdef>
113 <funcdef>void
<function>glColor4f
</function></funcdef>
114 <paramdef>GLfloat
<parameter>red
</parameter></paramdef>
115 <paramdef>GLfloat
<parameter>green
</parameter></paramdef>
116 <paramdef>GLfloat
<parameter>blue
</parameter></paramdef>
117 <paramdef>GLfloat
<parameter>alpha
</parameter></paramdef>
122 <funcdef>void
<function>glColor4d
</function></funcdef>
123 <paramdef>GLdouble
<parameter>red
</parameter></paramdef>
124 <paramdef>GLdouble
<parameter>green
</parameter></paramdef>
125 <paramdef>GLdouble
<parameter>blue
</parameter></paramdef>
126 <paramdef>GLdouble
<parameter>alpha
</parameter></paramdef>
131 <funcdef>void
<function>glColor4ub
</function></funcdef>
132 <paramdef>GLubyte
<parameter>red
</parameter></paramdef>
133 <paramdef>GLubyte
<parameter>green
</parameter></paramdef>
134 <paramdef>GLubyte
<parameter>blue
</parameter></paramdef>
135 <paramdef>GLubyte
<parameter>alpha
</parameter></paramdef>
140 <funcdef>void
<function>glColor4us
</function></funcdef>
141 <paramdef>GLushort
<parameter>red
</parameter></paramdef>
142 <paramdef>GLushort
<parameter>green
</parameter></paramdef>
143 <paramdef>GLushort
<parameter>blue
</parameter></paramdef>
144 <paramdef>GLushort
<parameter>alpha
</parameter></paramdef>
149 <funcdef>void
<function>glColor4ui
</function></funcdef>
150 <paramdef>GLuint
<parameter>red
</parameter></paramdef>
151 <paramdef>GLuint
<parameter>green
</parameter></paramdef>
152 <paramdef>GLuint
<parameter>blue
</parameter></paramdef>
153 <paramdef>GLuint
<parameter>alpha
</parameter></paramdef>
157 <!-- eqn: ignoring delim $$ -->
158 <refsect1 id=
"parameters"><title>Parameters
</title>
161 <term><parameter>red
</parameter></term>
162 <term><parameter>green
</parameter></term>
163 <term><parameter>blue
</parameter></term>
166 Specify new red, green, and blue values for the current color.
171 <term><parameter>alpha
</parameter></term>
174 Specifies a new alpha value for the current color.
175 Included only in the four-argument
<function>glColor4
</function> commands.
181 <refsynopsisdiv><title>C Specification
</title>
184 <funcdef>void
<function>glColor3bv
</function></funcdef>
185 <paramdef>const GLbyte *
<parameter>v
</parameter></paramdef>
190 <funcdef>void
<function>glColor3sv
</function></funcdef>
191 <paramdef>const GLshort *
<parameter>v
</parameter></paramdef>
196 <funcdef>void
<function>glColor3iv
</function></funcdef>
197 <paramdef>const GLint *
<parameter>v
</parameter></paramdef>
202 <funcdef>void
<function>glColor3fv
</function></funcdef>
203 <paramdef>const GLfloat *
<parameter>v
</parameter></paramdef>
208 <funcdef>void
<function>glColor3dv
</function></funcdef>
209 <paramdef>const GLdouble *
<parameter>v
</parameter></paramdef>
214 <funcdef>void
<function>glColor3ubv
</function></funcdef>
215 <paramdef>const GLubyte *
<parameter>v
</parameter></paramdef>
220 <funcdef>void
<function>glColor3usv
</function></funcdef>
221 <paramdef>const GLushort *
<parameter>v
</parameter></paramdef>
226 <funcdef>void
<function>glColor3uiv
</function></funcdef>
227 <paramdef>const GLuint *
<parameter>v
</parameter></paramdef>
232 <funcdef>void
<function>glColor4bv
</function></funcdef>
233 <paramdef>const GLbyte *
<parameter>v
</parameter></paramdef>
238 <funcdef>void
<function>glColor4sv
</function></funcdef>
239 <paramdef>const GLshort *
<parameter>v
</parameter></paramdef>
244 <funcdef>void
<function>glColor4iv
</function></funcdef>
245 <paramdef>const GLint *
<parameter>v
</parameter></paramdef>
250 <funcdef>void
<function>glColor4fv
</function></funcdef>
251 <paramdef>const GLfloat *
<parameter>v
</parameter></paramdef>
256 <funcdef>void
<function>glColor4dv
</function></funcdef>
257 <paramdef>const GLdouble *
<parameter>v
</parameter></paramdef>
262 <funcdef>void
<function>glColor4ubv
</function></funcdef>
263 <paramdef>const GLubyte *
<parameter>v
</parameter></paramdef>
268 <funcdef>void
<function>glColor4usv
</function></funcdef>
269 <paramdef>const GLushort *
<parameter>v
</parameter></paramdef>
274 <funcdef>void
<function>glColor4uiv
</function></funcdef>
275 <paramdef>const GLuint *
<parameter>v
</parameter></paramdef>
279 <refsect1 id=
"parameters2"><title>Parameters
</title>
282 <term><parameter>v
</parameter></term>
285 Specifies a pointer to an array that contains red, green, blue,
286 and (sometimes) alpha values.
292 <refsect1 id=
"description"><title>Description
</title>
294 The GL stores both a current single-valued color index
295 and a current four-valued RGBA color.
296 <function>glColor
</function> sets a new four-valued RGBA color.
297 <function>glColor
</function> has two major variants:
298 <function>glColor3
</function> and
<function>glColor4
</function>.
299 <function>glColor3
</function> variants specify new red,
301 and blue values explicitly
302 and set the current alpha value to
1.0 (full intensity) implicitly.
303 <function>glColor4
</function> variants specify all four color components explicitly.
306 <function>glColor3b
</function>,
<function>glColor4b
</function>,
307 <function>glColor3s
</function>,
<function>glColor4s
</function>,
<function>glColor3i
</function>, and
<function>glColor4i
</function> take
308 three or four signed byte, short, or long integers as arguments.
309 When
<emphasis role=
"bold">v
</emphasis> is appended to the name,
310 the color commands can take a pointer to an array of such values.
313 Current color values are stored in floating-point format,
314 with unspecified mantissa and exponent sizes.
315 Unsigned integer color components,
317 are linearly mapped to floating-point values such that the largest
318 representable value maps to
1.0 (full intensity),
319 and
0 maps to
0.0 (zero intensity).
320 Signed integer color components,
322 are linearly mapped to floating-point values such that the most positive
323 representable value maps to
1.0,
324 and the most negative representable value maps to
325 <inlineequation><mml:math>
327 <mml:mn>-
1.0</mml:mn>
328 </mml:math></inlineequation>.
330 this mapping does not convert
0 precisely to
0.0.)
331 Floating-point values are mapped directly.
334 Neither floating-point nor signed integer values are clamped
336 <inlineequation><mml:math>
338 <mml:mfenced open=
"[" close=
"]">
342 </mml:math></inlineequation>
343 before the current color is updated.
345 color components are clamped to this range before they are interpolated
346 or written into a color buffer.
349 <refsect1 id=
"notes"><title>Notes
</title>
351 The initial value for the current color is (
1,
1,
1,
1).
354 The current color can be updated at any time.
356 <function>glColor
</function> can be called between a call to
<citerefentry><refentrytitle>glBegin
</refentrytitle></citerefentry> and the corresponding
357 call to
<citerefentry><refentrytitle>glEnd
</refentrytitle></citerefentry>.
360 <refsect1 id=
"associatedgets"><title>Associated Gets
</title>
362 <citerefentry><refentrytitle>glGet
</refentrytitle></citerefentry> with argument
<constant>GL_CURRENT_COLOR
</constant>
365 <citerefentry><refentrytitle>glGet
</refentrytitle></citerefentry> with argument
<constant>GL_RGBA_MODE
</constant>
368 <refsect1 id=
"seealso"><title>See Also
</title>
370 <function>glColorPointer
</function>,
371 <citerefentry><refentrytitle>glIndex
</refentrytitle></citerefentry>,
372 <citerefentry><refentrytitle>glSecondaryColor
</refentrytitle></citerefentry>
375 <refsect1 id=
"Copyright"><title>Copyright
</title>
377 Copyright
<trademark class=
"copyright"></trademark> 1991-
2006
378 Silicon Graphics, Inc. This document is licensed under the SGI
379 Free Software B License. For details, see
380 <ulink url=
"http://oss.sgi.com/projects/FreeB/">http://oss.sgi.com/projects/FreeB/
</ulink>.