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

#include <OgreShaderFunction.h>

Inheritance diagram for Ogre::RTShader::Function:

Public Types
enum	FunctionType { FFT_INTERNAL, FFT_VS_MAIN, FFT_PS_MAIN }

Public Member Functions
void	addAtomInstance (FunctionAtom *atomInstance)
	Add a function atom instance to this function. More...

void	addInputParameter (ParameterPtr parameter)
	Add input parameter to this function. More...

void	addOutputParameter (ParameterPtr parameter)
	Add output parameter to this function. More...

void	deleteAllInputParameters ()
	Delete all input parameters from this function. More...

void	deleteAllOutputParameters ()
	Delete all output parameters from this function. More...

bool	deleteAtomInstance (FunctionAtom *atomInstance)
	Delete a function atom instance from this function. More...

void	deleteInputParameter (ParameterPtr parameter)
	Delete input parameter from this function. More...

void	deleteOutputParameter (ParameterPtr parameter)
	Delete output parameter from this function. More...

const FunctionAtomInstanceList &	getAtomInstances ()
	Return list of atom instances composing this function. More...

const String &	getDescription () const
	Get the description of this function. More...

FunctionType	getFunctionType () const

ParameterPtr	getInputParameter (Parameter::Content content, GpuConstantType type=GCT_UNKNOWN)
	get input parameter by content More...

const ShaderParameterList &	getInputParameters () const
	Return a list of input parameters. More...

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

ParameterPtr	getLocalParameter (Parameter::Content content)
	get local parameter by content More...

const ShaderParameterList &	getLocalParameters () const
	Return a list of local parameters. More...

const String &	getName () const
	Get the name of this function. More...

ParameterPtr	getOutputParameter (Parameter::Content content, GpuConstantType type=GCT_UNKNOWN)
	get output parameter by content More...

const ShaderParameterList &	getOutputParameters () const
	Return a list of output parameters. More...

FunctionStageRef	getStage (size_t s)
	get a FFPShaderStage of this function More...

ParameterPtr	resolveInputParameter (const ParameterPtr &out)
	resolve input parameter from previous output More...

ParameterPtr	resolveInputParameter (Parameter::Content content, GpuConstantType type=GCT_UNKNOWN)
	Resolve input parameter of this function. More...

ParameterPtr	resolveInputParameter (Parameter::Semantic semantic, int index, const Parameter::Content content, GpuConstantType type)

ParameterPtr	resolveLocalParameter (const String &name, GpuConstantType type)

ParameterPtr	resolveLocalParameter (GpuConstantType type, const String &name)
	Resolve local parameter of this function More...

ParameterPtr	resolveLocalParameter (Parameter::Content content, GpuConstantType type=GCT_UNKNOWN)
	Resolve local parameter of this function. More...

ParameterPtr	resolveLocalParameter (Parameter::Semantic semantic, int index, const Parameter::Content content, GpuConstantType type)

ParameterPtr	resolveLocalParameter (Parameter::Semantic semantic, int index, const String &name, GpuConstantType type)

ParameterPtr	resolveOutputParameter (Parameter::Content content, GpuConstantType type=GCT_UNKNOWN)
	Resolve output parameter of this function. More...

ParameterPtr	resolveOutputParameter (Parameter::Semantic semantic, int index, const Parameter::Content content, GpuConstantType type)

Detailed Description

A class that represents a shader based program function.

Member Enumeration Documentation

◆ FunctionType

enum Ogre::RTShader::Function::FunctionType

Deprecated:: do not use

Enumerator
FFT_INTERNAL
FFT_VS_MAIN
FFT_PS_MAIN

Member Function Documentation

◆ getName()

const String& Ogre::RTShader::Function::getName ( ) const

inline

Get the name of this function.

◆ getDescription()

const String& Ogre::RTShader::Function::getDescription ( ) const

inline

Get the description of this function.

◆ resolveInputParameter() [1/3]

