The Nebula Device 3: Base::MultipleRenderTargetBase Class Reference

The Nebula Device 3

Base::MultipleRenderTargetBase Class Reference

#include <multiplerendertargetbase.h>

Inheritance diagram for Base::MultipleRenderTargetBase:

Core::RefCounted CoreGraphics::MultipleRenderTarget

Detailed Description

Base class for render targets. A render targets wraps up to 4 color buffers and an optional depth/stencil buffer into a C++ object. The special default render target represents the backbuffer and default depth/stencil surface.

(C) 2007 Radon Labs GmbH

Public Member Functions

 MultipleRenderTargetBase ()
 constructor
virtual ~MultipleRenderTargetBase ()
 destructor
void AddRenderTarget (const Ptr< CoreGraphics::RenderTarget > &rt)
 set rendertarget
const Ptr< CoreGraphics::RenderTarget > & GetRenderTarget (IndexT i) const
 get rendertarget at index
SizeT GetNumRendertargets () const
 getnumber of rendertargets used
void BeginPass ()
 begin rendering to the render target
void BeginBatch (CoreGraphics::BatchType::Code batchType)
 begin a batch
void EndBatch ()
 end current batch
void EndPass ()
 end current render pass
void SetClearColor (IndexT i, const Math::float4 &color)
 set clear color of rendertarget at index
void SetClearDepth (float d)
 set clear depth
float GetClearDepth () const
 get clear depth
void SetClearStencil (uchar s)
 set clear stencil value
uchar GetClearStencil () const
 get clear stencil value
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!)

Static Public Attributes

static const IndexT MaxNumRenderTargets = 4
 max number of rendertargets

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.