xenocara/doc/gl-docs/GL/gl/getminmaxparameter.3gl
2006-11-29 17:00:35 +00:00

77 lines
1.8 KiB
Plaintext

'\" t
'\"! tbl | 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 01 getminmax
.ds Xs 8418 4 getminmaxparameter.gl
.TH GLGETMINMAXPARAMETER 3G
.SH NAME
.B "glGetMinmaxParameterfv, glGetMinmaxParameteriv
\- get minmax parameters
.SH C SPECIFICATION
void \f3glGetMinmaxParameterfv\fP(
GLenum \fItarget\fP,
.nf
.ta \w'\f3void \fPglGetMinmaxParameterfv( 'u
GLenum \fIpname\fP,
GLfloat \fI*params\fP )
.fi
void \f3glGetMinmaxParameteriv\fP(
GLenum \fItarget\fP,
.nf
.ta \w'\f3void \fPglGetMinmaxParameteriv( 'u
GLenum \fIpname\fP,
GLint \fI*params\fP )
.fi
.SH PARAMETERS
.TP \w'\f2target\fP\ \ 'u
\f2target\fP
Must be
\%\f3GL_MINMAX\fP.
.TP
\f2pname\fP
The parameter to be retrieved.
Must be one of
\%\f3GL_MINMAX_FORMAT\fP or
\%\f3GL_MINMAX_SINK\fP.
.TP
\f2params\fP
A pointer to storage for the retrieved parameters.
.SH DESCRIPTION
\%\f3glGetMinmaxParameter\fP retrieves parameters for the current minmax table by setting
\f2pname\fP to one of the following values:
.sp
.TS
center;
lb lb
l l.
_
Parameter Description
_
\%\f3GL_MINMAX_FORMAT\fP Internal of minmax table
\%\f3GL_MINMAX_SINK\fP Value of the \f2sink\fP parameter
_
.TE
.SH NOTES
\%\f3glGetMinmaxParameter\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 is not \%\f3GL_MINMAX\fP.
.P
\%\f3GL_INVALID_ENUM\fP is generated if \f2pname\fP is not one of the allowable
values.
.P
\%\f3GL_INVALID_OPERATION\fP is generated if \%\f3glGetMinmaxParameter\fP is executed
between the execution of \%\f3glBegin\fP and the corresponding
execution of \%\f3glEnd\fP.
.SH SEE ALSO
\%\f3glMinmax(3G)\fP,
\%\f3glGetMinmax(3G)\fP