ParameterPtr Ogre::RTShader::Function::resolveInputParameter	(	Parameter::Semantic	semantic,
		int	index,
		const Parameter::Content	content,
		GpuConstantType	type
	)

Deprecated:

◆ resolveInputParameter() [2/3]

ParameterPtr Ogre::RTShader::Function::resolveInputParameter	(	Parameter::Content	content,
		GpuConstantType	type = `GCT_UNKNOWN`
	)

inline

Resolve input parameter of this function.

Parameters

content	The content of the parameter.
type	The type of the desired parameter.

Returns: parameter instance in case of that resolve operation succeeded.

References Ogre::RTShader::Parameter::SPS_UNKNOWN.

◆ resolveInputParameter() [3/3]

ParameterPtr Ogre::RTShader::Function::resolveInputParameter ( const ParameterPtr & out )

inline

resolve input parameter from previous output

References OgreAssert.

◆ getInputParameter()

ParameterPtr Ogre::RTShader::Function::getInputParameter	(	Parameter::Content	content,
		GpuConstantType	type = `GCT_UNKNOWN`
	)

inline

get input parameter by content

Parameters

content
type	The type of the desired parameter.

Returns: parameter or NULL if not found

◆ resolveOutputParameter() [1/2]

ParameterPtr Ogre::RTShader::Function::resolveOutputParameter	(	Parameter::Semantic	semantic,
		int	index,
		const Parameter::Content	content,
		GpuConstantType	type
	)

Deprecated:

◆ resolveOutputParameter() [2/2]

ParameterPtr Ogre::RTShader::Function::resolveOutputParameter	(	Parameter::Content	content,
		GpuConstantType	type = `GCT_UNKNOWN`
	)

inline

Resolve output parameter of this function.

Parameters

content	The content of the parameter.
type	The type of the desired parameter.

Returns: parameter instance in case of that resolve operation succeeded.

References Ogre::RTShader::Parameter::SPS_UNKNOWN.

◆ getOutputParameter()

ParameterPtr Ogre::RTShader::Function::getOutputParameter	(	Parameter::Content	content,
		GpuConstantType	type = `GCT_UNKNOWN`
	)

inline

get output parameter by content

Parameters

content
type	The type of the desired parameter.

Returns: parameter or NULL if not found

◆ resolveLocalParameter() [1/5]

ParameterPtr Ogre::RTShader::Function::resolveLocalParameter	(	Parameter::Semantic	semantic,
		int	index,
		const String &	name,
		GpuConstantType	type
	)

Deprecated:: local parameters do not have index or semantic. use resolveLocalParameter(const String&, GpuConstantType)

◆ resolveLocalParameter() [2/5]

ParameterPtr Ogre::RTShader::Function::resolveLocalParameter	(	GpuConstantType	type,
		const String &	name
	)

inline

Resolve local parameter of this function

Parameters

name	The name of the parameter.
type	The type of the desired parameter. Return parameter instance in case of that resolve operation succeeded.

References Ogre::RTShader::Parameter::SPS_UNKNOWN.

◆ resolveLocalParameter() [3/5]

ParameterPtr Ogre::RTShader::Function::resolveLocalParameter	(	const String &	name,
		GpuConstantType	type
	)

inline

Deprecated:

References Ogre::RTShader::Parameter::SPS_UNKNOWN.

◆ resolveLocalParameter() [4/5]

ParameterPtr Ogre::RTShader::Function::resolveLocalParameter	(	Parameter::Semantic	semantic,
		int	index,
		const Parameter::Content	content,
		GpuConstantType	type
	)

Deprecated:: local parameters do not have index or semantic. use resolveLocalParameter(const String&, GpuConstantType)

◆ resolveLocalParameter() [5/5]

ParameterPtr Ogre::RTShader::Function::resolveLocalParameter	(	Parameter::Content	content,
		GpuConstantType	type = `GCT_UNKNOWN`
	)

inline

Resolve local parameter of this function.

Parameters

content	The content of the parameter.
type	The type of the desired parameter. Return parameter instance in case of that resolve operation succeeded.

