GLGETERROR(3G)

💖 NAME 💖

glGetError — return error information. This is the glGetError page from the 3G manual, bestie, and we're gonna get you comfy with it. 🫶

✨ C SPECIFICATION ✨

GLenum glGetError( void )

🌸 DESCRIPTION 🌸

okay so glGetError hands you back the value of the error flag. Every detectable error gets a numeric code and a symbolic name. When an error happens, the error flag is set to the matching error code value. No other errors get recorded until glGetError is called, that error code is returned, and the flag is reset to GL_NO_ERROR. If a call to glGetError returns GL_NO_ERROR, then there has been no detectable error since the last call to glGetError, or since the GL was initialized. iconic. ✨

Because distributed implementations are a thing, there may be several error flags. If any single error flag has recorded an error, that flag's value is returned and that flag gets reset to GL_NO_ERROR when glGetError is called. If more than one flag has recorded an error, glGetError returns and clears an arbitrary error flag value. So if you want all the error flags reset, call glGetError in a loop until it returns GL_NO_ERROR. periodt. 💅

Initially, all error flags are set to GL_NO_ERROR. 🎀

The following errors are currently defined:

• GL_NO_ERROR — no error has been recorded. The value of this symbolic constant is guaranteed to be 0. 🌸
• GL_INVALID_ENUM — 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. 🦋
• GL_INVALID_VALUE — a numeric argument is out of range. The offending command is ignored, and has no other side effect than to set the error flag. 💜
• GL_INVALID_OPERATION — 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. 🫶
• GL_STACK_OVERFLOW — this command would cause a stack overflow. The offending command is ignored, and has no other side effect than to set the error flag. 😭
• GL_STACK_UNDERFLOW — this command would cause a stack underflow. The offending command is ignored, and has no other side effect than to set the error flag. 🙈
• GL_OUT_OF_MEMORY — 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. 💀
• GL_TABLE_TOO_LARGE — 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, the results of a GL operation are undefined only if GL_OUT_OF_MEMORY has occurred. In every other case, the command that generated 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. And if glGetError itself generates an error, it returns 0. no cap. 🔥

🎀 NOTES 🎀

Fun fact for the lore: GL_TABLE_TOO_LARGE was introduced in GL version 1.2. 🌈

💀 ERRORS 💀

GL_INVALID_OPERATION is generated if glGetError is executed between the execution of glBegin and the corresponding execution of glEnd. In this case, glGetError returns 0. 😭

later bestie — this was the GLGETERROR page from the 3G manual section, and the footer has no separate date to spill, so that's all she wrote. 🫶💖