com.io7m.jcanephora.renderstate

Interface JCGLDepthStateType

All Known Implementing Classes:

JCGLDepthState, JCGLDepthStateMutable

@Value.Immutable
 @Value.Modifiable
public interface JCGLDepthStateType

Depth testing/writing state.

Method Summary

Modifier and Type	Method and Description
default JCGLDepthClamping	getDepthClamp()
default JCGLDepthStrict	getDepthStrict() Enable or disable strict mode.
Optional<JCGLDepthFunction>	getDepthTest()
default JCGLDepthWriting	getDepthWrite()

Method Detail

getDepthStrict

@Value.Parameter
 @Value.Default
default JCGLDepthStrict getDepthStrict()

Enable or disable strict mode. If strict mode is enabled, then attempting to enable depth writing/testing/clamping will fail with an exception if the currently bound framebuffer does not have a depth buffer.

Returns:

JCGLDepthStrict.DEPTH_STRICT_ENABLED iff strict mode is enabled

getDepthTest

@Value.Parameter
Optional<JCGLDepthFunction> getDepthTest()

Returns:

The depth testing function, if testing is enabled

getDepthWrite

@Value.Parameter
 @Value.Default
default JCGLDepthWriting getDepthWrite()

Returns:

JCGLDepthWriting.DEPTH_WRITE_ENABLED if depth writing is enabled

getDepthClamp

@Value.Parameter
 @Value.Default
default JCGLDepthClamping getDepthClamp()

Returns:

JCGLDepthClamping.DEPTH_CLAMP_ENABLED if depth clamping is enabled