om::graphics::base::StencilMode Class Reference

A class that specifies how the stencil buffer should be updated. More...

#include <omGraphicsStencilMode.h>

Public Member Functions
	StencilMode ()
	Create a new stencil mode with the default stencil test parameters. More...
	StencilMode (StencilTest newTest, StencilAction stencilFail, StencilAction stencilPassDepthFail, StencilAction stencilPass)
	Create a new depth mode with the specified test and action parameters. More...
	StencilMode (StencilTest newTest, StencilAction stencilFail, StencilAction stencilPassDepthFail, StencilAction stencilPass, StencilValue newMask=StencilValue(0xFFFFFFFF), StencilValue newValue=0)
	Create a new depth mode with the specified test and action parameters. More...
const StencilTest &	getTest () const
	Return an object that describes the stencil test used by this stencil mode. More...
void	setTest (const StencilTest &newTest)
	Set the stencil test used by this stencil mode. More...
const StencilAction &	getPassAction () const
	Return an object that describes the stencil action taken when the stencil test passes. More...
void	setPassAction (const StencilAction &newPassAction)
	Set an object that describes the stencil action taken when the stencil test passes. More...
const StencilAction &	getPassDepthFailAction () const
	Return an object that describes the stencil action taken when the stencil test passes but depth fails. More...
void	setPassDepthFailAction (const StencilAction &newPassDepthFailAction)
	Set an object that describes the stencil action taken when the stencil test passes but depth fails. More...
const StencilAction &	getFailAction () const
	Return an object that describes the stencil action taken when the stencil test fails. More...
void	setFailAction (const StencilAction &newFailAction)
	Set an object that describes the stencil action taken when the stencil test fails. More...
StencilValue	getMask () const
	Return a bitwise stencil value mask that is used to determine which bits of the stencil buffer to update. More...
void	setMask (StencilValue newMask)
	Set a bitwise stencil value mask that is used to determine which bits of the stencil buffer to update. More...
StencilValue	getValue () const
	Return a constant stencil value that may be used by some stencil actions. More...
void	setValue (StencilValue newValue)
	Set a constant stencil value that may be used by some stencil actions. More...
Bool	operator== (const StencilMode &other) const
	Return whether or not this stencil mode is equal to another stencil mode. More...
Bool	operator!= (const StencilMode &other) const
	Return whether or not this stencil mode is not equal to another stencil mode. More...

Detailed Description

A class that specifies how the stencil buffer should be updated.

Constructor & Destructor Documentation

om::graphics::base::StencilMode::StencilMode ( )

inline

Create a new stencil mode with the default stencil test parameters.

om::graphics::base::StencilMode::StencilMode ( StencilTest  newTest, StencilAction  stencilFail, StencilAction  stencilPassDepthFail, StencilAction  stencilPass  )

inline

Create a new depth mode with the specified test and action parameters.

om::graphics::base::StencilMode::StencilMode ( StencilTest  newTest, StencilAction  stencilFail, StencilAction  stencilPassDepthFail, StencilAction  stencilPass, StencilValue  newMask = StencilValue(0xFFFFFFFF), StencilValue  newValue = 0  )

inline

Create a new depth mode with the specified test and action parameters.

Member Function Documentation

const StencilTest& om::graphics::base::StencilMode::getTest ( ) const

inline

Return an object that describes the stencil test used by this stencil mode.

void om::graphics::base::StencilMode::setTest ( const StencilTest &  newTest )

inline

Set the stencil test used by this stencil mode.

const StencilAction& om::graphics::base::StencilMode::getPassAction ( ) const

inline

Return an object that describes the stencil action taken when the stencil test passes.

void om::graphics::base::StencilMode::setPassAction ( const StencilAction &  newPassAction )

inline

Set an object that describes the stencil action taken when the stencil test passes.

const StencilAction& om::graphics::base::StencilMode::getPassDepthFailAction ( ) const

inline

Return an object that describes the stencil action taken when the stencil test passes but depth fails.

void om::graphics::base::StencilMode::setPassDepthFailAction ( const StencilAction &  newPassDepthFailAction )

inline

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

const StencilAction& om::graphics::base::StencilMode::getFailAction ( ) const

inline

Return an object that describes the stencil action taken when the stencil test fails.

void om::graphics::base::StencilMode::setFailAction ( const StencilAction &  newFailAction )

inline

Set an object that describes the stencil action taken when the stencil test fails.

StencilValue om::graphics::base::StencilMode::getMask ( ) const

inline

Return a bitwise stencil value mask that is used to determine which bits of the stencil buffer to update.

If a bit in the mask is set to 1, that bit of the stencil buffer will be updated. Otherwise, the buffer is not updated for that bit.

void om::graphics::base::StencilMode::setMask ( StencilValue  newMask )

inline

Set a bitwise stencil value mask that is used to determine which bits of the stencil buffer to update.

If a bit in the mask is set to 1, that bit of the stencil buffer will be updated. Otherwise, the buffer is not updated for that bit.

StencilValue om::graphics::base::StencilMode::getValue ( ) const

inline

Return a constant stencil value that may be used by some stencil actions.

void om::graphics::base::StencilMode::setValue ( StencilValue  newValue )

inline

Set a constant stencil value that may be used by some stencil actions.

Bool om::graphics::base::StencilMode::operator== ( const StencilMode &  other ) const

inline

Return whether or not this stencil mode is equal to another stencil mode.

Bool om::graphics::base::StencilMode::operator!= ( const StencilMode &  other ) const

inline

Return whether or not this stencil mode is not equal to another stencil mode.

---

The documentation for this class was generated from the following file:

• omGraphicsStencilMode.h