OGRE  1.7
Object-Oriented Graphics Rendering Engine
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Ogre::RTShader::Program Class Reference

A class that represents a shader based program. More...

#include <OgreShaderProgram.h>

+ Inheritance diagram for Ogre::RTShader::Program:
+ Collaboration diagram for Ogre::RTShader::Program:

Public Member Functions

void addDependency (const String &libFileName)
 Add dependency for this program. More...
 
FunctioncreateFunction (const String &name, const String &desc, const Function::FunctionType functionType)
 Create new function in this program. More...
 
const StringgetDependency (unsigned int index) const
 Get the library name of the given index dependency. More...
 
size_t getDependencyCount () const
 Get the number of external libs this program depends on. More...
 
FunctiongetEntryPointFunction ()
 Get the entry point function of this program. More...
 
FunctiongetFunctionByName (const String &name)
 Get a function by a given name. More...
 
const ShaderFunctionListgetFunctions () const
 Get the function list of this program. More...
 
UniformParameterPtr getParameterByAutoType (GpuProgramParameters::AutoConstantType autoType)
 Get parameter by a given auto constant type. More...
 
UniformParameterPtr getParameterByName (const String &name)
 Get parameter by a given name. More...
 
UniformParameterPtr getParameterByType (GpuConstantType type, int index)
 Get parameter by a given type and index. More...
 
const UniformParameterListgetParameters () const
 Get the list of uniform parameters of this program. More...
 
GpuProgramType getType () const
 Get the type of this program. More...
 
void operator delete (void *ptr)
 
void operator delete (void *ptr, void *)
 
void operator delete (void *ptr, const char *, int, const char *)
 
void operator delete[] (void *ptr)
 
void operator delete[] (void *ptr, const char *, int, const char *)
 
void * operator new (size_t sz, const char *file, int line, const char *func)
 operator new, with debug line info More...
 
void * operator new (size_t sz)
 
void * operator new (size_t sz, void *ptr)
 placement operator new More...
 
void * operator new[] (size_t sz, const char *file, int line, const char *func)
 array operator new, with debug line info More...
 
void * operator new[] (size_t sz)
 
UniformParameterPtr resolveAutoParameterInt (GpuProgramParameters::AutoConstantType autoType, size_t data)
 Resolve uniform auto constant parameter with associated int data of this program. More...
 
UniformParameterPtr resolveAutoParameterReal (GpuProgramParameters::AutoConstantType autoType, Real data)
 Resolve uniform auto constant parameter with associated real data of this program. More...
 
UniformParameterPtr resolveParameter (GpuConstantType type, int index, uint16 variability, const String &suggestedName)
 Resolve uniform parameter of this program. More...
 
void setEntryPointFunction (Function *function)
 Set the entry point function. More...
 

Protected Member Functions

 Program (GpuProgramType type)
 Class constructor. More...
 
 ~Program ()
 Class destructor. More...
 
void addParameter (UniformParameterPtr parameter)
 Add parameter to this program. More...
 
void destroyFunctions ()
 Destroy all functions of this program. More...
 
void destroyParameters ()
 Destroy all parameters of this program. More...
 
void removeParameter (UniformParameterPtr parameter)
 Remove parameter from this program. More...
 

Protected Attributes

StringVector mDependencies
 
FunctionmEntryPointFunction
 
ShaderFunctionList mFunctions
 
UniformParameterList mParameters
 
GpuProgramType mType
 

Friends

class ProgramManager
 

Detailed Description

A class that represents a shader based program.

Definition at line 50 of file OgreShaderProgram.h.

Constructor & Destructor Documentation

Ogre::RTShader::Program::Program ( GpuProgramType  type)
protected

Class constructor.

Parameters
typeThe type of this program.
Ogre::RTShader::Program::~Program ( )
protected

Class destructor.

Member Function Documentation

void Ogre::RTShader::Program::addDependency ( const String libFileName)

Add dependency for this program.

Basically a filename that will be included in this program and provide predefined shader functions code. One should verify that the given library file he provides can be reached by the resource manager. This step can be achieved using the ResourceGroupManager::addResourceLocation method.

void Ogre::RTShader::Program::addParameter ( UniformParameterPtr  parameter)
protected

Add parameter to this program.

Function* Ogre::RTShader::Program::createFunction ( const String name,
const String desc,
const Function::FunctionType  functionType 
)

Create new function in this program.

Return the newly created function instance.

Parameters
nameThe name of the function to create.
descThe description of the function.
void Ogre::RTShader::Program::destroyFunctions ( )
protected

Destroy all functions of this program.

void Ogre::RTShader::Program::destroyParameters ( )
protected

Destroy all parameters of this program.

const String& Ogre::RTShader::Program::getDependency ( unsigned int  index) const

Get the library name of the given index dependency.

Parameters
indexThe index of the dependecy.
size_t Ogre::RTShader::Program::getDependencyCount ( ) const

Get the number of external libs this program depends on.

Function* Ogre::RTShader::Program::getEntryPointFunction ( )
inline

