getcolortableparameter.3gl   [plain text]

'\" te
'\"! tbl | eqn | mmdoc
'\"macro stdmacro
.ds Vn Version 1.2
.ds Dt 24 September 1999
.ds Re Release 1.2.1
.ds Dp Jan 14 18:30
.ds Dm 001 getcolor
.ds Xs 21434 5 getcolortableparameter.gl
.TH GLGETCOLORTABLEPARAMETER 3G
.SH NAME
.B "glGetColorTableParameterfv, glGetColorTableParameteriv
\- get color lookup table parameters

.SH C SPECIFICATION
void \f3glGetColorTableParameterfv\fP(
GLenum \fItarget\fP,
.nf
.ta \w'\f3void \fPglGetColorTableParameterfv( 'u
	GLenum \fIpname\fP,
	GLfloat \fI*params\fP )
.fi
void \f3glGetColorTableParameteriv\fP(
GLenum \fItarget\fP,
.nf
.ta \w'\f3void \fPglGetColorTableParameteriv( 'u
	GLenum \fIpname\fP,
	GLint \fI*params\fP )
.fi

.EQ
delim $$
.EN
.SH PARAMETERS
.TP \w'\f2target\fP\ \ 'u 
\f2target\fP
The target color table.
Must be
\%\f3GL_COLOR_TABLE\fP,
\%\f3GL_POST_CONVOLUTION_COLOR_TABLE\fP,
\%\f3GL_POST_COLOR_MATRIX_COLOR_TABLE\fP,
\%\f3GL_PROXY_COLOR_TABLE\fP,
\%\f3GL_PROXY_POST_CONVOLUTION_COLOR_TABLE\fP,
\%\f3GL_PROXY_POST_COLOR_MATRIX_COLOR_TABLE\fP.
.TP
\f2pname\fP
The symbolic name of a color lookup table parameter.
Must be one of
\%\f3GL_COLOR_TABLE_BIAS\fP,
\%\f3GL_COLOR_TABLE_SCALE\fP,
\%\f3GL_COLOR_TABLE_FORMAT\fP,
\%\f3GL_COLOR_TABLE_WIDTH\fP,
\%\f3GL_COLOR_TABLE_RED_SIZE\fP,
\%\f3GL_COLOR_TABLE_GREEN_SIZE\fP,
\%\f3GL_COLOR_TABLE_BLUE_SIZE\fP,
\%\f3GL_COLOR_TABLE_ALPHA_SIZE\fP,
\%\f3GL_COLOR_TABLE_LUMINANCE_SIZE\fP, or
\%\f3GL_COLOR_TABLE_INTENSITY_SIZE\fP.
.TP
\f2params\fP
A pointer to an array where the values of the parameter will be stored.
.SH DESCRIPTION
Returns parameters specific to color table \f2target\fP.
.P
When \f2pname\fP is set to \%\f3GL_COLOR_TABLE_SCALE\fP or
\%\f3GL_COLOR_TABLE_BIAS\fP, \%\f3glGetColorTableParameter\fP returns the color 
table scale or bias parameters for the table specified by \f2target\fP.
For these queries, \f2target\fP must be set to
\%\f3GL_COLOR_TABLE\fP,
\%\f3GL_POST_CONVOLUTION_COLOR_TABLE\fP,
or \%\f3GL_POST_COLOR_MATRIX_COLOR_TABLE\fP and
\f2params\fP points to an array of four elements, which receive
the scale or bias factors for red, green, blue, and alpha, in that order.
.P
\%\f3glGetColorTableParameter\fP can also be used to retrieve the  and size parameters
for a color table. For these queries, set \f2target\fP to either the
color table target or the proxy color table target.
The  and size parameters are set by \%\f3glColorTable\fP.
.P 
The following table lists the  and size parameters that may
be queried.
For each symbolic constant listed below for \f2pname\fP, 
\f2params\fP must point to an array of the 
given length, and receive the values indicated.
.P
.TS
center;
lb cb lb
l c l.
_
Parameter	N	Meaning
_
\%\f3GL_COLOR_TABLE_FORMAT\fP	1	Internal  (e.g. \%\f3GL_RGBA\fP)
\%\f3GL_COLOR_TABLE_WIDTH\fP	1	Number of elements in table
\%\f3GL_COLOR_TABLE_RED_SIZE\fP	1	Size of red component, in bits
\%\f3GL_COLOR_TABLE_GREEN_SIZE\fP	1	Size of green component
\%\f3GL_COLOR_TABLE_BLUE_SIZE\fP	1	Size of blue component
\%\f3GL_COLOR_TABLE_ALPHA_SIZE\fP	1	Size of alpha component
\%\f3GL_COLOR_TABLE_LUMINANCE_SIZE\fP	1	Size of luminance component
\%\f3GL_COLOR_TABLE_INTENSITY_SIZE\fP	1	Size of intensity component
_
.TE
.SH NOTES
\%\f3glGetColorTableParameter\fP is present only if \%\f3GL_ARB_imaging\fP is returned when \%\f3glGetString\fP
is called with an argument of \%\f3GL_EXTENSIONS\fP.
.SH ERRORS
\%\f3GL_INVALID_ENUM\fP is generated if \f2target\fP or \f2pname\fP is not
an acceptable value.
.P
\%\f3GL_INVALID_OPERATION\fP is generated if \%\f3glGetColorTableParameter\fP is executed
between the execution of \%\f3glBegin\fP and the corresponding
execution of \%\f3glEnd\fP.
.SH SEE ALSO
\%\f3glColorTable(3G)\fP,
\%\f3glTexParameter(3G)\fP,
\%\f3glColorTableParameter(3G)\fP