include/GL/glu.h

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