include/GL/glx.h

   1 /* $Id: glx.h,v 1.14 2000/03/03 15:35:51 brianp Exp $ */
   2
   3 /*
   4  * Mesa 3-D graphics library
   5  * Version:  3.3
   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
  29 #ifndef GLX_H
  30 #define GLX_H
  31
  32
  33 #include <X11/Xlib.h>
  34 #include <X11/Xutil.h>
  35 #include "GL/gl.h"
  36 #ifdef MESA
  37 #include "GL/xmesa.h"
  38 #endif
  39
  40
  41 #if defined(USE_MGL_NAMESPACE)
  42 #include "glx_mangle.h"
  43 #endif
  44
  45
  46 #ifdef __cplusplus
  47 extern "C" {
  48 #endif
  49
  50
  51 #define GLX_VERSION_1_1         1
  52 #define GLX_VERSION_1_2         1
  53
  54 #define GLX_EXTENSION_NAME   "GLX"
  55
  56
  57
  58 /*
  59  * Tokens for glXChooseVisual and glXGetConfig:
  60  */
  61 #define GLX_USE_GL              1
  62 #define GLX_BUFFER_SIZE         2
  63 #define GLX_LEVEL               3
  64 #define GLX_RGBA                4
  65 #define GLX_DOUBLEBUFFER        5
  66 #define GLX_STEREO              6
  67 #define GLX_AUX_BUFFERS         7
  68 #define GLX_RED_SIZE            8
  69 #define GLX_GREEN_SIZE          9
  70 #define GLX_BLUE_SIZE           10
  71 #define GLX_ALPHA_SIZE          11
  72 #define GLX_DEPTH_SIZE          12
  73 #define GLX_STENCIL_SIZE        13
  74 #define GLX_ACCUM_RED_SIZE      14
  75 #define GLX_ACCUM_GREEN_SIZE    15
  76 #define GLX_ACCUM_BLUE_SIZE     16
  77 #define GLX_ACCUM_ALPHA_SIZE    17
  78
  79
  80 /*
  81  * Error codes returned by glXGetConfig:
  82  */
  83 #define GLX_BAD_SCREEN          1
  84 #define GLX_BAD_ATTRIBUTE       2
  85 #define GLX_NO_EXTENSION        3
  86 #define GLX_BAD_VISUAL          4
  87 #define GLX_BAD_CONTEXT         5
  88 #define GLX_BAD_VALUE           6
  89 #define GLX_BAD_ENUM            7
  90
  91
  92 /*
  93  * GLX 1.1 and later:
  94  */
  95 #define GLX_VENDOR              1
  96 #define GLX_VERSION             2
  97 #define GLX_EXTENSIONS          3
  98
  99
 100 /*
 101  * GLX 1.3 and later:
 102  * XXX don't know the values of some of these enums!
 103  * XXX some 1.3 enums may be missing!
 104  */
 105 #define GLX_CONFIG_CAVEAT               ?
 106 #define GLX_DONT_CARE                   ?
 107 #define GLX_SLOW_CONFIG                 ?
 108 #define GLX_NON_CONFORMANT_CONFIG       ?
 109 #define GLX_X_VISUAL_TYPE               0x22
 110 #define GLX_TRANSPARENT_TYPE            0x23
 111 #define GLX_TRANSPARENT_INDEX_VALUE     0x24
 112 #define GLX_TRANSPARENT_RED_VALUE       0x25
 113 #define GLX_TRANSPARENT_GREEN_VALUE     0x26
 114 #define GLX_TRANSPARENT_BLUE_VALUE      0x27
 115 #define GLX_TRANSPARENT_ALPHA_VALUE     0x28
 116 #define GLX_MAX_PBUFFER_WIDTH           ?
 117 #define GLX_MAX_PBUFFER_HEIGHT          ?
 118 #define GLX_MAX_PBUFFER_PIXELS          ?
 119 #define GLX_PRESERVED_CONTENTS          ?
 120 #define GLX_LARGEST_BUFFER              ?
 121 #define GLX_DRAWABLE_TYPE               ?
 122 #define GLX_FBCONFIG_ID                 ?
 123 #define GLX_VISUAL_ID                   ?
 124 #define GLX_WINDOW_BIT                  ?
 125 #define GLX_PIXMAP_BIT                  ?
 126 #define GLX_PBUFFER_BIT                 ?
 127 #define GLX_AUX_BUFFERS_BIT             ?
 128 #define GLX_FRONT_LEFT_BUFFER_BIT       ?
 129 #define GLX_FRONT_RIGHT_BUFFER_BIT      ?
 130 #define GLX_BACK_LEFT_BUFFER_BIT        ?
 131 #define GLX_BACK_RIGHT_BUFFER_BIT       ?
 132 #define GLX_AUX_BUFFERS_BIT             ?
 133 #define GLX_DEPTH_BUFFER_BIT            ?
 134 #define GLX_STENCIL_BUFFER_BIT          ?
 135 #define GLX_ACCUM_BUFFER_BIT            ?
 136 #define GLX_RENDER_TYPE                 ?
 137 #define GLX_DRAWABLE_TYPE               ?
 138 #define GLX_X_RENDERABLE                ?
 139 #define GLX_NONE                        0x8000
 140 #define GLX_TRUE_COLOR                  0x8002
 141 #define GLX_DIRECT_COLOR                0x8003
 142 #define GLX_PSEUDO_COLOR                0x8004
 143 #define GLX_STATIC_COLOR                0x8005
 144 #define GLX_GRAY_SCALE                  0x8006
 145 #define GLX_STATIC_GRAY                 0x8007
 146 #define GLX_TRANSPARENT_INDEX           0x8009
 147 #define GLX_COLOR_INDEX_TYPE            ?
 148 #define GLX_COLOR_INDEX_BIT             ?
 149 #define GLX_SCREEN                      ?
 150 #define GLX_PBUFFER_CLOBBER_MASK        ?
 151 #define GLX_DAMAGED                     ?
 152 #define GLX_SAVED                       ?
 153 #define GLX_WINDOW                      ?
 154 #define GLX_PBUFFER                     ?
 155
 156
 157 /*
 158  * GLX_EXT_visual_info extension
 159  */
 160 #define GLX_X_VISUAL_TYPE_EXT           0x22
 161 #define GLX_TRANSPARENT_TYPE_EXT        0x23
 162 #define GLX_TRANSPARENT_INDEX_VALUE_EXT 0x24
 163 #define GLX_TRANSPARENT_RED_VALUE_EXT   0x25
 164 #define GLX_TRANSPARENT_GREEN_VALUE_EXT 0x26
 165 #define GLX_TRANSPARENT_BLUE_VALUE_EXT  0x27
 166 #define GLX_TRANSPARENT_ALPHA_VALUE_EXT 0x28
 167
 168
 169 /*
 170  * GLX_visual_info extension
 171  */
 172 #define GLX_TRUE_COLOR_EXT              0x8002
 173 #define GLX_DIRECT_COLOR_EXT            0x8003
 174 #define GLX_PSEUDO_COLOR_EXT            0x8004
 175 #define GLX_STATIC_COLOR_EXT            0x8005
 176 #define GLX_GRAY_SCALE_EXT              0x8006
 177 #define GLX_STATIC_GRAY_EXT             0x8007
 178 #define GLX_NONE_EXT                    0x8000
 179 #define GLX_TRANSPARENT_RGB_EXT         0x8008
 180 #define GLX_TRANSPARENT_INDEX_EXT       0x8009
 181
 182
 183 /*
 184  * Compile-time extension tests
 185  */
 186 #define GLX_EXT_visual_info             1
 187 #define GLX_MESA_pixmap_colormap        1
 188 #define GLX_MESA_release_buffers        1
 189 #define GLX_MESA_copy_sub_buffer        1
 190 #define GLX_MESA_set_3dfx_mode          1
 191 #define GLX_SGI_video_sync              1
 192 #define GLX_ARB_get_proc_address        1
 193
 194
 195
 196 #ifdef MESA
 197    typedef XMesaContext GLXContext;
 198    typedef Pixmap GLXPixmap;
 199    typedef Drawable GLXDrawable;
 200 #else
 201    typedef void * GLXContext;
 202    typedef XID GLXPixmap;
 203    typedef XID GLXDrawable;
 204    /* GLX 1.3 and later */
 205    typedef XID GLXFBConfigID;
 206    typedef XID GLXPfuffer;
 207    typedef XID GLXWindow;
 208    typedef XID GLXPbuffer;
 209    typedef XID GLXFBConfig;
 210 #endif
 211 typedef XID GLXContextID;
 212
 213
 214
 215 extern XVisualInfo* glXChooseVisual( Display *dpy, int screen,
 216                                      int *attribList );
 217
 218 extern GLXContext glXCreateContext( Display *dpy, XVisualInfo *vis,
 219                                     GLXContext shareList, Bool direct );
 220
 221 extern void glXDestroyContext( Display *dpy, GLXContext ctx );
 222
 223 extern Bool glXMakeCurrent( Display *dpy, GLXDrawable drawable,
 224                             GLXContext ctx);
 225
 226 extern void glXCopyContext( Display *dpy, GLXContext src, GLXContext dst,
 227                             unsigned long mask );
 228
 229 extern void glXSwapBuffers( Display *dpy, GLXDrawable drawable );
 230
 231 extern GLXPixmap glXCreateGLXPixmap( Display *dpy, XVisualInfo *visual,
 232                                      Pixmap pixmap );
 233
 234 extern void glXDestroyGLXPixmap( Display *dpy, GLXPixmap pixmap );
 235
 236 extern Bool glXQueryExtension( Display *dpy, int *errorb, int *event );
 237
 238 extern Bool glXQueryVersion( Display *dpy, int *maj, int *min );
 239
 240 extern Bool glXIsDirect( Display *dpy, GLXContext ctx );
 241
 242 extern int glXGetConfig( Display *dpy, XVisualInfo *visual,
 243                          int attrib, int *value );
 244
 245 extern GLXContext glXGetCurrentContext( void );
 246
 247 extern GLXDrawable glXGetCurrentDrawable( void );
 248
 249 extern void glXWaitGL( void );
 250
 251 extern void glXWaitX( void );
 252
 253 extern void glXUseXFont( Font font, int first, int count, int list );
 254
 255
 256
 257 /* GLX 1.1 and later */
 258 extern const char *glXQueryExtensionsString( Display *dpy, int screen );
 259
 260 extern const char *glXQueryServerString( Display *dpy, int screen, int name );
 261
 262 extern const char *glXGetClientString( Display *dpy, int name );
 263
 264
 265 /* GLX 1.2 and later */
 266 extern Display *glXGetCurrentDisplay( void );
 267
 268
 269 /* GLX 1.3 and later */
 270 extern GLXFBConfig glXChooseFBConfig( Display *dpy, int screen,
 271                                       const int *attribList, int *nitems );
 272
 273 extern int glXGetFBConfigAttrib( Display *dpy, GLXFBConfig config,
 274                                  int attribute, int *value );
 275
 276 extern XVisualInfo *glXGetVisualFromFBConfig( Display *dpy,
 277                                               GLXFBConfig config );
 278
 279 extern GLXWindow glXCreateWindow( Display *dpy, GLXFBConfig config,
 280                                   Window win, const int *attribList );
 281
 282 extern void glXDestroyWindow( Display *dpy, GLXWindow window );
 283
 284 extern GLXPixmap glXCreatePixmap( Display *dpy, GLXFBConfig config,
 285                                   Pixmap pixmap, const int *attribList );
 286
 287 extern void glXDestroyPixmap( Display *dpy, GLXPixmap pixmap );
 288
 289 extern GLXPbuffer glXCreatePbuffer( Display *dpy, GLXFBConfig config,
 290                                     const int *attribList );
 291
 292 extern void glXDestroyPbuffer( Display *dpy, GLXPbuffer pbuf );
 293
 294 extern void glXQueryDrawable( Display *dpy, GLXDrawable draw, int attribute,
 295                               unsigned int *value );
 296
 297 extern GLXContext glXCreateNewContext( Display *dpy, GLXFBConfig config,
 298                                        int renderType, GLXContext shareList,
 299                                        Bool direct );
 300
 301 extern Bool glXMakeContextCurrent( Display *dpy, GLXDrawable draw,
 302                                    GLXDrawable read, GLXContext ctx );
 303
 304 extern GLXDrawable glXGetCurrentReadDrawable( void );
 305
 306 extern int glXQueryContext( Display *dpy, GLXContext ctx, int attribute,
 307                             int *value );
 308
 309 extern void glXSelectEvent( Display *dpy, GLXDrawable drawable,
 310                             unsigned long mask );
 311
 312 extern void glXGetSelectedEvent( Display *dpy, GLXDrawable drawable,
 313                                  unsigned long *mask );
 314
 315
 316
 317 /* GLX_MESA_pixmap_colormap */
 318 extern GLXPixmap glXCreateGLXPixmapMESA( Display *dpy, XVisualInfo *visual,
 319                                          Pixmap pixmap, Colormap cmap );
 320
 321
 322 /* GLX_MESA_release_buffers */
 323 extern Bool glXReleaseBuffersMESA( Display *dpy, GLXDrawable d );
 324
 325
 326 /* GLX_MESA_copy_sub_buffer */
 327 extern void glXCopySubBufferMESA( Display *dpy, GLXDrawable drawable,
 328                                   int x, int y, int width, int height );
 329
 330
 331 /* GLX_MESA_set_3dfx_mode */
 332 extern GLboolean glXSet3DfxModeMESA( GLint mode );
 333
 334
 335 /* GLX_SGI_video_sync */
 336 extern int glXGetVideoSyncSGI(unsigned int *count);
 337 extern int glXWaitVideoSyncSGI(int divisor, int remainder,
 338                                unsigned int *count);
 339
 340
 341 /* GLX_ARB_get_proc_address */
 342 extern void (*glXGetProcAddressARB(const GLubyte *procName))();
 343
 344
 345
 346 #ifdef __cplusplus
 347 }
 348 #endif
 349
 350 #endif