Mitchell Stokes BGE MouseWarp patch + warning fix
[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
36 #include "GL/glew.h"
37
38 #include "RAS_ICanvas.h"
39 #include "RAS_Rect.h"
40
41 #include "KX_BlenderGL.h"
42
43 #ifdef WITH_CXX_GUARDEDALLOC
44 #include "MEM_guardedalloc.h"
45 #endif
46
47 struct ARegion;
48 struct wmWindow;
49
50 /**
51  * 2D Blender device context abstraction. 
52  * The connection from 3d rendercontext to 2d Blender surface embedding.
53  */
54
55 class KX_BlenderCanvas : public RAS_ICanvas
56 {
57 private:
58         /** Rect that defines the area used for rendering,
59             relative to the context */
60         RAS_Rect m_displayarea;
61
62 public:
63         /* Construct a new canvas.
64          * 
65          * @param area The Blender ARegion to run the game within.
66          */
67         KX_BlenderCanvas(struct wmWindow* win, class RAS_Rect &rect);
68         ~KX_BlenderCanvas();
69
70                 void 
71         Init(
72         );
73         
74                 void 
75         SwapBuffers(
76         );
77                 void 
78         Resize(
79                 int width,
80                 int height
81         );
82
83                 void
84         BeginFrame(
85         );
86
87                 void 
88         EndFrame(
89         );
90
91                 void 
92         ClearColor(
93                 float r,
94                 float g,
95                 float b,
96                 float a
97         );
98
99                 void 
100         ClearBuffer(
101                 int type
102         );
103
104                 int 
105         GetWidth(
106         ) const ;
107
108                 int 
109         GetHeight(
110         ) const ;
111
112         const
113                 RAS_Rect &
114         GetDisplayArea(
115         ) const {
116                 return m_displayarea;
117         };
118
119                 void
120         SetDisplayArea(RAS_Rect *rect
121         ) {
122                 m_displayarea= *rect;
123         };
124
125                 RAS_Rect &
126         GetWindowArea(
127         );
128
129                 void
130         SetViewPort(
131                 int x1, int y1,
132                 int x2, int y2
133         );
134
135                 void 
136         SetMouseState(
137                 RAS_MouseState mousestate
138         );
139
140                 void 
141         SetMousePosition(
142                 int x,
143                 int y
144         );
145
146                 void 
147         MakeScreenShot(
148                 const char* filename
149         );
150         
151         /**
152          * Nothing needs be done for BlenderCanvas
153          * Begin/End Draw, as the game engine GL context
154          * is always current/active.
155          */
156
157                 bool 
158         BeginDraw(
159         ) {
160                         return true;
161         };
162
163                 void 
164         EndDraw(
165         ) {
166         };
167
168 private:
169         /** Blender area the game engine is running within */
170         struct wmWindow* m_win;
171         RAS_Rect        m_frame_rect;
172         RAS_Rect        m_area_rect;
173
174
175 #ifdef WITH_CXX_GUARDEDALLOC
176 public:
177         void *operator new( unsigned int num_bytes) { return MEM_mallocN(num_bytes, "GE:KX_BlenderCanvas"); }
178         void operator delete( void *mem ) { MEM_freeN(mem); }
179 #endif
180 };
181
182 #endif // __KX_BLENDERCANVAS
183