Name
gl.Clear -- clear buffers to preset values
Synopsis
gl.Clear(mask)
Function
gl.Clear() sets the bitplane area of the window to values previously selected by gl.ClearColor(), gl.ClearIndex(), gl.ClearDepth(), gl.ClearStencil(), and gl.ClearAccum(). Multiple color buffers can be cleared simultaneously by selecting more than one buffer at a time using gl.DrawBuffer().

The pixel ownership test, the scissor test, dithering, and the buffer writemasks affect the operation of gl.Clear(). The scissor box bounds the cleared region. Alpha function, blend function, logical operation, stenciling, texture mapping, and depth-buffering are ignored by gl.Clear().

gl.Clear() takes a single argument that is the bitwise OR of several values indicating which buffer is to be cleared.

The values are as follows:

#GL_COLOR_BUFFER_BIT
Indicates the buffers currently enabled for color writing.

#GL_DEPTH_BUFFER_BIT
Indicates the depth buffer.

#GL_ACCUM_BUFFER_BIT
Indicates the accumulation buffer.

#GL_STENCIL_BUFFER_BIT
Indicates the stencil buffer.

The value to which each buffer is cleared depends on the setting of the clear value for that buffer.

If a buffer is not present, then a gl.Clear() directed at that buffer has no effect.

Please consult an OpenGL reference manual for more information.

Inputs
mask
bitwise OR of masks that indicate the buffers to be cleared. The four masks are #GL_COLOR_BUFFER_BIT, #GL_DEPTH_BUFFER_BIT, #GL_ACCUM_BUFFER_BIT, and #GL_STENCIL_BUFFER_BIT
Errors
#GL_INVALID_VALUE is generated if any bit other than the four defined bits is set in mask.

#GL_INVALID_OPERATION is generated if gl.Clear() is executed between the execution of gl.Begin() and the corresponding execution of gl.End()

Associated gets
gl.Get() with argument #GL_ACCUM_CLEAR_VALUE

gl.Get() with argument #GL_DEPTH_CLEAR_VALUE

gl.Get() with argument #GL_INDEX_CLEAR_VALUE

gl.Get() with argument #GL_COLOR_CLEAR_VALUE

gl.Get() with argument #GL_STENCIL_CLEAR_VALUE

Show TOC