shaderDependency.h

Engine/source/shaderGen/shaderDependency.h

More...

Classes:

Detailed Description

 1
 2//-----------------------------------------------------------------------------
 3// Copyright (c) 2012 GarageGames, LLC
 4//
 5// Permission is hereby granted, free of charge, to any person obtaining a copy
 6// of this software and associated documentation files (the "Software"), to
 7// deal in the Software without restriction, including without limitation the
 8// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
 9// sell copies of the Software, and to permit persons to whom the Software is
10// furnished to do so, subject to the following conditions:
11//
12// The above copyright notice and this permission notice shall be included in
13// all copies or substantial portions of the Software.
14//
15// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
21// IN THE SOFTWARE.
22//-----------------------------------------------------------------------------
23
24#ifndef _SHADER_DEPENDENCY_H_
25#define _SHADER_DEPENDENCY_H_
26
27#ifndef _PATH_H_
28#include "core/util/path.h"
29#endif
30
31
32class Stream;
33
34
35/// The base class for shader dependencies
36class ShaderDependency
37{
38public:
39   virtual ~ShaderDependency() {}
40   
41   /// Compare this dependency to another one.
42   virtual bool operator==( const ShaderDependency &cmpTo ) const 
43   { 
44      return this == &cmpTo; 
45   }
46
47   /// Print the dependency into the header of a shader.
48   virtual void print( Stream &s ) const = 0;
49};
50
51
52/// A shader dependency for adding #include's into shadergen shaders.
53class ShaderIncludeDependency : public ShaderDependency
54{
55protected:
56
57   Torque::Path mIncludePath;
58
59public:
60
61   ShaderIncludeDependency( const Torque::Path &pathToInclude );
62
63   virtual bool operator==( const ShaderDependency &cmpTo ) const;
64   virtual void print( Stream &s ) const;
65};
66
67#endif // _SHADER_DEPENDENCY_H_
68