GLU_EXT_get_proc_address clean-up
[mesa.git] / include / GL / glu.h
1 /* $Id: glu.h,v 1.6 1999/09/16 16:54:22 brianp Exp $ */
2
3 /*
4 * Mesa 3-D graphics library
5 * Version: 3.1
6 * Copyright (C) 1995-1999 Brian Paul
7 *
8 * This library is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Library General Public
10 * License as published by the Free Software Foundation; either
11 * version 2 of the License, or (at your option) any later version.
12 *
13 * This library is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * Library General Public License for more details.
17 *
18 * You should have received a copy of the GNU Library General Public
19 * License along with this library; if not, write to the Free
20 * Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21 */
22
23
24 /*
25 * $Log: glu.h,v $
26 * Revision 1.6 1999/09/16 16:54:22 brianp
27 * GLU_EXT_get_proc_address clean-up
28 *
29 * Revision 1.5 1999/09/14 03:23:08 gareth
30 * Fixed GLUtriangulatorObj again (spelling).
31 *
32 * Revision 1.4 1999/09/14 01:32:58 gareth
33 * Fixed definition of GLUtriangluatorObj for 1.3 tessellator.
34 *
35 * Revision 1.3 1999/09/11 11:34:21 brianp
36 * added GLU_EXT_get_proc_address
37 *
38 * Revision 1.2 1999/09/10 02:08:18 gareth
39 * Added GLU 1.3 tessellation (except winding rule code).
40 *
41 * Revision 1.1.1.1 1999/08/19 00:55:40 jtg
42 * Imported sources
43 *
44 * Revision 3.6 1999/02/14 03:39:45 brianp
45 * updated for BeOS R4
46 *
47 * Revision 3.5 1999/01/03 03:02:55 brianp
48 * now using GLAPI and GLAPIENTRY keywords, misc Windows changes (Ted Jump)
49 *
50 * Revision 3.4 1998/12/01 02:34:27 brianp
51 * applied Mark Kilgard's patches from November 30, 1998
52 *
53 * Revision 3.3 1998/11/17 01:14:02 brianp
54 * minor changes for OpenStep compilation (pete@ohm.york.ac.uk)
55 *
56 * Revision 3.2 1998/07/26 01:36:27 brianp
57 * changes for Windows compilation per Ted Jump
58 *
59 * Revision 3.1 1998/06/23 00:33:08 brianp
60 * added some WIN32 APIENTRY, CALLBACK stuff (Eric Lassauge)
61 *
62 * Revision 3.0 1998/02/20 05:06:01 brianp
63 * initial rev
64 *
65 */
66
67
68 #ifndef GLU_H
69 #define GLU_H
70
71
72 #if defined(USE_MGL_NAMESPACE)
73 #include "glu_mangle.h"
74 #endif
75
76
77 #ifdef __cplusplus
78 extern "C" {
79 #endif
80
81
82 #include "GL/gl.h"
83
84 /* to facilitate clean DLL building ... */
85 #if !defined(OPENSTEP) && (defined(__WIN32__) || defined(__CYGWIN32__))
86 # if defined(_MSC_VER) && defined(BUILD_GLU32) /* tag specify we're building mesa as a DLL */
87 # define GLUAPI __declspec(dllexport)
88 # elif defined(_MSC_VER) && defined(_DLL) /* tag specifying we're building for DLL runtime support */
89 # define GLUAPI __declspec(dllimport)
90 # else /* for use with static link lib build of Win32 edition only */
91 # define GLUAPI extern
92 # endif /* _STATIC_MESA support */
93 #else
94 # define GLUAPI extern
95 #endif /* WIN32 / CYGWIN32 bracket */
96
97 #ifdef macintosh
98 #pragma enumsalwaysint on
99 #if PRAGMA_IMPORT_SUPPORTED
100 #pragma import on
101 #endif
102 #endif
103
104
105 #define GLU_VERSION_1_1 1
106 #define GLU_VERSION_1_2 1
107
108
109 #define GLU_TRUE GL_TRUE
110 #define GLU_FALSE GL_FALSE
111
112
113 enum {
114 /* Normal vectors */
115 GLU_SMOOTH = 100000,
116 GLU_FLAT = 100001,
117 GLU_NONE = 100002,
118
119 /* Quadric draw styles */
120 GLU_POINT = 100010,
121 GLU_LINE = 100011,
122 GLU_FILL = 100012,
123 GLU_SILHOUETTE = 100013,
124
125 /* Quadric orientation */
126 GLU_OUTSIDE = 100020,
127 GLU_INSIDE = 100021,
128
129 /* Tessellator */
130 GLU_TESS_BEGIN = 100100,
131 GLU_TESS_VERTEX = 100101,
132 GLU_TESS_END = 100102,
133 GLU_TESS_ERROR = 100103,
134 GLU_TESS_EDGE_FLAG = 100104,
135 GLU_TESS_COMBINE = 100105,
136
137 GLU_TESS_BEGIN_DATA = 100106,
138 GLU_TESS_VERTEX_DATA = 100107,
139 GLU_TESS_END_DATA = 100108,
140 GLU_TESS_ERROR_DATA = 100109,
141 GLU_TESS_EDGE_FLAG_DATA = 100110,
142 GLU_TESS_COMBINE_DATA = 100111,
143
144 /* Winding rules */
145 GLU_TESS_WINDING_ODD = 100130,
146 GLU_TESS_WINDING_NONZERO = 100131,
147 GLU_TESS_WINDING_POSITIVE = 100132,
148 GLU_TESS_WINDING_NEGATIVE = 100133,
149 GLU_TESS_WINDING_ABS_GEQ_TWO = 100134,
150
151 /* Tessellation properties */
152 GLU_TESS_WINDING_RULE = 100140,
153 GLU_TESS_BOUNDARY_ONLY = 100141,
154 GLU_TESS_TOLERANCE = 100142,
155
156 /* Tessellation errors */
157 GLU_TESS_ERROR1 = 100151, /* Missing gluBeginPolygon */
158 GLU_TESS_ERROR2 = 100152, /* Missing gluBeginContour */
159 GLU_TESS_ERROR3 = 100153, /* Missing gluEndPolygon */
160 GLU_TESS_ERROR4 = 100154, /* Missing gluEndContour */
161 GLU_TESS_ERROR5 = 100155, /* */
162 GLU_TESS_ERROR6 = 100156, /* */
163 GLU_TESS_ERROR7 = 100157, /* */
164 GLU_TESS_ERROR8 = 100158, /* */
165
166 /* NURBS */
167 GLU_AUTO_LOAD_MATRIX = 100200,
168 GLU_CULLING = 100201,
169 GLU_PARAMETRIC_TOLERANCE= 100202,
170 GLU_SAMPLING_TOLERANCE = 100203,
171 GLU_DISPLAY_MODE = 100204,
172 GLU_SAMPLING_METHOD = 100205,
173 GLU_U_STEP = 100206,
174 GLU_V_STEP = 100207,
175
176 GLU_PATH_LENGTH = 100215,
177 GLU_PARAMETRIC_ERROR = 100216,
178 GLU_DOMAIN_DISTANCE = 100217,
179
180 GLU_MAP1_TRIM_2 = 100210,
181 GLU_MAP1_TRIM_3 = 100211,
182
183 GLU_OUTLINE_POLYGON = 100240,
184 GLU_OUTLINE_PATCH = 100241,
185
186 GLU_NURBS_ERROR1 = 100251, /* spline order un-supported */
187 GLU_NURBS_ERROR2 = 100252, /* too few knots */
188 GLU_NURBS_ERROR3 = 100253, /* valid knot range is empty */
189 GLU_NURBS_ERROR4 = 100254, /* decreasing knot sequence */
190 GLU_NURBS_ERROR5 = 100255, /* knot multiplicity > spline order */
191 GLU_NURBS_ERROR6 = 100256, /* endcurve() must follow bgncurve() */
192 GLU_NURBS_ERROR7 = 100257, /* bgncurve() must precede endcurve() */
193 GLU_NURBS_ERROR8 = 100258, /* ctrlarray or knot vector is NULL */
194 GLU_NURBS_ERROR9 = 100259, /* can't draw pwlcurves */
195 GLU_NURBS_ERROR10 = 100260, /* missing gluNurbsCurve() */
196 GLU_NURBS_ERROR11 = 100261, /* missing gluNurbsSurface() */
197 GLU_NURBS_ERROR12 = 100262, /* endtrim() must precede endsurface() */
198 GLU_NURBS_ERROR13 = 100263, /* bgnsurface() must precede endsurface() */
199 GLU_NURBS_ERROR14 = 100264, /* curve of improper type passed as trim curve */
200 GLU_NURBS_ERROR15 = 100265, /* bgnsurface() must precede bgntrim() */
201 GLU_NURBS_ERROR16 = 100266, /* endtrim() must follow bgntrim() */
202 GLU_NURBS_ERROR17 = 100267, /* bgntrim() must precede endtrim()*/
203 GLU_NURBS_ERROR18 = 100268, /* invalid or missing trim curve*/
204 GLU_NURBS_ERROR19 = 100269, /* bgntrim() must precede pwlcurve() */
205 GLU_NURBS_ERROR20 = 100270, /* pwlcurve referenced twice*/
206 GLU_NURBS_ERROR21 = 100271, /* pwlcurve and nurbscurve mixed */
207 GLU_NURBS_ERROR22 = 100272, /* improper usage of trim data type */
208 GLU_NURBS_ERROR23 = 100273, /* nurbscurve referenced twice */
209 GLU_NURBS_ERROR24 = 100274, /* nurbscurve and pwlcurve mixed */
210 GLU_NURBS_ERROR25 = 100275, /* nurbssurface referenced twice */
211 GLU_NURBS_ERROR26 = 100276, /* invalid property */
212 GLU_NURBS_ERROR27 = 100277, /* endsurface() must follow bgnsurface() */
213 GLU_NURBS_ERROR28 = 100278, /* intersecting or misoriented trim curves */
214 GLU_NURBS_ERROR29 = 100279, /* intersecting trim curves */
215 GLU_NURBS_ERROR30 = 100280, /* UNUSED */
216 GLU_NURBS_ERROR31 = 100281, /* unconnected trim curves */
217 GLU_NURBS_ERROR32 = 100282, /* unknown knot error */
218 GLU_NURBS_ERROR33 = 100283, /* negative vertex count encountered */
219 GLU_NURBS_ERROR34 = 100284, /* negative byte-stride */
220 GLU_NURBS_ERROR35 = 100285, /* unknown type descriptor */
221 GLU_NURBS_ERROR36 = 100286, /* null control point reference */
222 GLU_NURBS_ERROR37 = 100287, /* duplicate point on pwlcurve */
223
224 /* Errors */
225 GLU_INVALID_ENUM = 100900,
226 GLU_INVALID_VALUE = 100901,
227 GLU_OUT_OF_MEMORY = 100902,
228 GLU_INCOMPATIBLE_GL_VERSION = 100903,
229
230 /* New in GLU 1.1 */
231 GLU_VERSION = 100800,
232 GLU_EXTENSIONS = 100801,
233
234 /*** GLU 1.0 tessellation - obsolete! ***/
235
236 /* Contour types */
237 GLU_CW = 100120,
238 GLU_CCW = 100121,
239 GLU_INTERIOR = 100122,
240 GLU_EXTERIOR = 100123,
241 GLU_UNKNOWN = 100124,
242
243 /* Tessellator */
244 GLU_BEGIN = GLU_TESS_BEGIN,
245 GLU_VERTEX = GLU_TESS_VERTEX,
246 GLU_END = GLU_TESS_END,
247 GLU_ERROR = GLU_TESS_ERROR,
248 GLU_EDGE_FLAG = GLU_TESS_EDGE_FLAG
249 };
250
251
252 /*
253 * These are the GLU 1.1 typedefs. GLU 1.3 has different ones!
254 */
255 #if defined(__BEOS__)
256 /* The BeOS does something funky and makes these typedefs in one
257 * of its system headers.
258 */
259 #else
260 typedef struct GLUquadric GLUquadricObj;
261 typedef struct GLUnurbs GLUnurbsObj;
262
263 /* FIXME: We need to implement the other 1.3 typedefs - GH */
264 typedef struct GLUtesselator GLUtesselator;
265 typedef GLUtesselator GLUtriangulatorObj;
266 #endif
267
268
269
270 #if defined(__BEOS__) || defined(__QUICKDRAW__)
271 #pragma export on
272 #endif
273
274
275 /*
276 *
277 * Miscellaneous functions
278 *
279 */
280
281 GLUAPI void GLAPIENTRY gluLookAt( GLdouble eyex, GLdouble eyey, GLdouble eyez,
282 GLdouble centerx, GLdouble centery,
283 GLdouble centerz,
284 GLdouble upx, GLdouble upy, GLdouble upz );
285
286
287 GLUAPI void GLAPIENTRY gluOrtho2D( GLdouble left, GLdouble right,
288 GLdouble bottom, GLdouble top );
289
290
291 GLUAPI void GLAPIENTRY gluPerspective( GLdouble fovy, GLdouble aspect,
292 GLdouble zNear, GLdouble zFar );
293
294
295 GLUAPI void GLAPIENTRY gluPickMatrix( GLdouble x, GLdouble y,
296 GLdouble width, GLdouble height,
297 const GLint viewport[4] );
298
299 GLUAPI GLint GLAPIENTRY gluProject( GLdouble objx, GLdouble objy, GLdouble objz,
300 const GLdouble modelMatrix[16],
301 const GLdouble projMatrix[16],
302 const GLint viewport[4],
303 GLdouble *winx, GLdouble *winy,
304 GLdouble *winz );
305
306 GLUAPI GLint GLAPIENTRY gluUnProject( GLdouble winx, GLdouble winy,
307 GLdouble winz,
308 const GLdouble modelMatrix[16],
309 const GLdouble projMatrix[16],
310 const GLint viewport[4],
311 GLdouble *objx, GLdouble *objy,
312 GLdouble *objz );
313
314 GLUAPI const GLubyte* GLAPIENTRY gluErrorString( GLenum errorCode );
315
316
317
318 /*
319 *
320 * Mipmapping and image scaling
321 *
322 */
323
324 GLUAPI GLint GLAPIENTRY gluScaleImage( GLenum format,
325 GLint widthin, GLint heightin,
326 GLenum typein, const void *datain,
327 GLint widthout, GLint heightout,
328 GLenum typeout, void *dataout );
329
330 GLUAPI GLint GLAPIENTRY gluBuild1DMipmaps( GLenum target, GLint components,
331 GLint width, GLenum format,
332 GLenum type, const void *data );
333
334 GLUAPI GLint GLAPIENTRY gluBuild2DMipmaps( GLenum target, GLint components,
335 GLint width, GLint height,
336 GLenum format,
337 GLenum type, const void *data );
338
339
340
341 /*
342 *
343 * Quadrics
344 *
345 */
346
347 GLUAPI GLUquadricObj* GLAPIENTRY gluNewQuadric( void );
348
349 GLUAPI void GLAPIENTRY gluDeleteQuadric( GLUquadricObj *state );
350
351 GLUAPI void GLAPIENTRY gluQuadricDrawStyle( GLUquadricObj *quadObject,
352 GLenum drawStyle );
353
354 GLUAPI void GLAPIENTRY gluQuadricOrientation( GLUquadricObj *quadObject,
355 GLenum orientation );
356
357 GLUAPI void GLAPIENTRY gluQuadricNormals( GLUquadricObj *quadObject,
358 GLenum normals );
359
360 GLUAPI void GLAPIENTRY gluQuadricTexture( GLUquadricObj *quadObject,
361 GLboolean textureCoords );
362
363 GLUAPI void GLAPIENTRY gluQuadricCallback( GLUquadricObj *qobj,
364 GLenum which, void (GLCALLBACK *fn)() );
365
366 GLUAPI void GLAPIENTRY gluCylinder( GLUquadricObj *qobj,
367 GLdouble baseRadius,
368 GLdouble topRadius,
369 GLdouble height,
370 GLint slices, GLint stacks );
371
372 GLUAPI void GLAPIENTRY gluSphere( GLUquadricObj *qobj,
373 GLdouble radius, GLint slices, GLint stacks );
374
375 GLUAPI void GLAPIENTRY gluDisk( GLUquadricObj *qobj,
376 GLdouble innerRadius, GLdouble outerRadius,
377 GLint slices, GLint loops );
378
379 GLUAPI void GLAPIENTRY gluPartialDisk( GLUquadricObj *qobj, GLdouble innerRadius,
380 GLdouble outerRadius, GLint slices,
381 GLint loops, GLdouble startAngle,
382 GLdouble sweepAngle );
383
384
385
386 /*
387 *
388 * Nurbs
389 *
390 */
391
392 GLUAPI GLUnurbsObj* GLAPIENTRY gluNewNurbsRenderer( void );
393
394 GLUAPI void GLAPIENTRY gluDeleteNurbsRenderer( GLUnurbsObj *nobj );
395
396 GLUAPI void GLAPIENTRY gluLoadSamplingMatrices( GLUnurbsObj *nobj,
397 const GLfloat modelMatrix[16],
398 const GLfloat projMatrix[16],
399 const GLint viewport[4] );
400
401 GLUAPI void GLAPIENTRY gluNurbsProperty( GLUnurbsObj *nobj, GLenum property,
402 GLfloat value );
403
404 GLUAPI void GLAPIENTRY gluGetNurbsProperty( GLUnurbsObj *nobj, GLenum property,
405 GLfloat *value );
406
407 GLUAPI void GLAPIENTRY gluBeginCurve( GLUnurbsObj *nobj );
408
409 GLUAPI void GLAPIENTRY gluEndCurve( GLUnurbsObj * nobj );
410
411 GLUAPI void GLAPIENTRY gluNurbsCurve( GLUnurbsObj *nobj, GLint nknots,
412 GLfloat *knot, GLint stride,
413 GLfloat *ctlarray, GLint order,
414 GLenum type );
415
416 GLUAPI void GLAPIENTRY gluBeginSurface( GLUnurbsObj *nobj );
417
418 GLUAPI void GLAPIENTRY gluEndSurface( GLUnurbsObj * nobj );
419
420 GLUAPI void GLAPIENTRY gluNurbsSurface( GLUnurbsObj *nobj,
421 GLint sknot_count, GLfloat *sknot,
422 GLint tknot_count, GLfloat *tknot,
423 GLint s_stride, GLint t_stride,
424 GLfloat *ctlarray,
425 GLint sorder, GLint torder,
426 GLenum type );
427
428 GLUAPI void GLAPIENTRY gluBeginTrim( GLUnurbsObj *nobj );
429
430 GLUAPI void GLAPIENTRY gluEndTrim( GLUnurbsObj *nobj );
431
432 GLUAPI void GLAPIENTRY gluPwlCurve( GLUnurbsObj *nobj, GLint count,
433 GLfloat *array, GLint stride, GLenum type );
434
435 GLUAPI void GLAPIENTRY gluNurbsCallback( GLUnurbsObj *nobj, GLenum which,
436 void (GLCALLBACK *fn)() );
437
438
439
440 /*
441 *
442 * Polygon tessellation
443 *
444 */
445
446 GLUAPI GLUtesselator* GLAPIENTRY gluNewTess( void );
447
448 GLUAPI void GLAPIENTRY gluDeleteTess( GLUtesselator *tobj );
449
450 GLUAPI void GLAPIENTRY gluTessBeginPolygon( GLUtesselator *tobj,
451 void *polygon_data );
452
453 GLUAPI void GLAPIENTRY gluTessBeginContour( GLUtesselator *tobj );
454
455 GLUAPI void GLAPIENTRY gluTessVertex( GLUtesselator *tobj, GLdouble coords[3],
456 void *vertex_data );
457
458 GLUAPI void GLAPIENTRY gluTessEndContour( GLUtesselator *tobj );
459
460 GLUAPI void GLAPIENTRY gluTessEndPolygon( GLUtesselator *tobj );
461
462 GLUAPI void GLAPIENTRY gluTessProperty( GLUtesselator *tobj, GLenum which,
463 GLdouble value );
464
465 GLUAPI void GLAPIENTRY gluTessNormal( GLUtesselator *tobj, GLdouble x,
466 GLdouble y, GLdouble z );
467
468 GLUAPI void GLAPIENTRY gluTessCallback( GLUtesselator *tobj, GLenum which,
469 void (GLCALLBACK *fn)() );
470
471 GLUAPI void GLAPIENTRY gluGetTessProperty( GLUtesselator *tobj, GLenum which,
472 GLdouble *value );
473
474 /*
475 *
476 * Obsolete 1.0 tessellation functions
477 *
478 */
479
480 GLUAPI void GLAPIENTRY gluBeginPolygon( GLUtesselator *tobj );
481
482 GLUAPI void GLAPIENTRY gluNextContour( GLUtesselator *tobj, GLenum type );
483
484 GLUAPI void GLAPIENTRY gluEndPolygon( GLUtesselator *tobj );
485
486
487
488 /*
489 *
490 * New functions in GLU 1.1
491 *
492 */
493
494 GLUAPI const GLubyte* GLAPIENTRY gluGetString( GLenum name );
495
496
497
498 /*
499 * GLU_EXT_get_proc_address extension
500 */
501 /*
502 * WARNING: this extension is not finalized yet! Do not release code
503 * which uses this extension yet! It may change!
504 */
505 #define GLU_EXT_get_proc_address 1
506 GLUAPI void GLAPIENTRY (*gluGetProcAddressEXT(const GLubyte *procName))();
507
508
509
510
511 #if defined(__BEOS__) || defined(__QUICKDRAW__)
512 #pragma export off
513 #endif
514
515
516 #ifdef macintosh
517 #pragma enumsalwaysint reset
518 #if PRAGMA_IMPORT_SUPPORTED
519 #pragma import off
520 #endif
521 #endif
522
523
524 #ifdef __cplusplus
525 }
526 #endif
527
528
529 #endif