Caelum::DepthRenderer Class Reference
Render the depth buffer to a texture. More...
#include <DepthComposer.h>
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. | |
| int | getRenderGroupRangeFilterMin () |
| int | getRenderGroupRangeFilterMax () |
| void | disableRenderGroupRangeFilter () |
| Disable the effects of. | |
| void | setViewportVisibilityMask (uint value) |
| Query mask for the depth rendering viewport. | |
| uint | getViewportVisibilityMask () |
| void | disableViewportVisibilityMask () |
| void | setUseCustomDepthScheme (bool value) |
| If true then use a user-supplied material scheme which outputs depth. | |
| 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 = "CaelumDepth" |
| 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.
Definition at line 176 of file DepthComposer.h.
Member Function Documentation
| 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.
Definition at line 469 of file DepthComposer.cpp.
Referenced by disableRenderGroupRangeFilter().
| int Caelum::DepthRenderer::getRenderGroupRangeFilterMin | ( | ) | [inline] |
| void Caelum::DepthRenderer::disableRenderGroupRangeFilter | ( | ) |
Disable the effects of.
- See also:
- setRenderGroupRangeFilter
Definition at line 475 of file DepthComposer.cpp.
References Ogre::RENDER_QUEUE_BACKGROUND, Ogre::RENDER_QUEUE_MAX, and setRenderGroupRangeFilter().
| void Caelum::DepthRenderer::setViewportVisibilityMask | ( | uint | value | ) | [inline] |
Query mask for the depth rendering viewport.
Enforces on every update ();
Definition at line 238 of file DepthComposer.h.
| 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.
Definition at line 251 of file DepthComposer.h.
The documentation for this class was generated from the following files:
- main/include/DepthComposer.h
- main/src/DepthComposer.cpp
