om::graphics::base::StencilTest Class Reference

A class that specifies the operation performed when testing a new stencil fragment. More...

#include <omGraphicsStencilTest.h>

Public Types
enum	Enum {   NEVER = 0, ALWAYS = 1, EQUAL = 2, NOT_EQUAL = 3,   LESS_THAN = 4, LESS_THAN_OR_EQUAL = 5, GREATER_THAN = 6, GREATER_THAN_OR_EQUAL = 7 }
	An enum type which represents the type of stencil test. More...

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

Detailed Description

A class that specifies the operation performed when testing a new stencil fragment.

If the stencil test succeeds, the fragment is rendered. Otherwise, the fragment is discarded and rendering for the fragment stops.

Member Enumeration Documentation

enum om::graphics::base::StencilTest::Enum

An enum type which represents the type of stencil test.

Enumerator
NEVER	A test where the test never succeeds (no fragments ever pass or update the stencil buffer).
ALWAYS	A test where the test always succeeds (all fragments pass and update the stencil buffer).
EQUAL	A test where the test succeeds if the source and destination stencils are equal.
NOT_EQUAL	A test where the test succeeds if the source and destination stencils are not equal.
LESS_THAN	A test where the test succeeds if the new stencil value is less than the existing stencil value.
LESS_THAN_OR_EQUAL	A test where it succeeds if the new stencil value is less than or equal to the existing stencil value.
GREATER_THAN	A test where the test succeeds if the new stencil value is greater than the existing stencil value.
GREATER_THAN_OR_EQUAL	A test where it succeeds if the new stencil value is greater than or equal to the existing stencil value.

Constructor & Destructor Documentation

om::graphics::base::StencilTest::StencilTest ( Enum  newTest )

inline

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

Member Function Documentation

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

inline

Convert this stencil test type to an enum value.

String om::graphics::base::StencilTest::toString

(

)

const

Return a string representation of the stencil test.

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

inline

Convert this stencil test into a string representation.

---

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

• omGraphicsStencilTest.h