om::graphics::base::StencilAction Class Reference

A class that specifies the operation performed when updating a stencil buffer. More...

#include <omGraphicsStencilAction.h>

Public Types
enum	Enum {   KEEP = 0, ZERO = 1, REPLACE = 2, INCREMENT = 3,   INCREMENT_WRAP = 4, DECREMENT = 5, DECREMENT_WRAP = 6, INVERT = 7 }
	An enum type which represents the type of stencil action. More...

Public Member Functions
	StencilAction (Enum newAction)
	Create a new stencil action with the specified stencil action enum value. More...
	operator Enum () const
	Convert this stencil action type to an enum value. More...
String	toString () const
	Return a string representation of the stencil action. More...
	operator String () const
	Convert this stencil action into a string representation. More...

Detailed Description

A class that specifies the operation performed when updating a stencil buffer.

Member Enumeration Documentation

enum om::graphics::base::StencilAction::Enum

An enum type which represents the type of stencil action.

Enumerator
KEEP	An action where the current stencil value is kept in the stencil buffer.
ZERO	An action where the stencil buffer value is set to 0.
REPLACE	An action where the stencil buffer value is set to a constant stencil value.
INCREMENT	An action where one is added to the stencil buffer value. With this action, if the increment operation overflows the stencil buffer precision, the new stencil value is clamped at the maximum stencil value.
INCREMENT_WRAP	An action where one is added to the stencil buffer value, wrapping at the max stencil value. With this action, if the increment operation overflows the stencil buffer's precision, the new stencil value is set to 0.
DECREMENT	An action where one is subtracted from the stencil buffer value. With this action, if the decrement operation makes the value negative, the new stencil value is clamped at 0.
DECREMENT_WRAP	An action where one is subtracted from the stencil buffer value, wrapping at 0. With this action, if the decrement operation makes the value negative, the new stencil value is set to the maximum stencil value.
INVERT	An action where the stencil buffer value is set to its bitwise inverse.

Constructor & Destructor Documentation

om::graphics::base::StencilAction::StencilAction ( Enum  newAction )

inline

Create a new stencil action with the specified stencil action enum value.

Member Function Documentation

om::graphics::base::StencilAction::operator Enum ( ) const

inline

Convert this stencil action type to an enum value.

String om::graphics::base::StencilAction::toString

(

)

const

Return a string representation of the stencil action.

om::graphics::base::StencilAction::operator String ( ) const

inline

Convert this stencil action into a string representation.

---

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

• omGraphicsStencilAction.h