merge with/from trunk at r35190
[blender-staging.git] / source / gameengine / Rasterizer / RAS_ICanvas.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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, 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
30 /** \file RAS_ICanvas.h
31  *  \ingroup bgerast
32  */
33
34 #ifndef __RAS_ICANVAS
35 #define __RAS_ICANVAS
36
37 #ifdef WITH_CXX_GUARDEDALLOC
38 #include "MEM_guardedalloc.h"
39 #endif
40
41 class RAS_Rect;
42
43 /**
44  * 2D rendering device context. The connection from 3d rendercontext to 2d surface.
45  */
46 class RAS_ICanvas
47 {
48 public:
49         enum BufferType {
50                 COLOR_BUFFER=1,
51                 DEPTH_BUFFER=2
52         };
53
54         enum RAS_MouseState
55         {
56                 MOUSE_INVISIBLE=1,
57                 MOUSE_WAIT,
58                 MOUSE_NORMAL
59         };
60
61         virtual 
62         ~RAS_ICanvas(
63         ) {
64         };
65
66         virtual 
67                 void 
68         Init(
69         ) = 0;
70
71         virtual 
72                 void 
73         BeginFrame(
74         )=0;
75
76         virtual 
77                 void 
78         EndFrame(
79         )=0;
80
81         /**
82          * Initializes the canvas for drawing.  Drawing to the canvas is
83          * only allowed between BeginDraw() and EndDraw().
84          *
85          * @retval false Acquiring the canvas failed.
86          * @retval true Acquiring the canvas succeeded.
87          *
88          */
89
90         virtual 
91                 bool 
92         BeginDraw(
93         )=0;
94
95         /**
96          * Unitializes the canvas for drawing.
97          */
98
99         virtual 
100                 void 
101         EndDraw(
102         )=0;
103
104
105         /// probably needs some arguments for PS2 in future
106         virtual 
107                 void 
108         SwapBuffers(
109         )=0;
110  
111         virtual 
112                 void 
113         ClearBuffer(
114                 int type
115         )=0;
116
117         virtual 
118                 void 
119         ClearColor(
120                 float r,
121                 float g,
122                 float b,
123                 float a
124         )=0;
125
126         virtual 
127                 int      
128         GetWidth(
129         ) const = 0;
130
131         virtual 
132                 int      
133         GetHeight(
134         ) const = 0;
135
136         virtual
137                 int
138         GetMouseX( int x
139         )=0;
140
141         virtual
142                 int
143         GetMouseY( int y
144         )= 0;
145
146         virtual
147                 float
148         GetMouseNormalizedX( int x
149         )=0;
150
151         virtual
152                 float
153         GetMouseNormalizedY( int y
154         )= 0;
155
156         virtual 
157                 const RAS_Rect &
158         GetDisplayArea(
159         ) const = 0;
160
161         virtual
162                 void
163         SetDisplayArea(RAS_Rect *rect
164         ) = 0;
165
166         /**
167          * Used to get canvas area within blender.
168          */
169         virtual
170                 RAS_Rect &
171         GetWindowArea(
172         ) = 0;
173
174         /**
175          * Set the visible vieport 
176          */
177
178         virtual
179                 void
180         SetViewPort(
181                 int x1, int y1,
182                 int x2, int y2
183         ) = 0; 
184
185         virtual 
186                 void 
187         SetMouseState(
188                 RAS_MouseState mousestate
189         )=0;
190
191         virtual 
192                 void 
193         SetMousePosition(
194                 int x,
195                 int y
196         )=0;
197
198         virtual
199                 RAS_MouseState
200         GetMouseState()
201         {
202                 return m_mousestate;
203         }
204
205         virtual 
206                 void 
207         MakeScreenShot(
208                 const char* filename
209         )=0;
210         
211 protected:
212         RAS_MouseState m_mousestate;
213         
214 #ifdef WITH_CXX_GUARDEDALLOC
215 public:
216         void *operator new(size_t num_bytes) { return MEM_mallocN(num_bytes, "GE:RAS_ICanvas"); }
217         void operator delete( void *mem ) { MEM_freeN(mem); }
218 #endif
219 };
220
221 #endif //__RAS_ICANVAS
222