References Ogre::RTShader::Parameter::SPS_UNKNOWN.

◆ getLocalParameter() [1/2]

ParameterPtr Ogre::RTShader::Function::getLocalParameter ( Parameter::Content content )

inline

get local parameter by content

Parameters

content

Returns: parameter or NULL if not found

References Ogre::GCT_UNKNOWN.

◆ getLocalParameter() [2/2]

ParameterPtr Ogre::RTShader::Function::getLocalParameter ( const String & name )

inline

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ getInputParameters()

const ShaderParameterList& Ogre::RTShader::Function::getInputParameters ( ) const

inline

Return a list of input parameters.

◆ getOutputParameters()

const ShaderParameterList& Ogre::RTShader::Function::getOutputParameters ( ) const

inline

Return a list of output parameters.

◆ getLocalParameters()

const ShaderParameterList& Ogre::RTShader::Function::getLocalParameters ( ) const

inline

Return a list of local parameters.

◆ addAtomInstance()

void Ogre::RTShader::Function::addAtomInstance ( FunctionAtom * atomInstance )

Add a function atom instance to this function.

Parameters

atomInstance The atom instance to add.

◆ getStage()

FunctionStageRef Ogre::RTShader::Function::getStage ( size_t s )

inline

get a FFPShaderStage of this function

◆ deleteAtomInstance()

bool Ogre::RTShader::Function::deleteAtomInstance ( FunctionAtom * atomInstance )

Delete a function atom instance from this function.

Parameters

atomInstance The atom instance to OGRE_DELETE.

◆ getAtomInstances()

const FunctionAtomInstanceList& Ogre::RTShader::Function::getAtomInstances ( )

Return list of atom instances composing this function.

(Const version)

◆ addInputParameter()

void Ogre::RTShader::Function::addInputParameter ( ParameterPtr parameter )

Add input parameter to this function.

◆ addOutputParameter()

void Ogre::RTShader::Function::addOutputParameter ( ParameterPtr parameter )

Add output parameter to this function.

◆ deleteInputParameter()

void Ogre::RTShader::Function::deleteInputParameter ( ParameterPtr parameter )

Delete input parameter from this function.

◆ deleteOutputParameter()

void Ogre::RTShader::Function::deleteOutputParameter ( ParameterPtr parameter )

Delete output parameter from this function.

◆ deleteAllInputParameters()

void Ogre::RTShader::Function::deleteAllInputParameters ( )

Delete all input parameters from this function.

◆ deleteAllOutputParameters()

void Ogre::RTShader::Function::deleteAllOutputParameters ( )

Delete all output parameters from this function.

◆ getFunctionType()

FunctionType Ogre::RTShader::Function::getFunctionType ( ) const

Deprecated:: do not use

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

OgreShaderFunction.h

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

◆ FunctionType

Member Function Documentation

◆ getName()

◆ getDescription()

◆ resolveInputParameter() [1/3]

◆ resolveInputParameter() [2/3]

◆ resolveInputParameter() [3/3]

◆ getInputParameter()

◆ resolveOutputParameter() [1/2]

◆ resolveOutputParameter() [2/2]

◆ getOutputParameter()

◆ resolveLocalParameter() [1/5]

◆ resolveLocalParameter() [2/5]

◆ resolveLocalParameter() [3/5]

◆ resolveLocalParameter() [4/5]

◆ resolveLocalParameter() [5/5]

◆ getLocalParameter() [1/2]

◆ getLocalParameter() [2/2]

◆ getInputParameters()

◆ getOutputParameters()

◆ getLocalParameters()

◆ addAtomInstance()

◆ getStage()

◆ deleteAtomInstance()

◆ getAtomInstances()

◆ addInputParameter()

◆ addOutputParameter()

◆ deleteInputParameter()

◆ deleteOutputParameter()

◆ deleteAllInputParameters()

◆ deleteAllOutputParameters()

◆ getFunctionType()