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 
31 #include "OgreShaderProgramWriterManager.h"
32 
33 namespace Ogre {
34 	namespace RTShader {
35 
36 /** \addtogroup Core
37 *  @{
38 */
39 /** \addtogroup RTShader
40 *  @{
41 */
42 
43 /** HLSL target language writer implementation.
44 @see ProgramWriter.
45 */
46 class _OgreRTSSExport HLSLProgramWriter : public ProgramWriter
47 {
48 
49 	// Interface.
50 public:
51 
52 	/** Class constructor.
53 	*/
54 	HLSLProgramWriter();
55 
56 	/** Class destructor */
57 	virtual ~HLSLProgramWriter();
58 
59 	/**
60 	@see ProgramWriter::writeSourceCode.
61 	*/
62 	virtual void writeSourceCode(std::ostream& os, Program* program);
63 
64 	/**
65 	@see ProgramWriter::getTargetLanguage.
66 	*/
getTargetLanguage()67 	virtual const String& getTargetLanguage() const { return TargetLanguage; }
68 
69 	static String TargetLanguage;
70 
71 	// Protected methods.
72 protected:
73 
74 	/** Initialize string maps. */
75 	void initializeStringMaps();
76 
77 	/** Write the program dependencies. */
78 	void writeProgramDependencies(std::ostream& os, Program* program);
79 
80 	/** Write a uniform parameter. */
81 	void writeUniformParameter(std::ostream& os, UniformParameterPtr parameter);
82 
83 	/** Write a function parameter. */
84 	void writeFunctionParameter(std::ostream& os, ParameterPtr parameter, const char* forcedSemantic);
85 
86 	/** Write a local parameter. */
87 	void writeLocalParameter(std::ostream& os, ParameterPtr parameter);
88 
89 	/** Write a function declaration. */
90 	void writeFunctionDeclaration(std::ostream& os, Function* function);
91 
92 	/** Write function atom instance. */
93 	void writeAtomInstance(std::ostream& os, FunctionAtom* atom);
94 
95 protected:
96 	typedef	map<GpuConstantType, const char*>::type		GpuConstTypeToStringMap;
97 	typedef	map<Parameter::Semantic, const char*>::type	ParamSemanticToStringMap;
98 
99 	// Attributes.
100 protected:
101 	// Map between GPU constant type to string value.
102 	GpuConstTypeToStringMap mGpuConstTypeMap;
103 	// Map between parameter semantic to string value.
104 	ParamSemanticToStringMap mParamSemanticMap;
105 };
106 
107 /** HLSL program writer factory implementation.
108 @see ProgramWriterFactory
109 */
110 class _OgreRTSSExport ShaderProgramWriterHLSLFactory : public ProgramWriterFactory
111 {
112 public:
ShaderProgramWriterHLSLFactory()113 	ShaderProgramWriterHLSLFactory()
114 	{
115 		mLanguage = "hlsl";
116 	}
~ShaderProgramWriterHLSLFactory()117 	virtual ~ShaderProgramWriterHLSLFactory() {}
118 
119 	/**
120 	@see ProgramWriterFactory::getTargetLanguage
121 	*/
getTargetLanguage(void)122 	virtual const String& getTargetLanguage(void) const
123 	{
124 		return mLanguage;
125 	}
126 
127 	/**
128 	@see ProgramWriterFactory::create
129 	*/
create(void)130 	virtual ProgramWriter* create(void)
131 	{
132 		return OGRE_NEW HLSLProgramWriter();
133 	}
134 
135 private:
136 	String mLanguage;
137 
138 };
139 
140 
141 /** @} */
142 /** @} */
143 }
144 }
145 
146 #endif
147