9919ae5eb6744d4eb0d8fca69a2bb701528daf0c
[freeglut] / src / x11 / fg_internal_x11.h
1 /*
2  * freeglut_internal_x11.h
3  *
4  * The freeglut library private include file.
5  *
6  * Copyright (c) 2012 Stephen J. Baker. All Rights Reserved.
7  * Written by Diederick C. Niehorster, <dcnieho@gmail.com>
8  * Creation date: Fri Jan 20, 2012
9  *
10  * Permission is hereby granted, free of charge, to any person obtaining a
11  * copy of this software and associated documentation files (the "Software"),
12  * to deal in the Software without restriction, including without limitation
13  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
14  * and/or sell copies of the Software, and to permit persons to whom the
15  * Software is furnished to do so, subject to the following conditions:
16  *
17  * The above copyright notice and this permission notice shall be included
18  * in all copies or substantial portions of the Software.
19  *
20  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
21  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
22  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
23  * PAWEL W. OLSZTA BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
24  * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
25  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
26  */
27
28 #ifndef  FREEGLUT_INTERNAL_X11_H
29 #define  FREEGLUT_INTERNAL_X11_H
30
31
32 /* -- PLATFORM-SPECIFIC INCLUDES ------------------------------------------- */
33 #ifdef EGL_VERSION_1_0
34 #include "egl/fg_internal_egl.h"
35 #else
36 #include <GL/glx.h>
37 #include "x11/fg_internal_x11_glx.h"
38 #endif
39 #include <X11/Xlib.h>
40 #include <X11/Xatom.h>
41 #include <X11/keysym.h>
42 #include <X11/extensions/XInput.h>
43 #ifdef HAVE_X11_EXTENSIONS_XF86VMODE_H
44 #    include <X11/extensions/xf86vmode.h>
45 #endif
46 #ifdef HAVE_X11_EXTENSIONS_XRANDR_H
47 #    include <X11/extensions/Xrandr.h>
48 #endif
49
50
51 /* -- GLOBAL TYPE DEFINITIONS ---------------------------------------------- */
52 /* The structure used by display initialization in freeglut_init.c */
53 typedef struct tagSFG_PlatformDisplay SFG_PlatformDisplay;
54 struct tagSFG_PlatformDisplay
55 {
56     Display*        Display;            /* The display we are being run in.  */
57     int             Screen;             /* The screen we are about to use.   */
58     Window          RootWindow;         /* The screen's root window.         */
59     int             Connection;         /* The display's connection number   */
60     Atom            DeleteWindow;       /* The window deletion atom          */
61     Atom            State;              /* The state atom                    */
62     Atom            StateFullScreen;    /* The full screen atom              */
63
64 #ifdef HAVE_X11_EXTENSIONS_XRANDR_H
65     int prev_xsz, prev_ysz;
66     int prev_refresh;
67     int prev_size_valid;
68 #endif  /* HAVE_X11_EXTENSIONS_XRANDR_H */
69
70 #ifdef HAVE_X11_EXTENSIONS_XF86VMODE_H
71     /*
72      * XF86VidMode may be compilable even if it fails at runtime.  Therefore,
73      * the validity of the VidMode has to be tracked
74      */
75     int             DisplayModeValid;   /* Flag that indicates runtime status*/
76     XF86VidModeModeLine DisplayMode;    /* Current screen's display settings */
77     int             DisplayModeClock;   /* The display mode's refresh rate   */
78     int             DisplayViewPortX;   /* saved X location of the viewport  */
79     int             DisplayViewPortY;   /* saved Y location of the viewport  */
80 #endif /* HAVE_X11_EXTENSIONS_XF86VMODE_H */
81
82 #ifdef EGL_VERSION_1_0
83     struct tagSFG_PlatformDisplayEGL egl;
84 #endif
85
86     int             DisplayPointerX;    /* saved X location of the pointer   */
87     int             DisplayPointerY;    /* saved Y location of the pointer   */
88 };
89
90
91 /*
92  * Make "freeglut" window handle and context types so that we don't need so
93  * much conditionally-compiled code later in the library.
94  */
95 #ifndef EGL_VERSION_1_0
96 typedef Window     SFG_WindowHandleType ;
97 typedef GLXContext SFG_WindowContextType ;
98 #endif
99 typedef struct tagSFG_PlatformContext SFG_PlatformContext;
100 struct tagSFG_PlatformContext
101 {
102 #ifdef EGL_VERSION_1_0
103     struct tagSFG_PlatformContextEGL egl;
104 #else
105     GLXFBConfig    FBConfig;        /* The window's FBConfig               */
106 #endif
107 };
108
109
110 /* Window's state description. This structure should be kept portable. */
111 typedef struct tagSFG_PlatformWindowState SFG_PlatformWindowState;
112 struct tagSFG_PlatformWindowState
113 {
114     int             OldWidth;           /* Window width from before a resize */
115     int             OldHeight;          /*   "    height  "    "    "   "    */
116 };
117
118
119 /* -- JOYSTICK-SPECIFIC STRUCTURES AND TYPES ------------------------------- */
120 /*
121  * Initial defines from "js.h" starting around line 33 with the existing "freeglut_joystick.c"
122  * interspersed
123  */
124 #    ifdef HAVE_SYS_IOCTL_H
125 #        include <sys/ioctl.h>
126 #    endif
127 #    ifdef HAVE_FCNTL_H
128 #        include <fcntl.h>
129 #    endif
130 #    ifdef HAVE_ERRNO_H
131 #        include <errno.h>
132 #        include <string.h>
133 #    endif
134 #    if defined(__FreeBSD__) || defined(__FreeBSD_kernel__) || defined(__NetBSD__)
135 /* XXX The below hack is done until freeglut's autoconf is updated. */
136 #        define HAVE_USB_JS    1
137
138 #        if defined(__FreeBSD__) || defined(__FreeBSD_kernel__)
139 #            include <sys/joystick.h>
140 #        else
141 /*
142  * XXX NetBSD/amd64 systems may find that they have to steal the
143  * XXX /usr/include/machine/joystick.h from a NetBSD/i386 system.
144  * XXX I cannot comment whether that works for the interface, but
145  * XXX it lets you compile...(^&  I do not think that we can do away
146  * XXX with this header.
147  */
148 #            include <machine/joystick.h>         /* For analog joysticks */
149 #        endif
150 #        define JS_DATA_TYPE joystick
151 #        define JS_RETURN (sizeof(struct JS_DATA_TYPE))
152 #    endif
153
154 #    if defined(__linux__)
155 #        include <linux/joystick.h>
156
157 /* check the joystick driver version */
158 #        if defined(JS_VERSION) && JS_VERSION >= 0x010000
159 #            define JS_NEW
160 #        endif
161 #    else  /* Not BSD or Linux */
162 #        ifndef JS_RETURN
163
164   /*
165    * We'll put these values in and that should
166    * allow the code to at least compile when there is
167    * no support. The JS open routine should error out
168    * and shut off all the code downstream anyway and if
169    * the application doesn't use a joystick we'll be fine.
170    */
171
172   struct JS_DATA_TYPE
173   {
174     int buttons;
175     int x;
176     int y;
177   };
178
179 #            define JS_RETURN (sizeof(struct JS_DATA_TYPE))
180 #        endif
181 #    endif
182
183 /* XXX It might be better to poll the operating system for the numbers of buttons and
184  * XXX axes and then dynamically allocate the arrays.
185  */
186 #    define _JS_MAX_AXES 16
187 typedef struct tagSFG_PlatformJoystick SFG_PlatformJoystick;
188 struct tagSFG_PlatformJoystick
189 {
190 #   if defined(__FreeBSD__) || defined(__FreeBSD_kernel__) || defined(__NetBSD__)
191        struct os_specific_s *os;
192 #   endif
193
194 #   ifdef JS_NEW
195        struct js_event     js;
196        int          tmp_buttons;
197        float        tmp_axes [ _JS_MAX_AXES ];
198 #   else
199        struct JS_DATA_TYPE js;
200 #   endif
201
202     char         fname [ 128 ];
203     int          fd;
204 };
205
206
207 /* Menu font and color definitions */
208 #define  FREEGLUT_MENU_FONT    GLUT_BITMAP_HELVETICA_18
209
210 #define  FREEGLUT_MENU_PEN_FORE_COLORS   {0.0f,  0.0f,  0.0f,  1.0f}
211 #define  FREEGLUT_MENU_PEN_BACK_COLORS   {0.70f, 0.70f, 0.70f, 1.0f}
212 #define  FREEGLUT_MENU_PEN_HFORE_COLORS  {0.0f,  0.0f,  0.0f,  1.0f}
213 #define  FREEGLUT_MENU_PEN_HBACK_COLORS  {1.0f,  1.0f,  1.0f,  1.0f}
214
215
216
217
218 /* -- PRIVATE FUNCTION DECLARATIONS ---------------------------------------- */
219 /* spaceball device functions, defined in freeglut_spaceball.c */
220 int             fgIsSpaceballXEvent( const XEvent *ev );
221 void            fgSpaceballHandleXEvent( const XEvent *ev );
222
223 /*
224  * Check if "hint" is present in "property" for "window".  See freeglut_init.c
225  */
226 int             fgHintPresent(Window window, Atom property, Atom hint);
227
228 /* Handler for X extension Events */
229 #ifdef HAVE_X11_EXTENSIONS_XINPUT2_H
230   void          fgHandleExtensionEvents( XEvent * ev );
231   void          fgRegisterDevices( Display* dpy, Window* win );
232 #endif
233
234
235 #endif  /* FREEGLUT_INTERNAL_X11_H */