Added GLUT_ACTIVE_SUPER modifier, and corresponding GLUT_KEY_SUPER_L and
[freeglut] / include / GL / freeglut_ext.h
1 #ifndef  __FREEGLUT_EXT_H__
2 #define  __FREEGLUT_EXT_H__
3
4 /*
5  * freeglut_ext.h
6  *
7  * The non-GLUT-compatible extensions to the freeglut library include file
8  *
9  * Copyright (c) 1999-2000 Pawel W. Olszta. All Rights Reserved.
10  * Written by Pawel W. Olszta, <olszta@sourceforge.net>
11  * Creation date: Thu Dec 2 1999
12  *
13  * Permission is hereby granted, free of charge, to any person obtaining a
14  * copy of this software and associated documentation files (the "Software"),
15  * to deal in the Software without restriction, including without limitation
16  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
17  * and/or sell copies of the Software, and to permit persons to whom the
18  * Software is furnished to do so, subject to the following conditions:
19  *
20  * The above copyright notice and this permission notice shall be included
21  * in all copies or substantial portions of the Software.
22  *
23  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
24  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
25  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
26  * PAWEL W. OLSZTA BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
27  * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
28  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
29  */
30
31 #ifdef __cplusplus
32     extern "C" {
33 #endif
34
35 /*
36  * Additional GLUT Key definitions for the Special key function
37  */
38 #define GLUT_KEY_NUM_LOCK           0x006D
39 #define GLUT_KEY_BEGIN              0x006E
40 #define GLUT_KEY_DELETE             0x006F
41 #define GLUT_KEY_SHIFT_L            0x0070
42 #define GLUT_KEY_SHIFT_R            0x0071
43 #define GLUT_KEY_CTRL_L             0x0072
44 #define GLUT_KEY_CTRL_R             0x0073
45 #define GLUT_KEY_ALT_L              0x0074
46 #define GLUT_KEY_ALT_R              0x0075
47 #define GLUT_KEY_SUPER_L            0x0076
48 #define GLUT_KEY_SUPER_R            0x0077
49
50 /*
51  * Additional GLUT modifiers
52  */
53 #define GLUT_ACTIVE_SUPER           0x0008
54
55 /*
56  * GLUT API Extension macro definitions -- behaviour when the user clicks on an "x" to close a window
57  */
58 #define GLUT_ACTION_EXIT                         0
59 #define GLUT_ACTION_GLUTMAINLOOP_RETURNS         1
60 #define GLUT_ACTION_CONTINUE_EXECUTION           2
61
62 /*
63  * Create a new rendering context when the user opens a new window?
64  */
65 #define GLUT_CREATE_NEW_CONTEXT                  0
66 #define GLUT_USE_CURRENT_CONTEXT                 1
67
68 /*
69  * Direct/Indirect rendering context options (has meaning only in Unix/X11)
70  */
71 #define GLUT_FORCE_INDIRECT_CONTEXT              0
72 #define GLUT_ALLOW_DIRECT_CONTEXT                1
73 #define GLUT_TRY_DIRECT_CONTEXT                  2
74 #define GLUT_FORCE_DIRECT_CONTEXT                3
75
76 /*
77  * GLUT API Extension macro definitions -- the glutGet parameters
78  */
79 #define  GLUT_INIT_STATE                    0x007C
80
81 #define  GLUT_ACTION_ON_WINDOW_CLOSE        0x01F9
82
83 #define  GLUT_WINDOW_BORDER_WIDTH           0x01FA
84 #define  GLUT_WINDOW_BORDER_HEIGHT          0x01FB
85 #define  GLUT_WINDOW_HEADER_HEIGHT          0x01FB  /* Docs say it should always have been GLUT_WINDOW_BORDER_HEIGHT, keep this for backward compatibility */
86
87 #define  GLUT_VERSION                       0x01FC
88
89 #define  GLUT_RENDERING_CONTEXT             0x01FD
90 #define  GLUT_DIRECT_RENDERING              0x01FE
91
92 #define  GLUT_FULL_SCREEN                   0x01FF
93
94 #define  GLUT_SKIP_STALE_MOTION_EVENTS      0x0204
95
96 #define  GLUT_GEOMETRY_VISUALIZE_NORMALS    0x0205
97
98 #define  GLUT_STROKE_FONT_DRAW_JOIN_DOTS    0x0206  /* Draw dots between line segments of stroke fonts? */
99
100 #define  GLUT_ALLOW_NEGATIVE_WINDOW_POSITION 0x0207 /* GLUT doesn't allow negative window positions by default */
101
102 #define  GLUT_WINDOW_SRGB                   0x007D
103
104 /*
105  * New tokens for glutInitDisplayMode.
106  * Only one GLUT_AUXn bit may be used at a time.
107  * Value 0x0400 is defined in OpenGLUT.
108  */
109 #define  GLUT_AUX                           0x1000
110
111 #define  GLUT_AUX1                          0x1000
112 #define  GLUT_AUX2                          0x2000
113 #define  GLUT_AUX3                          0x4000
114 #define  GLUT_AUX4                          0x8000
115
116 /*
117  * Context-related flags, see fg_state.c
118  * Set the requested OpenGL version
119  */
120 #define  GLUT_INIT_MAJOR_VERSION            0x0200
121 #define  GLUT_INIT_MINOR_VERSION            0x0201
122 #define  GLUT_INIT_FLAGS                    0x0202
123 #define  GLUT_INIT_PROFILE                  0x0203
124
125 /*
126  * Flags for glutInitContextFlags, see fg_init.c
127  */
128 #define  GLUT_DEBUG                         0x0001
129 #define  GLUT_FORWARD_COMPATIBLE            0x0002
130
131
132 /*
133  * Flags for glutInitContextProfile, see fg_init.c
134  */
135 #define GLUT_CORE_PROFILE                   0x0001
136 #define GLUT_COMPATIBILITY_PROFILE          0x0002
137
138 /*
139 * GLUT API Extension macro definitions -- Spaceball button definitions
140 */
141
142 #define  GLUT_SPACEBALL_BUTTON_A            0x0001
143 #define  GLUT_SPACEBALL_BUTTON_B            0x0002
144 #define  GLUT_SPACEBALL_BUTTON_C            0x0004
145 #define  GLUT_SPACEBALL_BUTTON_D            0x0008
146 #define  GLUT_SPACEBALL_BUTTON_E            0x0010
147
148 /*
149  * Process loop function, see fg_main.c
150  */
151 FGAPI void    FGAPIENTRY glutMainLoopEvent( void );
152 FGAPI void    FGAPIENTRY glutLeaveMainLoop( void );
153 FGAPI void    FGAPIENTRY glutExit         ( void );
154
155 /*
156  * Window management functions, see fg_window.c
157  */
158 FGAPI void    FGAPIENTRY glutFullScreenToggle( void );
159 FGAPI void    FGAPIENTRY glutLeaveFullScreen( void );
160
161 /*
162  * Menu functions
163  */
164 FGAPI void    FGAPIENTRY glutSetMenuFont( int menuID, void* font );
165
166 /*
167  * Window-specific callback functions, see fg_callbacks.c
168  */
169 FGAPI void    FGAPIENTRY glutMouseWheelFunc( void (* callback)( int, int, int, int ) );
170 FGAPI void    FGAPIENTRY glutPositionFunc( void (* callback)( int, int ) );
171 FGAPI void    FGAPIENTRY glutCloseFunc( void (* callback)( void ) );
172 FGAPI void    FGAPIENTRY glutWMCloseFunc( void (* callback)( void ) );
173 /* And also a destruction callback for menus */
174 FGAPI void    FGAPIENTRY glutMenuDestroyFunc( void (* callback)( void ) );
175
176 /*
177  * State setting and retrieval functions, see fg_state.c
178  */
179 FGAPI void    FGAPIENTRY glutSetOption ( GLenum option_flag, int value );
180 FGAPI int *   FGAPIENTRY glutGetModeValues(GLenum mode, int * size);
181 /* A.Donev: User-data manipulation */
182 FGAPI void*   FGAPIENTRY glutGetWindowData( void );
183 FGAPI void    FGAPIENTRY glutSetWindowData(void* data);
184 FGAPI void*   FGAPIENTRY glutGetMenuData( void );
185 FGAPI void    FGAPIENTRY glutSetMenuData(void* data);
186
187 /*
188  * Font stuff, see fg_font.c
189  */
190 FGAPI int     FGAPIENTRY glutBitmapHeight( void* font );
191 FGAPI GLfloat FGAPIENTRY glutStrokeHeight( void* font );
192 FGAPI void    FGAPIENTRY glutBitmapString( void* font, const unsigned char *string );
193 FGAPI void    FGAPIENTRY glutStrokeString( void* font, const unsigned char *string );
194
195 /*
196  * Geometry functions, see fg_geometry.c
197  */
198 FGAPI void    FGAPIENTRY glutWireRhombicDodecahedron( void );
199 FGAPI void    FGAPIENTRY glutSolidRhombicDodecahedron( void );
200 FGAPI void    FGAPIENTRY glutWireSierpinskiSponge ( int num_levels, double offset[3], double scale );
201 FGAPI void    FGAPIENTRY glutSolidSierpinskiSponge ( int num_levels, double offset[3], double scale );
202 FGAPI void    FGAPIENTRY glutWireCylinder( double radius, double height, GLint slices, GLint stacks);
203 FGAPI void    FGAPIENTRY glutSolidCylinder( double radius, double height, GLint slices, GLint stacks);
204
205 /*
206  * Rest of functions for rendering Newell's teaset, found in fg_teapot.c
207  * NB: front facing polygons have clockwise winding, not counter clockwise
208  */
209 FGAPI void    FGAPIENTRY glutWireTeacup( double size );
210 FGAPI void    FGAPIENTRY glutSolidTeacup( double size );
211 FGAPI void    FGAPIENTRY glutWireTeaspoon( double size );
212 FGAPI void    FGAPIENTRY glutSolidTeaspoon( double size );
213
214 /*
215  * Extension functions, see fg_ext.c
216  */
217 typedef void (*GLUTproc)();
218 FGAPI GLUTproc FGAPIENTRY glutGetProcAddress( const char *procName );
219
220 /*
221  * Multi-touch/multi-pointer extensions
222  */
223
224 #define GLUT_HAS_MULTI 1
225
226 /* TODO: add device_id parameter,
227    cf. http://sourceforge.net/mailarchive/forum.php?thread_name=20120518071314.GA28061%40perso.beuc.net&forum_name=freeglut-developer */
228 FGAPI void FGAPIENTRY glutMultiEntryFunc( void (* callback)( int, int ) );
229 FGAPI void FGAPIENTRY glutMultiButtonFunc( void (* callback)( int, int, int, int, int ) );
230 FGAPI void FGAPIENTRY glutMultiMotionFunc( void (* callback)( int, int, int ) );
231 FGAPI void FGAPIENTRY glutMultiPassiveFunc( void (* callback)( int, int, int ) );
232
233 /*
234  * Joystick functions, see fg_joystick.c
235  */
236 /* USE OF THESE FUNCTIONS IS DEPRECATED !!!!! */
237 /* If you have a serious need for these functions in your application, please either
238  * contact the "freeglut" developer community at freeglut-developer@lists.sourceforge.net,
239  * switch to the OpenGLUT library, or else port your joystick functionality over to PLIB's
240  * "js" library.
241  */
242 int     glutJoystickGetNumAxes( int ident );
243 int     glutJoystickGetNumButtons( int ident );
244 int     glutJoystickNotWorking( int ident );
245 float   glutJoystickGetDeadBand( int ident, int axis );
246 void    glutJoystickSetDeadBand( int ident, int axis, float db );
247 float   glutJoystickGetSaturation( int ident, int axis );
248 void    glutJoystickSetSaturation( int ident, int axis, float st );
249 void    glutJoystickSetMinRange( int ident, float *axes );
250 void    glutJoystickSetMaxRange( int ident, float *axes );
251 void    glutJoystickSetCenter( int ident, float *axes );
252 void    glutJoystickGetMinRange( int ident, float *axes );
253 void    glutJoystickGetMaxRange( int ident, float *axes );
254 void    glutJoystickGetCenter( int ident, float *axes );
255
256 /*
257  * Initialization functions, see fg_init.c
258  */
259 /* to get the typedef for va_list */
260 #include <stdarg.h>
261 FGAPI void    FGAPIENTRY glutInitContextVersion( int majorVersion, int minorVersion );
262 FGAPI void    FGAPIENTRY glutInitContextFlags( int flags );
263 FGAPI void    FGAPIENTRY glutInitContextProfile( int profile );
264 FGAPI void    FGAPIENTRY glutInitErrorFunc( void (* callback)( const char *fmt, va_list ap ) );
265 FGAPI void    FGAPIENTRY glutInitWarningFunc( void (* callback)( const char *fmt, va_list ap ) );
266
267 /* OpenGL >= 2.0 support */
268 FGAPI void    FGAPIENTRY glutSetVertexAttribCoord3( GLint attrib );
269 FGAPI void    FGAPIENTRY glutSetVertexAttribNormal( GLint attrib );
270 FGAPI void    FGAPIENTRY glutSetVertexAttribTexCoord2( GLint attrib );
271
272 /* Mobile platforms lifecycle */
273 FGAPI void    FGAPIENTRY glutInitContextFunc( void (* callback)( void ) );
274 FGAPI void    FGAPIENTRY glutAppStatusFunc( void (* callback)( int ) );
275 /* state flags that can be passed to callback set by glutAppStatusFunc */
276 #define GLUT_APPSTATUS_PAUSE                0x0001
277 #define GLUT_APPSTATUS_RESUME               0x0002
278
279 /*
280  * GLUT API macro definitions -- the display mode definitions
281  */
282 #define  GLUT_CAPTIONLESS                   0x0400
283 #define  GLUT_BORDERLESS                    0x0800
284 #define  GLUT_SRGB                          0x1000
285
286 /* User-argument callbacks and implementation */
287 #include "freeglut_ucall.h"
288
289 #ifdef __cplusplus
290     }
291 #endif
292
293 /*** END OF FILE ***/
294
295 #endif /* __FREEGLUT_EXT_H__ */