Get the entry point function of this program.

Definition at line 126 of file OgreShaderProgram.h.

Function* Ogre::RTShader::Program::getFunctionByName ( const String name)

Get a function by a given name.

Return NULL if no matching function found.

Parameters
nameThe name of the function to search for.
const ShaderFunctionList& Ogre::RTShader::Program::getFunctions ( ) const
inline

Get the function list of this program.

Definition at line 118 of file OgreShaderProgram.h.

UniformParameterPtr Ogre::RTShader::Program::getParameterByAutoType ( GpuProgramParameters::AutoConstantType  autoType)

Get parameter by a given auto constant type.

Parameters
autoTypeThe auto type of the parameter to search for.
Remarks
Return NULL if no matching parameter found.
UniformParameterPtr Ogre::RTShader::Program::getParameterByName ( const String name)

Get parameter by a given name.

Parameters
nameThe name of the parameter to search for.
Remarks
Return NULL if no matching parameter found.
UniformParameterPtr Ogre::RTShader::Program::getParameterByType ( GpuConstantType  type,
int  index 
)

Get parameter by a given type and index.

Parameters
typeThe type of the parameter to search for.
indexThe index of the parameter to search for.
Remarks
Return NULL if no matching parameter found.
const UniformParameterList& Ogre::RTShader::Program::getParameters ( ) const
inline

Get the list of uniform parameters of this program.

Definition at line 103 of file OgreShaderProgram.h.

GpuProgramType Ogre::RTShader::Program::getType ( ) const

Get the type of this program.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr)
inlineinherited

Definition at line 95 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr,
void *   
)
inlineinherited

Definition at line 101 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr,
const char *  ,
int  ,
const char *   
)
inlineinherited

Definition at line 107 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete[] ( void *  ptr)
inlineinherited

Definition at line 112 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete[] ( void *  ptr,
const char *  ,
int  ,
const char *   
)
inlineinherited

Definition at line 118 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz,
const char *  file,
int  line,
const char *  func 
)
inlineinherited

operator new, with debug line info

Definition at line 67 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz)
inlineinherited

Definition at line 72 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz,
void *  ptr 
)
inlineinherited

placement operator new

Definition at line 78 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new[] ( size_t  sz,
const char *  file,
int  line,
const char *  func 
)
inlineinherited

array operator new, with debug line info

Definition at line 85 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new[] ( size_t  sz)
inlineinherited

Definition at line 90 of file OgreMemoryAllocatedObject.h.

void Ogre::RTShader::Program::removeParameter ( UniformParameterPtr  parameter)
protected

Remove parameter from this program.

UniformParameterPtr Ogre::RTShader::Program::resolveAutoParameterInt ( GpuProgramParameters::AutoConstantType  autoType,
size_t  data 
)

Resolve uniform auto constant parameter with associated int data of this program.

Parameters
autoTypeThe auto type of the desired parameter.
dataThe data to associate with the auto parameter. Return parameter instance in case of that resolve operation succeeded.
UniformParameterPtr Ogre::RTShader::Program::resolveAutoParameterReal ( GpuProgramParameters::AutoConstantType  autoType,
Real  data 
)

Resolve uniform auto constant parameter with associated real data of this program.

Parameters
autoTypeThe auto type of the desired parameter.
dataThe data to associate with the auto parameter. Return parameter instance in case of that resolve operation succeeded.
UniformParameterPtr Ogre::RTShader::Program::resolveParameter ( GpuConstantType  type,
int  index,
uint16  variability,
const String suggestedName 
)

Resolve uniform parameter of this program.

Parameters
typeThe type of the desired parameter.
indexThe index of the desired parameter.
suggestedNameThe suggested name for the parameter in case new one should be create.
variabilityHow this parameter varies (bitwise combination of GpuProgramVariability). Return parameter instance in case of that resolve operation succeeded.
Remarks
Pass -1 as index parameter to create a new parameter with the desired type and index.
void Ogre::RTShader::Program::setEntryPointFunction ( Function function)
inline

Set the entry point function.

Parameters
functionThe function that will use as entry point of this program.

Definition at line 123 of file OgreShaderProgram.h.

Friends And Related Function Documentation

friend class ProgramManager
friend

Definition at line 177 of file OgreShaderProgram.h.

Member Data Documentation

StringVector Ogre::RTShader::Program::mDependencies
protected

Definition at line 174 of file OgreShaderProgram.h.

Function* Ogre::RTShader::Program::mEntryPointFunction
protected

Definition at line 173 of file OgreShaderProgram.h.

ShaderFunctionList Ogre::RTShader::Program::mFunctions
protected

Definition at line 172 of file OgreShaderProgram.h.

UniformParameterList Ogre::RTShader::Program::mParameters
protected

Definition at line 171 of file OgreShaderProgram.h.

GpuProgramType Ogre::RTShader::Program::mType
protected

Definition at line 170 of file OgreShaderProgram.h.


The documentation for this class was generated from the following file: