GLCLIENTWAITSYNC(3G)

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

hii bestie 💖 you’ve landed on the GLCLIENTWAITSYNC(3G) page, and we’re about to make sync-object waiting make sense, no cap. ✨

🎀 NAME 🎀

glClientWaitSync — block and wait for a sync object to become signaled. literally the “chill until this thing is ready” call, and honestly? iconic. 🫶

💅 C SPECIFICATION 💅

GLenum glClientWaitSync(GLsync sync, GLbitfield flags,
                        GLuint64 timeout);

✨ PARAMETERS ✨

  • sync — the sync object whose status to wait on. bestie, this is the thing you’re waiting on. 👀
  • flags — a bitfield controlling the command flushing behavior. flags may be GL_SYNC_FLUSH_COMMANDS_BIT. 💅
  • timeout — the timeout, specified in nanoseconds, for which the implementation should wait for sync to become signaled. yes, nanoseconds, not vibes. ⏳

🦋 DESCRIPTION 🦋

glClientWaitSync causes the client to block and wait for the sync object specified by sync to become signaled. if sync is signaled when glClientWaitSync is called, glClientWaitSync returns immediately, otherwise it will block and wait for up to timeout nanoseconds for sync to become signaled. periodt. 💖

The return value is one of four status values:

  • GL_ALREADY_SIGNALED indicates that sync was signaled at the time that glClientWaitSync was called. already ready, bestie! ✨
  • GL_TIMEOUT_EXPIRED indicates that at least timeout nanoseconds passed and sync did not become signaled. oof, timed out. 😭
  • GL_CONDITION_SATISFIED indicates that sync was signaled before the timeout expired. slay, it happened in time! 🎀
  • GL_WAIT_FAILED indicates that an error occurred. Additionally, an OpenGL error will be generated. not the vibe, lowkey. 💀

🌸 NOTES 🌸

glClientWaitSync is available only if the GL version is 3.2 or greater. no cap, check your version first. 👑🦋

💀 ERRORS 💀

  • GL_INVALID_VALUE is generated if sync is not the name of an existing sync object. 🙈
  • GL_INVALID_VALUE is generated if flags contains any unsupported flag. 🚩

👑 VERSION SUPPORT 👑

under OpenGL Version, for the Function / Feature Name glClientWaitSync: 🌈

  • 2.0: -, 2.1: -, 3.0: -, 3.1: -, 3.2: ✔, 3.3: ✔, 4.0: ✔, 4.1: ✔, 4.2: ✔, 4.3: ✔, 4.4: ✔, 4.5: ✔

🌈 SEE ALSO 🌈

glFenceSync(), glIsSync() glWaitSync() — go give these icons a look too, iykyk. 💜

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. http://opencontent.org/openpub/.

Copyright © 2010-2014 Khronos Group

xoxo, this page was brought to you by the source/version tag [FIXME: source], dated 08/09/2021, signing off as GLCLIENTWAITSYNC(3G) 💅✨

📦 where this page comes from