1 #ifndef __FREEGLUT_EXT_H__
2 #define __FREEGLUT_EXT_H__
7 * The non-GLUT-compatible extensions to the freeglut library include file
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
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:
20 * The above copyright notice and this permission notice shall be included
21 * in all copies or substantial portions of the Software.
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.
36 * Additional GLUT Key definitions for the Special key function
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
49 * GLUT API Extension macro definitions -- behaviour when the user clicks on an "x" to close a window
51 #define GLUT_ACTION_EXIT 0
52 #define GLUT_ACTION_GLUTMAINLOOP_RETURNS 1
53 #define GLUT_ACTION_CONTINUE_EXECUTION 2
56 * Create a new rendering context when the user opens a new window?
58 #define GLUT_CREATE_NEW_CONTEXT 0
59 #define GLUT_USE_CURRENT_CONTEXT 1
62 * Direct/Indirect rendering context options (has meaning only in Unix/X11)
64 #define GLUT_FORCE_INDIRECT_CONTEXT 0
65 #define GLUT_ALLOW_DIRECT_CONTEXT 1
66 #define GLUT_TRY_DIRECT_CONTEXT 2
67 #define GLUT_FORCE_DIRECT_CONTEXT 3
70 * GLUT API Extension macro definitions -- the glutGet parameters
72 #define GLUT_INIT_STATE 0x007C
74 #define GLUT_ACTION_ON_WINDOW_CLOSE 0x01F9
76 #define GLUT_WINDOW_BORDER_WIDTH 0x01FA
77 #define GLUT_WINDOW_BORDER_HEIGHT 0x01FB
78 #define GLUT_WINDOW_HEADER_HEIGHT 0x01FB /* Docs say it should always have been GLUT_WINDOW_BORDER_HEIGHT, keep this for backward compatibility */
80 #define GLUT_VERSION 0x01FC
82 #define GLUT_RENDERING_CONTEXT 0x01FD
83 #define GLUT_DIRECT_RENDERING 0x01FE
85 #define GLUT_FULL_SCREEN 0x01FF
87 #define GLUT_SKIP_STALE_MOTION_EVENTS 0x0204
89 #define GLUT_GEOMETRY_VISUALIZE_NORMALS 0x0205
92 * New tokens for glutInitDisplayMode.
93 * Only one GLUT_AUXn bit may be used at a time.
94 * Value 0x0400 is defined in OpenGLUT.
96 #define GLUT_AUX 0x1000
98 #define GLUT_AUX1 0x1000
99 #define GLUT_AUX2 0x2000
100 #define GLUT_AUX3 0x4000
101 #define GLUT_AUX4 0x8000
104 * Context-related flags, see freeglut_state.c
105 * Set the requested OpenGL version
107 #define GLUT_INIT_MAJOR_VERSION 0x0200
108 #define GLUT_INIT_MINOR_VERSION 0x0201
109 #define GLUT_INIT_FLAGS 0x0202
110 #define GLUT_INIT_PROFILE 0x0203
113 * Flags for glutInitContextFlags, see freeglut_init.c
115 #define GLUT_DEBUG 0x0001
116 #define GLUT_FORWARD_COMPATIBLE 0x0002
120 * Flags for glutInitContextProfile, see freeglut_init.c
122 #define GLUT_CORE_PROFILE 0x0001
123 #define GLUT_COMPATIBILITY_PROFILE 0x0002
126 * Process loop function, see freeglut_main.c
128 FGAPI void FGAPIENTRY glutMainLoopEvent( void );
129 FGAPI void FGAPIENTRY glutLeaveMainLoop( void );
130 FGAPI void FGAPIENTRY glutExit ( void );
133 * Window management functions, see freeglut_window.c
135 FGAPI void FGAPIENTRY glutFullScreenToggle( void );
136 FGAPI void FGAPIENTRY glutLeaveFullScreen( void );
141 FGAPI void FGAPIENTRY glutSetMenuFont( int menuID, void* font );
144 * Window-specific callback functions, see freeglut_callbacks.c
146 FGAPI void FGAPIENTRY glutMouseWheelFunc( void (* callback)( int, int, int, int ) );
147 FGAPI void FGAPIENTRY glutPositionFunc( void (* callback)( int, int ) );
148 FGAPI void FGAPIENTRY glutCloseFunc( void (* callback)( void ) );
149 FGAPI void FGAPIENTRY glutWMCloseFunc( void (* callback)( void ) );
150 /* And also a destruction callback for menus */
151 FGAPI void FGAPIENTRY glutMenuDestroyFunc( void (* callback)( void ) );
154 * State setting and retrieval functions, see freeglut_state.c
156 FGAPI void FGAPIENTRY glutSetOption ( GLenum option_flag, int value );
157 FGAPI int * FGAPIENTRY glutGetModeValues(GLenum mode, int * size);
158 /* A.Donev: User-data manipulation */
159 FGAPI void* FGAPIENTRY glutGetWindowData( void );
160 FGAPI void FGAPIENTRY glutSetWindowData(void* data);
161 FGAPI void* FGAPIENTRY glutGetMenuData( void );
162 FGAPI void FGAPIENTRY glutSetMenuData(void* data);
165 * Font stuff, see freeglut_font.c
167 FGAPI int FGAPIENTRY glutBitmapHeight( void* font );
168 FGAPI GLfloat FGAPIENTRY glutStrokeHeight( void* font );
169 FGAPI void FGAPIENTRY glutBitmapString( void* font, const unsigned char *string );
170 FGAPI void FGAPIENTRY glutStrokeString( void* font, const unsigned char *string );
173 * Geometry functions, see freeglut_geometry.c
175 FGAPI void FGAPIENTRY glutWireRhombicDodecahedron( void );
176 FGAPI void FGAPIENTRY glutSolidRhombicDodecahedron( void );
177 FGAPI void FGAPIENTRY glutWireSierpinskiSponge ( int num_levels, double offset[3], double scale );
178 FGAPI void FGAPIENTRY glutSolidSierpinskiSponge ( int num_levels, double offset[3], double scale );
179 FGAPI void FGAPIENTRY glutWireCylinder( double radius, double height, GLint slices, GLint stacks);
180 FGAPI void FGAPIENTRY glutSolidCylinder( double radius, double height, GLint slices, GLint stacks);
183 * Rest of functions for rendering Newell's teaset, found in freeglut_teapot.c
184 * NB: front facing polygons have clockwise winding, not counter clockwise
186 FGAPI void FGAPIENTRY glutWireTeacup( double size );
187 FGAPI void FGAPIENTRY glutSolidTeacup( double size );
188 FGAPI void FGAPIENTRY glutWireTeaspoon( double size );
189 FGAPI void FGAPIENTRY glutSolidTeaspoon( double size );
192 * Extension functions, see freeglut_ext.c
194 typedef void (*GLUTproc)();
195 FGAPI GLUTproc FGAPIENTRY glutGetProcAddress( const char *procName );
198 * Multi-touch/multi-pointer extensions
201 #define GLUT_HAS_MULTI 1
203 /* TODO: add device_id paramater,
204 cf. http://sourceforge.net/mailarchive/forum.php?thread_name=20120518071314.GA28061%40perso.beuc.net&forum_name=freeglut-developer */
205 FGAPI void FGAPIENTRY glutMultiEntryFunc( void (* callback)( int, int ) );
206 FGAPI void FGAPIENTRY glutMultiButtonFunc( void (* callback)( int, int, int, int, int ) );
207 FGAPI void FGAPIENTRY glutMultiMotionFunc( void (* callback)( int, int, int ) );
208 FGAPI void FGAPIENTRY glutMultiPassiveFunc( void (* callback)( int, int, int ) );
211 * Joystick functions, see freeglut_joystick.c
213 /* USE OF THESE FUNCTIONS IS DEPRECATED !!!!! */
214 /* If you have a serious need for these functions in your application, please either
215 * contact the "freeglut" developer community at freeglut-developer@lists.sourceforge.net,
216 * switch to the OpenGLUT library, or else port your joystick functionality over to PLIB's
219 int glutJoystickGetNumAxes( int ident );
220 int glutJoystickGetNumButtons( int ident );
221 int glutJoystickNotWorking( int ident );
222 float glutJoystickGetDeadBand( int ident, int axis );
223 void glutJoystickSetDeadBand( int ident, int axis, float db );
224 float glutJoystickGetSaturation( int ident, int axis );
225 void glutJoystickSetSaturation( int ident, int axis, float st );
226 void glutJoystickSetMinRange( int ident, float *axes );
227 void glutJoystickSetMaxRange( int ident, float *axes );
228 void glutJoystickSetCenter( int ident, float *axes );
229 void glutJoystickGetMinRange( int ident, float *axes );
230 void glutJoystickGetMaxRange( int ident, float *axes );
231 void glutJoystickGetCenter( int ident, float *axes );
234 * Initialization functions, see freeglut_init.c
236 /* to get the typedef for va_list */
238 FGAPI void FGAPIENTRY glutInitContextVersion( int majorVersion, int minorVersion );
239 FGAPI void FGAPIENTRY glutInitContextFlags( int flags );
240 FGAPI void FGAPIENTRY glutInitContextProfile( int profile );
241 FGAPI void FGAPIENTRY glutInitErrorFunc( void (* callback)( const char *fmt, va_list ap ) );
242 FGAPI void FGAPIENTRY glutInitWarningFunc( void (* callback)( const char *fmt, va_list ap ) );
244 /* OpenGL >= 2.0 support */
245 FGAPI void FGAPIENTRY glutSetVertexAttribCoord3(GLint attrib);
246 FGAPI void FGAPIENTRY glutSetVertexAttribNormal(GLint attrib);
247 FGAPI void FGAPIENTRY glutSetVertexAttribTexCoord2(GLint attrib);
249 /* Mobile platforms lifecycle */
250 FGAPI void FGAPIENTRY glutInitContextFunc(void (* callback)());
251 FGAPI void FGAPIENTRY glutAppStatusFunc(void (* callback)(int));
252 /* state flags that can be passed to callback set by glutAppStatusFunc */
253 #define GLUT_APPSTATUS_PAUSE 0x0001
254 #define GLUT_APPSTATUS_RESUME 0x0002
257 * GLUT API macro definitions -- the display mode definitions
259 #define GLUT_CAPTIONLESS 0x0400
260 #define GLUT_BORDERLESS 0x0800
261 #define GLUT_SRGB 0x1000
267 /*** END OF FILE ***/
269 #endif /* __FREEGLUT_EXT_H__ */