CG Language program processor class. More...

#include <OgreShaderHLSLProgramProcessor.h>

Inheritance diagram for Ogre::RTShader::HLSLProgramProcessor:

[legend]

Public Member Functions
	HLSLProgramProcessor ()
	Class constructor.

virtual	~HLSLProgramProcessor ()
	Class destructor.

virtual const String &	getTargetLanguage () const
	Return the target language of this processor.

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

virtual bool	postCreateGpuPrograms (ProgramSet *programSet)

virtual bool	preCreateGpuPrograms (ProgramSet *programSet)

Static Public Attributes
static String	TargetLanguage

Protected Types
typedef map< Parameter *, ParameterPtr >::type	LocalParameterMap

typedef vector< MergeCombination >::type	MergeCombinationList

typedef vector< MergeParameter >::type	MergeParameterList

typedef vector< Operand * >::type	OperandPtrVector

typedef map< Parameter *, OperandPtrVector >::type	ParameterOperandMap

Protected Member Functions
void	bindAutoParameters (Program *pCpuProgram, GpuProgramPtr pGpuProgram)
	Bind the auto parameters for a given CPU and GPU program set.

void	buildMergeCombinations ()
	Build parameter merging combinations.

void	buildParameterReferenceMap (FunctionAtomInstanceList &funcAtomList, ParameterOperandMap &paramsRefMap)
	Builds a map between parameter and all the references to it.

void	buildTexcoordTable (const ShaderParameterList &paramList, ShaderParameterList outParamsTable[4])
	Internal function that builds parameters table.

virtual bool	compactVsOutputs (Function vsMain, Function fsMain)
	Compact the vertex shader output registers.

void	countVsTexcoordOutputs (Function *vsMain, int &outTexCoordSlots, int &outTexCoordFloats)
	Internal method that counts vertex shader texcoord output slots and output floats.

void	generateLocalSplitParameters (Function *func, GpuProgramType progType, MergeParameterList &mergedParams, ShaderParameterList &splitParams, LocalParameterMap &localParamsMap)
	Generates local parameters for the split parameters and perform packing/unpacking operation using them.

void	mergeParameters (ShaderParameterList paramsTable[4], MergeParameterList &mergedParams, ShaderParameterList &splitParams)
	Merge the parameters from the given table.

bool	mergeParametersByCombination (const MergeCombination &combination, ShaderParameterList paramsTable[4], MergeParameter *mergedParameter)
	Internal function that creates merged parameter from given combination.

void	mergeParametersByPredefinedCombinations (ShaderParameterList paramsTable[4], MergeParameterList &mergedParams)
	Internal function that creates merged parameter using pre defined combinations.

void	mergeParametersReminders (ShaderParameterList paramsTable[4], MergeParameterList &mergedParams, ShaderParameterList &splitParams)
	Merge reminders parameters that could not be merged into one slot using the predefined combinations.

void	rebuildFunctionInvocations (FunctionAtomInstanceList &funcAtomList, MergeParameterList &mergedParams, LocalParameterMap &localParamsMap)
	Rebuild function invocations by replacing references to old source parameters with the matching merged parameters components.

void	rebuildParameterList (Function *func, int paramsUsage, MergeParameterList &mergedParams)
	Rebuild the given parameters list using the merged parameters.

void	replaceParametersReferences (MergeParameterList &mergedParams, ParameterOperandMap &paramsRefMap)
	Replace references to old parameters with the new merged parameters.

void	replaceSplitParametersReferences (LocalParameterMap &localParamsMap, ParameterOperandMap &paramsRefMap)
	Replace references to old parameters that have been split with the new local parameters that represents them.

Static Protected Member Functions
static int	getParameterFloatCount (GpuConstantType type)
	Return number of floats needed by the given type.

static int	getParameterMaskByFloatCount (int floatCount)
	Return the parameter mask of by the float count type (I.E: X\|Y for 2 etc..)

static int	getParameterMaskByType (GpuConstantType type)
	Return the parameter mask of by the given parameter type (I.E: X\|Y for FLOAT2 etc..)

Protected Attributes
map< Function , String >::type	mFunctionMap

int	mMaxTexCoordFloats

int	mMaxTexCoordSlots

MergeCombinationList	mParamMergeCombinations

Detailed Description

CG Language program processor class.

Definition at line 46 of file OgreShaderHLSLProgramProcessor.h.

