The Nebula Device 3: CoreGraphics::ShaderVariableInstance Class Reference

The Nebula Device 3

CoreGraphics::ShaderVariableInstance Class Reference

#include <shadervariableinstance.h>

Inheritance diagram for CoreGraphics::ShaderVariableInstance:

Base::ShaderVariableInstanceBase Core::RefCounted

Detailed Description

A ShaderVariableInstance associates a value with a ShaderVariable and can apply that value at any time to the ShaderVariable. Setting the value on a ShaderVariableInstance will just store the value but not change the actual ShaderVariable. Only calling Apply() will set the stored value on the ShaderVariable. ShaderVariableInstance objects are used to manage per-instance state when rendering ModelNodeInstances.

(C) 2007 Radon Labs GmbH

Public Member Functions

void Setup (const Ptr< CoreGraphics::ShaderVariable > &var)
 setup the object from a shader variable
void Prepare (CoreGraphics::ShaderVariable::Type type)
 prepare the object for late-binding
void Bind (const Ptr< CoreGraphics::ShaderVariable > &var)
 late-bind the variable instance to a shader variable
const Ptr< CoreGraphics::ShaderVariable > & GetShaderVariable () const
 get the associated shader variable
void Apply ()
 apply local value to shader variable
void SetInt (int value)
 set int value
void SetFloat (float value)
 set float value
void SetFloat4 (const Math::float4 &value)
 set float4 value
void SetMatrix (const Math::matrix44 &value)
 set matrix44 value
void SetBool (bool value)
 set bool value
void SetTexture (const Ptr< CoreGraphics::Texture > &value)
 set texture value
void SetValue (const Util::Variant &v)
 set value directly
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

void Base::ShaderVariableInstanceBase::Apply (  )  [inherited]

apply local value to shader variable

Todo:
: hmm, the dynamic type switch is sort of lame...

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.