ported PrtView plugin
[xonotic/netradiant.git] / include / irender.h
1 /*
2 Copyright (C) 2001-2006, William Joseph.
3 All Rights Reserved.
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_IRENDER_H)
23 #define INCLUDED_IRENDER_H
24
25 #include "generic/constant.h"
26
27
28 // Rendering states to sort by.
29 // Higher bits have the most effect - slowest state changes should be highest.
30
31 const unsigned int RENDER_DEFAULT = 0;
32 const unsigned int RENDER_LINESTIPPLE = 1 << 0; // glEnable(GL_LINE_STIPPLE)
33 const unsigned int RENDER_LINESMOOTH = 1 << 1; // glEnable(GL_LINE_SMOOTH)
34 const unsigned int RENDER_POLYGONSTIPPLE = 1 << 2; // glEnable(GL_POLYGON_STIPPLE)
35 const unsigned int RENDER_POLYGONSMOOTH = 1 << 3; // glEnable(GL_POLYGON_SMOOTH)
36 const unsigned int RENDER_ALPHATEST = 1 << 4; // glEnable(GL_ALPHA_TEST)
37 const unsigned int RENDER_DEPTHTEST = 1 << 5; // glEnable(GL_DEPTH_TEST)
38 const unsigned int RENDER_DEPTHWRITE = 1 << 6; // glDepthMask(GL_TRUE)
39 const unsigned int RENDER_COLOURWRITE = 1 << 7; // glColorMask(GL_TRUE; GL_TRUE; GL_TRUE; GL_TRUE)
40 const unsigned int RENDER_CULLFACE = 1 << 8; // glglEnable(GL_CULL_FACE)
41 const unsigned int RENDER_SCALED = 1 << 9; // glEnable(GL_NORMALIZE)
42 const unsigned int RENDER_SMOOTH = 1 << 10; // glShadeModel
43 const unsigned int RENDER_FOG = 1 << 11; // glEnable(GL_FOG)
44 const unsigned int RENDER_LIGHTING = 1 << 12; // glEnable(GL_LIGHTING)
45 const unsigned int RENDER_BLEND = 1 << 13; // glEnable(GL_BLEND)
46 const unsigned int RENDER_OFFSETLINE = 1 << 14; // glEnable(GL_POLYGON_OFFSET_LINE)
47 const unsigned int RENDER_FILL = 1 << 15; // glPolygonMode
48 const unsigned int RENDER_COLOURARRAY = 1 << 16; // glEnableClientState(GL_COLOR_ARRAY)
49 const unsigned int RENDER_COLOURCHANGE = 1 << 17; // render() is allowed to call glColor*()
50 const unsigned int RENDER_TEXTURE = 1 << 18; // glEnable(GL_TEXTURE_2D)
51 const unsigned int RENDER_BUMP = 1 << 19;
52 const unsigned int RENDER_PROGRAM = 1 << 20;
53 const unsigned int RENDER_SCREEN = 1 << 21;
54 const unsigned int RENDER_OVERRIDE = 1 << 22;
55 typedef unsigned int RenderStateFlags;
56
57
58 class AABB;
59 class Matrix4;
60
61 template<typename Element> class BasicVector3;
62 typedef BasicVector3<float> Vector3;
63
64 class Shader;
65
66 class RendererLight
67 {
68 public:
69   virtual Shader* getShader() const = 0;
70   virtual const AABB& aabb() const = 0;
71   virtual bool testAABB(const AABB& other) const = 0;
72   virtual const Matrix4& rotation() const = 0;
73   virtual const Vector3& offset() const = 0;
74   virtual const Vector3& colour() const = 0;
75   virtual bool isProjected() const = 0;
76   virtual const Matrix4& projection() const = 0;
77 };
78
79 class LightCullable
80 {
81 public:
82   virtual bool testLight(const RendererLight& light) const = 0;
83   virtual void insertLight(const RendererLight& light)
84   {
85   }
86   virtual void clearLights()
87   {
88   }
89 };
90
91 template<typename FirstArgument>
92 class Callback1;
93
94 class Renderable;
95 typedef Callback1<const Renderable&> RenderableCallback;
96
97 typedef Callback1<const RendererLight&> RendererLightCallback;
98
99 class LightList
100 {
101 public:
102   virtual void evaluateLights() const = 0;
103   virtual void lightsChanged() const = 0;
104   virtual void forEachLight(const RendererLightCallback& callback) const = 0;
105 };
106
107 const int c_attr_TexCoord0 = 1;
108 const int c_attr_Tangent = 3;
109 const int c_attr_Binormal = 4;
110
111 class OpenGLRenderable
112 {
113 public:
114   virtual void render(RenderStateFlags state) const = 0;
115 };
116
117 class Matrix4;
118 struct qtexture_t;
119 class ModuleObserver;
120
121 #include "math/vector.h"
122
123 class Shader
124 {
125 public:
126   virtual void addRenderable(const OpenGLRenderable& renderable, const Matrix4& modelview, const LightList* lights = 0) = 0;
127   virtual void incrementUsed() = 0;
128   virtual void decrementUsed() = 0;
129   virtual void attach(ModuleObserver& observer) = 0;
130   virtual void detach(ModuleObserver& observer) = 0;
131   virtual qtexture_t& getTexture() const = 0;
132   virtual unsigned int getFlags() const = 0;
133 };
134
135 class ShaderCache
136 {
137 public:
138   INTEGER_CONSTANT(Version, 1);
139   STRING_CONSTANT(Name, "renderstate");
140
141   virtual Shader* capture(const char* name) = 0;
142   virtual void release(const char* name) = 0;
143   /*! Render all Shader objects. */
144   virtual void render(RenderStateFlags globalstate, const Matrix4& modelview, const Matrix4& projection, const Vector3& viewer = Vector3(0, 0, 0)) = 0;
145
146   virtual void realise() = 0;
147   virtual void unrealise() = 0;
148
149   virtual bool lightingSupported() const = 0;
150   virtual bool useShaderLanguage() const = 0;
151
152   virtual const LightList& attach(LightCullable& cullable) = 0;
153   virtual void detach(LightCullable& cullable) = 0;
154   virtual void changed(LightCullable& cullable) = 0;
155   virtual void attach(RendererLight& light) = 0;
156   virtual void detach(RendererLight& light) = 0;
157   virtual void changed(RendererLight& light) = 0;
158
159   virtual void attachRenderable(const Renderable& renderable) = 0;
160   virtual void detachRenderable(const Renderable& renderable) = 0;
161   virtual void forEachRenderable(const RenderableCallback& callback) const = 0;
162 };
163
164 #include "modulesystem.h"
165
166 template<typename Type>
167 class GlobalModule;
168 typedef GlobalModule<ShaderCache> GlobalShaderCacheModule;
169
170 template<typename Type>
171 class GlobalModuleRef;
172 typedef GlobalModuleRef<ShaderCache> GlobalShaderCacheModuleRef;
173
174 inline ShaderCache& GlobalShaderCache()
175 {
176   return GlobalShaderCacheModule::getTable();
177 }
178
179 #endif