om::graphics::base::DepthMode Class Reference

A class that specifies how the depth buffer should be updated when drawing. More...

#include <omGraphicsDepthMode.h>

Public Member Functions
	DepthMode ()
	Create a new depth mode with the default depth parameters. More...
	DepthMode (DepthTest newTest)
	Create a new depth mode with the given depth test and default range of [0,1]. More...
	DepthMode (DepthTest newTest, const AABB1f &newRange)
	Create a new depth mode with the given depth test and range. More...
const DepthTest &	getTest () const
	Return an object that describes the depth test used by this depth mode. More...
void	setTest (const DepthTest &newTest)
	Set the depth test used by this depth mode. More...
const AABB1f &	getRange () const
	Return the output range of depth values which should be written to the depth buffer. More...
void	setRange (const AABB1f &newDepthRange)
	Set the output range of depth values which should be written to the depth buffer. More...
void	setRange (Float minDepth, Float maxDepth)
	Set the output range of depth values which should be written to the depth buffer. More...
Bool	operator== (const DepthMode &other) const
	Return whether or not this depth mode is equal to another depth mode. More...
Bool	operator!= (const DepthMode &other) const
	Return whether or not this depth mode is not equal to another depth mode. More...

Detailed Description

A class that specifies how the depth buffer should be updated when drawing.

Constructor & Destructor Documentation

om::graphics::base::DepthMode::DepthMode ( )

inline

Create a new depth mode with the default depth parameters.

The default depth test is DepthTest::LESS_THAN and the default depth range is [0,1].

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

inline

Create a new depth mode with the given depth test and default range of [0,1].

om::graphics::base::DepthMode::DepthMode ( DepthTest  newTest, const AABB1f &  newRange  )

inline

Create a new depth mode with the given depth test and range.

Member Function Documentation

const DepthTest& om::graphics::base::DepthMode::getTest ( ) const

inline

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

void om::graphics::base::DepthMode::setTest ( const DepthTest &  newTest )

inline

Set the depth test used by this depth mode.

const AABB1f& om::graphics::base::DepthMode::getRange ( ) const

inline

Return the output range of depth values which should be written to the depth buffer.

The range of this value should lie within the range [0,1]. This specifies the range which normalized device coordiantes from [-1,1] should be mapped to before depth values are written to the depth buffer. For instance, a range of [0,0.5] means that depth values are in that range and only half of the depth buffer's precision is used.

void om::graphics::base::DepthMode::setRange ( const AABB1f &  newDepthRange )

inline

Set the output range of depth values which should be written to the depth buffer.

The range of this value should lie within the range [0,1]. This specifies the range which normalized device coordiantes from [-1,1] should be mapped to before depth values are written to the depth buffer. For instance, a range of [0,0.5] means that depth values are in that range and only half of the depth buffer's precision is used.

void om::graphics::base::DepthMode::setRange ( Float  minDepth, Float  maxDepth  )

inline

Set the output range of depth values which should be written to the depth buffer.

The range of this value should lie within the range [0,1]. This specifies the range which normalized device coordiantes from [-1,1] should be mapped to before depth values are written to the depth buffer. For instance, a range of [0,0.5] means that depth values are in that range and only half of the depth buffer's precision is used.

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

inline

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

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

inline

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

---

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

• omGraphicsDepthMode.h