include/ishaders.h

   1 /*
   2    Copyright (C) 1999-2006 Id Software, Inc. and contributors.
   3    For a list of contributors, see the accompanying CONTRIBUTORS file.
   4
   5    This file is part of GtkRadiant.
   6
   7    GtkRadiant is free software; you can redistribute it and/or modify
   8    it under the terms of the GNU General Public License as published by
   9    the Free Software Foundation; either version 2 of the License, or
  10    (at your option) any later version.
  11
  12    GtkRadiant is distributed in the hope that it will be useful,
  13    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15    GNU General Public License for more details.
  16
  17    You should have received a copy of the GNU General Public License
  18    along with GtkRadiant; if not, write to the Free Software
  19    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  20  */
  21
  22 #if !defined( INCLUDED_ISHADERS_H )
  23 #define INCLUDED_ISHADERS_H
  24
  25 #include "generic/constant.h"
  26 #include "generic/callbackfwd.h"
  27
  28 enum
  29 {
  30         QER_TRANS = 1 << 0,
  31         QER_NOCARVE = 1 << 1,
  32         QER_NODRAW = 1 << 2,
  33         QER_NONSOLID = 1 << 3,
  34         QER_WATER = 1 << 4,
  35         QER_LAVA = 1 << 5,
  36         QER_FOG = 1 << 6,
  37         QER_ALPHATEST = 1 << 7,
  38         QER_CULL = 1 << 8,
  39         QER_AREAPORTAL = 1 << 9,
  40         QER_CLIP = 1 << 10,
  41         QER_BOTCLIP = 1 << 11,
  42 };
  43
  44 struct qtexture_t;
  45
  46 template<typename Element> class BasicVector3;
  47 typedef BasicVector3<float> Vector3;
  48 typedef Vector3 Colour3;
  49
  50 typedef unsigned char BlendFactor;
  51 const BlendFactor BLEND_ZERO = 0;
  52 const BlendFactor BLEND_ONE = 1;
  53 const BlendFactor BLEND_SRC_COLOUR = 2;
  54 const BlendFactor BLEND_ONE_MINUS_SRC_COLOUR = 3;
  55 const BlendFactor BLEND_SRC_ALPHA = 4;
  56 const BlendFactor BLEND_ONE_MINUS_SRC_ALPHA = 5;
  57 const BlendFactor BLEND_DST_COLOUR = 6;
  58 const BlendFactor BLEND_ONE_MINUS_DST_COLOUR = 7;
  59 const BlendFactor BLEND_DST_ALPHA = 8;
  60 const BlendFactor BLEND_ONE_MINUS_DST_ALPHA = 9;
  61 const BlendFactor BLEND_SRC_ALPHA_SATURATE = 10;
  62
  63 class BlendFunc
  64 {
  65 public:
  66 BlendFunc( BlendFactor src, BlendFactor dst ) : m_src( src ), m_dst( dst ){
  67 }
  68 BlendFactor m_src;
  69 BlendFactor m_dst;
  70 };
  71
  72 class ShaderLayer
  73 {
  74 public:
  75 virtual qtexture_t* texture() const = 0;
  76 virtual BlendFunc blendFunc() const = 0;
  77 virtual bool clampToBorder() const = 0;
  78 virtual float alphaTest() const = 0;
  79 };
  80
  81 typedef Callback1<const ShaderLayer&> ShaderLayerCallback;
  82
  83
  84 class IShader
  85 {
  86 public:
  87 enum EAlphaFunc
  88 {
  89         eAlways,
  90         eEqual,
  91         eLess,
  92         eGreater,
  93         eLEqual,
  94         eGEqual,
  95 };
  96 enum ECull
  97 {
  98         eCullNone,
  99         eCullBack,
 100 };
 101 // Increment the number of references to this object
 102 virtual void IncRef() = 0;
 103 // Decrement the reference count
 104 virtual void DecRef() = 0;
 105 // get/set the qtexture_t* Radiant uses to represent this shader object
 106 virtual qtexture_t* getTexture() const = 0;
 107 virtual qtexture_t* getDiffuse() const = 0;
 108 virtual qtexture_t* getBump() const = 0;
 109 virtual qtexture_t* getSpecular() const = 0;
 110 // get shader name
 111 virtual const char* getName() const = 0;
 112 virtual bool IsInUse() const = 0;
 113 virtual void SetInUse( bool bInUse ) = 0;
 114 // get the editor flags (QER_NOCARVE QER_TRANS)
 115 virtual int getFlags() const = 0;
 116 // get the transparency value
 117 virtual float getTrans() const = 0;
 118 // test if it's a true shader, or a default shader created to wrap around a texture
 119 virtual bool IsDefault() const = 0;
 120 // get the alphaFunc
 121 virtual void getAlphaFunc( EAlphaFunc *func, float *ref ) = 0;
 122 virtual BlendFunc getBlendFunc() const = 0;
 123 // get the cull type
 124 virtual ECull getCull() = 0;
 125 // get shader file name (ie the file where this one is defined)
 126 virtual const char* getShaderFileName() const = 0;
 127
 128 virtual const ShaderLayer* firstLayer() const = 0;
 129 virtual void forEachLayer( const ShaderLayerCallback& layer ) const = 0;
 130
 131 virtual qtexture_t* lightFalloffImage() const = 0;
 132 };
 133
 134 typedef struct _GSList GSList;
 135 typedef Callback1<const char*> ShaderNameCallback;
 136
 137 class ModuleObserver;
 138
 139 class ShaderSystem
 140 {
 141 public:
 142 INTEGER_CONSTANT( Version, 1 );
 143 STRING_CONSTANT( Name, "shaders" );
 144 // NOTE: shader and texture names used must be full path.
 145 // Shaders usable as textures have prefix equal to getTexturePrefix()
 146
 147 virtual void realise() = 0;
 148 virtual void unrealise() = 0;
 149 virtual void refresh() = 0;
 150 // activate the shader for a given name and return it
 151 // will return the default shader if name is not found
 152 virtual IShader* getShaderForName( const char* name ) = 0;
 153
 154 virtual void foreachShaderName( const ShaderNameCallback& callback ) = 0;
 155
 156 // iterate over the list of active shaders
 157 virtual void beginActiveShadersIterator() = 0;
 158 virtual bool endActiveShadersIterator() = 0;
 159 virtual IShader* dereferenceActiveShadersIterator() = 0;
 160 virtual void incrementActiveShadersIterator() = 0;
 161
 162 virtual void setActiveShadersChangedNotify( const Callback& notify ) = 0;
 163
 164 virtual void attach( ModuleObserver& observer ) = 0;
 165 virtual void detach( ModuleObserver& observer ) = 0;
 166
 167 virtual void setLightingEnabled( bool enabled ) = 0;
 168
 169 virtual const char* getTexturePrefix() const = 0;
 170 };
 171
 172 #include "modulesystem.h"
 173
 174 template<typename Type>
 175 class GlobalModule;
 176 typedef GlobalModule<ShaderSystem> GlobalShadersModule;
 177
 178 template<typename Type>
 179 class GlobalModuleRef;
 180 typedef GlobalModuleRef<ShaderSystem> GlobalShadersModuleRef;
 181
 182 inline ShaderSystem& GlobalShaderSystem(){
 183         return GlobalShadersModule::getTable();
 184 }
 185
 186
 187 #define QERApp_Shader_ForName GlobalShaderSystem().getShaderForName
 188 #define QERApp_ActiveShaders_IteratorBegin GlobalShaderSystem().beginActiveShadersIterator
 189 #define QERApp_ActiveShaders_IteratorAtEnd GlobalShaderSystem().endActiveShadersIterator
 190 #define QERApp_ActiveShaders_IteratorCurrent GlobalShaderSystem().dereferenceActiveShadersIterator
 191 #define QERApp_ActiveShaders_IteratorIncrement GlobalShaderSystem().incrementActiveShadersIterator
 192
 193 #endif