]> git.mxchange.org Git - flightgear.git/blob - src/Main/fg_os.hxx
Fix a misuse of a return value that lead to an error message being displayed
[flightgear.git] / src / Main / fg_os.hxx
1 #ifndef _FG_OS_HXX
2 #define _FG_OS_HXX
3
4 // Plib pui needs to know at compile time what toolkit is in use.
5 // Change this when we move to something other than glut.
6 // #define PU_USE_GLUT -- moved to configure.ac -- EMH
7 #ifdef HAVE_CONFIG_H
8 #  include <config.h>
9 #endif
10
11
12 enum { MOUSE_BUTTON_LEFT,
13        MOUSE_BUTTON_MIDDLE,
14        MOUSE_BUTTON_RIGHT };
15
16 enum { MOUSE_BUTTON_DOWN,
17        MOUSE_BUTTON_UP };
18
19 enum { MOUSE_CURSOR_NONE,
20        MOUSE_CURSOR_POINTER,
21        MOUSE_CURSOR_WAIT,
22        MOUSE_CURSOR_CROSSHAIR,
23        MOUSE_CURSOR_LEFTRIGHT };
24
25 enum { KEYMOD_NONE     = 0,
26        KEYMOD_RELEASED = 1, // Not a mod key, indicates "up" action
27        KEYMOD_SHIFT    = 2,
28        KEYMOD_CTRL     = 4,
29        KEYMOD_ALT      = 8,
30        KEYMOD_MAX      = 16 };
31
32 // A note on key codes: none are defined here.  FlightGear has no
33 // hard-coded interpretations of codes other than modifier keys, so we
34 // can get away with that.  The only firm requirement is that the
35 // codes passed to the fgKeyHandler function be correctly interpreted
36 // by the PUI library.  Users who need to hard-code key codes
37 // (probably not a good idea in any case) can use the pu.hxx header
38 // for definitions.
39
40 //
41 // OS integration functions
42 //
43
44 void fgOSInit(int* argc, char** argv);
45 void fgOSOpenWindow(int w, int h, int bpp, bool alpha, bool stencil,
46                     bool fullscreen);
47 void fgOSFullScreen();
48 void fgOSMainLoop();
49 void fgOSExit(int code);
50
51 void fgSetMouseCursor(int cursor);
52 int  fgGetMouseCursor();
53 void fgWarpMouse(int x, int y);
54
55 int  fgGetKeyModifiers();
56
57 void fgRequestRedraw();
58
59 //
60 // Callbacks and registration API
61 //
62
63 typedef void (*fgIdleHandler)();
64 typedef void (*fgDrawHandler)();
65 typedef void (*fgWindowResizeHandler)(int w, int h);
66
67 typedef void (*fgKeyHandler)(int key, int keymod, int mousex, int mousey);
68 typedef void (*fgMouseClickHandler)(int button, int updown, int x, int y);
69 typedef void (*fgMouseMotionHandler)(int x, int y);
70
71 void fgRegisterIdleHandler(fgIdleHandler func);
72 void fgRegisterDrawHandler(fgDrawHandler func);
73 void fgRegisterWindowResizeHandler(fgWindowResizeHandler func);
74
75 void fgRegisterKeyHandler(fgKeyHandler func);
76 void fgRegisterMouseClickHandler(fgMouseClickHandler func);
77 void fgRegisterMouseMotionHandler(fgMouseMotionHandler func);
78
79 #endif // _FG_OS_HXX