BGE: Adding a render.setFullScreen() and a render.getFullScreen() to allow fulscreeni...
[blender.git] / source / gameengine / BlenderRoutines / KX_BlenderCanvas.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): none yet.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 /** \file KX_BlenderCanvas.h
29  *  \ingroup blroutines
30  */
31
32 #ifndef __KX_BLENDERCANVAS_H__
33 #define __KX_BLENDERCANVAS_H__
34
35 #ifdef WIN32
36 #include <windows.h>
37 #endif 
38
39 #include "GL/glew.h"
40
41 #include "RAS_ICanvas.h"
42 #include "RAS_Rect.h"
43
44 #include "KX_BlenderGL.h"
45
46 #ifdef WITH_CXX_GUARDEDALLOC
47 #include "MEM_guardedalloc.h"
48 #endif
49
50 struct ARegion;
51 struct wmWindow;
52
53 /**
54  * 2D Blender device context abstraction. 
55  * The connection from 3d rendercontext to 2d Blender surface embedding.
56  */
57
58 class KX_BlenderCanvas : public RAS_ICanvas
59 {
60 private:
61         /**
62          * Rect that defines the area used for rendering,
63          * relative to the context */
64         RAS_Rect m_displayarea;
65         int m_viewport[4];
66
67 public:
68         /* Construct a new canvas.
69          * 
70          * \param area The Blender ARegion to run the game within.
71          */
72         KX_BlenderCanvas(struct wmWindow* win, class RAS_Rect &rect, struct ARegion* ar);
73         ~KX_BlenderCanvas();
74
75                 void 
76         Init(
77         );
78         
79                 void 
80         SwapBuffers(
81         );
82                 void 
83         ResizeWindow(
84                 int width,
85                 int height
86         );
87
88                 void
89         SetFullScreen(
90                 bool enable
91         );
92
93                 bool
94         GetFullScreen();
95
96                 void
97         BeginFrame(
98         );
99
100                 void 
101         EndFrame(
102         );
103
104                 void 
105         ClearColor(
106                 float r,
107                 float g,
108                 float b,
109                 float a
110         );
111
112                 void 
113         ClearBuffer(
114                 int type
115         );
116
117                 int 
118         GetWidth(
119         ) const;
120
121                 int 
122         GetHeight(
123         ) const;
124
125                 int
126         GetMouseX(int x
127         );
128
129                 int
130         GetMouseY(int y
131         );
132
133                 float
134         GetMouseNormalizedX(int x
135         );
136
137                 float
138         GetMouseNormalizedY(int y
139         );
140
141         const
142                 RAS_Rect &
143         GetDisplayArea(
144         ) const {
145                 return m_displayarea;
146         };
147
148                 void
149         SetDisplayArea(RAS_Rect *rect
150         ) {
151                 m_displayarea= *rect;
152         };
153
154                 RAS_Rect &
155         GetWindowArea(
156         );
157
158                 void
159         SetViewPort(
160                 int x1, int y1,
161                 int x2, int y2
162         );
163
164                 void
165         UpdateViewPort(
166                 int x1, int y1,
167                 int x2, int y2
168         );
169
170                 const int*
171         GetViewPort();
172
173                 void 
174         SetMouseState(
175                 RAS_MouseState mousestate
176         );
177
178                 void 
179         SetMousePosition(
180                 int x,
181                 int y
182         );
183
184                 void 
185         MakeScreenShot(
186                 const char* filename
187         );
188         
189         /**
190          * Nothing needs be done for BlenderCanvas
191          * Begin/End Draw, as the game engine GL context
192          * is always current/active.
193          */
194
195                 bool 
196         BeginDraw(
197         ) {
198                         return true;
199         };
200
201                 void 
202         EndDraw(
203         ) {
204         };
205
206 private:
207         /** Blender area the game engine is running within */
208         struct wmWindow* m_win;
209         RAS_Rect        m_frame_rect;
210         RAS_Rect        m_area_rect;
211         int                     m_area_left;
212         int                     m_area_top;
213
214
215 #ifdef WITH_CXX_GUARDEDALLOC
216         MEM_CXX_CLASS_ALLOC_FUNCS("GE:KX_BlenderCanvas")
217 #endif
218 };
219
220 #endif  /* __KX_BLENDERCANVAS_H__ */