GLGETERROR(3G)

📦
version 1.1 · 7 versions
, in centos-stream 9

bestie, this is GLGETERROR(3G) — manual name 3G — and the header has a little [FIXME: manual] placeholder just vibing there. Let's get into the error-flag lore, because this one is lowkey essential. 💅✨

🌸 NAME 🌸

glGetError — return error information 👑

💻 C SPECIFICATION 💻

GLenum glGetError(void);

🧚 DESCRIPTION 🧚

glGetError returns 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 appropriate error code value. No other errors are recorded until glGetError is called, the error code is returned, and the flag is reset to GL_NO_ERROR. If a call to glGetError returns GL_NO_ERROR, there has been no detectable error since the last call to glGetError, or since the GL was initialized. periodt. 💖

Because distributed implementations are a thing, 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 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 bestie, if you want all the error flags reset, you should always call glGetError in a loop until it returns GL_NO_ERROR. iykyk. 🔁

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_INVALID_FRAMEBUFFER_OPERATION — The framebuffer object is not complete. 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_STACK_UNDERFLOW — An attempt has been made to perform an operation that would cause an internal stack to underflow. 🕳️
  • GL_STACK_OVERFLOW — An attempt has been made to perform an operation that would cause an internal stack to overflow. 🌊

When an error flag is set, results of a GL operation are undefined only if GL_OUT_OF_MEMORY 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 glGetError itself generates an error, it returns 0. no cap. 💯

🌈 VERSION SUPPORT 🌈

The original table has Function / Feature Name and OpenGL Version columns, with glGetError supported in every listed version. Every box is a ✔:

  • OpenGL 2.0 — ✔
  • OpenGL 2.1 — ✔
  • OpenGL 3.0 — ✔
  • OpenGL 3.1 — ✔
  • OpenGL 3.2 — ✔
  • OpenGL 3.3 — ✔
  • OpenGL 4.0 — ✔
  • OpenGL 4.1 — ✔
  • OpenGL 4.2 — ✔
  • OpenGL 4.3 — ✔
  • OpenGL 4.4 — ✔
  • OpenGL 4.5 — ✔

slay, she's supported everywhere on this list. 👑✨

👀 SEE ALSO 👀

No entries in this section, bestie — it's literally empty in the original. 🦋

Copyright © 1991-2006 Silicon Graphics, Inc. Copyright © 2010-2014 Khronos Group. This document is licensed under the SGI This document is licensed under the SGI Free Software B License. For details, see http://oss.sgi.com/projects/FreeB/.

Copyright © 1991-2006 Silicon Graphics, Inc.
Copyright © 2010-2014 Khronos Group

kisses, bestie — this page came from [FIXME: source], dated 08/09/2021, and it's filed under GLGETERROR(3G). 💖🦋🎀

📦 where this page comes from