The Nebula Device 3: Base::ShaderVariableBase Class Reference

The Nebula Device 3

Base::ShaderVariableBase Class Reference

#include <shadervariablebase.h>

Inheritance diagram for Base::ShaderVariableBase:

Core::RefCounted Direct3D9::D3D9ShaderVariable CoreGraphics::ShaderVariable


Detailed Description

Provides direct access to a shader's global variable. The fastest way to change the value of a shader variable is to obtain a pointer to a shader variable once, and use it repeatedly to set new values.

(C) 2006 Radon Labs GmbH

Public Types

enum  Type
 shader variable types
typedef Util::Atom
< Util::String
Name
 shader variable name typedef
typedef Util::Atom
< Util::String
Semantic
 shader variable semantic typedef

Public Member Functions

 ShaderVariableBase ()
 constructor
virtual ~ShaderVariableBase ()
 destructor
Ptr
< CoreGraphics::ShaderVariableInstance
CreateInstance ()
 create a shader variable instance
Type GetType () const
 get the data type of the variable
const NameGetName () const
 get the name of the variable
const SemanticGetSemantic () const
 get the semantics of the variable
SizeT GetNumArrayElements () const
 number of array elements if this is an array variable
bool IsArray () const
 return true if this is an array
void SetInt (int value)
 set int value
void SetIntArray (const int *values, SizeT count)
 set int array values
void SetFloat (float value)
 set float value
void SetFloatArray (const float *values, SizeT count)
 set float array values
void SetVector (const Math::float4 &value)
 set vector value
void SetVectorArray (const Math::float4 *values, SizeT count)
 set vector array values
void SetMatrix (const Math::matrix44 &value)
 set matrix value
void SetMatrixArray (const Math::matrix44 *values, SizeT count)
 set matrix array values
void SetBool (bool value)
 set bool value
void SetBoolArray (const bool *values, SizeT count)
 set bool array values
void SetTexture (const Ptr< CoreGraphics::Texture > &value)
 set texture 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 Util::String TypeToString (Type t)
 convert type to string
static void DumpRefCountingLeaks ()
 dump refcounting leaks, call at end of application (NEBULA3_DEBUG builds only!)

Protected Member Functions

void SetType (Type t)
 set variable type
void SetName (const Name &n)
 set variable name
void SetSemantic (const Semantic &s)
 set variable semantic
void SetNumArrayElements (SizeT n)
 set number of array elements

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.