include/GL/glx.h

   1 /* $Id: glx.h,v 1.30 2001/09/01 20:17:16 brianp Exp $ */
   2
   3 /*
   4  * Mesa 3-D graphics library
   5  * Version:  3.5
   6  *
   7  * Copyright (C) 1999-2000  Brian Paul   All Rights Reserved.
   8  *
   9  * Permission is hereby granted, free of charge, to any person obtaining a
  10  * copy of this software and associated documentation files (the "Software"),
  11  * to deal in the Software without restriction, including without limitation
  12  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  13  * and/or sell copies of the Software, and to permit persons to whom the
  14  * Software is furnished to do so, subject to the following conditions:
  15  *
  16  * The above copyright notice and this permission notice shall be included
  17  * in all copies or substantial portions of the Software.
  18  *
  19  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  20  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  21  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  22  * BRIAN PAUL BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
  23  * AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  24  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  25  */
  26
  27
  28 #ifndef GLX_H
  29 #define GLX_H
  30
  31
  32 #ifdef __VMS
  33 #include <GL/vms_x_fix.h>
  34 # ifdef __cplusplus
  35 /* VMS Xlib.h gives problems with C++.
  36  * this avoids a bunch of trivial warnings */
  37 #pragma message disable nosimpint
  38 #endif
  39 #endif
  40 #include <X11/Xlib.h>
  41 #include <X11/Xutil.h>
  42 #ifdef __VMS
  43 # ifdef __cplusplus
  44 #pragma message enable nosimpint
  45 #endif
  46 #endif
  47 #include <GL/gl.h>
  48
  49
  50 #if defined(USE_MGL_NAMESPACE)
  51 #include <GL/glx_mangle.h>
  52 #endif
  53
  54
  55 #ifdef __cplusplus
  56 extern "C" {
  57 #endif
  58
  59
  60 #define GLX_VERSION_1_1         1
  61 #define GLX_VERSION_1_2         1
  62 #define GLX_VERSION_1_3         1
  63
  64 #define GLX_EXTENSION_NAME   "GLX"
  65
  66
  67
  68 /*
  69  * Tokens for glXChooseVisual and glXGetConfig:
  70  */
  71 #define GLX_USE_GL              1
  72 #define GLX_BUFFER_SIZE         2
  73 #define GLX_LEVEL               3
  74 #define GLX_RGBA                4
  75 #define GLX_DOUBLEBUFFER        5
  76 #define GLX_STEREO              6
  77 #define GLX_AUX_BUFFERS         7
  78 #define GLX_RED_SIZE            8
  79 #define GLX_GREEN_SIZE          9
  80 #define GLX_BLUE_SIZE           10
  81 #define GLX_ALPHA_SIZE          11
  82 #define GLX_DEPTH_SIZE          12
  83 #define GLX_STENCIL_SIZE        13
  84 #define GLX_ACCUM_RED_SIZE      14
  85 #define GLX_ACCUM_GREEN_SIZE    15
  86 #define GLX_ACCUM_BLUE_SIZE     16
  87 #define GLX_ACCUM_ALPHA_SIZE    17
  88
  89
  90 /*
  91  * Error codes returned by glXGetConfig:
  92  */
  93 #define GLX_BAD_SCREEN          1
  94 #define GLX_BAD_ATTRIBUTE       2
  95 #define GLX_NO_EXTENSION        3
  96 #define GLX_BAD_VISUAL          4
  97 #define GLX_BAD_CONTEXT         5
  98 #define GLX_BAD_VALUE           6
  99 #define GLX_BAD_ENUM            7
 100
 101
 102 /*
 103  * GLX 1.1 and later:
 104  */
 105 #define GLX_VENDOR              1
 106 #define GLX_VERSION             2
 107 #define GLX_EXTENSIONS          3
 108
 109
 110 /*
 111  * GLX 1.3 and later:
 112  */
 113 #define GLX_CONFIG_CAVEAT               0x20
 114 #define GLX_DONT_CARE                   0xFFFFFFFF
 115 #define GLX_SLOW_CONFIG                 0x8001
 116 #define GLX_NON_CONFORMANT_CONFIG       0x800D
 117 #define GLX_X_VISUAL_TYPE               0x22
 118 #define GLX_TRANSPARENT_TYPE            0x23
 119 #define GLX_TRANSPARENT_INDEX_VALUE     0x24
 120 #define GLX_TRANSPARENT_RED_VALUE       0x25
 121 #define GLX_TRANSPARENT_GREEN_VALUE     0x26
 122 #define GLX_TRANSPARENT_BLUE_VALUE      0x27
 123 #define GLX_TRANSPARENT_ALPHA_VALUE     0x28
 124 #define GLX_MAX_PBUFFER_WIDTH           0x8016
 125 #define GLX_MAX_PBUFFER_HEIGHT          0x8017
 126 #define GLX_MAX_PBUFFER_PIXELS          0x8018
 127 #define GLX_PRESERVED_CONTENTS          0x801B
 128 #define GLX_LARGEST_PBUFFER             0x801C
 129 #define GLX_WIDTH                       0x801D
 130 #define GLX_HEIGHT                      0x801E
 131 #define GLX_EVENT_MASK                  0x801F
 132 #define GLX_DRAWABLE_TYPE               0x8010
 133 #define GLX_FBCONFIG_ID                 0x8013
 134 #define GLX_VISUAL_ID                   0x800B
 135 #define GLX_WINDOW_BIT                  0x00000001
 136 #define GLX_PIXMAP_BIT                  0x00000002
 137 #define GLX_PBUFFER_BIT                 0x00000004
 138 #define GLX_AUX_BUFFERS_BIT             0x00000010
 139 #define GLX_FRONT_LEFT_BUFFER_BIT       0x00000001
 140 #define GLX_FRONT_RIGHT_BUFFER_BIT      0x00000002
 141 #define GLX_BACK_LEFT_BUFFER_BIT        0x00000004
 142 #define GLX_BACK_RIGHT_BUFFER_BIT       0x00000008
 143 #define GLX_AUX_BUFFERS_BIT             0x00000010
 144 #define GLX_DEPTH_BUFFER_BIT            0x00000020
 145 #define GLX_STENCIL_BUFFER_BIT          0x00000040
 146 #define GLX_ACCUM_BUFFER_BIT            0x00000080
 147 #define GLX_DRAWABLE_TYPE               0x8010
 148 #define GLX_RENDER_TYPE                 0x8011
 149 #define GLX_X_RENDERABLE                0x8012
 150 #define GLX_NONE                        0x8000
 151 #define GLX_TRUE_COLOR                  0x8002
 152 #define GLX_DIRECT_COLOR                0x8003
 153 #define GLX_PSEUDO_COLOR                0x8004
 154 #define GLX_STATIC_COLOR                0x8005
 155 #define GLX_GRAY_SCALE                  0x8006
 156 #define GLX_STATIC_GRAY                 0x8007
 157 #define GLX_TRANSPARENT_INDEX           0x8009
 158 #define GLX_RGBA_TYPE                   0x8014
 159 #define GLX_COLOR_INDEX_TYPE            0x8015
 160 #define GLX_COLOR_INDEX_BIT             0x00000002
 161 #define GLX_RGBA_BIT                    0x00000001
 162 #define GLX_SCREEN                      0x800C
 163 #define GLX_PBUFFER_CLOBBER_MASK        0x08000000
 164 #define GLX_DAMAGED                     0x8020
 165 #define GLX_SAVED                       0x8021
 166 #define GLX_WINDOW                      0x8022
 167 #define GLX_PBUFFER                     0x8023
 168 #define GLX_PBUFFER_HEIGHT              0x8040
 169 #define GLX_PBUFFER_WIDTH               0x8041
 170
 171
 172
 173 typedef struct __GLXcontextRec *GLXContext;
 174 typedef XID GLXPixmap;
 175 typedef XID GLXDrawable;
 176 /* GLX 1.3 and later */
 177 typedef struct __GLXFBConfigRec *GLXFBConfig;
 178 typedef XID GLXFBConfigID;
 179 typedef XID GLXContextID;
 180 typedef XID GLXWindow;
 181 typedef XID GLXPbuffer;
 182
 183
 184
 185 extern XVisualInfo* glXChooseVisual( Display *dpy, int screen,
 186                                      int *attribList );
 187
 188 extern GLXContext glXCreateContext( Display *dpy, XVisualInfo *vis,
 189                                     GLXContext shareList, Bool direct );
 190
 191 extern void glXDestroyContext( Display *dpy, GLXContext ctx );
 192
 193 extern Bool glXMakeCurrent( Display *dpy, GLXDrawable drawable,
 194                             GLXContext ctx);
 195
 196 extern void glXCopyContext( Display *dpy, GLXContext src, GLXContext dst,
 197                             unsigned long mask );
 198
 199 extern void glXSwapBuffers( Display *dpy, GLXDrawable drawable );
 200
 201 extern GLXPixmap glXCreateGLXPixmap( Display *dpy, XVisualInfo *visual,
 202                                      Pixmap pixmap );
 203
 204 extern void glXDestroyGLXPixmap( Display *dpy, GLXPixmap pixmap );
 205
 206 extern Bool glXQueryExtension( Display *dpy, int *errorb, int *event );
 207
 208 extern Bool glXQueryVersion( Display *dpy, int *maj, int *min );
 209
 210 extern Bool glXIsDirect( Display *dpy, GLXContext ctx );
 211
 212 extern int glXGetConfig( Display *dpy, XVisualInfo *visual,
 213                          int attrib, int *value );
 214
 215 extern GLXContext glXGetCurrentContext( void );
 216
 217 extern GLXDrawable glXGetCurrentDrawable( void );
 218
 219 extern void glXWaitGL( void );
 220
 221 extern void glXWaitX( void );
 222
 223 extern void glXUseXFont( Font font, int first, int count, int list );
 224
 225
 226
 227 /* GLX 1.1 and later */
 228 extern const char *glXQueryExtensionsString( Display *dpy, int screen );
 229
 230 extern const char *glXQueryServerString( Display *dpy, int screen, int name );
 231
 232 extern const char *glXGetClientString( Display *dpy, int name );
 233
 234
 235 /* GLX 1.2 and later */
 236 extern Display *glXGetCurrentDisplay( void );
 237
 238
 239 /* GLX 1.3 and later */
 240 extern GLXFBConfig *glXChooseFBConfig( Display *dpy, int screen,
 241                                        const int *attribList, int *nitems );
 242
 243 extern int glXGetFBConfigAttrib( Display *dpy, GLXFBConfig config,
 244                                  int attribute, int *value );
 245
 246 extern GLXFBConfig *glXGetFBConfigs( Display *dpy, int screen,
 247                                      int *nelements );
 248
 249 extern XVisualInfo *glXGetVisualFromFBConfig( Display *dpy,
 250                                               GLXFBConfig config );
 251
 252 extern GLXWindow glXCreateWindow( Display *dpy, GLXFBConfig config,
 253                                   Window win, const int *attribList );
 254
 255 extern void glXDestroyWindow( Display *dpy, GLXWindow window );
 256
 257 extern GLXPixmap glXCreatePixmap( Display *dpy, GLXFBConfig config,
 258                                   Pixmap pixmap, const int *attribList );
 259
 260 extern void glXDestroyPixmap( Display *dpy, GLXPixmap pixmap );
 261
 262 extern GLXPbuffer glXCreatePbuffer( Display *dpy, GLXFBConfig config,
 263                                     const int *attribList );
 264
 265 extern void glXDestroyPbuffer( Display *dpy, GLXPbuffer pbuf );
 266
 267 extern void glXQueryDrawable( Display *dpy, GLXDrawable draw, int attribute,
 268                               unsigned int *value );
 269
 270 extern GLXContext glXCreateNewContext( Display *dpy, GLXFBConfig config,
 271                                        int renderType, GLXContext shareList,
 272                                        Bool direct );
 273
 274 extern Bool glXMakeContextCurrent( Display *dpy, GLXDrawable draw,
 275                                    GLXDrawable read, GLXContext ctx );
 276
 277 extern GLXDrawable glXGetCurrentReadDrawable( void );
 278
 279 extern int glXQueryContext( Display *dpy, GLXContext ctx, int attribute,
 280                             int *value );
 281
 282 extern void glXSelectEvent( Display *dpy, GLXDrawable drawable,
 283                             unsigned long mask );
 284
 285 extern void glXGetSelectedEvent( Display *dpy, GLXDrawable drawable,
 286                                  unsigned long *mask );
 287
 288
 289
 290 #ifndef GLX_GLXEXT_LEGACY
 291
 292 #include <GL/glxext.h>
 293
 294 #else
 295
 296
 297 /*
 298  * 28. GLX_EXT_visual_info extension
 299  */
 300 #ifndef GLX_EXT_visual_info
 301 #define GLX_EXT_visual_info             1
 302
 303 #define GLX_X_VISUAL_TYPE_EXT           0x22
 304 #define GLX_TRANSPARENT_TYPE_EXT        0x23
 305 #define GLX_TRANSPARENT_INDEX_VALUE_EXT 0x24
 306 #define GLX_TRANSPARENT_RED_VALUE_EXT   0x25
 307 #define GLX_TRANSPARENT_GREEN_VALUE_EXT 0x26
 308 #define GLX_TRANSPARENT_BLUE_VALUE_EXT  0x27
 309 #define GLX_TRANSPARENT_ALPHA_VALUE_EXT 0x28
 310 #define GLX_TRUE_COLOR_EXT              0x8002
 311 #define GLX_DIRECT_COLOR_EXT            0x8003
 312 #define GLX_PSEUDO_COLOR_EXT            0x8004
 313 #define GLX_STATIC_COLOR_EXT            0x8005
 314 #define GLX_GRAY_SCALE_EXT              0x8006
 315 #define GLX_STATIC_GRAY_EXT             0x8007
 316 #define GLX_NONE_EXT                    0x8000
 317 #define GLX_TRANSPARENT_RGB_EXT         0x8008
 318 #define GLX_TRANSPARENT_INDEX_EXT       0x8009
 319
 320 #endif /* 28. GLX_EXT_visual_info extension */
 321
 322
 323
 324 /*
 325  * 41. GLX_SGI_video_sync
 326  */
 327 #ifndef GLX_SGI_video_sync
 328 #define GLX_SGI_video_sync 1
 329
 330 extern int glXGetVideoSyncSGI(unsigned int *count);
 331 extern int glXWaitVideoSyncSGI(int divisor, int remainder, unsigned int *count);
 332
 333 #endif /* GLX_SGI_video_sync */
 334
 335
 336
 337 /*
 338  * 42. GLX_EXT_visual_rating
 339  */
 340 #ifndef GLX_EXT_visual_rating
 341 #define GLX_EXT_visual_rating           1
 342
 343 #define GLX_VISUAL_CAVEAT_EXT           0x20
 344 /*#define GLX_NONE_EXT                  0x8000*/
 345 #define GLX_SLOW_VISUAL_EXT             0x8001
 346 #define GLX_NON_CONFORMANT_VISUAL_EXT   0x800D
 347
 348 #endif /* GLX_EXT_visual_rating */
 349
 350
 351
 352 /*
 353  * 47. GLX_EXT_import_context
 354  */
 355 #ifndef GLX_EXT_import_context
 356 #define GLX_EXT_import_context 1
 357
 358 #define GLX_SHARE_CONTEXT_EXT           0x800A
 359 #define GLX_VISUAL_ID_EXT               0x800B
 360 #define GLX_SCREEN_EXT                  0x800C
 361
 362 extern void glXFreeContextEXT(Display *dpy, GLXContext context);
 363
 364 extern GLXContextID glXGetContextIDEXT(const GLXContext context);
 365
 366 extern Display *glXGetCurrentDisplayEXT(void);
 367
 368 extern GLXContext glXImportContextEXT(Display *dpy, GLXContextID contextID);
 369
 370 extern int glXQueryContextInfoEXT(Display *dpy, GLXContext context,
 371                                   int attribute,int *value);
 372
 373 #endif /* GLX_EXT_import_context */
 374
 375
 376
 377 /*
 378  * 215. GLX_MESA_copy_sub_buffer
 379  */
 380 #ifndef GLX_MESA_copy_sub_buffer
 381 #define GLX_MESA_copy_sub_buffer 1
 382
 383 extern void glXCopySubBufferMESA( Display *dpy, GLXDrawable drawable,
 384                                   int x, int y, int width, int height );
 385
 386 #endif
 387
 388
 389
 390 /*
 391  * 216. GLX_MESA_pixmap_colormap
 392  */
 393 #ifndef GLX_MESA_pixmap_colormap
 394 #define GLX_MESA_pixmap_colormap 1
 395
 396 extern GLXPixmap glXCreateGLXPixmapMESA( Display *dpy, XVisualInfo *visual,
 397                                          Pixmap pixmap, Colormap cmap );
 398
 399 #endif /* GLX_MESA_pixmap_colormap */
 400
 401
 402
 403 /*
 404  * 217. GLX_MESA_release_buffers
 405  */
 406 #ifndef GLX_MESA_release_buffers
 407 #define GLX_MESA_release_buffers 1
 408
 409 extern Bool glXReleaseBuffersMESA( Display *dpy, GLXDrawable d );
 410
 411 #endif /* GLX_MESA_release_buffers */
 412
 413
 414
 415 /*
 416  * 218. GLX_MESA_set_3dfx_mode
 417  */
 418 #ifndef GLX_MESA_set_3dfx_mode
 419 #define GLX_MESA_set_3dfx_mode 1
 420
 421 #define GLX_3DFX_WINDOW_MODE_MESA       0x1
 422 #define GLX_3DFX_FULLSCREEN_MODE_MESA   0x2
 423
 424 extern Bool glXSet3DfxModeMESA( int mode );
 425
 426 #endif /* GLX_MESA_set_3dfx_mode */
 427
 428
 429
 430 /*
 431  * ARB 2. GLX_ARB_get_proc_address
 432  */
 433 #ifndef GLX_ARB_get_proc_address
 434 #define GLX_ARB_get_proc_address 1
 435
 436 extern void (*glXGetProcAddressARB(const GLubyte *procName))();
 437
 438 #endif /* GLX_ARB_get_proc_address */
 439
 440
 441
 442 #endif /* GLX_GLXEXT_LEGACY */
 443
 444
 445
 446 #ifdef __cplusplus
 447 }
 448 #endif
 449
 450 #endif