diff options
Diffstat (limited to 'doc/gl-docs/GLU/errorstring.3gl')
-rw-r--r-- | doc/gl-docs/GLU/errorstring.3gl | 47 |
1 files changed, 47 insertions, 0 deletions
diff --git a/doc/gl-docs/GLU/errorstring.3gl b/doc/gl-docs/GLU/errorstring.3gl new file mode 100644 index 000000000..31207ae7a --- /dev/null +++ b/doc/gl-docs/GLU/errorstring.3gl @@ -0,0 +1,47 @@ +'\" e +'\"! eqn | mmdoc +'\"macro stdmacro +.ds Vn Version 1.2 +.ds Dt 6 March 1997 +.ds Re Release 1.2.0 +.ds Dp May 02 11:53 +.ds Dm 37 errorstri +.ds Xs 24940 3 errorstring.gl +.TH GLUERRORSTRING 3G +.SH NAME +.B "gluErrorString +\- produce an error string from a GL or GLU error code + +.SH C SPECIFICATION +const GLubyte * \f3gluErrorString\fP( +GLenum \fIerror\fP ) +.nf +.fi + +.EQ +delim $$ +.EN +.SH PARAMETERS +.TP \w'\f2error\fP\ \ 'u +\f2error\fP +Specifies a GL or GLU error code. +.SH DESCRIPTION +\%\f3gluErrorString\fP produces an error string from a GL or GLU error code. The string +is in ISO Latin 1 . For example, +\%\f3gluErrorString\fP(\%\f3GL_OUT_OF_MEMORY\fP) returns the string +\f2out of memory\fP. +.P +The standard GLU error codes are \%\f3GLU_INVALID_ENUM\fP, +\%\f3GLU_INVALID_VALUE\fP, +and \%\f3GLU_OUT_OF_MEMORY\fP. +Certain other GLU functions can return specialized error codes +through callbacks. +See the \f3glGetError\fP reference page for the list of +GL error codes. +.SH ERRORS +\%\f3NULL\fP is returned if \f2error\fP is not a valid GL or GLU error code. +.SH SEE ALSO +\f3glGetError(3G)\fP, +\%\f3gluNurbsCallback(3G)\fP, +\%\f3gluQuadricCallback(3G)\fP, +\%\f3gluTessCallback(3G)\fP |