Ignition Rendering

API Reference

5.0.0
RenderPass Class Referenceabstract

A render pass can be added to a camera to affect how the scene is rendered. It can be used to add post-processing effects. Multiple passes can be chained together. More...

#include <ignition/rendering/RenderPass.hh>

Public Member Functions

virtual ~RenderPass ()
 Destructor. More...
 
virtual bool IsEnabled () const =0
 Get whether or not the render pass is enabled. More...
 
virtual void SetEnabled (bool _enabled)=0
 Set to enable or disable the render pass. More...
 
- Public Member Functions inherited from Object
virtual ~Object ()
 Destructor. More...
 
virtual void Destroy ()=0
 Destroy any resources associated with this object. Invoking any other functions after destroying an object will result in undefined behavior. 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...
 

Detailed Description

A render pass can be added to a camera to affect how the scene is rendered. It can be used to add post-processing effects. Multiple passes can be chained together.

Constructor & Destructor Documentation

◆ ~RenderPass()

virtual ~RenderPass ( )
inlinevirtual

Destructor.

References RenderPass::IsEnabled(), and RenderPass::SetEnabled().

Member Function Documentation

◆ IsEnabled()

virtual bool IsEnabled ( ) const
pure virtual

Get whether or not the render pass is enabled.

Returns
True if the render pass is enabled, false otherwise.

Implemented in BaseRenderPass< T >, BaseRenderPass< Ogre2Object >, and BaseRenderPass< OgreObject >.

Referenced by RenderPass::~RenderPass().

◆ SetEnabled()

virtual void SetEnabled ( bool  _enabled)
pure virtual

Set to enable or disable the render pass.

Parameters
[in]_enabledTrue to enable the render pass, false to disable.

Implemented in BaseRenderPass< T >, BaseRenderPass< Ogre2Object >, and BaseRenderPass< OgreObject >.

Referenced by RenderPass::~RenderPass().


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