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.
Function *	createFunction (const String &name, const String &desc, const Function::FunctionType functionType)
	Create new function in this program.
const String &	getDependency (unsigned int index) const
	Get the library name of the given index dependency.
size_t	getDependencyCount () const
	Get the number of external libs this program depends on.
Function *	getEntryPointFunction ()
	Get the entry point function of this program.
Function *	getFunctionByName (const String &name)
	Get a function by a given name.
const ShaderFunctionList &	getFunctions () const
	Get the function list of this program.
UniformParameterPtr	getParameterByAutoType (GpuProgramParameters::AutoConstantType autoType)
	Get parameter by a given auto constant type.
UniformParameterPtr	getParameterByName (const String &name)
	Get parameter by a given name.
UniformParameterPtr	getParameterByType (GpuConstantType type, int index)
	Get parameter by a given type and index.
const UniformParameterList &	getParameters () const
	Get the list of uniform parameters of this program.
bool	getSkeletalAnimationIncluded () const
	Returns whether a vertex program includes the required instructions to perform skeletal animation.
GpuProgramType	getType () const
	Get the type of this program.
bool	getUseColumnMajorMatrices () const
	Returns whether Ogre will pass auto-bound matrices as column-major.
void	operator delete (void *ptr)
void	operator delete (void *ptr, const char *, int, const char *)
void	operator delete (void *ptr, void *)
void	operator delete[] (void *ptr)
void	operator delete[] (void *ptr, const char *, int, const char *)
void *	operator new (size_t sz)
void *	operator new (size_t sz, const char *file, int line, const char *func)
	operator new, with debug line info
void *	operator new (size_t sz, void *ptr)
	placement operator new
void *	operator new[] (size_t sz)
void *	operator new[] (size_t sz, const char *file, int line, const char *func)
	array operator new, with debug line info
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.
UniformParameterPtr	resolveAutoParameterInt (GpuProgramParameters::AutoConstantType autoType, size_t data, size_t size=0)
	Resolve uniform auto constant parameter with associated int data of this program.
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.
UniformParameterPtr	resolveAutoParameterReal (GpuProgramParameters::AutoConstantType autoType, Real data, size_t size=0)
	Resolve uniform auto constant parameter with associated real data of this program.
UniformParameterPtr	resolveParameter (GpuConstantType type, int index, uint16 variability, const String &suggestedName, size_t size=0)
	Resolve uniform parameter of this program.
void	setEntryPointFunction (Function *function)
	Set the entry point function.
void	setSkeletalAnimationIncluded (bool value)
	Sets whether a vertex program includes the required instructions to perform skeletal animation.
void	setUseColumnMajorMatrices (bool value)
	Tells Ogre whether auto-bound matrices should be sent in column or row-major order.

Friends
class	ProgramManager

Detailed Description

A class that represents a shader based program.

Member Function Documentation

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.

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

name	The name of the function to create.
desc	The description of the function.

getDependency()

const String & Ogre::RTShader::Program::getDependency

(

unsigned int

index

)

const

Get the library name of the given index dependency.

Parameters

index

The index of the dependecy.

getDependencyCount()

size_t Ogre::RTShader::Program::getDependencyCount

(

)

const

Get the number of external libs this program depends on.

getEntryPointFunction()

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

inline

Get the entry point function of this program.

getFunctionByName()

Function * Ogre::RTShader::Program::getFunctionByName

(

const String &

name

)

Get a function by a given name.

Return NULL if no matching function found.

Parameters

name	The name of the function to search for.

getFunctions()

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

inline

Get the function list of this program.

getParameterByAutoType()

UniformParameterPtr Ogre::RTShader::Program::getParameterByAutoType

(

GpuProgramParameters::AutoConstantType

autoType

)

Get parameter by a given auto constant type.

Parameters

autoType

The auto type of the parameter to search for.

Remarks

Return NULL if no matching parameter found.

getParameterByName()

UniformParameterPtr Ogre::RTShader::Program::getParameterByName

(

const String &

name

)

Get parameter by a given name.

Parameters

name	The name 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

type	The type of the parameter to search for.
index	The 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.

getSkeletalAnimationIncluded()

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

inline

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

getType()

GpuProgramType Ogre::RTShader::Program::getType

(

)

const

Get the type of this program.

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.

operator delete() [1/3]

template<class Alloc >

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

inlineinherited

operator delete() [2/3]

template<class Alloc >

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

inlineinherited

operator delete() [3/3]

template<class Alloc >

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

inlineinherited

operator delete[]() [1/2]

template<class Alloc >

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

inlineinherited

operator delete[]() [2/2]

template<class Alloc >

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

inlineinherited

operator new() [1/3]

template<class Alloc >

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

inlineinherited

operator new() [2/3]

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

operator new() [3/3]

template<class Alloc >

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

inlineinherited

placement operator new

operator new[]() [1/2]

template<class Alloc >

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

inlineinherited

operator new[]() [2/2]

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

resolveAutoParameterInt() [1/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

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.

resolveAutoParameterInt() [2/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

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.

resolveAutoParameterReal() [1/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

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.

resolveAutoParameterReal() [2/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

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.

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

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.

Remarks

Pass -1 as index parameter to create a new parameter with the desired type and index.

setEntryPointFunction()

void Ogre::RTShader::Program::setEntryPointFunction ( Function *  function )

inline

Set the entry point function.

Parameters

function

The function that will use as entry point of this program.

setSkeletalAnimationIncluded()

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

inline

Sets 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

value

Should Ogre pass auto-bound matrices as column-major? The default is true.

Friends And Related Symbol Documentation

ProgramManager

friend class ProgramManager

friend

---

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

• OgreShaderProgram.h