Package com.ardor3d.renderer.state

Class ZBufferState

java.lang.Object

com.ardor3d.renderer.state.RenderState

com.ardor3d.renderer.state.ZBufferState

All Implemented Interfaces:

Savable

public class ZBufferState
extends RenderState

ZBufferState maintains how the use of the depth buffer is to occur. Depth buffer comparisons are used to evaluate what incoming fragment will be used. This buffer is based on z depth, or distance between the pixel source and the eye.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ZBufferState.TestFunction

Nested classes/interfaces inherited from class com.ardor3d.renderer.state.RenderState

RenderState.StateStack, RenderState.StateType

Field Summary

Fields

Modifier and Type	Field	Description
protected ZBufferState.TestFunction	_function	Depth function.
protected boolean	_writable	Depth mask is writable or not.

Fields inherited from class com.ardor3d.renderer.state.RenderState

_quickCompare

Constructor Summary

Constructors

Constructor	Description
ZBufferState()	Constructor instantiates a new ZBufferState object.

Method Summary

Modifier and Type	Method	Description
StateRecord	createStateRecord(ContextCapabilities caps)
ZBufferState.TestFunction	getFunction()	getFunction returns the current depth function.
RenderState.StateType	getType()
boolean	isWritable()	isWritable returns if the depth mask is writable or not.
void	read(InputCapsule capsule)
void	setFunction(ZBufferState.TestFunction function)	setFunction sets the depth function.
void	setWritable(boolean writable)	setWritable sets the depth mask writable or not.
void	write(OutputCapsule capsule)

Methods inherited from class com.ardor3d.renderer.state.RenderState

createState, extract, getClassTag, isEnabled, needsRefresh, setEnabled, setNeedsRefresh, setQuickCompares

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

_function

protected ZBufferState.TestFunction _function

Depth function.

_writable

protected boolean _writable

Depth mask is writable or not.

Constructor Details

ZBufferState

public ZBufferState()

Constructor instantiates a new ZBufferState object. The initial values are TestFunction.LessThan and depth writing on.

Method Details

getFunction

public ZBufferState.TestFunction getFunction()

getFunction returns the current depth function.

Returns:

the depth function currently used.

setFunction

public void setFunction(ZBufferState.TestFunction function)

setFunction sets the depth function.

Parameters:

function - the depth function.

Throws:

IllegalArgumentException - if function is null

isWritable

public boolean isWritable()

isWritable returns if the depth mask is writable or not.

Returns:

true if the depth mask is writable, false otherwise.

setWritable

public void setWritable(boolean writable)

setWritable sets the depth mask writable or not.

Parameters:

writable - true to turn on depth writing, false otherwise.

getType

public RenderState.StateType getType()

Specified by:

getType in class RenderState

Returns:

An statetype enum value for the subclass.

See Also:

• RenderState.StateType

write

public void write(OutputCapsule capsule)
           throws IOException

Specified by:

write in interface Savable

Overrides:

write in class RenderState

Throws:

IOException

read

public void read(InputCapsule capsule)
          throws IOException

Specified by:

read in interface Savable

Overrides:

read in class RenderState

Throws:

IOException

createStateRecord

public StateRecord createStateRecord(ContextCapabilities caps)

Specified by:

createStateRecord in class RenderState