com.neovisionaries.android.opengl
Class StencilActionSet

java.lang.Object
  com.neovisionaries.android.opengl.StencilActionSet

public class StencilActionSet
extends Object

Set of stencil actions.

Author:

Takahiko Kawasaki

See Also:

StencilAction, glStencilOp, glStencilOpSeparate

Constructor Summary

StencilActionSet()
This constructor is an alias of StencilAction(null, null, null).

StencilActionSet(StencilActionSet actionSet)
A copy constructor.

StencilActionSet(StencilAction stencilFailureAction, StencilAction depthFailureAction, StencilAction passAction)
A constructor which stencil actions.

Method Summary

StencilAction	getDepthFailureAction() Get the action taken when the stencil test passes but the depth test fails.
StencilAction	getPassAction() Get the action taken when both the stencil test and the depth test pass.
StencilAction	getStencilFailureAction() Get the action taken when the stencil test fails.
StencilActionSet	setDepthFailureAction(StencilAction action) Set an action taken when the stencil test passes but the depth test fails.
StencilActionSet	setPassAction(StencilAction action) Set an action taken when both the stencil test and the depth test pass.
StencilActionSet	setStencilFailureAction(StencilAction action) Set an action taken when the stencil test fails.

Methods inherited from class java.lang.Object

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

Constructor Detail

StencilActionSet

public StencilActionSet()

This constructor is an alias of StencilAction(null, null, null).

StencilActionSet

public StencilActionSet(StencilAction stencilFailureAction,
                        StencilAction depthFailureAction,
                        StencilAction passAction)

A constructor which stencil actions.

Parameters:

stencilFailureAction - An action that is taken when the stencil test fails. If null is given, StencilAction.KEEP is set.

depthFailureAction - An action that is taken when the stencil test passes but the depth test fails. If null is given, StencilAction.KEEP is set.

passAction - An action that is taken when both the stencil test and the depth test pass. If null is given, StencilAction.KEEP is set.

StencilActionSet

public StencilActionSet(StencilActionSet actionSet)

A copy constructor.

Parameters:

actionSet - An action set to copy from. If null is given, If null is given, all actions are set to StencilAction.KEEP.

Method Detail

getStencilFailureAction

public StencilAction getStencilFailureAction()

Get the action taken when the stencil test fails.

Returns:

The action taken when the stencil test fails.

setStencilFailureAction

public StencilActionSet setStencilFailureAction(StencilAction action)

Set an action taken when the stencil test fails.

Parameters:

action - An action taken when the stencil test fails. If null is given, StencilAction.KEEP is set.

Returns:

This StencilActionSet object.

getDepthFailureAction

public StencilAction getDepthFailureAction()

Get the action taken when the stencil test passes but the depth test fails.

Returns:

The action taken when the stencil test passes but the depth test fails.

setDepthFailureAction

public StencilActionSet setDepthFailureAction(StencilAction action)

Set an action taken when the stencil test passes but the depth test fails.

Parameters:

action - An action taken when the stencil test passes but the depth test fails. If null is given, StencilAction.KEEP is set.

Returns:

This StencilActionSet object.

getPassAction

public StencilAction getPassAction()

Get the action taken when both the stencil test and the depth test pass.

Returns:

The action taken when both the stencil test and the depth test pass.

setPassAction

public StencilActionSet setPassAction(StencilAction action)

Set an action taken when both the stencil test and the depth test pass.

Parameters:

action - An action taken when both the stencil test and the depth test pass. If null is given, StencilAction.KEEP is set.

Returns:

This StencilActionSet object.