Ignition Rendering

API Reference

5.0.0
Ogre2RenderTargetMaterial Class Reference

Causes all objects in a scene to be rendered with the same material when rendered by a given RenderTarget. More...

#include <Ogre2RenderTargetMaterial.hh>

Public Member Functions

 Ogre2RenderTargetMaterial (Ogre::SceneManager *_scene, Ogre::RenderTarget *_renderTarget, Ogre::Material *_material)
 constructor More...
 
 ~Ogre2RenderTargetMaterial ()
 destructor More...
 
virtual Ogre::Technique * handleSchemeNotFound (uint16_t _schemeIndex, const Ogre::String &_schemeName, Ogre::Material *_originalMaterial, uint16_t _lodIndex, const Ogre::Renderable *_rend) override
 Ogre callback that assigned same material to all renderables when the requested scheme is not found. More...
 
bool IsSameRenderTarget (Ogre::RenderTarget *_renderTarget)
 Returns this->renderTarget == _renderTarget. More...
 

Detailed Description

Causes all objects in a scene to be rendered with the same material when rendered by a given RenderTarget.

Constructor & Destructor Documentation

◆ Ogre2RenderTargetMaterial()

Ogre2RenderTargetMaterial ( Ogre::SceneManager *  _scene,
Ogre::RenderTarget *  _renderTarget,
Ogre::Material *  _material 
)

constructor

Parameters
[in]_scenethe scene manager responsible for rendering
[in]_renderTargetthe RenderTarget this should apply to
[in]_materialthe material to apply to all renderables

◆ ~Ogre2RenderTargetMaterial()

destructor

Member Function Documentation

◆ handleSchemeNotFound()

virtual Ogre::Technique* handleSchemeNotFound ( uint16_t  _schemeIndex,
const Ogre::String &  _schemeName,
Ogre::Material *  _originalMaterial,
uint16_t  _lodIndex,
const Ogre::Renderable *  _rend 
)
overridevirtual

Ogre callback that assigned same material to all renderables when the requested scheme is not found.

Parameters
[in]_schemeIndexIndex of scheme requested
[in]_schemeNameName of scheme requested
[in]_originalMaterialOrignal material that does not contain the requested scheme
[in]_lodIndexThe material level-of-detail
[in]_rendPointer to the Ogre::Renderable object requesting the use of the techinique
Returns
The Ogre material technique to use when scheme is not found.

◆ IsSameRenderTarget()

bool IsSameRenderTarget ( Ogre::RenderTarget *  _renderTarget)

Returns this->renderTarget == _renderTarget.


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