glclientwaitsync(3g) [osx man page]
GLCLIENTWAITSYNC(3G) OpenGL 3.3 GLCLIENTWAITSYNC(3G) NAME
glClientWaitSync - block and wait for a sync object to become signaled C SPECIFICATION
GLenum glClientWaitSync(GLsync sync, GLbitfield flags, GLuint64 timeout); PARAMETERS
sync The sync object whose status to wait 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. 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. The return value is one of four status values: o GL_ALREADY_SIGNALED indicates that sync was signaled at the time that glClientWaitSync was called. o GL_TIMEOUT_EXPIRED indicates that at least timeout nanoseconds passed and sync did not become signaled. o GL_CONDITION_SATISFIED indicates that sync was signaled before the timeout expired. o GL_WAIT_FAILED indicates that an error occurred. Additionally, an OpenGL error will be generated. NOTES
glClientWaitSync is available only if the GL version is 3.2 or greater. 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. SEE ALSO
glFenceSync(), glIsSync() glWaitSync() COPYRIGHT
Copyright (C) 2010 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/. OpenGL 3.3 03/08/2011 GLCLIENTWAITSYNC(3G)
Check Out this Related Man Page
GLWAITSYNC(3G) OpenGL 3.3 GLWAITSYNC(3G) NAME
glWaitSync - instruct the GL server to block until the specified sync object becomes signaled C SPECIFICATION
void glWaitSync(GLsync sync, GLbitfield flags, GLuint64 timeout); PARAMETERS
sync Specifies the sync object whose status to wait on. flags A bitfield controlling the command flushing behavior. flags may be zero. timeout Specifies the timeout that the server should wait before continuing. timeout must be GL_TIMEOUT_IGNORED. DESCRIPTION
glWaitSync causes the GL server to block and wait until sync becomes signaled. sync is the name of an existing sync object upon which to wait. flags and timeout are currently not used and must be set to zero and the special value GL_TIMEOUT_IGNORED, respectively[1]. glWaitSync will always wait no longer than an implementation-dependent timeout. The duration of this timeout in nanoseconds may be queried by calling glGet() with the parameter GL_MAX_SERVER_WAIT_TIMEOUT. There is currently no way to determine whether glWaitSync unblocked because the timeout expired or because the sync object being waited on was signaled. If an error occurs, glWaitSync does not cause the GL server to block. NOTES
glWaitSync is available only if the GL version is 3.2 or higher. ERRORS
GL_INVALID_OPERATION is generated if sync is not the name of a sync object. GL_INVALID_VALUE is generated if flags is not zero. GL_INVALID_VALUE is generated if timeout is not GL_TIMEOUT_IGNORED. SEE ALSO
glFenceSync(), glClientWaitSync() COPYRIGHT
Copyright (C) 2010 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/. NOTES
1. flags and timeout are placeholders for anticipated future extensions of sync object capabilities. They must have these reserved values in order that existing code calling glWaitSync operate properly in the presence of such extensions. OpenGL 3.3 03/08/2011 GLWAITSYNC(3G)