Android: fix/upgrade paths in README
[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
48 /*
49  * GLUT API Extension macro definitions -- behaviour when the user clicks on an "x" to close a window
50  */
51 #define GLUT_ACTION_EXIT                         0
52 #define GLUT_ACTION_GLUTMAINLOOP_RETURNS         1
53 #define GLUT_ACTION_CONTINUE_EXECUTION           2
54
55 /*
56  * Create a new rendering context when the user opens a new window?
57  */
58 #define GLUT_CREATE_NEW_CONTEXT                  0
59 #define GLUT_USE_CURRENT_CONTEXT                 1
60
61 /*
62  * Direct/Indirect rendering context options (has meaning only in Unix/X11)
63  */
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
68
69 /*
70  * GLUT API Extension macro definitions -- the glutGet parameters
71  */
72 #define  GLUT_INIT_STATE                    0x007C
73
74 #define  GLUT_ACTION_ON_WINDOW_CLOSE        0x01F9
75
76 #define  GLUT_WINDOW_BORDER_WIDTH           0x01FA
77 #define  GLUT_WINDOW_HEADER_HEIGHT          0x01FB
78
79 #define  GLUT_VERSION                       0x01FC
80
81 #define  GLUT_RENDERING_CONTEXT             0x01FD
82 #define  GLUT_DIRECT_RENDERING              0x01FE
83
84 #define  GLUT_FULL_SCREEN                   0x01FF
85
86 #define  GLUT_SKIP_STALE_MOTION_EVENTS      0x0204
87
88 /*
89  * New tokens for glutInitDisplayMode.
90  * Only one GLUT_AUXn bit may be used at a time.
91  * Value 0x0400 is defined in OpenGLUT.
92  */
93 #define  GLUT_AUX                           0x1000
94
95 #define  GLUT_AUX1                          0x1000
96 #define  GLUT_AUX2                          0x2000
97 #define  GLUT_AUX3                          0x4000
98 #define  GLUT_AUX4                          0x8000
99
100 /*
101  * Context-related flags, see freeglut_state.c
102  * Set the requested OpenGL version
103  */
104 #define  GLUT_INIT_MAJOR_VERSION            0x0200
105 #define  GLUT_INIT_MINOR_VERSION            0x0201
106 #define  GLUT_INIT_FLAGS                    0x0202
107 #define  GLUT_INIT_PROFILE                  0x0203
108
109 /*
110  * Flags for glutInitContextFlags, see freeglut_init.c
111  */
112 #define  GLUT_DEBUG                         0x0001
113 #define  GLUT_FORWARD_COMPATIBLE            0x0002
114
115
116 /*
117  * Flags for glutInitContextProfile, see freeglut_init.c
118  */
119 #define GLUT_CORE_PROFILE                   0x0001
120 #define GLUT_COMPATIBILITY_PROFILE          0x0002
121
122 /*
123  * Process loop function, see freeglut_main.c
124  */
125 FGAPI void    FGAPIENTRY glutMainLoopEvent( void );
126 FGAPI void    FGAPIENTRY glutLeaveMainLoop( void );
127 FGAPI void    FGAPIENTRY glutExit         ( void );
128
129 /*
130  * Window management functions, see freeglut_window.c
131  */
132 FGAPI void    FGAPIENTRY glutFullScreenToggle( void );
133 FGAPI void    FGAPIENTRY glutLeaveFullScreen( void );
134
135 /*
136  * Window-specific callback functions, see freeglut_callbacks.c
137  */
138 FGAPI void    FGAPIENTRY glutMouseWheelFunc( void (* callback)( int, int, int, int ) );
139 FGAPI void    FGAPIENTRY glutCloseFunc( void (* callback)( void ) );
140 FGAPI void    FGAPIENTRY glutWMCloseFunc( void (* callback)( void ) );
141 /* A. Donev: Also a destruction callback for menus */
142 FGAPI void    FGAPIENTRY glutMenuDestroyFunc( void (* callback)( void ) );
143
144 /*
145  * State setting and retrieval functions, see freeglut_state.c
146  */
147 FGAPI void    FGAPIENTRY glutSetOption ( GLenum option_flag, int value );
148 FGAPI int *   FGAPIENTRY glutGetModeValues(GLenum mode, int * size);
149 /* A.Donev: User-data manipulation */
150 FGAPI void*   FGAPIENTRY glutGetWindowData( void );
151 FGAPI void    FGAPIENTRY glutSetWindowData(void* data);
152 FGAPI void*   FGAPIENTRY glutGetMenuData( void );
153 FGAPI void    FGAPIENTRY glutSetMenuData(void* data);
154
155 /*
156  * Font stuff, see freeglut_font.c
157  */
158 FGAPI int     FGAPIENTRY glutBitmapHeight( void* font );
159 FGAPI GLfloat FGAPIENTRY glutStrokeHeight( void* font );
160 FGAPI void    FGAPIENTRY glutBitmapString( void* font, const unsigned char *string );
161 FGAPI void    FGAPIENTRY glutStrokeString( void* font, const unsigned char *string );
162
163 /*
164  * Geometry functions, see freeglut_geometry.c
165  */
166 #ifndef GL_ES_VERSION_2_0
167 FGAPI void    FGAPIENTRY glutWireRhombicDodecahedron( void );
168 FGAPI void    FGAPIENTRY glutSolidRhombicDodecahedron( void );
169 #endif
170
171 FGAPI void    FGAPIENTRY glutWireSierpinskiSponge ( int num_levels, double offset[3], double scale );
172 FGAPI void    FGAPIENTRY glutSolidSierpinskiSponge ( int num_levels, double offset[3], double scale );
173 #ifndef GL_ES_VERSION_2_0
174 FGAPI void    FGAPIENTRY glutWireCylinder( double radius, double height, GLint slices, GLint stacks);
175 FGAPI void    FGAPIENTRY glutSolidCylinder( double radius, double height, GLint slices, GLint stacks);
176 #endif
177
178 /*
179  * Extension functions, see freeglut_ext.c
180  */
181 typedef void (*GLUTproc)();
182 FGAPI GLUTproc FGAPIENTRY glutGetProcAddress( const char *procName );
183
184 /*
185  * Multi-touch/multi-pointer extensions
186  */
187
188 #define GLUT_HAS_MULTI 1
189
190 FGAPI void FGAPIENTRY glutMultiEntryFunc( void (* callback)( int, int ) );
191 FGAPI void FGAPIENTRY glutMultiButtonFunc( void (* callback)( int, int, int, int, int ) );
192 FGAPI void FGAPIENTRY glutMultiMotionFunc( void (* callback)( int, int, int ) );
193 FGAPI void FGAPIENTRY glutMultiPassiveFunc( void (* callback)( int, int, int ) );
194
195 /*
196  * Joystick functions, see freeglut_joystick.c
197  */
198 /* USE OF THESE FUNCTIONS IS DEPRECATED !!!!! */
199 /* If you have a serious need for these functions in your application, please either
200  * contact the "freeglut" developer community at freeglut-developer@lists.sourceforge.net,
201  * switch to the OpenGLUT library, or else port your joystick functionality over to PLIB's
202  * "js" library.
203  */
204 int     glutJoystickGetNumAxes( int ident );
205 int     glutJoystickGetNumButtons( int ident );
206 int     glutJoystickNotWorking( int ident );
207 float   glutJoystickGetDeadBand( int ident, int axis );
208 void    glutJoystickSetDeadBand( int ident, int axis, float db );
209 float   glutJoystickGetSaturation( int ident, int axis );
210 void    glutJoystickSetSaturation( int ident, int axis, float st );
211 void    glutJoystickSetMinRange( int ident, float *axes );
212 void    glutJoystickSetMaxRange( int ident, float *axes );
213 void    glutJoystickSetCenter( int ident, float *axes );
214 void    glutJoystickGetMinRange( int ident, float *axes );
215 void    glutJoystickGetMaxRange( int ident, float *axes );
216 void    glutJoystickGetCenter( int ident, float *axes );
217
218 /*
219  * Initialization functions, see freeglut_init.c
220  */
221 FGAPI void    FGAPIENTRY glutInitContextVersion( int majorVersion, int minorVersion );
222 FGAPI void    FGAPIENTRY glutInitContextFlags( int flags );
223 FGAPI void    FGAPIENTRY glutInitContextProfile( int profile );
224
225 /* to get the typedef for va_list */
226 #include <stdarg.h>
227
228 FGAPI void    FGAPIENTRY glutInitErrorFunc( void (* vError)( const char *fmt, va_list ap ) );
229 FGAPI void    FGAPIENTRY glutInitWarningFunc( void (* vWarning)( const char *fmt, va_list ap ) );
230
231 /* OpenGL >= 2.0 support */
232 FGAPI void    FGAPIENTRY glutSetVertexAttribCoord3(GLint attrib);
233 FGAPI void    FGAPIENTRY glutSetVertexAttribNormal(GLint attrib);
234
235
236 /*
237  * GLUT API macro definitions -- the display mode definitions
238  */
239 #define  GLUT_CAPTIONLESS                   0x0400
240 #define  GLUT_BORDERLESS                    0x0800
241 #define  GLUT_SRGB                          0x1000
242
243 #ifdef __cplusplus
244     }
245 #endif
246
247 /*** END OF FILE ***/
248
249 #endif /* __FREEGLUT_EXT_H__ */