BGE: alpha on frame buffer and precedence of MSAA over swap.
[blender.git] / intern / ghost / GHOST_ISystem.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 ghost/GHOST_ISystem.h
29  *  \ingroup GHOST
30  * %Main interface file for C++ Api with declaration of GHOST_ISystem interface
31  * class.
32  * Contains the doxygen documentation main page.
33  */
34
35 #ifndef __GHOST_ISYSTEM_H__
36 #define __GHOST_ISYSTEM_H__
37
38 #include "GHOST_Types.h"
39 #include "GHOST_ITimerTask.h"
40 #include "GHOST_IWindow.h"
41
42 class GHOST_IEventConsumer;
43
44 /**
45  * \page GHOSTPage GHOST
46  *
47  * \section intro Introduction
48  *
49  * GHOST is yet another acronym. It stands for "Generic Handy Operating System
50  * Toolkit". It has been created to replace the OpenGL utility tool kit
51  * <a href="http://www.opengl.org/resources/libraries/glut/">GLUT</a>.
52  * GLUT was used in <a href="http://www.blender3d.com">Blender</a> until the
53  * point that Blender needed to be ported to Apple's Mac OSX. Blender needed a
54  * number of modifications in GLUT to work but the GLUT sources for OSX were
55  * unavailable at the time. The decision was made to build our own replacement
56  * for GLUT. In those days, NaN Technologies BV was the company that developed
57  * Blender.
58  * <br><br>
59  * Enough history. What does GHOST have to offer?<br>
60  * In short: everything that Blender needed from GLUT to run on all it's supported
61  * operating systems and some extra's.
62  * This includes :
63  *
64  * - Time(r) management.
65  * - Display/window management (windows are only created on the main display).
66  * - Event management.
67  * - Cursor shape management (no custom cursors for now).
68  * - Access to the state of the mouse buttons and the keyboard.
69  * - Menus for windows with events generated when they are accessed (this is
70  *   work in progress).
71  * - Video mode switching.
72  * - Copy/Paste buffers.
73  * - System paths.
74  *
75  * Font management has been moved to a separate library.
76  *
77  * \section platforms Platforms
78  *
79  * GHOST supports the following platforms:
80  *
81  * - OSX Cocoa.
82  * - Windows.
83  * - X11.
84  * - SDL2 (experimental).
85  * - NULL (headless mode).
86  *
87  * \section Building GHOST
88  *
89  * GHOST is not build standalone however there are tests in intern/ghost/test
90  *
91  * \section interface Interface
92  * GHOST has two programming interfaces:
93  *
94  * - The C-API. For programs written in C.
95  * - The C++-API. For programs written in C++.
96  *
97  * GHOST itself is written in C++ and the C-API is a wrapper around the C++
98  * API.
99  *
100  * \subsection cplusplus_api The C++ API consists of the following files:
101  *
102  * - GHOST_IEvent.h
103  * - GHOST_IEventConsumer.h
104  * - GHOST_ISystem.h
105  * - GHOST_ITimerTask.h
106  * - GHOST_IWindow.h
107  * - GHOST_Rect.h
108  * - GHOST_Types.h
109  *
110  * For an example of using the C++-API, have a look at the GHOST_C-Test.cpp
111  * program in the ?/ghost/test/gears/ directory.
112  *
113  * \subsection c_api The C-API
114  * To use GHOST in programs written in C, include the file GHOST_C-API.h in
115  * your program. This file includes the GHOST_Types.h file for all GHOST types
116  * and defines functions that give you access to the same functionality present
117  * in the C++ API.<br>
118  * For an example of using the C-API, have a look at the GHOST_C-Test.c program
119  * in the ?/ghost/test/gears/ directory.
120  *
121  * \section work Work in progress
122  * \todo write WIP section
123  */
124
125 /** \interface GHOST_ISystem
126  * Interface for classes that provide access to the operating system.
127  * There should be only one system class in an application.
128  * Therefore, the routines to create and dispose the system are static.
129  * Provides:
130  *  -# Time(r) management.
131  *  -# Display/window management (windows are only created on the main display).
132  *  -# Event management.
133  *  -# Cursor shape management (no custom cursors for now).
134  *  -# Access to the state of the mouse buttons and the keyboard.
135  *  -# Menus for windows with events generated when they are accessed (this is
136  *     work in progress).
137  * \author  Maarten Gribnau
138  * \date    May 30, 2001
139  */
140 class GHOST_ISystem
141 {
142 public:
143         /**
144          * Creates the one and only system.
145          * \return An indication of success.
146          */
147         static GHOST_TSuccess createSystem();
148
149         /**
150          * Disposes the one and only system.
151          * \return An indication of success.
152          */
153         static GHOST_TSuccess disposeSystem();
154
155         /**
156          * Returns a pointer to the one and only system (nil if it hasn't been created).
157          * \return A pointer to the system.
158          */
159         static GHOST_ISystem *getSystem();
160
161 protected:
162         /**
163          * Constructor.
164          * Protected default constructor to force use of static createSystem member.
165          */
166         GHOST_ISystem() {
167         }
168
169         /**
170          * Destructor.
171          * Protected default constructor to force use of static dispose member.
172          */
173         virtual ~GHOST_ISystem() {
174         }
175
176 public:
177         /***************************************************************************************
178          * Time(r) functionality
179          ***************************************************************************************/
180
181         /**
182          * Returns the system time.
183          * Returns the number of milliseconds since the start of the system process.
184          * Based on ANSI clock() routine.
185          * \return The number of milliseconds.
186          */
187         virtual GHOST_TUns64 getMilliSeconds() const = 0;
188
189         /**
190          * Installs a timer.
191          * Note that, on most operating systems, messages need to be processed in order
192          * for the timer callbacks to be invoked.
193          * \param delay     The time to wait for the first call to the timerProc (in milliseconds)
194          * \param interval  The interval between calls to the timerProc (in milliseconds)
195          * \param timerProc The callback invoked when the interval expires,
196          * \param userData  Placeholder for user data.
197          * \return A timer task (0 if timer task installation failed).
198          */
199         virtual GHOST_ITimerTask *installTimer(GHOST_TUns64 delay,
200                                                GHOST_TUns64 interval,
201                                                GHOST_TimerProcPtr timerProc,
202                                                GHOST_TUserDataPtr userData = NULL) = 0;
203
204         /**
205          * Removes a timer.
206          * \param timerTask Timer task to be removed.
207          * \return Indication of success.
208          */
209         virtual GHOST_TSuccess removeTimer(GHOST_ITimerTask *timerTask) = 0;
210
211         /***************************************************************************************
212          * Display/window management functionality
213          ***************************************************************************************/
214
215         /**
216          * Returns the number of displays on this system.
217          * \return The number of displays.
218          */
219         virtual GHOST_TUns8 getNumDisplays() const = 0;
220
221         /**
222          * Returns the dimensions of the main display on this system.
223          * \return The dimension of the main display.
224          */
225         virtual void getMainDisplayDimensions(GHOST_TUns32& width, GHOST_TUns32& height) const = 0;
226
227         /**
228          * Returns the combine dimensions of all monitors.
229          * \return The dimension of the workspace.
230          */
231         virtual void getAllDisplayDimensions(GHOST_TUns32& width, GHOST_TUns32& height) const = 0;
232
233         /**
234          * Create a new window.
235          * The new window is added to the list of windows managed.
236          * Never explicitly delete the window, use disposeWindow() instead.
237          * \param   title           The name of the window (displayed in the title bar of the window if the OS supports it).
238          * \param   left            The coordinate of the left edge of the window.
239          * \param   top             The coordinate of the top edge of the window.
240          * \param   width           The width the window.
241          * \param   height          The height the window.
242          * \param   state           The state of the window when opened.
243          * \param   type            The type of drawing context installed in this window.
244          * \param glSettings: Misc OpenGL settings.
245          * \param exclusive: Use to show the window ontop and ignore others (used fullscreen).
246          * \param   parentWindow    Parent (embedder) window
247          * \return  The new window (or 0 if creation failed).
248          */
249         virtual GHOST_IWindow *createWindow(
250                 const STR_String& title,
251                 GHOST_TInt32 left, GHOST_TInt32 top, GHOST_TUns32 width, GHOST_TUns32 height,
252                 GHOST_TWindowState state, GHOST_TDrawingContextType type,
253                 GHOST_GLSettings glSettings,
254                 const bool exclusive = false,
255                 const GHOST_TEmbedderWindowID parentWindow = 0) = 0;
256
257         /**
258          * Dispose a window.
259          * \param   window Pointer to the window to be disposed.
260          * \return  Indication of success.
261          */
262         virtual GHOST_TSuccess disposeWindow(GHOST_IWindow *window) = 0;
263
264         /**
265          * Returns whether a window is valid.
266          * \param   window Pointer to the window to be checked.
267          * \return  Indication of validity.
268          */
269         virtual bool validWindow(GHOST_IWindow *window) = 0;
270
271         /**
272          * Begins full screen mode.
273          * \param setting   The new setting of the display.
274          * \param window    Window displayed in full screen.
275          *                  This window is invalid after full screen has been ended.
276          * \return  Indication of success.
277          */
278         virtual GHOST_TSuccess beginFullScreen(
279                 const GHOST_DisplaySetting& setting, GHOST_IWindow **window,
280                 const bool stereoVisual, const bool alphaBackground = 0, const GHOST_TUns16 numOfAASamples = 0) = 0;
281
282         /**
283          * Updates the resolution while in fullscreen mode.
284          * \param setting   The new setting of the display.
285          * \param window    Window displayed in full screen.
286          *
287          * \return  Indication of success.
288          */
289         virtual GHOST_TSuccess updateFullScreen(
290                 const GHOST_DisplaySetting& setting, GHOST_IWindow **window) = 0;
291
292         /**
293          * Ends full screen mode.
294          * \return  Indication of success.
295          */
296         virtual GHOST_TSuccess endFullScreen(void) = 0;
297
298         /**
299          * Returns current full screen mode status.
300          * \return The current status.
301          */
302         virtual bool getFullScreen(void) = 0;
303         
304         /**
305          * Native pixel size support (MacBook 'retina').
306          */
307         virtual bool useNativePixel(void) = 0;
308
309         /***************************************************************************************
310          * Event management functionality
311          ***************************************************************************************/
312
313         /**
314          * Retrieves events from the system and stores them in the queue.
315          * \param waitForEvent Flag to wait for an event (or return immediately).
316          * \return Indication of the presence of events.
317          */
318         virtual bool processEvents(bool waitForEvent) = 0;
319
320         /**
321          * Retrieves events from the queue and send them to the event consumers.
322          */
323         virtual void dispatchEvents() = 0;
324
325         /**
326          * Adds the given event consumer to our list.
327          * \param consumer The event consumer to add.
328          * \return Indication of success.
329          */
330         virtual GHOST_TSuccess addEventConsumer(GHOST_IEventConsumer *consumer) = 0;
331
332         /**
333          * Removes the given event consumer to our list.
334          * \param consumer The event consumer to remove.
335          * \return Indication of success.
336          */
337         virtual GHOST_TSuccess removeEventConsumer(GHOST_IEventConsumer *consumer) = 0;
338
339         /***************************************************************************************
340          * Cursor management functionality
341          ***************************************************************************************/
342
343         /**
344          * Returns the current location of the cursor (location in screen coordinates)
345          * \param x         The x-coordinate of the cursor.
346          * \param y         The y-coordinate of the cursor.
347          * \return          Indication of success.
348          */
349         virtual GHOST_TSuccess getCursorPosition(GHOST_TInt32& x, GHOST_TInt32& y) const = 0;
350
351         /**
352          * Updates the location of the cursor (location in screen coordinates).
353          * Not all operating systems allow the cursor to be moved (without the input device being moved).
354          * \param x         The x-coordinate of the cursor.
355          * \param y         The y-coordinate of the cursor.
356          * \return          Indication of success.
357          */
358         virtual GHOST_TSuccess setCursorPosition(GHOST_TInt32 x, GHOST_TInt32 y) = 0;
359
360         /***************************************************************************************
361          * Access to mouse button and keyboard states.
362          ***************************************************************************************/
363
364         /**
365          * Returns the state of a modifier key (ouside the message queue).
366          * \param mask      The modifier key state to retrieve.
367          * \param isDown    The state of a modifier key (true == pressed).
368          * \return          Indication of success.
369          */
370         virtual GHOST_TSuccess getModifierKeyState(GHOST_TModifierKeyMask mask, bool& isDown) const = 0;
371
372         /**
373          * Returns the state of a mouse button (ouside the message queue).
374          * \param mask      The button state to retrieve.
375          * \param isDown    Button state.
376          * \return          Indication of success.
377          */
378         virtual GHOST_TSuccess getButtonState(GHOST_TButtonMask mask, bool& isDown) const = 0;
379
380         /**
381          * Sets 3D mouse deadzone
382          * \param deadzone: Deadzone of the 3D mouse (both for rotation and pan) relative to full range
383          */
384         virtual void setNDOFDeadZone(float deadzone) = 0;
385
386         /**
387          * Toggles console
388          * \param action
389          * - 0: Hides
390          * - 1: Shows
391          * - 2: Toggles
392          * - 3: Hides if it runs not from  command line
393          * - *: Does nothing
394          * \return current status (1 -visible, 0 - hidden)
395          */
396         virtual int toggleConsole(int action) = 0;
397
398         /***************************************************************************************
399          * Access to clipboard.
400          ***************************************************************************************/
401
402         /**
403          * Returns the selection buffer
404          * \return "unsigned char" from X11 XA_CUT_BUFFER0 buffer
405          *
406          */
407         virtual GHOST_TUns8 *getClipboard(bool selection) const = 0;
408
409         /**
410          * Put data to the Clipboard
411          */
412         virtual void putClipboard(GHOST_TInt8 *buffer, bool selection) const = 0;
413
414         /**
415          * Confirms quitting he program when there is just one window left open
416          * in the application
417          */
418         virtual int confirmQuit(GHOST_IWindow *window) const = 0;
419 protected:
420         /**
421          * Initialize the system.
422          * \return Indication of success.
423          */
424         virtual GHOST_TSuccess init() = 0;
425
426         /**
427          * Shut the system down.
428          * \return Indication of success.
429          */
430         virtual GHOST_TSuccess exit() = 0;
431
432         /** The one and only system */
433         static GHOST_ISystem *m_system;
434
435
436 #ifdef WITH_CXX_GUARDEDALLOC
437         MEM_CXX_CLASS_ALLOC_FUNCS("GHOST:GHOST_ISystem")
438 #endif
439 };
440
441 #endif // __GHOST_ISYSTEM_H__
442