Ignition Rendering

API Reference

4.1.0

Ogre implementation of the RenderPass class. More...

#include <OgreRenderPass.hh>

Public Member Functions

virtual ~OgreRenderPass ()
 Destructor. More...
 
virtual void CreateRenderPass ()
 Create the render pass using ogre compositor. More...
 
void Destroy () override
 Destroy any resources associated with this object. Invoking any other functions after destroying an object will result in undefined behavior. More...
 
virtual void SetCamera (Ogre::Camera *_camera)
 Set the ogre camera that the render pass applies to. More...
 
- Public Member Functions inherited from BaseRenderPass< OgreObject >
virtual ~BaseRenderPass ()
 Destructor. More...
 
virtual bool IsEnabled () const override
 Get whether or not the render pass is enabled. More...
 
virtual void SetEnabled (bool _enabled) override
 Set to enable or disable the render pass. More...
 
- Public Member Functions inherited from RenderPass
virtual ~RenderPass ()
 Destructor. More...
 
- Public Member Functions inherited from Object
virtual ~Object ()
 Destructor. More...
 
- Public Member Functions inherited from OgreObject
virtual ~OgreObject ()
 
virtual ScenePtr Scene () const
 Get the Scene that created this object. More...
 
- Public Member Functions inherited from BaseObject
virtual ~BaseObject ()
 
virtual unsigned int Id () const override
 Get the object ID. This ID will be unique across all objects inside a given scene, but necessarily true for objects across different scenes. More...
 
virtual std::string Name () const override
 Get the object name. This name will be unique across all objects inside a given scene, but necessarily true for objects across different scenes. More...
 
virtual void PostRender () override
 Post process this object and any of its children after rendering. More...
 
virtual void PreRender () override
 Prepare this object and any of its children for rendering. This should be called for each object in a scene just before rendering, which can be achieved by a single call to Scene::PreRender. More...
 
- Public Member Functions inherited from enable_shared_from_this< BaseObject >
enable_shared_from_this (T... args)
 
~enable_shared_from_this (T... args)
 
operator= (T... args)
 
shared_from_this (T... args)
 

Protected Member Functions

 OgreRenderPass ()
 Constructor. More...
 
- Protected Member Functions inherited from BaseRenderPass< OgreObject >
 BaseRenderPass ()
 Constructor. More...
 
- Protected Member Functions inherited from OgreObject
 OgreObject ()
 
- Protected Member Functions inherited from BaseObject
 BaseObject ()
 
virtual void Init ()
 
virtual void Load ()
 

Protected Attributes

Ogre::Camera * ogreCamera = nullptr
 Pointer to the ogre camera. More...
 
- Protected Attributes inherited from BaseRenderPass< OgreObject >
bool enabled
 Flag to indicate if render pass is enabled or not. More...
 
- Protected Attributes inherited from OgreObject
OgreScenePtr scene
 
- Protected Attributes inherited from BaseObject
unsigned int id
 
std::string name
 

Detailed Description

Ogre implementation of the RenderPass class.

Constructor & Destructor Documentation

◆ OgreRenderPass()

OgreRenderPass ( )
protected

Constructor.

◆ ~OgreRenderPass()

virtual ~OgreRenderPass ( )
virtual

Destructor.

Member Function Documentation

◆ CreateRenderPass()

virtual void CreateRenderPass ( )
virtual

Create the render pass using ogre compositor.

Reimplemented in OgreGaussianNoisePass.

◆ Destroy()

void Destroy ( )
overridevirtual

Destroy any resources associated with this object. Invoking any other functions after destroying an object will result in undefined behavior.

Reimplemented from BaseObject.

◆ SetCamera()

virtual void SetCamera ( Ogre::Camera *  _camera)
virtual

Set the ogre camera that the render pass applies to.

Parameters
[in]_cameraPointer to the ogre camera.

Member Data Documentation

◆ ogreCamera

Ogre::Camera* ogreCamera = nullptr
protected

Pointer to the ogre camera.


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