OgreShaderGLSLESProgramWriter.h
Go to the documentation of this file.
/*
-----------------------------------------------------------------------------
This source file is part of OGRE
(Object-oriented Graphics Rendering Engine)
For the latest info, see http://www.ogre3d.org
Copyright (c) 2000-2013 Torus Knot Software Ltd
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
-----------------------------------------------------------------------------
*/
#ifndef _ShaderProgramWriterGLSLES_
#define _ShaderProgramWriterGLSLES_
#include "OgreShaderProgramWriterManager.h"
namespace Ogre {
namespace RTShader {
class GLSLESProgramWriter : public ProgramWriter
{
// Interface.
public:
GLSLESProgramWriter ();
virtual ~GLSLESProgramWriter ();
virtual void writeSourceCode (std::ostream& os, Program* program);
virtual const String& getTargetLanguage () const { return TargetLanguage; }
static String TargetLanguage;
protected:
typedef map<GpuConstantType, const char*>::type GpuConstTypeToStringMap;
typedef map<Parameter::Semantic, const char*>::type ParamSemanticToStringMap;
typedef map<Parameter::Content, const char*> ::type ParamContentToStringMap;
typedef map<String, String>::type StringMap;
typedef map<FunctionInvocation, String>::type FunctionMap;
typedef vector<FunctionInvocation>::type FunctionVector;
typedef FunctionMap::const_iterator FunctionMapIterator;
typedef FunctionVector::const_iterator FunctionVectorIterator;
typedef GpuConstTypeToStringMap::const_iterator GpuConstTypeToStringMapIterator;
// Protected methods.
protected:
void initializeStringMaps ();
virtual void cacheDependencyFunctions(const String & libName);
FunctionInvocation *createInvocationFromString (const String & input);
void writeProgramDependencies (std::ostream& os, Program* program);
void writeLocalParameter (std::ostream& os, ParameterPtr parameter);
void writeInputParameters (std::ostream& os, Function* function, GpuProgramType gpuType);
void writeOutParameters (std::ostream& os, Function* function, GpuProgramType gpuType);
String processOperand(Operand op, GpuProgramType gpuType);
bool isBasicType(String &type);
void discoverFunctionDependencies(const FunctionInvocation &invoc, FunctionVector &depVector);
// Attributes.
protected:
GpuConstTypeToStringMap mGpuConstTypeMap; // Map between GPU constant type to string value.
ParamSemanticToStringMap mParamSemanticMap; // Map between parameter semantic to string value.
StringMap mInputToGLStatesMap; // Map parameter name to a new parameter name (sometimes renaming is required to match names between vertex and fragment shader)
FunctionMap mFunctionCacheMap; // Map function invocation to body. Used as a cache to reduce library file reads and for inlining
StringMap mDefinesMap; // Map of #defines and the function library that contains them
ParamContentToStringMap mContentToPerVertexAttributes; // Map parameter content to vertex attributes
int mGLSLVersion; // Holds the current glsl es version
StringVector mFragInputParams; // Holds the fragment input params
StringMap mCachedFunctionLibraries; // Holds the cached function libraries
};
class ShaderProgramWriterGLSLESFactory : public ProgramWriterFactory
{
public:
ShaderProgramWriterGLSLESFactory() : mLanguage("glsles")
{
}
virtual ~ShaderProgramWriterGLSLESFactory() {}
virtual const String& getTargetLanguage(void) const
{
return mLanguage;
}
virtual ProgramWriter* create(void)
{
return OGRE_NEW GLSLESProgramWriter();
}
private:
String mLanguage;
};
}
}
#endif
Ogre::RTShader::GLSLESProgramWriter::~GLSLESProgramWriter
virtual ~GLSLESProgramWriter()
Class destructor.
Ogre::RTShader::ProgramWriterFactory
Interface definition for factories of ShaderProgramWriter.
Definition: OgreShaderProgramWriterManager.h:46
Ogre::RTShader::ShaderProgramWriterGLSLESFactory::getTargetLanguage
virtual const String & getTargetLanguage(void) const
Definition: OgreShaderGLSLESProgramWriter.h:142
Ogre::RTShader::ShaderProgramWriterGLSLESFactory::~ShaderProgramWriterGLSLESFactory
virtual ~ShaderProgramWriterGLSLESFactory()
Definition: OgreShaderGLSLESProgramWriter.h:137
Ogre::RTShader::ShaderProgramWriterGLSLESFactory::mLanguage
String mLanguage
Definition: OgreShaderGLSLESProgramWriter.h:156
Ogre::RTShader::GLSLESProgramWriter::createInvocationFromString
FunctionInvocation * createInvocationFromString(const String &input)
Create a FunctionInvocation object from a string taken out of a shader library.
Ogre::RTShader::GLSLESProgramWriter::getTargetLanguage
virtual const String & getTargetLanguage() const
Definition: OgreShaderGLSLESProgramWriter.h:66
Ogre::vector::type
std::vector< T, A > type
Definition: OgrePrerequisites.h:494
Ogre::RTShader::GLSLESProgramWriter::GpuConstTypeToStringMap
map< GpuConstantType, const char * >::type GpuConstTypeToStringMap
Definition: OgreShaderGLSLESProgramWriter.h:71
Ogre::RTShader::GLSLESProgramWriter::StringMap
map< String, String >::type StringMap
Definition: OgreShaderGLSLESProgramWriter.h:74
Ogre::RTShader::GLSLESProgramWriter::mParamSemanticMap
ParamSemanticToStringMap mParamSemanticMap
Definition: OgreShaderGLSLESProgramWriter.h:117
Ogre::RTShader::ShaderProgramWriterGLSLESFactory
GLSL ES program writer factory implementation.
Definition: OgreShaderGLSLESProgramWriter.h:131
Ogre::StringVector
vector< String >::type StringVector
Definition: OgreStringVector.h:45
Ogre::RTShader::GLSLESProgramWriter::isBasicType
bool isBasicType(String &type)
Check if a string matches one of the GLSL ES basic types.
Ogre::RTShader::ShaderProgramWriterGLSLESFactory::ShaderProgramWriterGLSLESFactory
ShaderProgramWriterGLSLESFactory()
Definition: OgreShaderGLSLESProgramWriter.h:134
OGRE_NEW
#define OGRE_NEW
Definition: OgreMemoryAllocatorConfig.h:473
Ogre::RTShader::GLSLESProgramWriter::writeProgramDependencies
void writeProgramDependencies(std::ostream &os, Program *program)
Write the program dependencies.
Ogre::RTShader::GLSLESProgramWriter::mContentToPerVertexAttributes
ParamContentToStringMap mContentToPerVertexAttributes
Definition: OgreShaderGLSLESProgramWriter.h:122
Ogre::RTShader::GLSLESProgramWriter::GLSLESProgramWriter
GLSLESProgramWriter()
Class constructor.
Ogre::RTShader::GLSLESProgramWriter::ParamSemanticToStringMap
map< Parameter::Semantic, const char * >::type ParamSemanticToStringMap
Definition: OgreShaderGLSLESProgramWriter.h:72
Ogre::RTShader::GLSLESProgramWriter::cacheDependencyFunctions
virtual void cacheDependencyFunctions(const String &libName)
Cache functions of a dependency.
Ogre::RTShader::FunctionInvocation
A class that represents function invocation code from shader based program function.
Definition: OgreShaderFunctionAtom.h:178
Ogre::RTShader::GLSLESProgramWriter::writeInputParameters
void writeInputParameters(std::ostream &os, Function *function, GpuProgramType gpuType)
Write the input params of the function.
Ogre::RTShader::ProgramWriter
Base class interface for shader program writers.
Definition: OgreShaderProgramWriter.h:52
Ogre::RTShader::GLSLESProgramWriter::TargetLanguage
static String TargetLanguage
Definition: OgreShaderGLSLESProgramWriter.h:68
Ogre::RTShader::GLSLESProgramWriter::ParamContentToStringMap
map< Parameter::Content, const char * >::type ParamContentToStringMap
Definition: OgreShaderGLSLESProgramWriter.h:73
Ogre::RTShader::GLSLESProgramWriter::processOperand
String processOperand(Operand op, GpuProgramType gpuType)
Ogre::RTShader::GLSLESProgramWriter
GLSL ES target language writer implementation.
Definition: OgreShaderGLSLESProgramWriter.h:45
Ogre::RTShader::GLSLESProgramWriter::mGLSLVersion
int mGLSLVersion
Definition: OgreShaderGLSLESProgramWriter.h:123
Ogre::RTShader::Program
A class that represents a shader based program.
Definition: OgreShaderProgram.h:50
Ogre::String
_StringBase String
Definition: OgrePrerequisites.h:439
OgreShaderProgramWriterManager.h
Ogre::RTShader::GLSLESProgramWriter::FunctionVector
vector< FunctionInvocation >::type FunctionVector
Definition: OgreShaderGLSLESProgramWriter.h:76
Ogre::GpuProgramType
GpuProgramType
Enumerates the types of programs which can run on the GPU.
Definition: OgreGpuProgram.h:50
Ogre::RTShader::GLSLESProgramWriter::mInputToGLStatesMap
StringMap mInputToGLStatesMap
Definition: OgreShaderGLSLESProgramWriter.h:119
Ogre::RTShader::Operand
A class that represents a function operand (its the combination of a parameter the in/out semantic an...
Definition: OgreShaderFunctionAtom.h:80
Ogre
Definition: OgreAndroidLogListener.h:34
Ogre::RTShader::GLSLESProgramWriter::mCachedFunctionLibraries
StringMap mCachedFunctionLibraries
Definition: OgreShaderGLSLESProgramWriter.h:125
Ogre::RTShader::Function
A class that represents a shader based program function.
Definition: OgreShaderFunction.h:46
Ogre::RTShader::GLSLESProgramWriter::writeLocalParameter
void writeLocalParameter(std::ostream &os, ParameterPtr parameter)
Write a local parameter.
Ogre::RTShader::GLSLESProgramWriter::writeSourceCode
virtual void writeSourceCode(std::ostream &os, Program *program)
Ogre::RTShader::GLSLESProgramWriter::initializeStringMaps
void initializeStringMaps()
Initialize string maps.
Ogre::SharedPtr< Parameter >
Ogre::RTShader::GLSLESProgramWriter::writeOutParameters
void writeOutParameters(std::ostream &os, Function *function, GpuProgramType gpuType)
Write the output params of the function.
Ogre::RTShader::GLSLESProgramWriter::FunctionVectorIterator
FunctionVector::const_iterator FunctionVectorIterator
Definition: OgreShaderGLSLESProgramWriter.h:78
Ogre::RTShader::GLSLESProgramWriter::mGpuConstTypeMap
GpuConstTypeToStringMap mGpuConstTypeMap
Definition: OgreShaderGLSLESProgramWriter.h:116
Ogre::map
Definition: OgrePrerequisites.h:533
Ogre::RTShader::GLSLESProgramWriter::discoverFunctionDependencies
void discoverFunctionDependencies(const FunctionInvocation &invoc, FunctionVector &depVector)
Search within a function body for non-builtin functions that a given function invocation depends on...
Ogre::RTShader::ShaderProgramWriterGLSLESFactory::create
virtual ProgramWriter * create(void)
Definition: OgreShaderGLSLESProgramWriter.h:150
Ogre::RTShader::GLSLESProgramWriter::FunctionMap
map< FunctionInvocation, String >::type FunctionMap
Definition: OgreShaderGLSLESProgramWriter.h:75
Ogre::RTShader::GLSLESProgramWriter::FunctionMapIterator
FunctionMap::const_iterator FunctionMapIterator
Definition: OgreShaderGLSLESProgramWriter.h:77
Ogre::RTShader::GLSLESProgramWriter::mFunctionCacheMap
FunctionMap mFunctionCacheMap
Definition: OgreShaderGLSLESProgramWriter.h:120
Ogre::RTShader::GLSLESProgramWriter::mFragInputParams
StringVector mFragInputParams
Definition: OgreShaderGLSLESProgramWriter.h:124
Ogre::RTShader::GLSLESProgramWriter::GpuConstTypeToStringMapIterator
GpuConstTypeToStringMap::const_iterator GpuConstTypeToStringMapIterator
Definition: OgreShaderGLSLESProgramWriter.h:79
Ogre::RTShader::GLSLESProgramWriter::mDefinesMap
StringMap mDefinesMap
Definition: OgreShaderGLSLESProgramWriter.h:121

Copyright © 2012 Torus Knot Software Ltd
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.