The Nebula Device 3: RenderModules::RenderModule Class Reference

The Nebula Device 3

RenderModules::RenderModule Class Reference

#include <rendermodule.h>

Inheritance diagram for RenderModules::RenderModule:

Core::RefCounted

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

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
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::StringGetClassName () const
 get the class name
Util::FourCC GetClassFourCC () const
 get the class FourCC code

Static Public Member Functions

static void DumpRefCountingLeaks ()
 dump refcounting leaks, call at end of application (NEBULA3_DEBUG builds only!)

Member Function Documentation

int Core::RefCounted::GetRefCount (  )  const [inline, inherited]

get the current refcount

Return the current refcount of the object.

void Core::RefCounted::AddRef (  )  [inline, inherited]

increment refcount by one

Increment the refcount of the object.

void Core::RefCounted::Release (  )  [inline, inherited]

decrement refcount and destroy object if refcount is zero

Decrement the refcount and destroy object if refcount is zero.

const Util::String & Core::RefCounted::GetClassName (  )  const [inline, inherited]

get the class name

Get the class name of the object.

Util::FourCC Core::RefCounted::GetClassFourCC (  )  const [inline, inherited]

get the class FourCC code

Get the class FourCC of the object.

void Core::RefCounted::DumpRefCountingLeaks (  )  [static, inherited]

dump refcounting leaks, call at end of application (NEBULA3_DEBUG builds only!)

This method should be called as the very last before an application exits.