fa5a8eda962a369bf87eb1d1c810f0253bd81c88
[mesa.git] / include / GL / glx.h
1 /*
2 * Mesa 3-D graphics library
3 *
4 * Copyright (C) 1999-2006 Brian Paul All Rights Reserved.
5 *
6 * Permission is hereby granted, free of charge, to any person obtaining a
7 * copy of this software and associated documentation files (the "Software"),
8 * to deal in the Software without restriction, including without limitation
9 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
10 * and/or sell copies of the Software, and to permit persons to whom the
11 * Software is furnished to do so, subject to the following conditions:
12 *
13 * The above copyright notice and this permission notice shall be included
14 * in all copies or substantial portions of the Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
17 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
20 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
21 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
22 * OTHER DEALINGS IN THE SOFTWARE.
23 */
24
25
26 #ifndef GLX_H
27 #define GLX_H
28
29
30 #include <X11/Xlib.h>
31 #include <X11/Xutil.h>
32 #include <GL/gl.h>
33
34
35 #if defined(USE_MGL_NAMESPACE)
36 #include "glx_mangle.h"
37 #endif
38
39
40 #ifdef __cplusplus
41 extern "C" {
42 #endif
43
44
45 #define GLX_VERSION_1_1 1
46 #define GLX_VERSION_1_2 1
47 #define GLX_VERSION_1_3 1
48 #define GLX_VERSION_1_4 1
49
50 #define GLX_EXTENSION_NAME "GLX"
51
52
53
54 /*
55 * Tokens for glXChooseVisual and glXGetConfig:
56 */
57 #define GLX_USE_GL 1
58 #define GLX_BUFFER_SIZE 2
59 #define GLX_LEVEL 3
60 #define GLX_RGBA 4
61 #define GLX_DOUBLEBUFFER 5
62 #define GLX_STEREO 6
63 #define GLX_AUX_BUFFERS 7
64 #define GLX_RED_SIZE 8
65 #define GLX_GREEN_SIZE 9
66 #define GLX_BLUE_SIZE 10
67 #define GLX_ALPHA_SIZE 11
68 #define GLX_DEPTH_SIZE 12
69 #define GLX_STENCIL_SIZE 13
70 #define GLX_ACCUM_RED_SIZE 14
71 #define GLX_ACCUM_GREEN_SIZE 15
72 #define GLX_ACCUM_BLUE_SIZE 16
73 #define GLX_ACCUM_ALPHA_SIZE 17
74
75
76 /*
77 * Error codes returned by glXGetConfig:
78 */
79 #define GLX_BAD_SCREEN 1
80 #define GLX_BAD_ATTRIBUTE 2
81 #define GLX_NO_EXTENSION 3
82 #define GLX_BAD_VISUAL 4
83 #define GLX_BAD_CONTEXT 5
84 #define GLX_BAD_VALUE 6
85 #define GLX_BAD_ENUM 7
86
87
88 /*
89 * GLX 1.1 and later:
90 */
91 #define GLX_VENDOR 1
92 #define GLX_VERSION 2
93 #define GLX_EXTENSIONS 3
94
95
96 /*
97 * GLX 1.3 and later:
98 */
99 #define GLX_CONFIG_CAVEAT 0x20
100 #define GLX_DONT_CARE 0xFFFFFFFF
101 #define GLX_X_VISUAL_TYPE 0x22
102 #define GLX_TRANSPARENT_TYPE 0x23
103 #define GLX_TRANSPARENT_INDEX_VALUE 0x24
104 #define GLX_TRANSPARENT_RED_VALUE 0x25
105 #define GLX_TRANSPARENT_GREEN_VALUE 0x26
106 #define GLX_TRANSPARENT_BLUE_VALUE 0x27
107 #define GLX_TRANSPARENT_ALPHA_VALUE 0x28
108 #define GLX_WINDOW_BIT 0x00000001
109 #define GLX_PIXMAP_BIT 0x00000002
110 #define GLX_PBUFFER_BIT 0x00000004
111 #define GLX_AUX_BUFFERS_BIT 0x00000010
112 #define GLX_FRONT_LEFT_BUFFER_BIT 0x00000001
113 #define GLX_FRONT_RIGHT_BUFFER_BIT 0x00000002
114 #define GLX_BACK_LEFT_BUFFER_BIT 0x00000004
115 #define GLX_BACK_RIGHT_BUFFER_BIT 0x00000008
116 #define GLX_DEPTH_BUFFER_BIT 0x00000020
117 #define GLX_STENCIL_BUFFER_BIT 0x00000040
118 #define GLX_ACCUM_BUFFER_BIT 0x00000080
119 #define GLX_NONE 0x8000
120 #define GLX_SLOW_CONFIG 0x8001
121 #define GLX_TRUE_COLOR 0x8002
122 #define GLX_DIRECT_COLOR 0x8003
123 #define GLX_PSEUDO_COLOR 0x8004
124 #define GLX_STATIC_COLOR 0x8005
125 #define GLX_GRAY_SCALE 0x8006
126 #define GLX_STATIC_GRAY 0x8007
127 #define GLX_TRANSPARENT_RGB 0x8008
128 #define GLX_TRANSPARENT_INDEX 0x8009
129 #define GLX_VISUAL_ID 0x800B
130 #define GLX_SCREEN 0x800C
131 #define GLX_NON_CONFORMANT_CONFIG 0x800D
132 #define GLX_DRAWABLE_TYPE 0x8010
133 #define GLX_RENDER_TYPE 0x8011
134 #define GLX_X_RENDERABLE 0x8012
135 #define GLX_FBCONFIG_ID 0x8013
136 #define GLX_RGBA_TYPE 0x8014
137 #define GLX_COLOR_INDEX_TYPE 0x8015
138 #define GLX_MAX_PBUFFER_WIDTH 0x8016
139 #define GLX_MAX_PBUFFER_HEIGHT 0x8017
140 #define GLX_MAX_PBUFFER_PIXELS 0x8018
141 #define GLX_PRESERVED_CONTENTS 0x801B
142 #define GLX_LARGEST_PBUFFER 0x801C
143 #define GLX_WIDTH 0x801D
144 #define GLX_HEIGHT 0x801E
145 #define GLX_EVENT_MASK 0x801F
146 #define GLX_DAMAGED 0x8020
147 #define GLX_SAVED 0x8021
148 #define GLX_WINDOW 0x8022
149 #define GLX_PBUFFER 0x8023
150 #define GLX_PBUFFER_HEIGHT 0x8040
151 #define GLX_PBUFFER_WIDTH 0x8041
152 #define GLX_RGBA_BIT 0x00000001
153 #define GLX_COLOR_INDEX_BIT 0x00000002
154 #define GLX_PBUFFER_CLOBBER_MASK 0x08000000
155
156
157 /*
158 * GLX 1.4 and later:
159 */
160 #define GLX_SAMPLE_BUFFERS 0x186a0 /*100000*/
161 #define GLX_SAMPLES 0x186a1 /*100001*/
162
163
164
165 typedef struct __GLXcontextRec *GLXContext;
166 typedef XID GLXPixmap;
167 typedef XID GLXDrawable;
168 /* GLX 1.3 and later */
169 typedef struct __GLXFBConfigRec *GLXFBConfig;
170 typedef XID GLXFBConfigID;
171 typedef XID GLXWindow;
172 typedef XID GLXPbuffer;
173
174
175 /*
176 ** Events.
177 ** __GLX_NUMBER_EVENTS is set to 17 to account for the BufferClobberSGIX
178 ** event - this helps initialization if the server supports the pbuffer
179 ** extension and the client doesn't.
180 */
181 #define GLX_PbufferClobber 0
182 #define GLX_BufferSwapComplete 1
183
184 #define __GLX_NUMBER_EVENTS 17
185
186 extern XVisualInfo* glXChooseVisual( Display *dpy, int screen,
187 int *attribList );
188
189 extern GLXContext glXCreateContext( Display *dpy, XVisualInfo *vis,
190 GLXContext shareList, Bool direct );
191
192 extern void glXDestroyContext( Display *dpy, GLXContext ctx );
193
194 extern Bool glXMakeCurrent( Display *dpy, GLXDrawable drawable,
195 GLXContext ctx);
196
197 extern void glXCopyContext( Display *dpy, GLXContext src, GLXContext dst,
198 unsigned long mask );
199
200 extern void glXSwapBuffers( Display *dpy, GLXDrawable drawable );
201
202 extern GLXPixmap glXCreateGLXPixmap( Display *dpy, XVisualInfo *visual,
203 Pixmap pixmap );
204
205 extern void glXDestroyGLXPixmap( Display *dpy, GLXPixmap pixmap );
206
207 extern Bool glXQueryExtension( Display *dpy, int *errorb, int *event );
208
209 extern Bool glXQueryVersion( Display *dpy, int *maj, int *min );
210
211 extern Bool glXIsDirect( Display *dpy, GLXContext ctx );
212
213 extern int glXGetConfig( Display *dpy, XVisualInfo *visual,
214 int attrib, int *value );
215
216 extern GLXContext glXGetCurrentContext( void );
217
218 extern GLXDrawable glXGetCurrentDrawable( void );
219
220 extern void glXWaitGL( void );
221
222 extern void glXWaitX( void );
223
224 extern void glXUseXFont( Font font, int first, int count, int list );
225
226
227
228 /* GLX 1.1 and later */
229 extern const char *glXQueryExtensionsString( Display *dpy, int screen );
230
231 extern const char *glXQueryServerString( Display *dpy, int screen, int name );
232
233 extern const char *glXGetClientString( Display *dpy, int name );
234
235
236 /* GLX 1.2 and later */
237 extern Display *glXGetCurrentDisplay( void );
238
239
240 /* GLX 1.3 and later */
241 extern GLXFBConfig *glXChooseFBConfig( Display *dpy, int screen,
242 const int *attribList, int *nitems );
243
244 extern int glXGetFBConfigAttrib( Display *dpy, GLXFBConfig config,
245 int attribute, int *value );
246
247 extern GLXFBConfig *glXGetFBConfigs( Display *dpy, int screen,
248 int *nelements );
249
250 extern XVisualInfo *glXGetVisualFromFBConfig( Display *dpy,
251 GLXFBConfig config );
252
253 extern GLXWindow glXCreateWindow( Display *dpy, GLXFBConfig config,
254 Window win, const int *attribList );
255
256 extern void glXDestroyWindow( Display *dpy, GLXWindow window );
257
258 extern GLXPixmap glXCreatePixmap( Display *dpy, GLXFBConfig config,
259 Pixmap pixmap, const int *attribList );
260
261 extern void glXDestroyPixmap( Display *dpy, GLXPixmap pixmap );
262
263 extern GLXPbuffer glXCreatePbuffer( Display *dpy, GLXFBConfig config,
264 const int *attribList );
265
266 extern void glXDestroyPbuffer( Display *dpy, GLXPbuffer pbuf );
267
268 extern void glXQueryDrawable( Display *dpy, GLXDrawable draw, int attribute,
269 unsigned int *value );
270
271 extern GLXContext glXCreateNewContext( Display *dpy, GLXFBConfig config,
272 int renderType, GLXContext shareList,
273 Bool direct );
274
275 extern Bool glXMakeContextCurrent( Display *dpy, GLXDrawable draw,
276 GLXDrawable read, GLXContext ctx );
277
278 extern GLXDrawable glXGetCurrentReadDrawable( void );
279
280 extern int glXQueryContext( Display *dpy, GLXContext ctx, int attribute,
281 int *value );
282
283 extern void glXSelectEvent( Display *dpy, GLXDrawable drawable,
284 unsigned long mask );
285
286 extern void glXGetSelectedEvent( Display *dpy, GLXDrawable drawable,
287 unsigned long *mask );
288
289 /* GLX 1.3 function pointer typedefs */
290 typedef GLXFBConfig * (* PFNGLXGETFBCONFIGSPROC) (Display *dpy, int screen, int *nelements);
291 typedef GLXFBConfig * (* PFNGLXCHOOSEFBCONFIGPROC) (Display *dpy, int screen, const int *attrib_list, int *nelements);
292 typedef int (* PFNGLXGETFBCONFIGATTRIBPROC) (Display *dpy, GLXFBConfig config, int attribute, int *value);
293 typedef XVisualInfo * (* PFNGLXGETVISUALFROMFBCONFIGPROC) (Display *dpy, GLXFBConfig config);
294 typedef GLXWindow (* PFNGLXCREATEWINDOWPROC) (Display *dpy, GLXFBConfig config, Window win, const int *attrib_list);
295 typedef void (* PFNGLXDESTROYWINDOWPROC) (Display *dpy, GLXWindow win);
296 typedef GLXPixmap (* PFNGLXCREATEPIXMAPPROC) (Display *dpy, GLXFBConfig config, Pixmap pixmap, const int *attrib_list);
297 typedef void (* PFNGLXDESTROYPIXMAPPROC) (Display *dpy, GLXPixmap pixmap);
298 typedef GLXPbuffer (* PFNGLXCREATEPBUFFERPROC) (Display *dpy, GLXFBConfig config, const int *attrib_list);
299 typedef void (* PFNGLXDESTROYPBUFFERPROC) (Display *dpy, GLXPbuffer pbuf);
300 typedef void (* PFNGLXQUERYDRAWABLEPROC) (Display *dpy, GLXDrawable draw, int attribute, unsigned int *value);
301 typedef GLXContext (* PFNGLXCREATENEWCONTEXTPROC) (Display *dpy, GLXFBConfig config, int render_type, GLXContext share_list, Bool direct);
302 typedef Bool (* PFNGLXMAKECONTEXTCURRENTPROC) (Display *dpy, GLXDrawable draw, GLXDrawable read, GLXContext ctx);
303 typedef GLXDrawable (* PFNGLXGETCURRENTREADDRAWABLEPROC) (void);
304 typedef Display * (* PFNGLXGETCURRENTDISPLAYPROC) (void);
305 typedef int (* PFNGLXQUERYCONTEXTPROC) (Display *dpy, GLXContext ctx, int attribute, int *value);
306 typedef void (* PFNGLXSELECTEVENTPROC) (Display *dpy, GLXDrawable draw, unsigned long event_mask);
307 typedef void (* PFNGLXGETSELECTEDEVENTPROC) (Display *dpy, GLXDrawable draw, unsigned long *event_mask);
308
309
310 /*
311 * ARB 2. GLX_ARB_get_proc_address
312 */
313 #ifndef GLX_ARB_get_proc_address
314 #define GLX_ARB_get_proc_address 1
315
316 typedef void (*__GLXextFuncPtr)(void);
317 extern __GLXextFuncPtr glXGetProcAddressARB (const GLubyte *);
318
319 #endif /* GLX_ARB_get_proc_address */
320
321
322
323 /* GLX 1.4 and later */
324 extern void (*glXGetProcAddress(const GLubyte *procname))( void );
325
326 /* GLX 1.4 function pointer typedefs */
327 typedef __GLXextFuncPtr (* PFNGLXGETPROCADDRESSPROC) (const GLubyte *procName);
328
329
330 #ifndef GLX_GLXEXT_LEGACY
331
332 #include <GL/glxext.h>
333
334 #endif /* GLX_GLXEXT_LEGACY */
335
336
337 /**
338 ** The following aren't in glxext.h yet.
339 **/
340
341
342 /*
343 * ???. GLX_NV_vertex_array_range
344 */
345 #ifndef GLX_NV_vertex_array_range
346 #define GLX_NV_vertex_array_range
347
348 extern void *glXAllocateMemoryNV(GLsizei size, GLfloat readfreq, GLfloat writefreq, GLfloat priority);
349 extern void glXFreeMemoryNV(GLvoid *pointer);
350 typedef void * ( * PFNGLXALLOCATEMEMORYNVPROC) (GLsizei size, GLfloat readfreq, GLfloat writefreq, GLfloat priority);
351 typedef void ( * PFNGLXFREEMEMORYNVPROC) (GLvoid *pointer);
352
353 #endif /* GLX_NV_vertex_array_range */
354
355
356 /*
357 * ARB ?. GLX_ARB_render_texture
358 * XXX This was never finalized!
359 */
360 #ifndef GLX_ARB_render_texture
361 #define GLX_ARB_render_texture 1
362
363 extern Bool glXBindTexImageARB(Display *dpy, GLXPbuffer pbuffer, int buffer);
364 extern Bool glXReleaseTexImageARB(Display *dpy, GLXPbuffer pbuffer, int buffer);
365 extern Bool glXDrawableAttribARB(Display *dpy, GLXDrawable draw, const int *attribList);
366
367 #endif /* GLX_ARB_render_texture */
368
369
370 /*
371 * Remove this when glxext.h is updated.
372 */
373 #ifndef GLX_NV_float_buffer
374 #define GLX_NV_float_buffer 1
375
376 #define GLX_FLOAT_COMPONENTS_NV 0x20B0
377
378 #endif /* GLX_NV_float_buffer */
379
380
381
382 /*
383 * #?. GLX_MESA_swap_frame_usage
384 */
385 #ifndef GLX_MESA_swap_frame_usage
386 #define GLX_MESA_swap_frame_usage 1
387
388 extern int glXGetFrameUsageMESA(Display *dpy, GLXDrawable drawable, float *usage);
389 extern int glXBeginFrameTrackingMESA(Display *dpy, GLXDrawable drawable);
390 extern int glXEndFrameTrackingMESA(Display *dpy, GLXDrawable drawable);
391 extern int glXQueryFrameTrackingMESA(Display *dpy, GLXDrawable drawable, int64_t *swapCount, int64_t *missedFrames, float *lastMissedUsage);
392
393 typedef int (*PFNGLXGETFRAMEUSAGEMESAPROC) (Display *dpy, GLXDrawable drawable, float *usage);
394 typedef int (*PFNGLXBEGINFRAMETRACKINGMESAPROC)(Display *dpy, GLXDrawable drawable);
395 typedef int (*PFNGLXENDFRAMETRACKINGMESAPROC)(Display *dpy, GLXDrawable drawable);
396 typedef int (*PFNGLXQUERYFRAMETRACKINGMESAPROC)(Display *dpy, GLXDrawable drawable, int64_t *swapCount, int64_t *missedFrames, float *lastMissedUsage);
397
398 #endif /* GLX_MESA_swap_frame_usage */
399
400
401
402 /*
403 * #?. GLX_MESA_swap_control
404 */
405 #ifndef GLX_MESA_swap_control
406 #define GLX_MESA_swap_control 1
407
408 extern int glXSwapIntervalMESA(unsigned int interval);
409 extern int glXGetSwapIntervalMESA(void);
410
411 typedef int (*PFNGLXSWAPINTERVALMESAPROC)(unsigned int interval);
412 typedef int (*PFNGLXGETSWAPINTERVALMESAPROC)(void);
413
414 #endif /* GLX_MESA_swap_control */
415
416
417
418 /*
419 * #?. GLX_EXT_texture_from_pixmap
420 * XXX not finished?
421 */
422 #ifndef GLX_EXT_texture_from_pixmap
423 #define GLX_EXT_texture_from_pixmap 1
424
425 #define GLX_BIND_TO_TEXTURE_RGB_EXT 0x20D0
426 #define GLX_BIND_TO_TEXTURE_RGBA_EXT 0x20D1
427 #define GLX_BIND_TO_MIPMAP_TEXTURE_EXT 0x20D2
428 #define GLX_BIND_TO_TEXTURE_TARGETS_EXT 0x20D3
429 #define GLX_Y_INVERTED_EXT 0x20D4
430
431 #define GLX_TEXTURE_FORMAT_EXT 0x20D5
432 #define GLX_TEXTURE_TARGET_EXT 0x20D6
433 #define GLX_MIPMAP_TEXTURE_EXT 0x20D7
434
435 #define GLX_TEXTURE_FORMAT_NONE_EXT 0x20D8
436 #define GLX_TEXTURE_FORMAT_RGB_EXT 0x20D9
437 #define GLX_TEXTURE_FORMAT_RGBA_EXT 0x20DA
438
439 #define GLX_TEXTURE_1D_BIT_EXT 0x00000001
440 #define GLX_TEXTURE_2D_BIT_EXT 0x00000002
441 #define GLX_TEXTURE_RECTANGLE_BIT_EXT 0x00000004
442
443 #define GLX_TEXTURE_1D_EXT 0x20DB
444 #define GLX_TEXTURE_2D_EXT 0x20DC
445 #define GLX_TEXTURE_RECTANGLE_EXT 0x20DD
446
447 #define GLX_FRONT_LEFT_EXT 0x20DE
448 #define GLX_FRONT_RIGHT_EXT 0x20DF
449 #define GLX_BACK_LEFT_EXT 0x20E0
450 #define GLX_BACK_RIGHT_EXT 0x20E1
451 #define GLX_FRONT_EXT GLX_FRONT_LEFT_EXT
452 #define GLX_BACK_EXT GLX_BACK_LEFT_EXT
453 #define GLX_AUX0_EXT 0x20E2
454 #define GLX_AUX1_EXT 0x20E3
455 #define GLX_AUX2_EXT 0x20E4
456 #define GLX_AUX3_EXT 0x20E5
457 #define GLX_AUX4_EXT 0x20E6
458 #define GLX_AUX5_EXT 0x20E7
459 #define GLX_AUX6_EXT 0x20E8
460 #define GLX_AUX7_EXT 0x20E9
461 #define GLX_AUX8_EXT 0x20EA
462 #define GLX_AUX9_EXT 0x20EB
463
464 extern void glXBindTexImageEXT(Display *dpy, GLXDrawable drawable, int buffer, const int *attrib_list);
465 extern void glXReleaseTexImageEXT(Display *dpy, GLXDrawable drawable, int buffer);
466
467 #endif /* GLX_EXT_texture_from_pixmap */
468
469
470
471
472 /*** Should these go here, or in another header? */
473 /*
474 ** GLX Events
475 */
476 typedef struct {
477 int event_type; /* GLX_DAMAGED or GLX_SAVED */
478 int draw_type; /* GLX_WINDOW or GLX_PBUFFER */
479 unsigned long serial; /* # of last request processed by server */
480 Bool send_event; /* true if this came for SendEvent request */
481 Display *display; /* display the event was read from */
482 GLXDrawable drawable; /* XID of Drawable */
483 unsigned int buffer_mask; /* mask indicating which buffers are affected */
484 unsigned int aux_buffer; /* which aux buffer was affected */
485 int x, y;
486 int width, height;
487 int count; /* if nonzero, at least this many more */
488 } GLXPbufferClobberEvent;
489
490 typedef struct {
491 int type;
492 unsigned long serial; /* # of last request processed by server */
493 Bool send_event; /* true if this came from a SendEvent request */
494 Display *display; /* Display the event was read from */
495 GLXDrawable drawable; /* drawable on which event was requested in event mask */
496 int event_type;
497 int64_t ust;
498 int64_t msc;
499 int64_t sbc;
500 } GLXBufferSwapComplete;
501
502 typedef union __GLXEvent {
503 GLXPbufferClobberEvent glxpbufferclobber;
504 GLXBufferSwapComplete glxbufferswapcomplete;
505 long pad[24];
506 } GLXEvent;
507
508 #ifdef __cplusplus
509 }
510 #endif
511
512 #endif