OGRE  1.10.12
Object-Oriented Graphics Rendering Engine
Ogre::RTShader::Program Class Reference

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

#include <OgreShaderProgram.h>

+ Inheritance 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...
 
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...
 
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...
 

Friends

class ProgramManager
 

Detailed Description

A class that represents a shader based program.

Member Function Documentation

◆ getType()

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

Get the type of this program.

◆ resolveAutoParameterReal() [1/2]

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.

Parameters
autoTypeThe auto type of the desired parameter.
dataThe data to associate with the auto parameter.
sizenumber of elements in the parameter. Return parameter instance in case of that resolve operation succeeded.

◆ resolveAutoParameterReal() [2/2]

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.

Parameters
autoTypeThe auto type of the desired parameter.
typeThe desired data type of the auto parameter.
dataThe data to associate with the auto parameter.
sizenumber of elements in the parameter. Return parameter instance in case of that resolve operation succeeded.

◆ resolveAutoParameterInt() [1/2]

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.

Parameters
autoTypeThe auto type of the desired parameter.
dataThe data to associate with the auto parameter.
sizenumber of elements in the parameter. Return parameter instance in case of that resolve operation succeeded.

◆ resolveAutoParameterInt() [2/2]

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.

Parameters
autoTypeThe auto type of the desired parameter.
typeThe desired data type of the auto parameter.
dataThe data to associate with the auto parameter.
sizenumber of elements in the parameter. Return parameter instance in case of that resolve operation succeeded.

◆ resolveParameter()

UniformParameterPtr Ogre::RTShader::Program::resolveParameter ( GpuConstantType  type,
int  index,
uint16  variability,
const String suggestedName,
size_t  size = 0 
)

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).
sizenumber of elements in the parameter. 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.

◆ getParameterByName()

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.

◆ getParameterByAutoType()

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.

◆ getParameterByType()

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.

◆ getParameters()

const UniformParameterList& Ogre::RTShader::Program::getParameters ( ) const
inline

Get the list of uniform parameters of this program.

◆ createFunction()

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.
functionType

◆ getFunctionByName()

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.

◆ getFunctions()

const ShaderFunctionList& Ogre::RTShader::Program::getFunctions ( ) const
inline

Get the function list of this program.

◆ setEntryPointFunction()

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.

◆ getEntryPointFunction()

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

Get the entry point function of this program.

◆ addDependency()

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.

◆ getDependencyCount()

size_t Ogre::RTShader::Program::getDependencyCount ( ) const

Get the number of external libs this program depends on.

◆ getDependency()

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.

◆ setSkeletalAnimationIncluded()

void Ogre::RTShader::Program::setSkeletalAnimationIncluded ( bool  value)
inline

Sets whether a vertex program includes the required instructions to perform skeletal animation.

◆ getSkeletalAnimationIncluded()

bool Ogre::RTShader::Program::getSkeletalAnimationIncluded ( ) const
inline

Returns whether a vertex program includes the required instructions to perform skeletal animation.

◆ setUseColumnMajorMatrices()

void Ogre::RTShader::Program::setUseColumnMajorMatrices ( bool  value)
inline

Tells Ogre whether auto-bound matrices should be sent in column or row-major order.

Remarks
This method has the same effect as column_major_matrices option used when declaring manually written hlsl program. You want to use this method only when you use float3x4 type in a shader, e.g. for bone matrices. In mentioned case you should call this method with false as parameter.
For more detail see OGRE Manual, section 3.1.6 DirectX9 HLSL.
Note
This setting has any effect only when the target language is HLSL.
Parameters
valueShould Ogre pass auto-bound matrices as column-major? The default is true.

◆ getUseColumnMajorMatrices()

bool Ogre::RTShader::Program::getUseColumnMajorMatrices ( ) const
inline

Returns whether Ogre will pass auto-bound matrices as column-major.

Returns
true, when the matrices will be passed in column-major order, false, when they will be passed as row-major.

Friends And Related Function Documentation

◆ ProgramManager

friend class ProgramManager
friend

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