RenderModules::RenderModule Class Reference

#include <rendermodule.h>

Detailed Description

A RenderModule wraps a specific, optional, rendering functionality into a simple object which only requires a simple setup.

For instance, setting up the debug render functionality in an application looks like this:

this->debugRenderModule = DebugRenderModule::Create(); this->debugRenderModule->Setup();

This will setup the required environment on the main-thread and render-thread side to implement debug rendering.

(C) 2009 Radon Labs GmbH (C) 2013-2018 Individual contributors, see AUTHORS file

Inherits Core::RefCounted.

Public Member Functions
	RenderModule ()
	constructor
virtual	~RenderModule ()
	destructor
virtual void	Setup ()
	setup the render module
virtual void	Discard ()
	discard the render module
bool	IsValid () const
	return true if the render module has been setup
virtual void	OnFrame ()
	called per-frame by Graphics::GraphicsServer
Public Member Functions inherited from Core::RefCounted
	RefCounted ()
	constructor
int	GetRefCount () const
	get the current refcount
void	AddRef ()
	increment refcount by one
void	Release ()
	decrement refcount and destroy object if refcount is zero
bool	IsInstanceOf (const Rtti &rtti) const
	return true if this object is instance of given class
bool	IsInstanceOf (const Util::String &className) const
	return true if this object is instance of given class by string
bool	IsInstanceOf (const Util::FourCC &classFourCC) const
	return true if this object is instance of given class by fourcc
bool	IsA (const Rtti &rtti) const
	return true if this object is instance of given class, or a derived class
bool	IsA (const Util::String &rttiName) const
	return true if this object is instance of given class, or a derived class, by string
bool	IsA (const Util::FourCC &rttiFourCC) const
	return true if this object is instance of given class, or a derived class, by fourcc
const Util::String &	GetClassName () const
	get the class name
Util::FourCC	GetClassFourCC () const
	get the class FourCC code

Private Member Functions
	__DeclareClass (RenderModule)

Private Attributes
bool	isValid

Additional Inherited Members
Static Public Member Functions inherited from Core::RefCounted
static void	DumpRefCountingLeaks ()
	dump refcounting leaks, call at end of application (NEBULA_DEBUG builds only!)
Protected Member Functions inherited from Core::RefCounted
virtual	~RefCounted ()
	destructor (called when refcount reaches zero)

Constructor & Destructor Documentation

RenderModule()

RenderModules::RenderModule::RenderModule

(

)

constructor

~RenderModule()

RenderModules::RenderModule::~RenderModule ( )

virtual

destructor

Member Function Documentation

__DeclareClass()

RenderModules::RenderModule::__DeclareClass ( RenderModule )

private

Discard()

void RenderModules::RenderModule::Discard ( )

virtual

discard the render module

IsValid()

bool RenderModules::RenderModule::IsValid ( ) const

inline

return true if the render module has been setup

OnFrame()

void RenderModules::RenderModule::OnFrame ( )

virtual

called per-frame by Graphics::GraphicsServer

Setup()

void RenderModules::RenderModule::Setup ( )

virtual

setup the render module

Member Data Documentation

isValid

bool RenderModules::RenderModule::isValid

private

---

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

• /github/workspace/code/render/rendermodules/rendermodule.h
• /github/workspace/code/render/rendermodules/rendermodule.cc