om::graphics::base::DepthTest Class Reference

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

#include <omGraphicsDepthTest.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 depth test. More...

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

Detailed Description

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

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

Member Enumeration Documentation

enum om::graphics::base::DepthTest::Enum

An enum type which represents the type of depth test.

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

Constructor & Destructor Documentation

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

inline

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

Member Function Documentation

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

inline

Convert this depth test type to an enum value.

String om::graphics::base::DepthTest::toString

(

)

const

Return a string representation of the depth test.

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

inline

Convert this depth test into a string representation.

---

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

• omGraphicsDepthTest.h