org.xith3d.scenegraph
Class StencilFuncSeparate

java.lang.Object
  extended by org.xith3d.scenegraph.StencilFuncSeparate

public class StencilFuncSeparate
extends java.lang.Object

This is an abstraction of the OpenGL function glStencilFuncSeparate().


Constructor Summary
StencilFuncSeparate(org.jagatoo.opengl.enums.StencilFace face)
          Creates a new StencilFuncSeparate.
StencilFuncSeparate(org.jagatoo.opengl.enums.StencilFace face, org.jagatoo.opengl.enums.TestFunction func)
          Creates a new StencilFuncSeparate.
StencilFuncSeparate(org.jagatoo.opengl.enums.StencilFace face, org.jagatoo.opengl.enums.TestFunction func, int ref)
          Creates a new StencilFuncSeparate.
StencilFuncSeparate(org.jagatoo.opengl.enums.StencilFace face, org.jagatoo.opengl.enums.TestFunction func, int ref, int mask)
          Creates a new StencilFuncSeparate.
 
Method Summary
 org.jagatoo.opengl.enums.StencilFace getFace()
          Specifies whether front and/or back stencil state is updated.
 int getMask()
           
 int getRef()
          Specifies the reference value for the stencil test.
 org.jagatoo.opengl.enums.TestFunction getTestFunction()
          Specifies the test function.
 void setFace(org.jagatoo.opengl.enums.StencilFace face)
          Specifies whether front and/or back stencil state is updated.
 void setMask(int mask)
          Specifies a mask that is ANDed with both the reference value and the stored stencil value when the test is done.
 void setRef(int ref)
          Specifies the reference value for the stencil test.
 void setTestFunction(org.jagatoo.opengl.enums.TestFunction func)
          Specifies the test function.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

StencilFuncSeparate

public StencilFuncSeparate(org.jagatoo.opengl.enums.StencilFace face)
Creates a new StencilFuncSeparate.

Parameters:
face -

StencilFuncSeparate

public StencilFuncSeparate(org.jagatoo.opengl.enums.StencilFace face,
                           org.jagatoo.opengl.enums.TestFunction func)
Creates a new StencilFuncSeparate.

Parameters:
face -
func -

StencilFuncSeparate

public StencilFuncSeparate(org.jagatoo.opengl.enums.StencilFace face,
                           org.jagatoo.opengl.enums.TestFunction func,
                           int ref)
Creates a new StencilFuncSeparate.

Parameters:
face -
func -
ref -

StencilFuncSeparate

public StencilFuncSeparate(org.jagatoo.opengl.enums.StencilFace face,
                           org.jagatoo.opengl.enums.TestFunction func,
                           int ref,
                           int mask)
Creates a new StencilFuncSeparate.

Parameters:
face -
func -
ref -
mask -
Method Detail

setFace

public final void setFace(org.jagatoo.opengl.enums.StencilFace face)
Specifies whether front and/or back stencil state is updated.

Parameters:
face -

getFace

public final org.jagatoo.opengl.enums.StencilFace getFace()
Specifies whether front and/or back stencil state is updated.


setTestFunction

public final void setTestFunction(org.jagatoo.opengl.enums.TestFunction func)
Specifies the test function. The initial value is ALWAYS.

Parameters:
func -

getTestFunction

public final org.jagatoo.opengl.enums.TestFunction getTestFunction()
Specifies the test function. The initial value is ALWAYS.


setRef

public final void setRef(int ref)
Specifies the reference value for the stencil test. ref is clamped to the range [2, 2^n - 1], where n is the number of bitplanes in the stencil buffer. The initial value is 0.

Parameters:
ref -

getRef

public final int getRef()
Specifies the reference value for the stencil test. ref is clamped to the range [2, 2^n - 1], where n is the number of bitplanes in the stencil buffer. The initial value is 0.


setMask

public final void setMask(int mask)
Specifies a mask that is ANDed with both the reference value and the stored stencil value when the test is done. The initial value is all 1's.

Parameters:
mask -

getMask

public final int getMask()