getting ARB shaders working again in GE.
[blender.git] / source / gameengine / BlenderRoutines / KX_BlenderCanvas.h
1 /**
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
19  *
20  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
21  * All rights reserved.
22  *
23  * The Original Code is: all of this file.
24  *
25  * Contributor(s): none yet.
26  *
27  * ***** END GPL LICENSE BLOCK *****
28  */
29 #ifndef __KX_BLENDERCANVAS
30 #define __KX_BLENDERCANVAS
31
32 #ifdef WIN32
33 #include <windows.h>
34 #endif 
35 #ifdef __APPLE__
36 #  define GL_GLEXT_LEGACY 1
37 #include <OpenGL/gl.h>
38 #else
39 #include <GL/gl.h>
40 #endif
41
42 #include "RAS_ICanvas.h"
43 #include "RAS_Rect.h"
44
45 #include "KX_BlenderGL.h"
46
47 struct ScrArea;
48
49 /**
50  * 2D Blender device context abstraction. 
51  * The connection from 3d rendercontext to 2d Blender surface embedding.
52  */
53
54 class KX_BlenderCanvas : public RAS_ICanvas
55 {
56 private:
57         /** Rect that defines the area used for rendering,
58             relative to the context */
59         RAS_Rect m_displayarea;
60
61 public:
62         /* Construct a new canvas.
63          * 
64          * @param area The Blender ScrArea to run the game within.
65          */
66         KX_BlenderCanvas(struct ScrArea* area);
67         ~KX_BlenderCanvas();
68
69                 void 
70         Init(
71         );
72         
73                 void 
74         SwapBuffers(
75         );
76                 void 
77         Resize(
78                 int width,
79                 int height
80         );
81
82                 void
83         BeginFrame(
84         );
85
86                 void 
87         EndFrame(
88         );
89
90                 void 
91         ClearColor(
92                 float r,
93                 float g,
94                 float b,
95                 float a
96         );
97
98                 void 
99         ClearBuffer(
100                 int type
101         );
102
103                 int 
104         GetWidth(
105         ) const ;
106
107                 int 
108         GetHeight(
109         ) const ;
110
111         const
112                 RAS_Rect &
113         GetDisplayArea(
114         ) const {
115                 return m_displayarea;
116         };
117
118                 RAS_Rect &
119         GetDisplayArea(
120         ) {
121                 return m_displayarea;
122         };
123
124                 void
125         SetViewPort(
126                 int x1, int y1,
127                 int x2, int y2
128         );
129
130                 void 
131         SetMouseState(
132                 RAS_MouseState mousestate
133         );
134
135                 void 
136         SetMousePosition(
137                 int x,
138                 int y
139         );
140
141                 void 
142         MakeScreenShot(
143                 const char* filename
144         );
145         
146         /**
147          * Nothing needs be done for BlenderCanvas
148          * Begin/End Draw, as the game engine GL context
149          * is always current/active.
150          */
151
152                 bool 
153         BeginDraw(
154         ) {
155                         return true;
156         };
157
158                 void 
159         EndDraw(
160         ) {
161         };
162
163 private:
164         /** Blender area the game engine is running within */
165         struct ScrArea* m_area;
166 };
167
168 #endif // __KX_BLENDERCANVAS
169