BGE Rasterizer Cleanup: Removing KX_BlenderGL since it was mostly one-line functions...
[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 "RAS_ICanvas.h"
40 #include "RAS_Rect.h"
41
42 #ifdef WITH_CXX_GUARDEDALLOC
43 #include "MEM_guardedalloc.h"
44 #endif
45
46 struct ARegion;
47 struct wmWindow;
48 struct wmWindowManager;
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         /**
59          * Rect that defines the area used for rendering,
60          * relative to the context */
61         RAS_Rect m_displayarea;
62         int m_viewport[4];
63
64 public:
65         /* Construct a new canvas.
66          * 
67          * \param area The Blender ARegion to run the game within.
68          */
69         KX_BlenderCanvas(struct wmWindowManager *wm, struct wmWindow* win, RAS_Rect &rect, struct ARegion* ar);
70         ~KX_BlenderCanvas();
71
72                 void 
73         Init(
74         );
75         
76                 void 
77         SwapBuffers(
78         );
79
80                 void
81         SetSwapInterval(
82                 int interval
83         );
84
85                 int
86         GetSwapInterval(
87         );
88
89                 void 
90         ResizeWindow(
91                 int width,
92                 int height
93         );
94
95                 void
96         SetFullScreen(
97                 bool enable
98         );
99
100                 bool
101         GetFullScreen();
102
103                 void
104         BeginFrame(
105         );
106
107                 void 
108         EndFrame(
109         );
110
111                 void 
112         ClearColor(
113                 float r,
114                 float g,
115                 float b,
116                 float a
117         );
118
119                 void 
120         ClearBuffer(
121                 int type
122         );
123
124                 int 
125         GetWidth(
126         ) const;
127
128                 int 
129         GetHeight(
130         ) const;
131
132                 int
133         GetMouseX(int x
134         );
135
136                 int
137         GetMouseY(int y
138         );
139
140                 float
141         GetMouseNormalizedX(int x
142         );
143
144                 float
145         GetMouseNormalizedY(int y
146         );
147
148         const
149                 RAS_Rect &
150         GetDisplayArea(
151         ) const {
152                 return m_displayarea;
153         };
154
155                 void
156         SetDisplayArea(RAS_Rect *rect
157         ) {
158                 m_displayarea= *rect;
159         };
160
161                 RAS_Rect &
162         GetWindowArea(
163         );
164
165                 void
166         SetViewPort(
167                 int x1, int y1,
168                 int x2, int y2
169         );
170
171                 void
172         UpdateViewPort(
173                 int x1, int y1,
174                 int x2, int y2
175         );
176
177                 const int*
178         GetViewPort();
179
180                 void 
181         SetMouseState(
182                 RAS_MouseState mousestate
183         );
184
185                 void 
186         SetMousePosition(
187                 int x,
188                 int y
189         );
190
191                 void 
192         MakeScreenShot(
193                 const char* filename
194         );
195         
196                 bool 
197         BeginDraw(
198         );
199
200                 void 
201         EndDraw(
202         );
203
204 private:
205         /** Blender area the game engine is running within */
206         struct wmWindowManager *m_wm;
207         struct wmWindow* m_win;
208         RAS_Rect        m_frame_rect;
209         RAS_Rect        m_area_rect;
210         int                     m_area_left;
211         int                     m_area_top;
212
213
214 #ifdef WITH_CXX_GUARDEDALLOC
215         MEM_CXX_CLASS_ALLOC_FUNCS("GE:KX_BlenderCanvas")
216 #endif
217 };
218
219 #endif  /* __KX_BLENDERCANVAS_H__ */