Member Typedef Documentation

◆ LocalParameterMap

typedef map<Parameter*,ParameterPtr>::type Ogre::RTShader::ProgramProcessor::LocalParameterMap

protectedinherited

Definition at line 169 of file OgreShaderProgramProcessor.h.

◆ MergeCombinationList

typedef vector<MergeCombination>::type Ogre::RTShader::ProgramProcessor::MergeCombinationList

protectedinherited

Definition at line 164 of file OgreShaderProgramProcessor.h.

◆ MergeParameterList

typedef vector<MergeParameter>::type Ogre::RTShader::ProgramProcessor::MergeParameterList

protectedinherited

Definition at line 135 of file OgreShaderProgramProcessor.h.

◆ OperandPtrVector

typedef vector<Operand*>::type Ogre::RTShader::ProgramProcessor::OperandPtrVector

protectedinherited

Definition at line 167 of file OgreShaderProgramProcessor.h.

◆ ParameterOperandMap

typedef map<Parameter*,OperandPtrVector>::type Ogre::RTShader::ProgramProcessor::ParameterOperandMap

protectedinherited

Definition at line 168 of file OgreShaderProgramProcessor.h.

Constructor & Destructor Documentation

◆ HLSLProgramProcessor()

Ogre::RTShader::HLSLProgramProcessor::HLSLProgramProcessor ( )

Class constructor.

◆ ~HLSLProgramProcessor()

virtual Ogre::RTShader::HLSLProgramProcessor::~HLSLProgramProcessor ( )

virtual

Class destructor.

Member Function Documentation

◆ bindAutoParameters()

void Ogre::RTShader::ProgramProcessor::bindAutoParameters	(	Program *	pCpuProgram,
		GpuProgramPtr	pGpuProgram )

protectedinherited

Bind the auto parameters for a given CPU and GPU program set.

◆ buildMergeCombinations()

void Ogre::RTShader::ProgramProcessor::buildMergeCombinations ( )

protectedinherited

Build parameter merging combinations.

◆ buildParameterReferenceMap()

void Ogre::RTShader::ProgramProcessor::buildParameterReferenceMap	(	FunctionAtomInstanceList &	funcAtomList,
		ParameterOperandMap &	paramsRefMap )

protectedinherited

Builds a map between parameter and all the references to it.

◆ buildTexcoordTable()

void Ogre::RTShader::ProgramProcessor::buildTexcoordTable	(	const ShaderParameterList &	paramList,
		ShaderParameterList	outParamsTable[4] )

protectedinherited

Internal function that builds parameters table.

Parameters

paramList	The parameter list.
outParamsTable	Will hold the texcoord params sorted by types in each row.

◆ compactVsOutputs()

virtual bool Ogre::RTShader::ProgramProcessor::compactVsOutputs	(	Function *	vsMain,
		Function *	fsMain )

protectedvirtualinherited

Compact the vertex shader output registers.

Parameters

vsMain	The vertex shader entry function.
fsMain	The fragment shader entry function. Return true on success.

◆ countVsTexcoordOutputs()

void Ogre::RTShader::ProgramProcessor::countVsTexcoordOutputs	(	Function *	vsMain,
		int &	outTexCoordSlots,
		int &	outTexCoordFloats )

protectedinherited

Internal method that counts vertex shader texcoord output slots and output floats.

Parameters

vsMain	The vertex shader entry function.
outTexCoordSlots	Will hold the number of used output texcoord slots.
outTexCoordFloats	Will hold the total number of floats used by output texcoord slots.

◆ generateLocalSplitParameters()

void Ogre::RTShader::ProgramProcessor::generateLocalSplitParameters	(	Function *	func,
		GpuProgramType	progType,
		MergeParameterList &	mergedParams,
		ShaderParameterList &	splitParams,
		LocalParameterMap &	localParamsMap )

protectedinherited

Generates local parameters for the split parameters and perform packing/unpacking operation using them.

◆ getParameterFloatCount()

static int Ogre::RTShader::ProgramProcessor::getParameterFloatCount ( GpuConstantType type )

staticprotectedinherited

Return number of floats needed by the given type.

◆ getParameterMaskByFloatCount()

static int Ogre::RTShader::ProgramProcessor::getParameterMaskByFloatCount ( int floatCount )

staticprotectedinherited

Return the parameter mask of by the float count type (I.E: X|Y for 2 etc..)

