OGRE  2.0
Object-Oriented Graphics Rendering Engine
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
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-2014 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 
34 #include "OgreShaderParameter.h"
35 
36 namespace Ogre {
37 namespace RTShader {
38 
39  class Function;
40  class FunctionAtom;
41  class Program;
42 
54 {
55 
56 // Interface.
57 public:
58 
62 
64  virtual ~CGProgramWriter();
65 
69  virtual void writeSourceCode(std::ostream& os, Program* program);
70 
74  virtual const String& getTargetLanguage() const { return TargetLanguage; }
75 
77 
78 // Protected methods.
79 protected:
80 
82  void initializeStringMaps();
83 
85  void writeProgramDependencies(std::ostream& os, Program* program);
86 
88  void writeUniformParameter(std::ostream& os, UniformParameterPtr parameter);
89 
91  void writeFunctionParameter(std::ostream& os, ParameterPtr parameter);
92 
94  void writeLocalParameter(std::ostream& os, ParameterPtr parameter);
95 
97  void writeFunctionDeclaration(std::ostream& os, Function* function);
98 
100  void writeAtomInstance(std::ostream& os, FunctionAtom* atom);
101 
102 
103 protected:
106 
107 // Attributes.
108 protected:
109  // Map between GPU constant type to string value.
111  // Map between parameter semantic to string value.
113 };
114 
119 {
120 public:
121  ShaderProgramWriterCGFactory() : mLanguage("cg")
122  {
123  }
125 
129  virtual const String& getTargetLanguage(void) const
130  {
131  return mLanguage;
132  }
133 
137  virtual ProgramWriter* create(void)
138  {
139  return OGRE_NEW CGProgramWriter();
140  }
141 
142 private:
144 
145 };
146 
149 }
150 }
151 
152 #endif
CG program writer factory implementation.
Interface definition for factories of ShaderProgramWriter.
virtual const String & getTargetLanguage() const
map< GpuConstantType, const char * >::type GpuConstTypeToStringMap
#define _OgreRTSSExport
virtual const String & getTargetLanguage(void) const
ParamSemanticToStringMap mParamSemanticMap
map< Parameter::Semantic, const char * >::type ParamSemanticToStringMap
A class that represents a shader based program function.
Base class interface for shader program writers.
A class that represents an atomic code section of shader based program function.
A class that represents a shader based program.
#define OGRE_NEW
Reference-counted shared pointer, used for objects where implicit destruction is required.
_StringBase String
Definition: OgreCommon.h:53
CG target language writer implementation.