Caelum::DepthRenderer Class Reference

Render the depth buffer to a texture. More...

#include <DepthComposer.h>

Inheritance diagram for Caelum::DepthRenderer:

Public Member Functions
	DepthRenderer (Ogre::Viewport *viewport)
Ogre::Viewport *	getMasterViewport ()
Ogre::Texture *	getDepthRenderTexture ()
Ogre::Viewport *	getDepthRenderViewport ()
Ogre::RenderTexture *	getDepthRenderTarget ()
void	update ()
	Render the depth buffer now!
void	setRenderGroupRangeFilter (int minGroup, int maxGroup)
	Render only the render groups in a certain range. More...
int	getRenderGroupRangeFilterMin ()
int	getRenderGroupRangeFilterMax ()
void	disableRenderGroupRangeFilter ()
	Disable the effects of. More...
void	setViewportVisibilityMask (uint value)
	Query mask for the depth rendering viewport. More...
uint	getViewportVisibilityMask ()
void	disableViewportVisibilityMask ()
void	setUseCustomDepthScheme (bool value)
	If true then use a user-supplied material scheme which outputs depth. More...
bool	getUseCustomDepthScheme ()
void	setCustomDepthSchemeName (const Ogre::String &value)
	Set the name of the custom depth scheme (default is CaelumDepth).
const Ogre::String &	getCustomDepthSchemeName ()

Static Public Attributes
static const String	DEFAULT_CUSTOM_DEPTH_SCHEME_NAME
	Default name of the custom scheme.

Detailed Description

Render the depth buffer to a texture.

This class tries to be as generic and flexible as possible; but it is currently only used by the depth composer.

Member Function Documentation

setRenderGroupRangeFilter()

void Caelum::DepthRenderer::setRenderGroupRangeFilter	(	int	minGroup,
		int	maxGroup
	)

Render only the render groups in a certain range.

Call this to only render objects in certain render queue groups. The range is inclusive. This is a very primitive sort of filter.

getRenderGroupRangeFilterMin()

int Caelum::DepthRenderer::getRenderGroupRangeFilterMin ( )

inline

See also

setRenderGroupRangeFilter

disableRenderGroupRangeFilter()

void Caelum::DepthRenderer::disableRenderGroupRangeFilter

(

)

Disable the effects of.

See also

setRenderGroupRangeFilter

setViewportVisibilityMask()

void Caelum::DepthRenderer::setViewportVisibilityMask ( uint  value )

inline

Query mask for the depth rendering viewport.

Enforces on every update ();

setUseCustomDepthScheme()

void Caelum::DepthRenderer::setUseCustomDepthScheme ( bool  value )

inline

If true then use a user-supplied material scheme which outputs depth.

The depth output of most materials is obvious and can be guessed most of the time. When that fails you can provide a custom material scheme for certain materials which renders the depth buffer.

This is enabled by default for a scheme called CaelumDepth.