OgreShaderCGProgramWriter.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 
9 Permission is hereby granted, free of charge, to any person obtaining a copy
10 of this software and associated documentation files (the "Software"), to deal
11 in the Software without restriction, including without limitation the rights
12 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13 copies of the Software, and to permit persons to whom the Software is
14 furnished to do so, subject to the following conditions:
15 
16 The above copyright notice and this permission notice shall be included in
17 all copies or substantial portions of the Software.
18 
19 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
25 THE SOFTWARE.
26 -----------------------------------------------------------------------------
27 */
28 #ifndef __ShaderProgramWriterCG_H__
29 #define __ShaderProgramWriterCG_H__
30 
32 
33 namespace Ogre {
34 namespace RTShader {
35 
47 {
48 
49 // Interface.
50 public:
51 
55 
57  virtual ~CGProgramWriter();
58 
62  virtual void writeSourceCode(std::ostream& os, Program* program);
63 
67  virtual const String& getTargetLanguage() const { return TargetLanguage; }
68 
70 
71 // Protected methods.
72 protected:
73 
76 
78  void writeProgramDependencies(std::ostream& os, Program* program);
79 
81  void writeUniformParameter(std::ostream& os, UniformParameterPtr parameter);
82 
84  void writeFunctionParameter(std::ostream& os, ParameterPtr parameter);
85 
87  void writeLocalParameter(std::ostream& os, ParameterPtr parameter);
88 
90  void writeFunctionDeclaration(std::ostream& os, Function* function);
91 
93  void writeAtomInstance(std::ostream& os, FunctionAtom* atom);
94 
95 
96 protected:
99 
100 // Attributes.
101 protected:
102  // Map between GPU constant type to string value.
104  // Map between parameter semantic to string value.
106 };
107 
112 {
113 public:
114  ShaderProgramWriterCGFactory() : mLanguage("cg")
115  {
116  }
118 
122  virtual const String& getTargetLanguage(void) const
123  {
124  return mLanguage;
125  }
126 
130  virtual ProgramWriter* create(void)
131  {
132  return OGRE_NEW CGProgramWriter();
133  }
134 
135 private:
137 
138 };
139 
142 }
143 }
144 
145 #endif
Ogre::RTShader::CGProgramWriter::writeLocalParameter
void writeLocalParameter(std::ostream &os, ParameterPtr parameter)
Write a local parameter.
Ogre::RTShader::CGProgramWriter::ParamSemanticToStringMap
map< Parameter::Semantic, const char * >::type ParamSemanticToStringMap
Definition: OgreShaderCGProgramWriter.h:98
Ogre::RTShader::ShaderProgramWriterCGFactory::create
virtual ProgramWriter * create(void)
Definition: OgreShaderCGProgramWriter.h:130
Ogre
Definition: OgreAndroidLogListener.h:35
Ogre::RTShader::ShaderProgramWriterCGFactory
CG program writer factory implementation.
Definition: OgreShaderCGProgramWriter.h:112
Ogre::RTShader::CGProgramWriter::TargetLanguage
static String TargetLanguage
Definition: OgreShaderCGProgramWriter.h:69
Ogre::map
Definition: OgrePrerequisites.h:534
Ogre::RTShader::CGProgramWriter::initializeStringMaps
void initializeStringMaps()
Initialize string maps.
OgreShaderProgramWriterManager.h
Ogre::RTShader::CGProgramWriter::writeFunctionParameter
void writeFunctionParameter(std::ostream &os, ParameterPtr parameter)
Write a function parameter.
Ogre::RTShader::ProgramWriter
Base class interface for shader program writers.
Definition: OgreShaderProgramWriter.h:53
Ogre::RTShader::ShaderProgramWriterCGFactory::~ShaderProgramWriterCGFactory
virtual ~ShaderProgramWriterCGFactory()
Definition: OgreShaderCGProgramWriter.h:117
Ogre::String
_StringBase String
Definition: OgrePrerequisites.h:439
Ogre::RTShader::CGProgramWriter::getTargetLanguage
virtual const String & getTargetLanguage() const
Definition: OgreShaderCGProgramWriter.h:67
Ogre::RTShader::CGProgramWriter
CG target language writer implementation.
Definition: OgreShaderCGProgramWriter.h:47
Ogre::RTShader::ShaderProgramWriterCGFactory::mLanguage
String mLanguage
Definition: OgreShaderCGProgramWriter.h:136
Ogre::RTShader::CGProgramWriter::writeUniformParameter
void writeUniformParameter(std::ostream &os, UniformParameterPtr parameter)
Write a uniform parameter.
Ogre::RTShader::Program
A class that represents a shader based program.
Definition: OgreShaderProgram.h:51
Ogre::RTShader::ShaderProgramWriterCGFactory::ShaderProgramWriterCGFactory
ShaderProgramWriterCGFactory()
Definition: OgreShaderCGProgramWriter.h:114
Ogre::RTShader::FunctionAtom
A class that represents an atomic code section of shader based program function.
Definition: OgreShaderFunctionAtom.h:49
Ogre::RTShader::CGProgramWriter::CGProgramWriter
CGProgramWriter()
Class constructor.
Ogre::RTShader::CGProgramWriter::writeFunctionDeclaration
void writeFunctionDeclaration(std::ostream &os, Function *function)
Write a function declaration.
Ogre::RTShader::CGProgramWriter::writeProgramDependencies
void writeProgramDependencies(std::ostream &os, Program *program)
Write the program dependencies.
Ogre::RTShader::CGProgramWriter::writeAtomInstance
void writeAtomInstance(std::ostream &os, FunctionAtom *atom)
Write function atom instance.
Ogre::SharedPtr
Reference-counted shared pointer, used for objects where implicit destruction is required.
Definition: OgreSharedPtr.h:112
Ogre::RTShader::CGProgramWriter::mGpuConstTypeMap
GpuConstTypeToStringMap mGpuConstTypeMap
Definition: OgreShaderCGProgramWriter.h:103
Ogre::RTShader::CGProgramWriter::GpuConstTypeToStringMap
map< GpuConstantType, const char * >::type GpuConstTypeToStringMap
Definition: OgreShaderCGProgramWriter.h:97
Ogre::RTShader::CGProgramWriter::~CGProgramWriter
virtual ~CGProgramWriter()
Class destructor.
Ogre::RTShader::ProgramWriterFactory
Interface definition for factories of ShaderProgramWriter.
Definition: OgreShaderProgramWriterManager.h:47
OGRE_NEW
#define OGRE_NEW
Definition: OgreMemoryAllocatorConfig.h:473
Ogre::RTShader::ShaderProgramWriterCGFactory::getTargetLanguage
virtual const String & getTargetLanguage(void) const
Definition: OgreShaderCGProgramWriter.h:122
Ogre::RTShader::CGProgramWriter::mParamSemanticMap
ParamSemanticToStringMap mParamSemanticMap
Definition: OgreShaderCGProgramWriter.h:105
Ogre::RTShader::Function
A class that represents a shader based program function.
Definition: OgreShaderFunction.h:47
Ogre::RTShader::CGProgramWriter::writeSourceCode
virtual void writeSourceCode(std::ostream &os, Program *program)
_OgreRTSSExport
#define _OgreRTSSExport
Definition: OgreShaderPrerequisites.h:108

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