|  | OGRE 14.3
    Object-Oriented Graphics Rendering Engine | 
A class that represents a shader based program function. More...
#include <OgreShaderFunction.h>
 Inheritance diagram for Ogre::RTShader::Function:
 Inheritance diagram for Ogre::RTShader::Function:| Public Member Functions | |
| Function (GpuProgramType type=GPT_VERTEX_PROGRAM) | |
| void | addAtomInstance (FunctionAtom *atomInstance) | 
| Add a function atom instance to this function. | |
| void | addInputParameter (ParameterPtr parameter) | 
| Add input parameter to this function. | |
| void | addOutputParameter (ParameterPtr parameter) | 
| Add output parameter to this function. | |
| void | deleteAllInputParameters () | 
| Delete all input parameters from this function. | |
| void | deleteAllOutputParameters () | 
| Delete all output parameters from this function. | |
| bool | deleteAtomInstance (FunctionAtom *atomInstance) | 
| Delete a function atom instance from this function. | |
| void | deleteInputParameter (ParameterPtr parameter) | 
| Delete input parameter from this function. | |
| void | deleteOutputParameter (ParameterPtr parameter) | 
| Delete output parameter from this function. | |
| const FunctionAtomInstanceList & | getAtomInstances () | 
| Return list of atom instances composing this function. | |
| ParameterPtr | getInputParameter (Parameter::Content content, GpuConstantType type=GCT_UNKNOWN) | 
| get input parameter by content | |
| const ShaderParameterList & | getInputParameters () const | 
| Return a list of input parameters. | |
| ParameterPtr | getLocalParameter (const String &name) | 
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
| ParameterPtr | getLocalParameter (Parameter::Content content) | 
| get local parameter by content | |
| const ShaderParameterList & | getLocalParameters () const | 
| Return a list of local parameters. | |
| ParameterPtr | getOutputParameter (Parameter::Content content, GpuConstantType type=GCT_UNKNOWN) | 
| get output parameter by content | |
| const ShaderParameterList & | getOutputParameters () const | 
| Return a list of output parameters. | |
| FunctionStageRef | getStage (uint32 s) | 
| get a FFPShaderStage of this function | |
| ParameterPtr | resolveInputParameter (const ParameterPtr &out) | 
| resolve input parameter from previous output | |
| ParameterPtr | resolveInputParameter (Parameter::Content content, GpuConstantType type=GCT_UNKNOWN) | 
| Resolve input parameter of this function. | |
| ParameterPtr | resolveInputParameter (Parameter::Semantic semantic, int index, const Parameter::Content content, GpuConstantType type) | 
| ParameterPtr | resolveLocalParameter (GpuConstantType type, const String &name, size_t arraySize=0) | 
| Resolve local parameter of this function. | |
| ParameterPtr | resolveLocalParameter (Parameter::Content content, GpuConstantType type=GCT_UNKNOWN) | 
| Resolve local parameter of this function. | |
| ParameterPtr | resolveLocalStructParameter (const String &type, const String &name) | 
| ParameterPtr | resolveOutputParameter (Parameter::Content content, GpuConstantType type=GCT_UNKNOWN) | 
| Resolve output parameter of this function. | |
| ParameterPtr | resolveOutputParameter (Parameter::Semantic semantic, int index, const Parameter::Content content, GpuConstantType type) | 
A class that represents a shader based program function.
| 
 | explicit | 
References Function(), and Ogre::GPT_VERTEX_PROGRAM.
Referenced by Function().
| ParameterPtr Ogre::RTShader::Function::resolveInputParameter | ( | Parameter::Semantic | semantic, | 
| int | index, | ||
| const Parameter::Content | content, | ||
| GpuConstantType | type ) | 
Referenced by resolveInputParameter(), and resolveInputParameter().
| 
 | inline | 
Resolve input parameter of this function.
| content | The content of the parameter. | 
| type | The type of the desired parameter. | 
References Ogre::GCT_UNKNOWN, resolveInputParameter(), and Ogre::RTShader::Parameter::SPS_UNKNOWN.
| 
 | inline | 
resolve input parameter from previous output
References OgreAssert, and resolveInputParameter().
| 
 | inline | 
get input parameter by content
| content | |
| type | The type of the desired parameter. | 
References Ogre::GCT_UNKNOWN.
| ParameterPtr Ogre::RTShader::Function::resolveOutputParameter | ( | Parameter::Semantic | semantic, | 
| int | index, | ||
| const Parameter::Content | content, | ||
| GpuConstantType | type ) | 
Referenced by resolveOutputParameter().
| 
 | inline | 
Resolve output parameter of this function.
| content | The content of the parameter. | 
| type | The type of the desired parameter. | 
References Ogre::GCT_UNKNOWN, resolveOutputParameter(), and Ogre::RTShader::Parameter::SPS_UNKNOWN.
| 
 | inline | 
get output parameter by content
| content | |
| type | The type of the desired parameter. | 
References Ogre::GCT_UNKNOWN.
| ParameterPtr Ogre::RTShader::Function::resolveLocalParameter | ( | GpuConstantType | type, | 
| const String & | name, | ||
| size_t | arraySize = 0 ) | 
Resolve local parameter of this function.
local parameters do not have index or semantic.
| name | The name of the parameter. | 
| type | The type of the desired parameter. | 
| arraySize | If > 0, the parameter will be an array of the given size. | 
| ParameterPtr Ogre::RTShader::Function::resolveLocalParameter | ( | Parameter::Content | content, | 
| GpuConstantType | type = GCT_UNKNOWN ) | 
Resolve local parameter of this function.
local parameters do not have index or semantic.
| content | The content of the parameter. | 
| type | The type of the desired parameter. | 
References Ogre::GCT_UNKNOWN.
| ParameterPtr Ogre::RTShader::Function::resolveLocalStructParameter | ( | const String & | type, | 
| const String & | name ) | 
| 
 | inline | 
get local parameter by content
| content | 
References Ogre::GCT_UNKNOWN.
| 
 | inline | 
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
| 
 | inline | 
Return a list of input parameters.
| 
 | inline | 
Return a list of output parameters.
| 
 | inline | 
Return a list of local parameters.
| void Ogre::RTShader::Function::addAtomInstance | ( | FunctionAtom * | atomInstance | ) | 
Add a function atom instance to this function.
| atomInstance | The atom instance to add. | 
| 
 | inline | 
get a FFPShaderStage of this function
| bool Ogre::RTShader::Function::deleteAtomInstance | ( | FunctionAtom * | atomInstance | ) | 
Delete a function atom instance from this function.
| atomInstance | The atom instance to OGRE_DELETE. | 
| const FunctionAtomInstanceList & Ogre::RTShader::Function::getAtomInstances | ( | ) | 
Return list of atom instances composing this function.
(Const version)
| void Ogre::RTShader::Function::addInputParameter | ( | ParameterPtr | parameter | ) | 
Add input parameter to this function.
| void Ogre::RTShader::Function::addOutputParameter | ( | ParameterPtr | parameter | ) | 
Add output parameter to this function.
| void Ogre::RTShader::Function::deleteInputParameter | ( | ParameterPtr | parameter | ) | 
Delete input parameter from this function.
| void Ogre::RTShader::Function::deleteOutputParameter | ( | ParameterPtr | parameter | ) | 
Delete output parameter from this function.
| void Ogre::RTShader::Function::deleteAllInputParameters | ( | ) | 
Delete all input parameters from this function.
| void Ogre::RTShader::Function::deleteAllOutputParameters | ( | ) | 
Delete all output parameters from this function.