A class that represents a shader based program. More...
#include <OgreShaderProgram.h>
Public Member Functions | |
void | addDependency (const String &libFileName) |
Add dependency for this program. More... | |
Function * | createFunction (const String &name, const String &desc, const Function::FunctionType functionType) |
Create new function in this program. More... | |
const String & | getDependency (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... | |
Function * | getEntryPointFunction () |
Get the entry point function of this program. More... | |
Function * | getFunctionByName (const String &name) |
Get a function by a given name. More... | |
const ShaderFunctionList & | getFunctions () 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 UniformParameterList & | getParameters () const |
Get the list of uniform parameters of this program. More... | |
bool | getSkeletalAnimationIncluded () const |
Returns whether a vertex program includes the required instructions to perform skeletal animation. More... | |
GpuProgramType | getType () const |
Get the type of this program. More... | |
bool | getUseColumnMajorMatrices () const |
Returns whether Ogre will pass auto-bound matrices as column-major. 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, size_t size=0) |
Resolve uniform auto constant parameter with associated int data of this program. More... | |
UniformParameterPtr | resolveAutoParameterInt (GpuProgramParameters::AutoConstantType autoType, GpuConstantType type, size_t data, size_t size=0) |
Resolve uniform auto constant parameter with associated int data of this program. More... | |
UniformParameterPtr | resolveAutoParameterReal (GpuProgramParameters::AutoConstantType autoType, Real data, size_t size=0) |
Resolve uniform auto constant parameter with associated real data of this program. More... | |
UniformParameterPtr | resolveAutoParameterReal (GpuProgramParameters::AutoConstantType autoType, GpuConstantType type, Real data, size_t size=0) |
Resolve uniform auto constant parameter with associated real data of this program. More... | |
UniformParameterPtr | resolveParameter (GpuConstantType type, int index, uint16 variability, const String &suggestedName, size_t size=0) |
Resolve uniform parameter of this program. More... | |
void | setEntryPointFunction (Function *function) |
Set the entry point function. More... | |
void | setSkeletalAnimationIncluded (bool value) |
Sets whether a vertex program includes the required instructions to perform skeletal animation. More... | |
void | setUseColumnMajorMatrices (bool value) |
Tells Ogre whether auto-bound matrices should be sent in column or row-major order. 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 | |
bool | mColumnMajorMatrices |
StringVector | mDependencies |
Function * | mEntryPointFunction |
ShaderFunctionList | mFunctions |
UniformParameterList | mParameters |
bool | mSkeletalAnimation |
GpuProgramType | mType |
Friends | |
class | ProgramManager |
A class that represents a shader based program.
Definition at line 50 of file OgreShaderProgram.h.
|
protected |
Class constructor.
type | The type of this program. |
|
protected |
Class destructor.
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.
|
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.
name | The name of the function to create. |
desc | The description of the function. |
|
protected |
Destroy all functions of this program.
|
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.
index | The index of the dependecy. |
size_t Ogre::RTShader::Program::getDependencyCount | ( | ) | const |
Get the number of external libs this program depends on.
|
inline |
Get the entry point function of this program.
Definition at line 147 of file OgreShaderProgram.h.
Get a function by a given name.
Return NULL if no matching function found.
name | The name of the function to search for. |
|
inline |
Get the function list of this program.
Definition at line 139 of file OgreShaderProgram.h.
UniformParameterPtr Ogre::RTShader::Program::getParameterByAutoType | ( | GpuProgramParameters::AutoConstantType | autoType | ) |
Get parameter by a given auto constant type.
autoType | The auto type of the parameter to search for. |
UniformParameterPtr Ogre::RTShader::Program::getParameterByName | ( | const String & | name | ) |
Get parameter by a given name.
name | The name of the parameter to search for. |
UniformParameterPtr Ogre::RTShader::Program::getParameterByType | ( | GpuConstantType | type, |
int | index | ||
) |
Get parameter by a given type and index.
type | The type of the parameter to search for. |
index | The index of the parameter to search for. |
|
inline |
Get the list of uniform parameters of this program.
Definition at line 124 of file OgreShaderProgram.h.
|
inline |
Returns whether a vertex program includes the required instructions to perform skeletal animation.
Definition at line 173 of file OgreShaderProgram.h.
GpuProgramType Ogre::RTShader::Program::getType | ( | ) | const |
Get the type of this program.
|
inline |
Returns whether Ogre will pass auto-bound matrices as column-major.
Definition at line 192 of file OgreShaderProgram.h.
|
inlineinherited |
Definition at line 96 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 102 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 108 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 113 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 119 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
operator new, with debug line info
Definition at line 68 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 73 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
placement operator new
Definition at line 79 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
array operator new, with debug line info
Definition at line 86 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 91 of file OgreMemoryAllocatedObject.h.
|
protected |
Remove parameter from this program.
UniformParameterPtr Ogre::RTShader::Program::resolveAutoParameterInt | ( | GpuProgramParameters::AutoConstantType | autoType, |
size_t | data, | ||
size_t | size = 0 |
||
) |
Resolve uniform auto constant parameter with associated int data of this program.
autoType | The auto type of the desired parameter. |
data | The data to associate with the auto parameter. |
size | number of elements in the parameter. Return parameter instance in case of that resolve operation succeeded. |
UniformParameterPtr Ogre::RTShader::Program::resolveAutoParameterInt | ( | GpuProgramParameters::AutoConstantType | autoType, |
GpuConstantType | type, | ||
size_t | data, | ||
size_t | size = 0 |
||
) |
Resolve uniform auto constant parameter with associated int data of this program.
autoType | The auto type of the desired parameter. |
type | The desired data type of the auto parameter. |
data | The data to associate with the auto parameter. |
size | number of elements in the parameter. Return parameter instance in case of that resolve operation succeeded. |
UniformParameterPtr Ogre::RTShader::Program::resolveAutoParameterReal | ( | GpuProgramParameters::AutoConstantType | autoType, |
Real | data, | ||
size_t | size = 0 |
||
) |
Resolve uniform auto constant parameter with associated real data of this program.
autoType | The auto type of the desired parameter. |
data | The data to associate with the auto parameter. |
size | number of elements in the parameter. Return parameter instance in case of that resolve operation succeeded. |
UniformParameterPtr Ogre::RTShader::Program::resolveAutoParameterReal | ( | GpuProgramParameters::AutoConstantType | autoType, |
GpuConstantType | type, | ||
Real | data, | ||
size_t | size = 0 |
||
) |
Resolve uniform auto constant parameter with associated real data of this program.
autoType | The auto type of the desired parameter. |
type | The desired data type of the auto parameter. |
data | The data to associate with the auto parameter. |
size | number of elements in the 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, | ||
size_t | size = 0 |
||
) |
Resolve uniform parameter of this program.
type | The type of the desired parameter. |
index | The index of the desired parameter. |
suggestedName | The suggested name for the parameter in case new one should be create. |
variability | How this parameter varies (bitwise combination of GpuProgramVariability). |
size | number of elements in the parameter. Return parameter instance in case of that resolve operation succeeded. |
|
inline |
Set the entry point function.
function | The function that will use as entry point of this program. |
Definition at line 144 of file OgreShaderProgram.h.
|
inline |
Sets whether a vertex program includes the required instructions to perform skeletal animation.
Definition at line 168 of file OgreShaderProgram.h.
|
inline |
Tells Ogre whether auto-bound matrices should be sent in column or row-major order.
value | Should Ogre pass auto-bound matrices as column-major? The default is true. |
Definition at line 186 of file OgreShaderProgram.h.
|
friend |
Definition at line 235 of file OgreShaderProgram.h.
|
protected |
Definition at line 233 of file OgreShaderProgram.h.
|
protected |
Definition at line 229 of file OgreShaderProgram.h.
|
protected |
Definition at line 227 of file OgreShaderProgram.h.
|
protected |
Definition at line 225 of file OgreShaderProgram.h.
|
protected |
Definition at line 223 of file OgreShaderProgram.h.
|
protected |
Definition at line 231 of file OgreShaderProgram.h.
|
protected |
Definition at line 221 of file OgreShaderProgram.h.