BaseRenderPass< T > Class Template Reference

Base render pass that can be applied to a render target. More...

#include <BaseRenderPass.hh>

Public Member Functions
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...
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...

Protected Member Functions
	BaseRenderPass ()
	Constructor. More...

Protected Attributes
bool	enabled = true
	Flag to indicate if render pass is enabled or not. More...

Detailed Description

template<class T>
class ignition::rendering::BaseRenderPass< T >

Base render pass that can be applied to a render target.

Constructor & Destructor Documentation

BaseRenderPass()

BaseRenderPass

protected

Constructor.

~BaseRenderPass()

~BaseRenderPass

virtual

Destructor.

Member Function Documentation

IsEnabled()

bool IsEnabled ( ) const

overridevirtual

Get whether or not the render pass is enabled.

Returns

True if the render pass is enabled, false otherwise.

Implements RenderPass.

SetEnabled()

void SetEnabled ( bool  _enabled )

overridevirtual

Set to enable or disable the render pass.

Parameters

[in]

_enabled

True to enable the render pass, false to disable.

Implements RenderPass.

Member Data Documentation

enabled

bool enabled = true

protected

Flag to indicate if render pass is enabled or not.

---

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

• gz/rendering/base/BaseRenderPass.hh