GLProgramming.com

home :: about :: development guides :: irc :: forums :: search :: paste :: links :: contribute :: code dump

-> Click here to learn how to get live help <-


Manpage of GLGETERROR

GLGETERROR

Index
 

NAME

glGetError - return error information

 

C SPECIFICATION

GLenum f3glGetErrorfP( void )


 

DESCRIPTION

%f3glGetErrorfP returns the value of the error flag. Each detectable error is assigned a numeric code and symbolic name. When an error occurs, the error flag is set to the appropriate error code value. No other errors are recorded until %f3glGetErrorfP is called, the error code is returned, and the flag is reset to %f3GL_NO_ERRORfP. If a call to %f3glGetErrorfP returns %f3GL_NO_ERRORfP, there has been no detectable error since the last call to %f3glGetErrorfP, or since the GL was initialized. To allow for distributed implementations, there may be several error flags. If any single error flag has recorded an error, the value of that flag is returned and that flag is reset to %f3GL_NO_ERRORfP when %f3glGetErrorfP is called. If more than one flag has recorded an error, %f3glGetErrorfP returns and clears an arbitrary error flag value. Thus, %f3glGetErrorfP should always be called in a loop, until it returns %f3GL_NO_ERRORfP, if all error flags are to be reset. Initially, all error flags are set to %f3GL_NO_ERRORfP. The following errors are currently defined:
%f3GL_NO_ERRORfP
No error has been recorded. The value of this symbolic constant is guaranteed to be 0.
%f3GL_INVALID_ENUMfP
An unacceptable value is specified for an enumerated argument. The offending command is ignored, and has no other side effect than to set the error flag.
%f3GL_INVALID_VALUEfP
A numeric argument is out of range. The offending command is ignored, and has no other side effect than to set the error flag.
%f3GL_INVALID_OPERATIONfP
The specified operation is not allowed in the current state. The offending command is ignored, and has no other side effect than to set the error flag.
%f3GL_STACK_OVERFLOWfP
This command would cause a stack overflow. The offending command is ignored, and has no other side effect than to set the error flag.
%f3GL_STACK_UNDERFLOWfP
This command would cause a stack underflow. The offending command is ignored, and has no other side effect than to set the error flag.
%f3GL_OUT_OF_MEMORYfP
There is not enough memory left to execute the command. The state of the GL is undefined, except for the state of the error flags, after this error is recorded.
%f3GL_TABLE_TOO_LARGEfP
The specified table exceeds the implementation's maximum supported table size. The offending command is ignored, and has no other side effect than to set the error flag. When an error flag is set, results of a GL operation are undefined only if %f3GL_OUT_OF_MEMORYfP has occurred. In all other cases, the command generating the error is ignored and has no effect on the GL state or frame buffer contents. If the generating command returns a value, it returns 0. If %f3glGetErrorfP itself generates an error, it returns 0.
 

NOTES

%f3GL_TABLE_TOO_LARGEfP was introduced in GL version 1.2.  

ERRORS

%f3GL_INVALID_OPERATIONfP is generated if %f3glGetErrorfP is executed between the execution of %f3glBeginfP and the corresponding execution of %f3glEndfP. In this case %f3glGetErrorfP returns 0.


 

Index

NAME
C SPECIFICATION
DESCRIPTION
NOTES
ERRORS