1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
|
/*
* ***** BEGIN GPL LICENSE BLOCK *****
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software Foundation,
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
* The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
* All rights reserved.
*
* The Original Code is: all of this file.
*
* Contributor(s): none yet.
*
* ***** END GPL LICENSE BLOCK *****
*/
/** \file RAS_ICanvas.h
* \ingroup bgerast
*/
#ifndef __RAS_ICANVAS_H__
#define __RAS_ICANVAS_H__
#ifdef WITH_CXX_GUARDEDALLOC
#include "MEM_guardedalloc.h"
#endif
class RAS_Rect;
struct TaskScheduler;
struct TaskPool;
struct ImageFormatData;
/**
* 2D rendering device context. The connection from 3d rendercontext to 2d surface.
*/
class RAS_ICanvas
{
public:
enum BufferType {
COLOR_BUFFER=1,
DEPTH_BUFFER=2
};
enum RAS_MouseState
{
MOUSE_INVISIBLE=1,
MOUSE_WAIT,
MOUSE_NORMAL
};
RAS_ICanvas();
virtual ~RAS_ICanvas();
virtual
void
Init(
) = 0;
virtual
void
BeginFrame(
)=0;
virtual
void
EndFrame(
)=0;
/**
* Initializes the canvas for drawing. Drawing to the canvas is
* only allowed between BeginDraw() and EndDraw().
*
* \retval false Acquiring the canvas failed.
* \retval true Acquiring the canvas succeeded.
*
*/
virtual
bool
BeginDraw(
)=0;
/**
* Unitializes the canvas for drawing.
*/
virtual
void
EndDraw(
)=0;
/// probably needs some arguments for PS2 in future
virtual
void
SwapBuffers(
)=0;
virtual
void
SetSwapInterval(
int interval
)=0;
virtual
bool
GetSwapInterval(
int& intervalOut
)=0;
virtual
void
ClearBuffer(
int type
)=0;
virtual
void
ClearColor(
float r,
float g,
float b,
float a
)=0;
virtual
int
GetWidth(
) const = 0;
virtual
int
GetHeight(
) const = 0;
virtual
int
GetMouseX(int x
)=0;
virtual
int
GetMouseY(int y
)= 0;
virtual
float
GetMouseNormalizedX(int x
)=0;
virtual
float
GetMouseNormalizedY(int y
)= 0;
virtual
const RAS_Rect &
GetDisplayArea(
) const = 0;
virtual
void
SetDisplayArea(RAS_Rect *rect
) = 0;
/**
* Used to get canvas area within blender.
*/
virtual
RAS_Rect &
GetWindowArea(
) = 0;
/**
* Set the visible view-port
*/
virtual
void
SetViewPort(
int x1, int y1,
int x2, int y2
) = 0;
/**
* Update the Canvas' viewport (used when the viewport changes without using SetViewPort()
* eg: Shadow buffers and FBOs
*/
virtual
void
UpdateViewPort(
int x1, int y1,
int x2, int y2
) = 0;
/**
* Get the visible viewport
*/
virtual
const int*
GetViewPort() = 0;
virtual
void
SetMouseState(
RAS_MouseState mousestate
)=0;
virtual
void
SetMousePosition(
int x,
int y
)=0;
virtual
RAS_MouseState
GetMouseState()
{
return m_mousestate;
}
virtual
void
MakeScreenShot(
const char* filename
)=0;
virtual void GetDisplayDimensions(int &width, int &height) = 0;
virtual
void
ResizeWindow(
int width,
int height
)=0;
virtual
void
SetFullScreen(
bool enable
)=0;
virtual
bool
GetFullScreen()=0;
protected:
RAS_MouseState m_mousestate;
int m_frame; /// frame number for screenshots.
TaskScheduler *m_taskscheduler;
TaskPool *m_taskpool;
/**
* Saves screenshot data to a file. The actual compression and disk I/O is performed in
* a separate thread.
*
* \param filename name of the file, can contain "###" for sequential numbering. A copy of the string
* is made, so the pointer can be freed by the caller.
* \param dumpsx width in pixels.
* \param dumpsy height in pixels.
* \param dumprect pixel data; ownership is passed to this function, which also frees the data.
* \param im_format image format for the file; ownership is passed to this function, which also frees the data.
*/
void save_screenshot(const char *filename, int dumpsx, int dumpsy, unsigned int *dumprect,
ImageFormatData * im_format);
#ifdef WITH_CXX_GUARDEDALLOC
MEM_CXX_CLASS_ALLOC_FUNCS("GE:RAS_ICanvas")
#endif
};
#endif /* __RAS_ICANVAS_H__ */
|