The Nebula Device 3: Frame::FrameBatch Class Reference

The Nebula Device 3

Frame::FrameBatch Class Reference

#include <framebatch.h>

Inheritance diagram for Frame::FrameBatch:

Core::RefCounted


Detailed Description

A frame batch encapsulates the rendering of a batch of ModelNodeInstances.

(C) 2007 Radon Labs GmbH

Public Member Functions

 FrameBatch ()
 constructor
virtual ~FrameBatch ()
 destructor
void Discard ()
 discard the frame batch
void Render ()
 render the batch
void SetShader (const Ptr< CoreGraphics::ShaderInstance > &shd)
 set batch shader
const Ptr
< CoreGraphics::ShaderInstance > & 
GetShader () const
 get batch shader
void SetType (CoreGraphics::BatchType::Code t)
 set batch type
CoreGraphics::BatchType::Code GetType () const
 get batch type
void SetNodeFilter (Models::ModelNodeType::Code f)
 set model node filter
Models::ModelNodeType::Code GetNodeFilter () const
 get model node filter
void SetLightingMode (LightingMode::Code c)
 set lighting mode
LightingMode::Code GetLightingMode () const
 get lighting mode
void SetSortingMode (SortingMode::Code c)
 set sorting mode
SortingMode::Code GetSortingMode () const
 get sorting mode
void SetShaderFeatures (CoreGraphics::ShaderFeature::Mask m)
 set shader features
CoreGraphics::ShaderFeature::Mask GetShaderFeatures () const
 get shader features
void AddVariable (const Ptr< CoreGraphics::ShaderVariableInstance > &var)
 add a shader variable instance to the frame pass
SizeT GetNumVariables () const
 get number of shader variables
const Ptr
< CoreGraphics::ShaderVariableInstance > & 
GetVariableByIndex (IndexT i) const
 get shader variable by index
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.