OgreShaderHLSLProgramWriter.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 __ShaderProgramWriterHLSL_H__
29 #define __ShaderProgramWriterHLSL_H__
30 
32 
33 namespace Ogre {
34  namespace RTShader {
35 
47 {
48 
49  // Interface.
50 public:
51 
55 
57  virtual ~HLSLProgramWriter();
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 
75  void initializeStringMaps();
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, const char* forcedSemantic);
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 protected:
98 
99  // Attributes.
100 protected:
101  // Map between GPU constant type to string value.
103  // Map between parameter semantic to string value.
105 };
106 
111 {
112 public:
114  {
115  mLanguage = "hlsl";
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 HLSLProgramWriter();
133  }
134 
135 private:
137 
138 };
139 
140 
143 }
144 }
145 
146 #endif
Ogre
Definition: OgreAndroidLogListener.h:34
Ogre::map
Definition: OgrePrerequisites.h:533
OgreShaderProgramWriterManager.h
Ogre::RTShader::ShaderProgramWriterHLSLFactory::getTargetLanguage
virtual const String & getTargetLanguage(void) const
Definition: OgreShaderHLSLProgramWriter.h:122
Ogre::RTShader::ProgramWriter
Base class interface for shader program writers.
Definition: OgreShaderProgramWriter.h:52
Ogre::String
_StringBase String
Definition: OgrePrerequisites.h:439
Ogre::RTShader::ShaderProgramWriterHLSLFactory::~ShaderProgramWriterHLSLFactory
virtual ~ShaderProgramWriterHLSLFactory()
Definition: OgreShaderHLSLProgramWriter.h:117
Ogre::RTShader::ShaderProgramWriterHLSLFactory::create
virtual ProgramWriter * create(void)
Definition: OgreShaderHLSLProgramWriter.h:130
Ogre::RTShader::ShaderProgramWriterHLSLFactory::mLanguage
String mLanguage
Definition: OgreShaderHLSLProgramWriter.h:136
Ogre::RTShader::HLSLProgramWriter::TargetLanguage
static String TargetLanguage
Definition: OgreShaderHLSLProgramWriter.h:69
Ogre::RTShader::HLSLProgramWriter::mParamSemanticMap
ParamSemanticToStringMap mParamSemanticMap
Definition: OgreShaderHLSLProgramWriter.h:104
Ogre::RTShader::Program
A class that represents a shader based program.
Definition: OgreShaderProgram.h:50
Ogre::RTShader::HLSLProgramWriter::getTargetLanguage
virtual const String & getTargetLanguage() const
Definition: OgreShaderHLSLProgramWriter.h:67
Ogre::RTShader::HLSLProgramWriter::GpuConstTypeToStringMap
map< GpuConstantType, const char * >::type GpuConstTypeToStringMap
Definition: OgreShaderHLSLProgramWriter.h:96
Ogre::RTShader::FunctionAtom
A class that represents an atomic code section of shader based program function.
Definition: OgreShaderFunctionAtom.h:48
Ogre::RTShader::ShaderProgramWriterHLSLFactory
HLSL program writer factory implementation.
Definition: OgreShaderHLSLProgramWriter.h:110
Ogre::RTShader::ShaderProgramWriterHLSLFactory::ShaderProgramWriterHLSLFactory
ShaderProgramWriterHLSLFactory()
Definition: OgreShaderHLSLProgramWriter.h:113
Ogre::SharedPtr
Reference-counted shared pointer, used for objects where implicit destruction is required.
Definition: OgrePrerequisites.h:310
Ogre::RTShader::ProgramWriterFactory
Interface definition for factories of ShaderProgramWriter.
Definition: OgreShaderProgramWriterManager.h:46
Ogre::RTShader::HLSLProgramWriter::ParamSemanticToStringMap
map< Parameter::Semantic, const char * >::type ParamSemanticToStringMap
Definition: OgreShaderHLSLProgramWriter.h:97
OGRE_NEW
#define OGRE_NEW
Definition: OgreMemoryAllocatorConfig.h:473
Ogre::RTShader::HLSLProgramWriter::mGpuConstTypeMap
GpuConstTypeToStringMap mGpuConstTypeMap
Definition: OgreShaderHLSLProgramWriter.h:102
Ogre::RTShader::Function
A class that represents a shader based program function.
Definition: OgreShaderFunction.h:46
Ogre::RTShader::HLSLProgramWriter
HLSL target language writer implementation.
Definition: OgreShaderHLSLProgramWriter.h:46
_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.