TheWebGL2RenderingContext.clientWaitSync() method of theWebGL 2 API blocks and waits for aWebGLSync object to become signaled or a given timeout to be passed.

Syntax

clientWaitSync(sync, flags, timeout)

Parameters

sync

AWebGLSync object on which to wait on.

flags

AGLbitfield specifying a bitwise combination of flags controllingthe flushing behavior. May begl.SYNC_FLUSH_COMMANDS_BIT.

timeout

AGLint64 specifying a timeout (in nanoseconds) for which to wait forthe sync object to become signaled. Must not be larger thangl.MAX_CLIENT_WAIT_TIMEOUT_WEBGL.

Return value

AGLenum indicating the sync object's status.

• gl.ALREADY_SIGNALED: Indicates that the sync object was signaled whenthis method was called.
• gl.TIMEOUT_EXPIRED: Indicates that thetimeout time passedand that the sync object did not become signaled.
• gl.CONDITION_SATISFIED: Indicates that the sync object was signaledbefore thetimeout expired.
• gl.WAIT_FAILED: Indicates that an error occurred during the execution.

Examples

const sync = gl.fenceSync(gl.SYNC_GPU_COMMANDS_COMPLETE, 0);const status = gl.clientWaitSync(sync, 0, 0);

Specifications

Browser compatibility

See also

• WebGLSync