◆ getParameterMaskByType()

static int Ogre::RTShader::ProgramProcessor::getParameterMaskByType ( GpuConstantType type )

staticprotectedinherited

Return the parameter mask of by the given parameter type (I.E: X|Y for FLOAT2 etc..)

◆ getTargetLanguage()

virtual const String & Ogre::RTShader::HLSLProgramProcessor::getTargetLanguage ( ) const

virtual

Return the target language of this processor.

Implements Ogre::RTShader::ProgramProcessor.

Definition at line 60 of file OgreShaderHLSLProgramProcessor.h.

◆ mergeParameters()

void Ogre::RTShader::ProgramProcessor::mergeParameters	(	ShaderParameterList	paramsTable[4],
		MergeParameterList &	mergedParams,
		ShaderParameterList &	splitParams )

protectedinherited

Merge the parameters from the given table.

Parameters

paramsTable	Source parameters table.
mergedParams	Will hold the merged parameters list.

◆ mergeParametersByCombination()

bool Ogre::RTShader::ProgramProcessor::mergeParametersByCombination	(	const MergeCombination &	combination,
		ShaderParameterList	paramsTable[4],
		MergeParameter *	mergedParameter )

protectedinherited

Internal function that creates merged parameter from given combination.

Parameters

combination	The merge combination to try.
paramsTable	The params table sorted by types in each row.
mergedParameter	Will hold the merged parameter.

◆ mergeParametersByPredefinedCombinations()

void Ogre::RTShader::ProgramProcessor::mergeParametersByPredefinedCombinations	(	ShaderParameterList	paramsTable[4],
		MergeParameterList &	mergedParams )

protectedinherited

Internal function that creates merged parameter using pre defined combinations.

Parameters

paramsTable	Source parameters table.
mergedParams	The merged parameters list.

◆ mergeParametersReminders()

void Ogre::RTShader::ProgramProcessor::mergeParametersReminders	(	ShaderParameterList	paramsTable[4],
		MergeParameterList &	mergedParams,
		ShaderParameterList &	splitParams )

protectedinherited

Merge reminders parameters that could not be merged into one slot using the predefined combinations.

Parameters

paramsTable	The params table sorted by types in each row.
mergedParams	The merged parameters list.
splitParams	The split parameters list.

◆ operator delete() [1/3]

template<class Alloc >

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

inherited

Definition at line 96 of file OgreMemoryAllocatedObject.h.

◆ operator delete() [2/3]

template<class Alloc >

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

inherited

Definition at line 108 of file OgreMemoryAllocatedObject.h.

◆ operator delete() [3/3]

template<class Alloc >

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

inherited

Definition at line 102 of file OgreMemoryAllocatedObject.h.

◆ operator delete[]() [1/2]

template<class Alloc >

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

inherited

Definition at line 113 of file OgreMemoryAllocatedObject.h.

◆ operator delete[]() [2/2]

template<class Alloc >

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

inherited

Definition at line 119 of file OgreMemoryAllocatedObject.h.

◆ operator new() [1/3]

template<class Alloc >

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

inherited

Definition at line 73 of file OgreMemoryAllocatedObject.h.

◆ operator new() [2/3]

template<class Alloc >

void * Ogre::AllocatedObject< Alloc >::operator new	(	size_t	sz,
		const char *	file,
		int	line,
		const char *	func )

inherited

operator new, with debug line info

Definition at line 68 of file OgreMemoryAllocatedObject.h.

◆ operator new() [3/3]

template<class Alloc >

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

inherited

placement operator new

Definition at line 79 of file OgreMemoryAllocatedObject.h.

◆ operator new[]() [1/2]

template<class Alloc >

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

inherited

Definition at line 91 of file OgreMemoryAllocatedObject.h.

◆ operator new[]() [2/2]

template<class Alloc >

void * Ogre::AllocatedObject< Alloc >::operator new[]	(	size_t	sz,
		const char *	file,
		int	line,
		const char *	func )

inherited

array operator new, with debug line info

Definition at line 86 of file OgreMemoryAllocatedObject.h.

◆ postCreateGpuPrograms()

virtual bool Ogre::RTShader::HLSLProgramProcessor::postCreateGpuPrograms ( ProgramSet * programSet )

virtual

See also: ProgramProcessor::postCreateGpuPrograms

Implements Ogre::RTShader::ProgramProcessor.

◆ preCreateGpuPrograms()

virtual bool Ogre::RTShader::HLSLProgramProcessor::preCreateGpuPrograms ( ProgramSet * programSet )

virtual

See also: ProgramProcessor::preCreateGpuPrograms

Implements Ogre::RTShader::ProgramProcessor.

◆ rebuildFunctionInvocations()

void Ogre::RTShader::ProgramProcessor::rebuildFunctionInvocations	(	FunctionAtomInstanceList &	funcAtomList,
		MergeParameterList &	mergedParams,
		LocalParameterMap &	localParamsMap )

protectedinherited

Rebuild function invocations by replacing references to old source parameters with the matching merged parameters components.

◆ rebuildParameterList()

void Ogre::RTShader::ProgramProcessor::rebuildParameterList	(	Function *	func,
		int	paramsUsage,
		MergeParameterList &	mergedParams )

protectedinherited

Rebuild the given parameters list using the merged parameters.

◆ replaceParametersReferences()

void Ogre::RTShader::ProgramProcessor::replaceParametersReferences	(	MergeParameterList &	mergedParams,
		ParameterOperandMap &	paramsRefMap )

protectedinherited

Replace references to old parameters with the new merged parameters.

◆ replaceSplitParametersReferences()

void Ogre::RTShader::ProgramProcessor::replaceSplitParametersReferences	(	LocalParameterMap &	localParamsMap,
		ParameterOperandMap &	paramsRefMap )

protectedinherited

Replace references to old parameters that have been split with the new local parameters that represents them.

Member Data Documentation

◆ mFunctionMap

map<Function*,String*>::type Ogre::RTShader::ProgramProcessor::mFunctionMap

protectedinherited

Definition at line 264 of file OgreShaderProgramProcessor.h.

◆ mMaxTexCoordFloats

int Ogre::RTShader::ProgramProcessor::mMaxTexCoordFloats

protectedinherited

Definition at line 263 of file OgreShaderProgramProcessor.h.

◆ mMaxTexCoordSlots

int Ogre::RTShader::ProgramProcessor::mMaxTexCoordSlots

protectedinherited

Definition at line 261 of file OgreShaderProgramProcessor.h.

◆ mParamMergeCombinations

MergeCombinationList Ogre::RTShader::ProgramProcessor::mParamMergeCombinations

protectedinherited

Definition at line 259 of file OgreShaderProgramProcessor.h.

◆ TargetLanguage

String Ogre::RTShader::HLSLProgramProcessor::TargetLanguage

static

Definition at line 71 of file OgreShaderHLSLProgramProcessor.h.

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

OgreShaderHLSLProgramProcessor.h

Public Member Functions

Static Public Attributes

Protected Types

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ LocalParameterMap

◆ MergeCombinationList

◆ MergeParameterList

◆ OperandPtrVector

◆ ParameterOperandMap

Constructor & Destructor Documentation

◆ HLSLProgramProcessor()

◆ ~HLSLProgramProcessor()

Member Function Documentation

◆ bindAutoParameters()

◆ buildMergeCombinations()

◆ buildParameterReferenceMap()

◆ buildTexcoordTable()

◆ compactVsOutputs()

◆ countVsTexcoordOutputs()

◆ generateLocalSplitParameters()

◆ getParameterFloatCount()

◆ getParameterMaskByFloatCount()

◆ getParameterMaskByType()

◆ getTargetLanguage()

◆ mergeParameters()

◆ mergeParametersByCombination()

◆ mergeParametersByPredefinedCombinations()

◆ mergeParametersReminders()

◆ operator delete() [1/3]

◆ operator delete() [2/3]

◆ operator delete() [3/3]

◆ operator delete[]() [1/2]

◆ operator delete[]() [2/2]

◆ operator new() [1/3]

◆ operator new() [2/3]

◆ operator new() [3/3]

◆ operator new[]() [1/2]

◆ operator new[]() [2/2]

◆ postCreateGpuPrograms()

◆ preCreateGpuPrograms()

◆ rebuildFunctionInvocations()

◆ rebuildParameterList()

◆ replaceParametersReferences()

◆ replaceSplitParametersReferences()

Member Data Documentation

◆ mFunctionMap

◆ mMaxTexCoordFloats

◆ mMaxTexCoordSlots

◆ mParamMergeCombinations

◆ TargetLanguage