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=
"glGetColorTable">
9 <holder>Silicon Graphics, Inc.
</holder>
12 <refentrytitle>glGetColorTable
</refentrytitle>
13 <manvolnum>3G
</manvolnum>
16 <refname>glGetColorTable
</refname>
17 <refpurpose>retrieve contents of a color lookup table
</refpurpose>
19 <refsynopsisdiv><title>C Specification
</title>
22 <funcdef>void
<function>glGetColorTable
</function></funcdef>
23 <paramdef>GLenum
<parameter>target
</parameter></paramdef>
24 <paramdef>GLenum
<parameter>format
</parameter></paramdef>
25 <paramdef>GLenum
<parameter>type
</parameter></paramdef>
26 <paramdef>GLvoid *
<parameter>table
</parameter></paramdef>
30 <refsect1 id=
"parameters"><title>Parameters
</title>
33 <term><parameter>target
</parameter></term>
36 Must be
<constant>GL_COLOR_TABLE
</constant>,
37 <constant>GL_POST_CONVOLUTION_COLOR_TABLE
</constant>,
39 <constant>GL_POST_COLOR_MATRIX_COLOR_TABLE
</constant>.
44 <term><parameter>format
</parameter></term>
47 The format of the pixel data in
<parameter>table
</parameter>.
48 The possible values are
49 <constant>GL_RED
</constant>,
50 <constant>GL_GREEN
</constant>,
51 <constant>GL_BLUE
</constant>,
52 <constant>GL_ALPHA
</constant>,
53 <constant>GL_LUMINANCE
</constant>,
54 <constant>GL_LUMINANCE_ALPHA
</constant>,
55 <constant>GL_RGB
</constant>,
56 <constant>GL_BGR
</constant>,
57 <constant>GL_RGBA
</constant>, and
58 <constant>GL_BGRA
</constant>.
63 <term><parameter>type
</parameter></term>
66 The type of the pixel data in
<parameter>table
</parameter>.
68 <constant>GL_UNSIGNED_BYTE
</constant>,
69 <constant>GL_BYTE
</constant>,
70 <constant>GL_BITMAP
</constant>,
71 <constant>GL_UNSIGNED_SHORT
</constant>,
72 <constant>GL_SHORT
</constant>,
73 <constant>GL_UNSIGNED_INT
</constant>,
74 <constant>GL_INT
</constant>,
75 <constant>GL_FLOAT
</constant>,
76 <constant>GL_UNSIGNED_BYTE_3_3_2
</constant>,
77 <constant>GL_UNSIGNED_BYTE_2_3_3_REV
</constant>,
78 <constant>GL_UNSIGNED_SHORT_5_6_5
</constant>,
79 <constant>GL_UNSIGNED_SHORT_5_6_5_REV
</constant>,
80 <constant>GL_UNSIGNED_SHORT_4_4_4_4
</constant>,
81 <constant>GL_UNSIGNED_SHORT_4_4_4_4_REV
</constant>,
82 <constant>GL_UNSIGNED_SHORT_5_5_5_1
</constant>,
83 <constant>GL_UNSIGNED_SHORT_1_5_5_5_REV
</constant>,
84 <constant>GL_UNSIGNED_INT_8_8_8_8
</constant>,
85 <constant>GL_UNSIGNED_INT_8_8_8_8_REV
</constant>,
86 <constant>GL_UNSIGNED_INT_10_10_10_2
</constant>, and
87 <constant>GL_UNSIGNED_INT_2_10_10_10_REV
</constant>
93 <term><parameter>table
</parameter></term>
96 Pointer to a one-dimensional array of pixel data containing the contents
103 <refsect1 id=
"description"><title>Description
</title>
105 <function>glGetColorTable
</function> returns in
<parameter>table
</parameter> the contents of the color table specified
106 by
<parameter>target
</parameter>. No pixel transfer operations are performed, but pixel
107 storage modes that are applicable to
108 <citerefentry><refentrytitle>glReadPixels
</refentrytitle></citerefentry> are performed.
111 If a non-zero named buffer object is bound to the
<constant>GL_PIXEL_PACK_BUFFER
</constant> target
112 (see
<citerefentry><refentrytitle>glBindBuffer
</refentrytitle></citerefentry>) while a histogram table is
113 requested,
<parameter>table
</parameter> is treated as a byte offset into the buffer object's data store.
116 Color components that are requested in
117 the specified
<parameter>format
</parameter>, but which are not included in the internal
118 format of the color lookup table, are returned as zero. The
119 assignments of internal color components to the components
120 requested by
<parameter>format
</parameter> are
122 <informaltable frame=
"topbot">
123 <tgroup cols=
"2" align=
"left">
128 <entry rowsep=
"1" align=
"left"><emphasis role=
"bold">
131 <entry rowsep=
"1" align=
"left"><emphasis role=
"bold">
191 <refsect1 id=
"notes"><title>Notes
</title>
193 <function>glGetColorTable
</function> is present only if
<code>ARB_imaging
</code> is returned when
<citerefentry><refentrytitle>glGetString
</refentrytitle></citerefentry>
194 is called with an argument of
<constant>GL_EXTENSIONS
</constant>.
199 <refsect1 id=
"errors"><title>Errors
</title>
201 <constant>GL_INVALID_ENUM
</constant> is generated if
<parameter>target
</parameter> is not one of the allowable
205 <constant>GL_INVALID_ENUM
</constant> is generated if
<parameter>format
</parameter> is not one of the allowable
209 <constant>GL_INVALID_ENUM
</constant> is generated if
<parameter>type
</parameter> is not one of the allowable
213 <constant>GL_INVALID_OPERATION
</constant> is generated if
<parameter>type
</parameter> is one of
214 <constant>GL_UNSIGNED_BYTE_3_3_2
</constant>,
215 <constant>GL_UNSIGNED_BYTE_2_3_3_REV
</constant>,
216 <constant>GL_UNSIGNED_SHORT_5_6_5
</constant>, or
217 <constant>GL_UNSIGNED_SHORT_5_6_5_REV
</constant>
218 and
<parameter>format
</parameter> is not
<constant>GL_RGB
</constant>.
221 <constant>GL_INVALID_OPERATION
</constant> is generated if
<parameter>type
</parameter> is one of
222 <constant>GL_UNSIGNED_SHORT_4_4_4_4
</constant>,
223 <constant>GL_UNSIGNED_SHORT_4_4_4_4_REV
</constant>,
224 <constant>GL_UNSIGNED_SHORT_5_5_5_1
</constant>,
225 <constant>GL_UNSIGNED_SHORT_1_5_5_5_REV
</constant>,
226 <constant>GL_UNSIGNED_INT_8_8_8_8
</constant>,
227 <constant>GL_UNSIGNED_INT_8_8_8_8_REV
</constant>,
228 <constant>GL_UNSIGNED_INT_10_10_10_2
</constant>, or
229 <constant>GL_UNSIGNED_INT_2_10_10_10_REV
</constant>
230 and
<parameter>format
</parameter> is neither
<constant>GL_RGBA
</constant> nor
<constant>GL_BGRA
</constant>.
233 <constant>GL_INVALID_OPERATION
</constant> is generated if a non-zero buffer object name is bound to the
234 <constant>GL_PIXEL_PACK_BUFFER
</constant> target and the buffer object's data store is currently mapped.
237 <constant>GL_INVALID_OPERATION
</constant> is generated if a non-zero buffer object name is bound to the
238 <constant>GL_PIXEL_PACK_BUFFER
</constant> target and the data would be packed to the buffer
239 object such that the memory writes required would exceed the data store size.
242 <constant>GL_INVALID_OPERATION
</constant> is generated if a non-zero buffer object name is bound to the
243 <constant>GL_PIXEL_PACK_BUFFER
</constant> target and
<parameter>table
</parameter> is not evenly divisible
244 into the number of bytes needed to store in memory a datum indicated by
<parameter>type
</parameter>.
247 <constant>GL_INVALID_OPERATION
</constant> is generated if
<function>glGetColorTable
</function> is executed
248 between the execution of
<citerefentry><refentrytitle>glBegin
</refentrytitle></citerefentry> and the corresponding
249 execution of
<citerefentry><refentrytitle>glEnd
</refentrytitle></citerefentry>.
252 <refsect1 id=
"associatedgets"><title>Associated Gets
</title>
254 <citerefentry><refentrytitle>glGetColorTableParameter
</refentrytitle></citerefentry>
257 <citerefentry><refentrytitle>glGet
</refentrytitle></citerefentry> with argument
<constant>GL_PIXEL_PACK_BUFFER_BINDING
</constant>
260 <refsect1 id=
"seealso"><title>See Also
</title>
262 <citerefentry><refentrytitle>glColorTable
</refentrytitle></citerefentry>,
263 <citerefentry><refentrytitle>glColorTableParameter
</refentrytitle></citerefentry>
266 <refsect1 id=
"Copyright"><title>Copyright
</title>
268 Copyright
<trademark class=
"copyright"></trademark> 1991-
2006
269 Silicon Graphics, Inc. This document is licensed under the SGI
270 Free Software B License. For details, see
271 <ulink url=
"http://oss.sgi.com/projects/FreeB/">http://oss.sgi.com/projects/FreeB/
</ulink>.