soc-2008-mxcurioni: merged changes to revision 15705
[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 struct ScrArea;
44
45 /**
46  * 2D Blender device context abstraction. 
47  * The connection from 3d rendercontext to 2d Blender surface embedding.
48  */
49
50 class KX_BlenderCanvas : public RAS_ICanvas
51 {
52 private:
53         /** Rect that defines the area used for rendering,
54             relative to the context */
55         RAS_Rect m_displayarea;
56
57 public:
58         /* Construct a new canvas.
59          * 
60          * @param area The Blender ScrArea to run the game within.
61          */
62         KX_BlenderCanvas(struct ScrArea* area);
63         ~KX_BlenderCanvas();
64
65                 void 
66         Init(
67         );
68         
69                 void 
70         SwapBuffers(
71         );
72                 void 
73         Resize(
74                 int width,
75                 int height
76         );
77
78                 void
79         BeginFrame(
80         );
81
82                 void 
83         EndFrame(
84         );
85
86                 void 
87         ClearColor(
88                 float r,
89                 float g,
90                 float b,
91                 float a
92         );
93
94                 void 
95         ClearBuffer(
96                 int type
97         );
98
99                 int 
100         GetWidth(
101         ) const ;
102
103                 int 
104         GetHeight(
105         ) const ;
106
107         const
108                 RAS_Rect &
109         GetDisplayArea(
110         ) const {
111                 return m_displayarea;
112         };
113
114                 RAS_Rect &
115         GetDisplayArea(
116         ) {
117                 return m_displayarea;
118         };
119
120                 RAS_Rect &
121         GetWindowArea(
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         RAS_Rect        m_area_rect;
167 };
168
169 #endif // __KX_BLENDERCANVAS
170