Name
gl.DepthFunc -- specify the value used for depth buffer comparisons
Synopsis
gl.DepthFunc(func)
Function
gl.DepthFunc() specifies the function used to compare each incoming pixel depth value with the depth value present in the depth buffer. The comparison is performed only if depth testing is enabled. (See gl.Enable() and gl.Disable() of #GL_DEPTH_TEST)

func specifies the conditions under which the pixel will be drawn. The comparison functions are as follows:

#GL_NEVER
Never passes.

#GL_LESS
Passes if the incoming depth value is less than the stored depth value.

#GL_EQUAL
Passes if the incoming depth value is equal to the stored depth value.

#GL_LEQUAL
Passes if the incoming depth value is less than or equal to the stored depth value.

#GL_GREATER
Passes if the incoming depth value is greater than the stored depth value.

#GL_NOTEQUAL
Passes if the incoming depth value is not equal to the stored depth value.

#GL_GEQUAL
Passes if the incoming depth value is greater than or equal to the stored depth value.

#GL_ALWAYS
Always passes.

The initial value of func is #GL_LESS. Initially, depth testing is disabled. If depth testing is disabled or if no depth buffer exists, it is as if the depth test always passes.

Even if the depth buffer exists and the depth mask is non-zero, the depth buffer is not updated if the depth test is disabled.

Please consult an OpenGL reference manual for more information.

Inputs
func
specifies the depth comparison function (see above)
Errors
#GL_INVALID_ENUM is generated if func is not an accepted value.

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

Associated gets
gl.Get() with argument #GL_DEPTH_FUNC

gl.IsEnabled() with argument #GL_DEPTH_TEST


Show TOC