1 <!DOCTYPE html PUBLIC
"-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd">
2 <!-- saved from url=(0013)about:internet -->
3 <?xml-stylesheet type=
"text/xsl" href=
"mathml.xsl"?><html xmlns=
"http://www.w3.org/1999/xhtml" xmlns:
pref=
"http://www.w3.org/2002/Math/preference" pref:
renderer=
"mathplayer-dl"><head><meta http-equiv=
"Content-Type" content=
"text/html; charset=UTF-8" /><title>glGetColorTableParameter
</title><meta name=
"generator" content=
"DocBook XSL Stylesheets V1.73.2" /></head><body><div class=
"refentry" lang=
"en" xml:
lang=
"en"><a id=
"glGetColorTableParameter"></a><div class=
"titlepage"></div><div class=
"refnamediv"><h2>Name
</h2><p>glGetColorTableParameter — get color lookup table parameters
</p></div><div class=
"refsynopsisdiv"><h2>C Specification
</h2><div class=
"funcsynopsis"><table border=
"0" summary=
"Function synopsis" cellspacing=
"0" cellpadding=
"0"><tr><td><code class=
"funcdef">void
<b class=
"fsfunc">glGetColorTableParameterfv
</b>(
</code></td><td>GLenum
</td><td><var class=
"pdparam">target
</var>,
</td></tr><tr><td> </td><td>GLenum
</td><td><var class=
"pdparam">pname
</var>,
</td></tr><tr><td> </td><td>GLfloat *
</td><td><var class=
"pdparam">params
</var><code>)
</code>;
</td></tr></table></div><div class=
"funcsynopsis"><table border=
"0" summary=
"Function synopsis" cellspacing=
"0" cellpadding=
"0"><tr><td><code class=
"funcdef">void
<b class=
"fsfunc">glGetColorTableParameteriv
</b>(
</code></td><td>GLenum
</td><td><var class=
"pdparam">target
</var>,
</td></tr><tr><td> </td><td>GLenum
</td><td><var class=
"pdparam">pname
</var>,
</td></tr><tr><td> </td><td>GLint *
</td><td><var class=
"pdparam">params
</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>target
</code></em></span></dt><dd><p>
4 The target color table.
6 <code class=
"constant">GL_COLOR_TABLE
</code>,
7 <code class=
"constant">GL_POST_CONVOLUTION_COLOR_TABLE
</code>,
8 <code class=
"constant">GL_POST_COLOR_MATRIX_COLOR_TABLE
</code>,
9 <code class=
"constant">GL_PROXY_COLOR_TABLE
</code>,
10 <code class=
"constant">GL_PROXY_POST_CONVOLUTION_COLOR_TABLE
</code>, or
11 <code class=
"constant">GL_PROXY_POST_COLOR_MATRIX_COLOR_TABLE
</code>.
12 </p></dd><dt><span class=
"term"><em class=
"parameter"><code>pname
</code></em></span></dt><dd><p>
13 The symbolic name of a color lookup table parameter.
15 <code class=
"constant">GL_COLOR_TABLE_BIAS
</code>,
16 <code class=
"constant">GL_COLOR_TABLE_SCALE
</code>,
17 <code class=
"constant">GL_COLOR_TABLE_FORMAT
</code>,
18 <code class=
"constant">GL_COLOR_TABLE_WIDTH
</code>,
19 <code class=
"constant">GL_COLOR_TABLE_RED_SIZE
</code>,
20 <code class=
"constant">GL_COLOR_TABLE_GREEN_SIZE
</code>,
21 <code class=
"constant">GL_COLOR_TABLE_BLUE_SIZE
</code>,
22 <code class=
"constant">GL_COLOR_TABLE_ALPHA_SIZE
</code>,
23 <code class=
"constant">GL_COLOR_TABLE_LUMINANCE_SIZE
</code>, or
24 <code class=
"constant">GL_COLOR_TABLE_INTENSITY_SIZE
</code>.
25 </p></dd><dt><span class=
"term"><em class=
"parameter"><code>params
</code></em></span></dt><dd><p>
26 A pointer to an array where the values of the parameter will be stored.
27 </p></dd></dl></div></div><div class=
"refsect1" lang=
"en" xml:
lang=
"en"><a id=
"description"></a><h2>Description
</h2><p>
28 Returns parameters specific to color table
<em class=
"parameter"><code>target
</code></em>.
30 When
<em class=
"parameter"><code>pname
</code></em> is set to
<code class=
"constant">GL_COLOR_TABLE_SCALE
</code> or
31 <code class=
"constant">GL_COLOR_TABLE_BIAS
</code>,
<code class=
"function">glGetColorTableParameter
</code> returns the color
32 table scale or bias parameters for the table specified by
<em class=
"parameter"><code>target
</code></em>.
33 For these queries,
<em class=
"parameter"><code>target
</code></em> must be set to
34 <code class=
"constant">GL_COLOR_TABLE
</code>,
35 <code class=
"constant">GL_POST_CONVOLUTION_COLOR_TABLE
</code>,
36 or
<code class=
"constant">GL_POST_COLOR_MATRIX_COLOR_TABLE
</code> and
37 <em class=
"parameter"><code>params
</code></em> points to an array of four elements, which receive
38 the scale or bias factors for red, green, blue, and alpha, in that order.
40 <code class=
"function">glGetColorTableParameter
</code> can also be used to retrieve the format and size parameters
41 for a color table. For these queries, set
<em class=
"parameter"><code>target
</code></em> to either the
42 color table target or the proxy color table target.
43 The format and size parameters are set by
<a class=
"citerefentry" href=
"glColorTable.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glColorTable
</span></span></a>.
45 The following table lists the format and size parameters that may
47 For each symbolic constant listed below for
<em class=
"parameter"><code>pname
</code></em>,
48 <em class=
"parameter"><code>params
</code></em> must point to an array of the
49 given length and receive the values indicated.
51 </p><div class=
"informaltable"><table border=
"1"><colgroup><col align=
"left" /><col align=
"center" /><col align=
"left" /></colgroup><thead><tr><th align=
"left"><span class=
"bold"><strong>
53 </strong></span></th><th align=
"center"><span class=
"bold"><strong>
55 </strong></span></th><th align=
"left"><span class=
"bold"><strong>
57 </strong></span></th></tr></thead><tbody><tr><td align=
"left">
58 <code class=
"constant">GL_COLOR_TABLE_FORMAT
</code>
59 </td><td align=
"center">
61 </td><td align=
"left">
62 Internal format (e.g.,
<code class=
"constant">GL_RGBA
</code>)
63 </td></tr><tr><td align=
"left">
64 <code class=
"constant">GL_COLOR_TABLE_WIDTH
</code>
65 </td><td align=
"center">
67 </td><td align=
"left">
68 Number of elements in table
69 </td></tr><tr><td align=
"left">
70 <code class=
"constant">GL_COLOR_TABLE_RED_SIZE
</code>
71 </td><td align=
"center">
73 </td><td align=
"left">
74 Size of red component, in bits
75 </td></tr><tr><td align=
"left">
76 <code class=
"constant">GL_COLOR_TABLE_GREEN_SIZE
</code>
77 </td><td align=
"center">
79 </td><td align=
"left">
80 Size of green component
81 </td></tr><tr><td align=
"left">
82 <code class=
"constant">GL_COLOR_TABLE_BLUE_SIZE
</code>
83 </td><td align=
"center">
85 </td><td align=
"left">
86 Size of blue component
87 </td></tr><tr><td align=
"left">
88 <code class=
"constant">GL_COLOR_TABLE_ALPHA_SIZE
</code>
89 </td><td align=
"center">
91 </td><td align=
"left">
92 Size of alpha component
93 </td></tr><tr><td align=
"left">
94 <code class=
"constant">GL_COLOR_TABLE_LUMINANCE_SIZE
</code>
95 </td><td align=
"center">
97 </td><td align=
"left">
98 Size of luminance component
99 </td></tr><tr><td align=
"left">
100 <code class=
"constant">GL_COLOR_TABLE_INTENSITY_SIZE
</code>
101 </td><td align=
"center">
103 </td><td align=
"left">
104 Size of intensity component
105 </td></tr></tbody></table></div><p>
106 </p></div><div class=
"refsect1" lang=
"en" xml:
lang=
"en"><a id=
"notes"></a><h2>Notes
</h2><p>
107 <code class=
"function">glGetColorTableParameter
</code> is present only if
<code class=
"code">ARB_imaging
</code> is returned when
<a class=
"citerefentry" href=
"glGetString.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glGetString
</span></span></a>
108 is called with an argument of
<code class=
"constant">GL_EXTENSIONS
</code>.
109 </p></div><div class=
"refsect1" lang=
"en" xml:
lang=
"en"><a id=
"errors"></a><h2>Errors
</h2><p>
110 <code class=
"constant">GL_INVALID_ENUM
</code> is generated if
<em class=
"parameter"><code>target
</code></em> or
<em class=
"parameter"><code>pname
</code></em> is not
113 <code class=
"constant">GL_INVALID_OPERATION
</code> is generated if
<code class=
"function">glGetColorTableParameter
</code> is executed
114 between the execution of
<a class=
"citerefentry" href=
"glBegin.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glBegin
</span></span></a> and the corresponding
115 execution of
<a class=
"citerefentry" href=
"glEnd.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glEnd
</span></span></a>.
116 </p></div><div class=
"refsect1" lang=
"en" xml:
lang=
"en"><a id=
"seealso"></a><h2>See Also
</h2><p>
117 <a class=
"citerefentry" href=
"glColorTable.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glColorTable
</span></span></a>,
118 <a class=
"citerefentry" href=
"glTexParameter.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glTexParameter
</span></span></a>,
119 <a class=
"citerefentry" href=
"glColorTableParameter.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glColorTableParameter
</span></span></a>
120 </p></div><div class=
"refsect1" lang=
"en" xml:
lang=
"en"><a id=
"Copyright"></a><h2>Copyright
</h2><p>
121 Copyright
<span class=
"trademark"></span>©
1991-
2006
122 Silicon Graphics, Inc. This document is licensed under the SGI
123 Free Software B License. For details, see
124 <a class=
"ulink" href=
"http://oss.sgi.com/projects/FreeB/" target=
"_top">http://oss.sgi.com/projects/FreeB/
</a>.
125 </p></div></div></body></html>