Ogre::CompositorPassImguiProvider Class Reference

Generates the CompositorPassImgui pass needed to render imgui UI Also ensures the compositor scripts recognize the pass type "dear_imgui" i.e. More...

#include <OgreCompositorPassImguiProvider.h>

Inheritance diagram for Ogre::CompositorPassImguiProvider:

Public Member Functions
	CompositorPassImguiProvider (ImguiManager *imguiManager)
CompositorPass *	addPass (const CompositorPassDef *definition, Camera *defaultCamera, CompositorNode *parentNode, const RenderTargetViewDef *rtvDef, SceneManager *sceneManager) override
	Creates a CompositorPass from a CompositorPassDef for Compositor Pass of type 'custom'.
CompositorPassDef *	addPassDef (CompositorPassType passType, IdString customId, CompositorTargetDef *parentTargetDef, CompositorNodeDef *parentNodeDef) override
	Called from CompositorTargetDef::addPass when adding a Compositor Pass of type 'custom'.
ImguiManager *	getColibriManager () const
void	translateCustomPass (ScriptCompiler *compiler, const AbstractNodePtr &node, IdString customId, CompositorPassDef *customPassDef) override
	Optional override which allows users to define custom properties in the compositor scripts for custom passes.
Public Member Functions inherited from Ogre::CompositorPassProvider
virtual	~CompositorPassProvider ()
virtual void	translateCustomPass (const AbstractNodePtr &node, CompositorPassDef *customPassDef)

Detailed Description

Generates the CompositorPassImgui pass needed to render imgui UI Also ensures the compositor scripts recognize the pass type "dear_imgui" i.e.

pass custom dear_imgui
{
}

Constructor & Destructor Documentation

CompositorPassImguiProvider()

Ogre::CompositorPassImguiProvider::CompositorPassImguiProvider

(

ImguiManager *

imguiManager

)

Member Function Documentation

addPass()

CompositorPass * Ogre::CompositorPassImguiProvider::addPass ( const CompositorPassDef *  definition, Camera *  defaultCamera, CompositorNode *  parentNode, const RenderTargetViewDef *  rtvDef, SceneManager *  sceneManager  )

overridevirtual

Creates a CompositorPass from a CompositorPassDef for Compositor Pass of type 'custom'.

Remarks

If you have multiple custom pass types then you will need to use dynamic_cast<>() on the CompositorPassDef to determine what custom pass it is.

Implements Ogre::CompositorPassProvider.

addPassDef()

CompositorPassDef * Ogre::CompositorPassImguiProvider::addPassDef ( CompositorPassType  passType, IdString  customId, CompositorTargetDef *  parentTargetDef, CompositorNodeDef *  parentNodeDef  )

overridevirtual

Called from CompositorTargetDef::addPass when adding a Compositor Pass of type 'custom'.

Parameters

passType
customId	Arbitrary ID in case there is more than one type of custom pass you want to implement. Defaults to IdString()
rtIndex
parentNodeDef

Returns

Implements Ogre::CompositorPassProvider.

getColibriManager()

ImguiManager * Ogre::CompositorPassImguiProvider::getColibriManager ( ) const

inline

translateCustomPass()

void Ogre::CompositorPassImguiProvider::translateCustomPass ( ScriptCompiler *  compiler, const AbstractNodePtr &  node, IdString  customId, CompositorPassDef *  customPassDef  )

overridevirtual

Optional override which allows users to define custom properties in the compositor scripts for custom passes.

Remarks

Please note this is called after CompositorPassProvider::addPassDef and similar to addPass you will need to dynamic_cast<>() to determine custom pass type.

Parameters

node	The AST node for this pass
customPassDef	The CompositorPassDef returned in CompositorPassProvider::addPassDef

Reimplemented from Ogre::CompositorPassProvider.

---

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

• OgreCompositorPassImguiProvider.h