OgreShaderGLSLESProgramWriter.h
Go to the documentation of this file.
1 /*
2 -----------------------------------------------------------------------------
3 This source file is part of OGRE
4 (Object-oriented Graphics Rendering Engine)
5 For the latest info, see http://www.ogre3d.org
6 
7 Copyright (c) 2000-2013 Torus Knot Software Ltd
8 Permission is hereby granted, free of charge, to any person obtaining a copy
9 of this software and associated documentation files (the "Software"), to deal
10 in the Software without restriction, including without limitation the rights
11 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12 copies of the Software, and to permit persons to whom the Software is
13 furnished to do so, subject to the following conditions:
14 
15 The above copyright notice and this permission notice shall be included in
16 all copies or substantial portions of the Software.
17 
18 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
24 THE SOFTWARE.
25 -----------------------------------------------------------------------------
26 */
27 #ifndef _ShaderProgramWriterGLSLES_
28 #define _ShaderProgramWriterGLSLES_
29 
31 
32 namespace Ogre {
33 namespace RTShader {
34 
46 {
47  // Interface.
48 public:
49 
53 
55  virtual ~GLSLESProgramWriter ();
56 
57 
61  virtual void writeSourceCode (std::ostream& os, Program* program);
62 
66  virtual const String& getTargetLanguage () const { return TargetLanguage; }
67 
69 
70  protected:
77  typedef FunctionMap::const_iterator FunctionMapIterator;
78  typedef FunctionVector::const_iterator FunctionVectorIterator;
79  typedef GpuConstTypeToStringMap::const_iterator GpuConstTypeToStringMapIterator;
80 
81  // Protected methods.
82 protected:
83 
85  void initializeStringMaps ();
86 
88  virtual void cacheDependencyFunctions(const String & libName);
89 
90 
93 
95  void writeProgramDependencies (std::ostream& os, Program* program);
96 
98  void writeLocalParameter (std::ostream& os, ParameterPtr parameter);
99 
101  void writeInputParameters (std::ostream& os, Function* function, GpuProgramType gpuType);
102 
104  void writeOutParameters (std::ostream& os, Function* function, GpuProgramType gpuType);
105 
107 
109  bool isBasicType(String &type);
110 
112  void discoverFunctionDependencies(const FunctionInvocation &invoc, FunctionVector &depVector);
113 
114  // Attributes.
115 protected:
116  GpuConstTypeToStringMap mGpuConstTypeMap; // Map between GPU constant type to string value.
117  ParamSemanticToStringMap mParamSemanticMap; // Map between parameter semantic to string value.
118 
119  StringMap mInputToGLStatesMap; // Map parameter name to a new parameter name (sometimes renaming is required to match names between vertex and fragment shader)
120  FunctionMap mFunctionCacheMap; // Map function invocation to body. Used as a cache to reduce library file reads and for inlining
121  StringMap mDefinesMap; // Map of #defines and the function library that contains them
122  ParamContentToStringMap mContentToPerVertexAttributes; // Map parameter content to vertex attributes
123  int mGLSLVersion; // Holds the current glsl es version
124  StringVector mFragInputParams; // Holds the fragment input params
125  StringMap mCachedFunctionLibraries; // Holds the cached function libraries
126 };
127 
132 {
133 public:
134  ShaderProgramWriterGLSLESFactory() : mLanguage("glsles")
135  {
136  }
138 
142  virtual const String& getTargetLanguage(void) const
143  {
144  return mLanguage;
145  }
146 
150  virtual ProgramWriter* create(void)
151  {
152  return OGRE_NEW GLSLESProgramWriter();
153  }
154 
155 private:
157 };
158 
162 }
163 }
164 
165 #endif
virtual ~GLSLESProgramWriter()
Class destructor.
Interface definition for factories of ShaderProgramWriter.
FunctionInvocation * createInvocationFromString(const String &input)
Create a FunctionInvocation object from a string taken out of a shader library.
virtual const String & getTargetLanguage() const
std::vector< T, A > type
map< GpuConstantType, const char * >::type GpuConstTypeToStringMap
GLSL ES program writer factory implementation.
vector< String >::type StringVector
bool isBasicType(String &type)
Check if a string matches one of the GLSL ES basic types.
#define OGRE_NEW
void writeProgramDependencies(std::ostream &os, Program *program)
Write the program dependencies.
GLSLESProgramWriter()
Class constructor.
map< Parameter::Semantic, const char * >::type ParamSemanticToStringMap
virtual void cacheDependencyFunctions(const String &libName)
Cache functions of a dependency.
A class that represents function invocation code from shader based program function.
void writeInputParameters(std::ostream &os, Function *function, GpuProgramType gpuType)
Write the input params of the function.
Base class interface for shader program writers.
map< Parameter::Content, const char * >::type ParamContentToStringMap
String processOperand(Operand op, GpuProgramType gpuType)
GLSL ES target language writer implementation.
A class that represents a shader based program.
_StringBase String
vector< FunctionInvocation >::type FunctionVector
GpuProgramType
Enumerates the types of programs which can run on the GPU.
A class that represents a function operand (its the combination of a parameter the in/out semantic an...
This source file is part of OGRE (Object-oriented Graphics Rendering Engine) For the latest info...
A class that represents a shader based program function.
void writeLocalParameter(std::ostream &os, ParameterPtr parameter)
Write a local parameter.
virtual void writeSourceCode(std::ostream &os, Program *program)
void initializeStringMaps()
Initialize string maps.
void writeOutParameters(std::ostream &os, Function *function, GpuProgramType gpuType)
Write the output params of the function.
FunctionVector::const_iterator FunctionVectorIterator
void discoverFunctionDependencies(const FunctionInvocation &invoc, FunctionVector &depVector)
Search within a function body for non-builtin functions that a given function invocation depends on...
map< FunctionInvocation, String >::type FunctionMap
GpuConstTypeToStringMap::const_iterator GpuConstTypeToStringMapIterator

Copyright © 2012 Torus Knot Software Ltd
Creative Commons License
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.
Last modified Sun Oct 22 2017 04:04:15