OgreRenderPass Class Reference
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 |
| virtual void | SetCamera (Ogre::Camera *_camera) |
| Set the ogre camera that the render pass applies to. More... | |
| virtual void | SetCameras (Ogre::Camera *_cameras[kMaxOgreRenderPassCameras]) |
| Set all ogre cameras that the render pass applies to at once. 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... | |
| void | PreRender (const CameraPtr &_camera) override |
| See Object::PreRender. This function will call Object::PreRender but with the added bonus that it has access to the camera that is about to render. More... | |
| virtual void | SetEnabled (bool _enabled) override |
| Set to enable or disable the render pass. More... | |
| void | SetWideAngleCameraAfterStitching (bool _afterStitching) override |
| WideAngleCamera renders to 6 faces; then stitches all 6 into a final "fish-eye" lens result. More... | |
| bool | WideAngleCameraAfterStitching () const override |
| See SetWideAngleCameraAfterStitching() More... | |
| Public Member Functions inherited from RenderPass | |
| virtual | ~RenderPass () |
| Destructor. More... | |
| Public Member Functions inherited from Object | |
| virtual | ~Object () |
| Destructor. More... | |
| virtual unsigned int | Id () const =0 |
| 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 =0 |
| 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 ()=0 |
| Post process this object and any of its children after rendering. More... | |
| virtual void | PreRender ()=0 |
| 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... | |
| virtual ScenePtr | Scene () const =0 |
| Get the Scene that created this object. More... | |
| Public Member Functions inherited from OgreObject | |
| virtual | ~OgreObject () |
| virtual ScenePtr | Scene () const |
| Public Member Functions inherited from BaseObject | |
| virtual | ~BaseObject () |
| virtual unsigned int | Id () const override |
| virtual std::string | Name () const override |
| virtual void | PostRender () override |
| virtual void | PreRender () override |
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 [kMaxOgreRenderPassCameras] = {} |
| Pointer to the ogre camera May have more than one. Must check for nullptr on all of them. Not all RenderPasses support multiple cameras. More... | |
| Protected Attributes inherited from BaseRenderPass< OgreObject > | |
| bool | afterStitching |
| Flag tracking the current value of SetWideAngleCameraAfterStitching() More... | |
| 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()
|
protected |
Constructor.
◆ ~OgreRenderPass()
|
virtual |
Destructor.
Member Function Documentation
◆ CreateRenderPass()
|
virtual |
Create the render pass using ogre compositor.
Reimplemented in OgreLensFlarePass, OgreGaussianNoisePass, and OgreDistortionPass.
◆ Destroy()
|
overridevirtual |
Reimplemented from BaseObject.
◆ SetCamera()
|
virtual |
Set the ogre camera that the render pass applies to.
- Parameters
-
[in] _camera Pointer to the ogre camera.
◆ SetCameras()
|
virtual |
Set all ogre cameras that the render pass applies to at once.
- Parameters
-
[in] _cameras Pointer to the ogre cameras.
Member Data Documentation
◆ ogreCamera
|
protected |
Pointer to the ogre camera May have more than one. Must check for nullptr on all of them. Not all RenderPasses support multiple cameras.
The documentation for this class was generated from the following file: