GLGETQUERYOBJECT(3G)

📦 in arch rolling

💅 NAME (yes bestie, it's giving what even is this)

glGetQueryObject, glGetQueryBufferObject — these return parameters of a query object. Obsessed. 🎀

Heads up that this page lives in section 3G of the manual, so like… GL library docs, iykyk. 🌸

✨ C SPECIFICATION ✨

The whole squad, verbatim, no cap:

void glGetQueryObjectiv(GLuint id, GLenum pname, GLint * params);

void glGetQueryObjectuiv(GLuint id, GLenum pname, GLuint * params);

void glGetQueryObjecti64v(GLuint id, GLenum pname, GLint64 * params);

void glGetQueryObjectui64v(GLuint id, GLenum pname, GLuint64 * params);

void glGetQueryBufferObjectiv(GLuint id, GLuint buffer, GLenum pname,
                              GLintptr offset);

void glGetQueryBufferObjectuiv(GLuint id, GLuint buffer, GLenum pname,
                               GLintptr offset);

void glGetQueryBufferObjecti64v(GLuint id, GLuint buffer, GLenum pname,
                                GLintptr offset);

void glGetQueryBufferObjectui64v(GLuint id, GLuint buffer, GLenum pname,
                                 GLintptr offset);

🫶 PARAMETERS

  • id — the name of a query object. It's the main character of this whole page, lowkey. ⭐
  • buffer — the name of a buffer object. Different thing, don't mix them up bestie. 🦋
  • pname — the symbolic name of a query object parameter. The accepted values are GL_QUERY_RESULT, GL_QUERY_RESULT_AVAILABLE, GL_QUERY_RESULT_NO_WAIT, or GL_QUERY_TARGET. That's the whole list, periodt. 💅
  • params — okay so this one's a two-for-one situation 😭: if a buffer is bound to the GL_QUERY_RESULT_BUFFER target, then params is treated as an offset to a location within that buffer's data store to receive the result of the query. But if no buffer is bound to GL_QUERY_RESULT_BUFFER, then params is treated as an address in client memory of a variable to receive the resulting data. Same name, different personality, so watch out. 🙈
  • offset — the byte offset into buffer's data store where the queried result will be written. 🎀

💖 DESCRIPTION

So these commands return a selected parameter of the query object specified by id. glGetQueryObject returns in params a selected parameter of the query object specified by id. And glGetQueryBufferObject returns in buffer a selected parameter of the query object specified by id, by writing it to buffer's data store at the byte offset specified by offset. Slay, both of them. ✨

pname names a specific query object parameter, and pname can be as follows — the full roster, no skips:

🌈 GL_QUERY_RESULT

params or buffer returns the value of the query object's passed samples counter. The initial value is 0. Simple, iconic.

🌈 GL_QUERY_RESULT_NO_WAIT

If the result of the query is available (that is, a query of GL_QUERY_RESULT_AVAILABLE would return non-zero), then params or buffer returns the value of the query object's passed samples counter. Otherwise, the data referred to by params or buffer is not modified. The initial value is 0. She said "no refunds, no rewrites." 💀

🌈 GL_QUERY_RESULT_AVAILABLE

params or buffer returns whether the passed samples counter is immediately available. If a delay would occur waiting for the query result, GL_FALSE is returned. Otherwise, GL_TRUE is returned — which also indicates that the results of all previous queries are available as well. Group-chat energy: if she's here, everyone before her already got here too. 🔥

🌈 GL_QUERY_TARGET

params or buffer returns the query object's target. Short and sweet. 🍓

💀 NOTES

  • If an error is generated, no change is made to the contents of params or buffer. Errors are a full stop, not a partial write, ngl.
  • glGetQueryObject and glGetQueryBufferObject implicitly flush the GL pipeline so that any incomplete rendering delimited by the occlusion query completes in finite time. They literally push things along so you don't wait forever. ⏳
  • If multiple queries are issued using the same query object id before calling glGetQueryObject or glGetQueryBufferObject, the results of the most recent query will be returned. And in this case, when issuing a new query, the results of the previous query are discarded. Out with the old, bestie. 🗑️
  • glGetQueryObjecti64v and glGetQueryObjectui64v are available only if the GL version is 3.3 or greater. Gatekept, unfortunately.
  • GL_QUERY_RESULT_NO_WAIT is accepted for pname only if the GL version is 4.4 or greater. 👑
  • The GL_QUERY_RESULT_BUFFER target is available only if the GL version is 4.4 or higher. On earlier versions of the GL, params is always an address in client memory — no buffer shenanigans for the old-heads. 🧚

🚨 ERRORS

Like, read these carefully, because every single one of them is a real vibe check you can fail.
  • GL_INVALID_ENUM is generated if pname is not an accepted value.
  • GL_INVALID_OPERATION is generated if id is not the name of a query object.
  • GL_INVALID_OPERATION is generated by glGetQueryBufferObject if buffer is not the name of an already created buffer object.
  • GL_INVALID_OPERATION is generated if id is the name of a currently active query object. Not while she's busy, please. 😭
  • GL_INVALID_OPERATION is generated by glGetQueryObject if a buffer is currently bound to the GL_QUERY_RESULT_BUFFER target and the command would cause data to be written beyond the bounds of that buffer's data store. Don't overflow, bestie. 🫶
  • GL_INVALID_OPERATION is generated by glGetQueryBufferObject if the command would cause data to be written beyond the bounds of buffer's data store. Same vibes, different buffer.
  • GL_INVALID_VALUE is generated by glGetQueryBufferObject if offset is negative. Negative offsets? In this economy? No ma'am. 🙈

👑 VERSION SUPPORT

Okay so the original gives you a big fancy grid — the columns are OpenGL versions 2.0, 2.1, 3.0, 3.1, 3.2, 3.3, 4.0, 4.1, 4.2, 4.3, 4.4, 4.5, 4.6, and the rows are "Function / Feature Name." I'm giving you the exact same tea in list form so it's actually readable on your terminal. ✔ means supported, - means nope. 💅

  • glGetQueryObjecti64v — - on 2.0, 2.1, 3.0, 3.1; ✔ on 3.2, 3.3, 4.0, 4.1, 4.2, 4.3, 4.4, 4.5, 4.6
  • glGetQueryObjectiv — ✔ on 2.0, 2.1, 3.0, 3.1, 3.2, 3.3, 4.0, 4.1, 4.2, 4.3, 4.4, 4.5, 4.6 (all of them, she's been here since day one ⭐)
  • glGetQueryObjectui64v — - on 2.0, 2.1, 3.0, 3.1; ✔ on 3.2, 3.3, 4.0, 4.1, 4.2, 4.3, 4.4, 4.5, 4.6
  • glGetQueryObjectuiv — ✔ on 2.0, 2.1, 3.0, 3.1, 3.2, 3.3, 4.0, 4.1, 4.2, 4.3, 4.4, 4.5, 4.6
  • glGetQueryBufferObjecti64v — - on 2.0, 2.1, 3.0, 3.1, 3.2, 3.3, 4.0, 4.1, 4.2, 4.3, 4.4; ✔ on 4.5, 4.6
  • glGetQueryBufferObjectiv — - on 2.0, 2.1, 3.0, 3.1, 3.2, 3.3, 4.0, 4.1, 4.2, 4.3, 4.4; ✔ on 4.5, 4.6
  • glGetQueryBufferObjectui64v — - on 2.0, 2.1, 3.0, 3.1, 3.2, 3.3, 4.0, 4.1, 4.2, 4.3, 4.4; ✔ on 4.5, 4.6
  • glGetQueryBufferObjectuiv — - on 2.0, 2.1, 3.0, 3.1, 3.2, 3.3, 4.0, 4.1, 4.2, 4.3, 4.4; ✔ on 4.5, 4.6

So the BufferObject girlies are strictly 4.5/4.6 only. Late bloomers, but they ate. 🔥

🦋 SEE ALSO

The whole friend group, go say hi:

  • glBeginQuery(),
  • glEndQuery, glGetQueryiv(), glIsQuery(), glQueryCounter()

Copyright © 2005 Addison-Wesley. Copyright © 2010-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. https://opencontent.org/openpub/.

Copyright © 2005 Sams Publishing

Copyright © 2010-2014 Khronos Group

And that's the whole page, bestie — mwah 💋 This cutie came from [FIXME: source], dated 10/07/2026, and she answers to the name GLGETQUERYOBJECT(3G). Go read your query results responsibly. 💜🌸✨

📦 where this page comes from