Implementing Jocelyn Frechot's changes -- see e-mail of Thursday, 11/8/2007 9:12 AM.
[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  * GLUT API Extension macro definitions -- behaviour when the user clicks on an "x" to close a window
37  */
38 #define GLUT_ACTION_EXIT                         0
39 #define GLUT_ACTION_GLUTMAINLOOP_RETURNS         1
40 #define GLUT_ACTION_CONTINUE_EXECUTION           2
41
42 /*
43  * Create a new rendering context when the user opens a new window?
44  */
45 #define GLUT_CREATE_NEW_CONTEXT                  0
46 #define GLUT_USE_CURRENT_CONTEXT                 1
47
48 /*
49  * Direct/Indirect rendering context options (has meaning only in Unix/X11)
50  */
51 #define GLUT_FORCE_INDIRECT_CONTEXT              0
52 #define GLUT_ALLOW_DIRECT_CONTEXT                1
53 #define GLUT_TRY_DIRECT_CONTEXT                  2
54 #define GLUT_FORCE_DIRECT_CONTEXT                3
55
56 /*
57  * GLUT API Extension macro definitions -- the glutGet parameters
58  */
59 #define  GLUT_INIT_STATE                    0x007C
60
61 #define  GLUT_ACTION_ON_WINDOW_CLOSE        0x01F9
62
63 #define  GLUT_WINDOW_BORDER_WIDTH           0x01FA
64 #define  GLUT_WINDOW_HEADER_HEIGHT          0x01FB
65
66 #define  GLUT_VERSION                       0x01FC
67
68 #define  GLUT_RENDERING_CONTEXT             0x01FD
69 #define  GLUT_DIRECT_RENDERING              0x01FE
70
71 /*
72  * New tokens for glutInitDisplayMode.
73  * Only one GLUT_AUXn bit may be used at a time.
74  * Value 0x0400 is defined in OpenGLUT.
75  */
76 #define  GLUT_AUX                           0x1000
77
78 #define  GLUT_AUX1                          0x1000
79 #define  GLUT_AUX2                          0x2000
80 #define  GLUT_AUX3                          0x4000
81 #define  GLUT_AUX4                          0x8000
82
83
84 /*
85  * Process loop function, see freeglut_main.c
86  */
87 FGAPI void    FGAPIENTRY glutMainLoopEvent( void );
88 FGAPI void    FGAPIENTRY glutLeaveMainLoop( void );
89 FGAPI void    FGAPIENTRY glutExit         ( void );
90
91 /*
92  * Window-specific callback functions, see freeglut_callbacks.c
93  */
94 FGAPI void    FGAPIENTRY glutMouseWheelFunc( void (* callback)( int, int, int, int ) );
95 FGAPI void    FGAPIENTRY glutCloseFunc( void (* callback)( void ) );
96 FGAPI void    FGAPIENTRY glutWMCloseFunc( void (* callback)( void ) );
97 /* A. Donev: Also a destruction callback for menus */
98 FGAPI void    FGAPIENTRY glutMenuDestroyFunc( void (* callback)( void ) );
99
100 /*
101  * State setting and retrieval functions, see freeglut_state.c
102  */
103 FGAPI void    FGAPIENTRY glutSetOption ( GLenum option_flag, int value );
104 FGAPI int *   FGAPIENTRY glutGetModeValues(GLenum mode, int * size);
105 /* A.Donev: User-data manipulation */
106 FGAPI void*   FGAPIENTRY glutGetWindowData( void );
107 FGAPI void    FGAPIENTRY glutSetWindowData(void* data);
108 FGAPI void*   FGAPIENTRY glutGetMenuData( void );
109 FGAPI void    FGAPIENTRY glutSetMenuData(void* data);
110
111 /*
112  * Font stuff, see freeglut_font.c
113  */
114 FGAPI int     FGAPIENTRY glutBitmapHeight( void* font );
115 FGAPI GLfloat FGAPIENTRY glutStrokeHeight( void* font );
116 FGAPI void    FGAPIENTRY glutBitmapString( void* font, const unsigned char *string );
117 FGAPI void    FGAPIENTRY glutStrokeString( void* font, const unsigned char *string );
118
119 /*
120  * Geometry functions, see freeglut_geometry.c
121  */
122 FGAPI void    FGAPIENTRY glutWireRhombicDodecahedron( void );
123 FGAPI void    FGAPIENTRY glutSolidRhombicDodecahedron( void );
124 FGAPI void    FGAPIENTRY glutWireSierpinskiSponge ( int num_levels, GLdouble offset[3], GLdouble scale );
125 FGAPI void    FGAPIENTRY glutSolidSierpinskiSponge ( int num_levels, GLdouble offset[3], GLdouble scale );
126 FGAPI void    FGAPIENTRY glutWireCylinder( GLdouble radius, GLdouble height, GLint slices, GLint stacks);
127 FGAPI void    FGAPIENTRY glutSolidCylinder( GLdouble radius, GLdouble height, GLint slices, GLint stacks);
128
129 /*
130  * Extension functions, see freeglut_ext.c
131  */
132 typedef void (*GLUTproc)();
133 FGAPI GLUTproc FGAPIENTRY glutGetProcAddress( const char *procName );
134
135 /*
136  * Joystick functions, see freeglut_joystick.c
137  */
138 /* USE OF THESE FUNCTIONS IS DEPRECATED !!!!! */
139 /* If you have a serious need for these functions in your application, please either
140  * contact the "freeglut" developer community at freeglut-developer@lists.sourceforge.net,
141  * switch to the OpenGLUT library, or else port your joystick functionality over to PLIB's
142  * "js" library.
143  */
144 int     glutJoystickGetNumAxes( int ident );
145 int     glutJoystickGetNumButtons( int ident );
146 int     glutJoystickNotWorking( int ident );
147 float   glutJoystickGetDeadBand( int ident, int axis );
148 void    glutJoystickSetDeadBand( int ident, int axis, float db );
149 float   glutJoystickGetSaturation( int ident, int axis );
150 void    glutJoystickSetSaturation( int ident, int axis, float st );
151 void    glutJoystickSetMinRange( int ident, float *axes );
152 void    glutJoystickSetMaxRange( int ident, float *axes );
153 void    glutJoystickSetCenter( int ident, float *axes );
154 void    glutJoystickGetMinRange( int ident, float *axes );
155 void    glutJoystickGetMaxRange( int ident, float *axes );
156 void    glutJoystickGetCenter( int ident, float *axes );
157
158 #ifdef __cplusplus
159     }
160 #endif
161
162 /*** END OF FILE ***/
163
164 #endif /* __FREEGLUT_EXT_H__ */