GLGETGRAPHICSRESETST(3G)

πŸ’… GLGETGRAPHICSRESETST(3G)

okay so bestie, you're in the 3G section of the manual (that's the OpenGL manual pages, iykyk) and today's main character is glGetGraphicsResetStatus. she's the one who tells you whether your rendering context is still alive or whether the universe said "nope" πŸ’€


✨ NAME ✨

glGetGraphicsResetStatus β€” check if the rendering context has not been lost due to software or hardware issues

like, a vibe check for your context. if the driver had a whole meltdown, she'll let you know 🫢


🌸 C SPECIFICATION 🌸

GLenum glGetGraphicsResetStatus(void);

that's it. no params. she takes zero arguments and she's still iconic πŸ‘‘


🫢 DESCRIPTION 🫢

okay so here's the tea πŸ“ β€” certain events can result in a reset of the GL context. and a reset is not a little oopsie, it literally causes all context state to be lost and requires the application to recreate all objects in the affected context. yes, all of them. everything. start over 😭

glGetGraphicsResetStatus can return one of the following constants:

  • GL_NO_ERROR β€” Indicates that the GL context has not been in a reset state since the last call. she's fine, she's thriving, nothing happened ✨
  • GL_GUILTY_CONTEXT_RESET β€” Indicates that a reset has been detected that is attributable to the current GL context. like… it was your context. it's giving "this is your fault actually" πŸ™ˆ
  • GL_INNOCENT_CONTEXT_RESET β€” Indicates a reset has been detected that is not attributable to the current GL context. your context is innocent, your honor πŸ’… somebody else did it
  • GL_UNKNOWN_CONTEXT_RESET β€” Indicates a detected graphics reset whose cause is unknown. we literally do not know. it's a mystery. a little enigma πŸ•΅οΈ

If a reset status other than GL_NO_ERROR is returned and subsequent calls return GL_NO_ERROR, the context reset was encountered and completed. If a reset status is repeatedly returned, the context may be in the process of resetting. so like β€” keep polling, bestie, you'll catch the moment it finishes πŸŽ€

Reset notification behavior is determined at context creation time, and may be queried by calling GetIntegerv with the symbolic constant GL_RESET_NOTIFICATION_STRATEGY. (you can't change it later, it's set in stone, periodt)

Now, depending on what that strategy is:

  • If the reset notification behavior is GL_NO_RESET_NOTIFICATION, then the implementation will never deliver notification of reset events, and glGetGraphicsResetStatus will always return GL_NO_ERROR. she's on do-not-disturb mode forever, you will simply never hear about it πŸ”‡
  • If the behavior is GL_LOSE_CONTEXT_ON_RESET, a graphics reset will result in the loss of all context state, requiring the recreation of all associated objects. In this case glGetGraphicsResetStatus may return any of the values described above. so buckle up, that's the spicy mode πŸ”₯

If a graphics reset notification occurs in a context, a notification must also occur in all other contexts which share objects with that context. it spreads. it's contagious. the whole friend group knows πŸ’€

okay important part, listen up 🫢 After a graphics reset has occurred on a context, subsequent GL commands on that context (or any context which shares with that context) will generate a GL_CONTEXT_LOST error.

And here's the reassuring bit: such commands will not have side effects (in particular, they will not modify memory passed by pointer for query results), and will not block indefinitely or cause termination of the application. so no hang, no crash, no drama ✨

There are two important exceptions to this behavior:

  • glGetError and glGetGraphicsResetStatus behave normally following a graphics reset, so that the application can determine a reset has occurred, and when it is safe to destroy and re-create the context. these two are the only ones still picking up the phone 😌
  • Any commands which might cause a polling application to block indefinitely will generate a GL_CONTEXT_LOST error, but will also return a value indicating completion to the application. Such commands include:
    • glGetSynciv with pname GL_SYNC_STATUS ignores the other parameters and returns GL_SIGNALED in values.
    • glGetQueryObjectuiv with pname GL_QUERY_RESULT_AVAILABLE ignores the other parameters and returns TRUE in params.

like, they'll scream "CONTEXT LOST" at you but they'll still hand you an answer on the way out. polite, honestly πŸŽ€


🌈 VERSION SUPPORT 🌈

here's the grid, bestie β€” the column is the OpenGL Version and the row is our girl. let's read it together πŸ’œ

Function / Feature Name: glGetGraphicsResetStatus

Version result

okay no tables allowed in here so let's just say it plainly:

  • OpenGL 2.0 β†’ - (not supported)
  • OpenGL 2.1 β†’ - (not supported)
  • OpenGL 3.0 β†’ - (not supported)
  • OpenGL 3.1 β†’ - (not supported)
  • OpenGL 3.2 β†’ - (not supported)
  • OpenGL 3.3 β†’ - (not supported)
  • OpenGL 4.0 β†’ - (not supported)
  • OpenGL 4.1 β†’ - (not supported)
  • OpenGL 4.2 β†’ - (not supported)
  • OpenGL 4.3 β†’ - (not supported)
  • OpenGL 4.4 β†’ - (not supported)
  • OpenGL 4.5 β†’ βœ” (supported)

so yeah. she's a 4.5 girlie. before 4.5? she literally did not exist. she arrived and ate πŸ’…


πŸ¦‹ SEE ALSO πŸ¦‹

go read these next, they're all connected to the same lore πŸ”₯

  • glGetError()
  • glGetIntegerv, β€” (yes there's a comma in the original, she's quirky like that πŸŽ€)
  • glGetQueryObjectuiv
  • glGetSynciv

Copyright Β© 2014 Khronos Group. This material may be distributed subject to the terms and conditions set forth in the Open Publication License, v 1.0, 8 June 1999. http://opencontent.org/openpub/.


Copyright Β© 2014 Khronos Group


and that's the whole page, bestie 🫢 source placeholder [FIXME: source], dated 08/09/2021, and it lives in the GLGETGRAPHICSRESETST(3G) aisle of the manual. go forth, check your reset status, and slay πŸ’–βœ¨πŸŒΈ

πŸ“¦ where this page comes from