OgreRenderPass Class Reference
Ogre implementation of the RenderPass class. More...
#include <OgreRenderPass.hh>
Public Member Functions | |
virtual | ~OgreRenderPass () |
Destructor. | |
virtual void | CreateRenderPass () |
Create the render pass using ogre compositor. | |
void | Destroy () override |
Destroy any resources associated with this object. Invoking any other functions after destroying an object will result in undefined behavior. | |
virtual void | SetCamera (Ogre::Camera *_camera) |
Set the ogre camera that the render pass applies to. | |
virtual void | SetCameras (Ogre::Camera *_cameras[kMaxOgreRenderPassCameras]) |
Set all ogre cameras that the render pass applies to at once. | |
![]() | |
virtual | ~BaseRenderPass () |
Destructor. | |
virtual bool | IsEnabled () const override |
Get whether or not the render pass is enabled. | |
virtual 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. | |
virtual void | SetEnabled (bool _enabled) override |
Set to enable or disable the render pass. | |
void | SetWideAngleCameraAfterStitching (bool _afterStitching) override |
WideAngleCamera renders to 6 faces; then stitches all 6 into a final "fish-eye" lens result. | |
bool | WideAngleCameraAfterStitching () const override |
See SetWideAngleCameraAfterStitching() | |
![]() | |
virtual | ~RenderPass () |
Destructor. | |
![]() | |
virtual | ~Object () |
Destructor. | |
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. | |
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. | |
virtual void | PostRender ()=0 |
Post process this object and any of its children after rendering. | |
virtual ScenePtr | Scene () const =0 |
Get the Scene that created this object. | |
![]() | |
virtual | ~OgreObject () |
virtual ScenePtr | Scene () const |
![]() | |
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. | |
![]() | |
BaseRenderPass () | |
Constructor. | |
![]() | |
OgreObject () | |
![]() | |
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. | |
![]() | |
bool | afterStitching |
Flag tracking the current value of SetWideAngleCameraAfterStitching() | |
bool | enabled |
Flag to indicate if render pass is enabled or not. | |
![]() | |
OgreScenePtr | scene |
![]() | |
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 OgreDistortionPass, OgreGaussianNoisePass, and OgreLensFlarePass.
◆ Destroy()
|
overridevirtual |
Destroy any resources associated with this object. Invoking any other functions after destroying an object will result in undefined behavior.
Implements Object.
◆ 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: