OGRE  1.9.0
OgreShaderProgramProcessor.h
Go to the documentation of this file.
1/*
2-----------------------------------------------------------------------------
3This source file is part of OGRE
4(Object-oriented Graphics Rendering Engine)
5For the latest info, see http://www.ogre3d.org
6
7Copyright (c) 2000-2014 Torus Knot Software Ltd
8Permission is hereby granted, free of charge, to any person obtaining a copy
9of this software and associated documentation files (the "Software"), to deal
10in the Software without restriction, including without limitation the rights
11to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12copies of the Software, and to permit persons to whom the Software is
13furnished to do so, subject to the following conditions:
14
15The above copyright notice and this permission notice shall be included in
16all copies or substantial portions of the Software.
17
18THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
24THE SOFTWARE.
25-----------------------------------------------------------------------------
26*/
27#ifndef _ShaderProgramProcessor_
28#define _ShaderProgramProcessor_
29
31#include "OgreShaderParameter.h"
33
34
35namespace Ogre {
36namespace RTShader {
37
50{
51
52// Interface.
53public:
54
58
61
63 virtual const String& getTargetLanguage() const = 0;
64
71
77
78// Protected types.
79protected:
80
81 //-----------------------------------------------------------------------------
82 // Class that holds merge parameter information.
84 {
85 // Interface.
86 public:
89
90
92 void clear();
93
96
98 size_t getSourceParameterCount() const { return mSrcParameterCount; }
99
101 ParameterPtr getSourceParameter(unsigned int index) { return mSrcParameter[index]; }
102
104 int getSourceParameterMask(unsigned int index) const { return mSrcParameterMask[index]; }
105
107 int getDestinationParameterMask(unsigned int index) const { return mDstParameterMask[index]; }
108
111
114
115 protected:
116
118 void createDestinationParameter(int usage, int index);
119
120
121 protected:
122 // Destination merged parameter.
124 // Source parameters - 4 source at max 1,1,1,1 -> 4.
125 ParameterPtr mSrcParameter[4];
126 // Source parameters mask. OPM_ALL means all fields used, otherwise it is split source parameter.
127 int mSrcParameterMask[4];
128 // Destination parameters mask. OPM_ALL means all fields used, otherwise it is split source parameter.
129 int mDstParameterMask[4];
130 // The actual source parameters count.
132 // The number of used floats.
134 };
136
137
138 //-----------------------------------------------------------------------------
139 // A struct that defines merge parameters combination.
141 {
142 // The count of each source type. I.E (1 FLOAT1, 0 FLOAT2, 1 FLOAT3, 0 FLOAT4).
143 size_t srcParameterTypeCount[4];
144 // Source parameters mask. OPM_ALL means all fields used, otherwise it is split source parameter.
145 int srcParameterMask[4];
146
148 int float1Count, int float1Mask,
149 int float2Count, int float2Mask,
150 int float3Count, int float3Mask,
151 int float4Count, int float4Mask)
152 {
153 srcParameterTypeCount[0] = float1Count;
154 srcParameterTypeCount[1] = float2Count;
155 srcParameterTypeCount[2] = float3Count;
156 srcParameterTypeCount[3] = float4Count;
157 srcParameterMask[0] = float1Mask;
158 srcParameterMask[1] = float2Mask;
159 srcParameterMask[2] = float3Mask;
160 srcParameterMask[3] = float4Mask;
161
162 }
163 };
165
166 //-----------------------------------------------------------------------------
170
171protected:
172
175
182
189
195
196
202
203
209
217
224
225
228
232
235
238
241
244
247
250
253
256
257protected:
258 // Merging combinations defs.
260 // Maximum texcoord slots.
262 // Maximum texcoord floats count.
264 map<Function *, String *>::type mFunctionMap; // Map between function signatures and source code
265
266};
267
268
272}
273}
274
275#endif
276
#define _OgreRTSSExport
Superclass for all objects that wish to use custom memory allocators when their new / delete operator...
A class that represents a shader based program function.
void addSourceParameter(ParameterPtr srcParam, int mask)
Add source parameter to this merged.
ParameterPtr getDestinationParameter(int usage, int index)
Return the destination parameter.
int getSourceParameterMask(unsigned int index) const
Return source parameter mask by index.
int getUsedFloatCount()
Return the number of used floats.
int getDestinationParameterMask(unsigned int index) const
Return destination parameter mask by index.
void clear()
Clear the state of this merge parameter.
ParameterPtr getSourceParameter(unsigned int index)
Return source parameter by index.
size_t getSourceParameterCount() const
Return the source parameter count.
void createDestinationParameter(int usage, int index)
Creates the destination parameter by a given class and index.
A class that provides extra processing services on CPU based programs.
void buildMergeCombinations()
Build parameter merging combinations.
void rebuildParameterList(Function *func, int paramsUsage, MergeParameterList &mergedParams)
Rebuild the given parameters list using the merged parameters.
ProgramProcessor()
Class constructor.
void rebuildFunctionInvocations(FunctionAtomInstanceList &funcAtomList, MergeParameterList &mergedParams, LocalParameterMap &localParamsMap)
Rebuild function invocations by replacing references to old source parameters with the matching merge...
void countVsTexcoordOutputs(Function *vsMain, int &outTexCoordSlots, int &outTexCoordFloats)
Internal method that counts vertex shader texcoord output slots and output floats.
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 buildParameterReferenceMap(FunctionAtomInstanceList &funcAtomList, ParameterOperandMap &paramsRefMap)
Builds a map between parameter and all the references to it.
vector< MergeCombination >::type MergeCombinationList
map< Function *, String * >::type mFunctionMap
map< Parameter *, OperandPtrVector >::type ParameterOperandMap
map< Parameter *, ParameterPtr >::type LocalParameterMap
void bindAutoParameters(Program *pCpuProgram, GpuProgramPtr pGpuProgram)
Bind the auto parameters for a given CPU and GPU program set.
static int getParameterFloatCount(GpuConstantType type)
Return number of floats needed by the given type.
virtual const String & getTargetLanguage() const =0
Return the target language of this processor.
virtual bool postCreateGpuPrograms(ProgramSet *programSet)=0
Called after creation of the GPU programs.
void buildTexcoordTable(const ShaderParameterList &paramList, ShaderParameterList outParamsTable[4])
Internal function that builds parameters table.
static int getParameterMaskByFloatCount(int floatCount)
Return the parameter mask of by the float count type (I.E: X|Y for 2 etc..)
void mergeParameters(ShaderParameterList paramsTable[4], MergeParameterList &mergedParams, ShaderParameterList &splitParams)
Merge the parameters from the given table.
vector< MergeParameter >::type MergeParameterList
virtual ~ProgramProcessor()
Class destructor.
void replaceParametersReferences(MergeParameterList &mergedParams, ParameterOperandMap &paramsRefMap)
Replace references to old parameters with the new merged parameters.
virtual bool compactVsOutputs(Function *vsMain, Function *fsMain)
Compact the vertex shader output registers.
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 the...
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 replaceSplitParametersReferences(LocalParameterMap &localParamsMap, ParameterOperandMap &paramsRefMap)
Replace references to old parameters that have been split with the new local parameters that represen...
virtual bool preCreateGpuPrograms(ProgramSet *programSet)=0
Called before creation of the GPU programs.
static int getParameterMaskByType(GpuConstantType type)
Return the parameter mask of by the given parameter type (I.E: X|Y for FLOAT2 etc....
Container class for shader based programs.
A class that represents a shader based program.
Reference-counted shared pointer, used for objects where implicit destruction is required.
GpuConstantType
Enumeration of the types of constant we may encounter in programs.
GpuProgramType
Enumerates the types of programs which can run on the GPU.
_StringBase String
MergeCombination(int float1Count, int float1Mask, int float2Count, int float2Mask, int float3Count, int float3Mask, int float4Count, int float4Mask)
std::map< K, V, P, A > type
std::vector< T, A > type