Initial revision
[mesa.git] / include / GL / glx.h
1 /* $Id: glx.h,v 1.1 1999/08/19 00:55:40 jtg Exp $ */
2
3 /*
4 * Mesa 3-D graphics library
5 * Version: 3.1
6 *
7 * Copyright (C) 1999 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 * $Log: glx.h,v $
30 * Revision 1.1 1999/08/19 00:55:40 jtg
31 * Initial revision
32 *
33 * Revision 3.3 1999/02/14 03:39:09 brianp
34 * new copyright
35 *
36 * Revision 3.2 1998/06/18 03:44:00 brianp
37 * replaced "uint" with "unsigned int"
38 *
39 * Revision 3.1 1998/06/01 00:00:17 brianp
40 * added GLX_SGI_video_sync extension
41 *
42 * Revision 3.0 1998/02/20 05:06:01 brianp
43 * initial rev
44 *
45 */
46
47
48 #ifndef GLX_H
49 #define GLX_H
50
51
52 /*
53 * A pseudo-GLX implementation to allow GLX-based OpenGL programs to
54 * work with Mesa.
55 *
56 * Notes:
57 * 1. If the visual passed to glXGetConfig was not one returned by
58 * glXChooseVisual then the GLX_RGBA and GLX_DOUBLEBUFFER queries
59 * will always return True and the GLX_DEPTH_SIZE query will always
60 * return non-zero.
61 * 2. The glXIsDirect() function always returns True.
62 */
63
64
65
66 #include <X11/Xlib.h>
67 #include <X11/Xutil.h>
68 #include "GL/gl.h"
69 #ifdef MESA
70 #include "GL/xmesa.h"
71 #endif
72
73
74 #if defined(USE_MGL_NAMESPACE)
75 #include "glx_mangle.h"
76 #endif
77
78
79 #ifdef __cplusplus
80 extern "C" {
81 #endif
82
83
84 #define GLX_VERSION_1_1 1
85
86
87 /*
88 * Tokens for glXChooseVisual and glXGetConfig:
89 */
90 enum _GLX_CONFIGS {
91 GLX_USE_GL = 1,
92 GLX_BUFFER_SIZE = 2,
93 GLX_LEVEL = 3,
94 GLX_RGBA = 4,
95 GLX_DOUBLEBUFFER = 5,
96 GLX_STEREO = 6,
97 GLX_AUX_BUFFERS = 7,
98 GLX_RED_SIZE = 8,
99 GLX_GREEN_SIZE = 9,
100 GLX_BLUE_SIZE = 10,
101 GLX_ALPHA_SIZE = 11,
102 GLX_DEPTH_SIZE = 12,
103 GLX_STENCIL_SIZE = 13,
104 GLX_ACCUM_RED_SIZE = 14,
105 GLX_ACCUM_GREEN_SIZE = 15,
106 GLX_ACCUM_BLUE_SIZE = 16,
107 GLX_ACCUM_ALPHA_SIZE = 17,
108
109 /* GLX_EXT_visual_info extension */
110 GLX_X_VISUAL_TYPE_EXT = 0x22,
111 GLX_TRANSPARENT_TYPE_EXT = 0x23,
112 GLX_TRANSPARENT_INDEX_VALUE_EXT = 0x24,
113 GLX_TRANSPARENT_RED_VALUE_EXT = 0x25,
114 GLX_TRANSPARENT_GREEN_VALUE_EXT = 0x26,
115 GLX_TRANSPARENT_BLUE_VALUE_EXT = 0x27,
116 GLX_TRANSPARENT_ALPHA_VALUE_EXT = 0x28
117 };
118
119
120 /*
121 * Error codes returned by glXGetConfig:
122 */
123 #define GLX_BAD_SCREEN 1
124 #define GLX_BAD_ATTRIBUTE 2
125 #define GLX_NO_EXTENSION 3
126 #define GLX_BAD_VISUAL 4
127 #define GLX_BAD_CONTEXT 5
128 #define GLX_BAD_VALUE 6
129 #define GLX_BAD_ENUM 7
130
131
132 /*
133 * GLX 1.1 and later:
134 */
135 #define GLX_VENDOR 1
136 #define GLX_VERSION 2
137 #define GLX_EXTENSIONS 3
138
139
140 /*
141 * GLX_visual_info extension
142 */
143 #define GLX_TRUE_COLOR_EXT 0x8002
144 #define GLX_DIRECT_COLOR_EXT 0x8003
145 #define GLX_PSEUDO_COLOR_EXT 0x8004
146 #define GLX_STATIC_COLOR_EXT 0x8005
147 #define GLX_GRAY_SCALE_EXT 0x8006
148 #define GLX_STATIC_GRAY_EXT 0x8007
149 #define GLX_NONE_EXT 0x8000
150 #define GLX_TRANSPARENT_RGB_EXT 0x8008
151 #define GLX_TRANSPARENT_INDEX_EXT 0x8009
152
153
154 /*
155 * Compile-time extension tests
156 */
157 #ifdef MESA
158 #define GLX_EXT_visual_info 1
159 #define GLX_MESA_pixmap_colormap 1
160 #define GLX_MESA_release_buffers 1
161 #define GLX_MESA_copy_sub_buffer 1
162 #define GLX_SGI_video_sync 1
163 #endif
164
165
166
167 #ifdef MESA
168 typedef XMesaContext GLXContext;
169 typedef Pixmap GLXPixmap;
170 typedef Drawable GLXDrawable;
171 #else
172 typedef void * GLXContext;
173 typedef XID GLXPixmap;
174 typedef XID GLXDrawable;
175 #endif
176 typedef XID GLXContextID;
177
178
179
180 extern XVisualInfo* glXChooseVisual( Display *dpy, int screen,
181 int *attribList );
182
183 extern GLXContext glXCreateContext( Display *dpy, XVisualInfo *vis,
184 GLXContext shareList, Bool direct );
185
186 extern void glXDestroyContext( Display *dpy, GLXContext ctx );
187
188 extern Bool glXMakeCurrent( Display *dpy, GLXDrawable drawable,
189 GLXContext ctx);
190
191 extern void glXCopyContext( Display *dpy, GLXContext src, GLXContext dst,
192 GLuint mask );
193
194 extern void glXSwapBuffers( Display *dpy, GLXDrawable drawable );
195
196 extern GLXPixmap glXCreateGLXPixmap( Display *dpy, XVisualInfo *visual,
197 Pixmap pixmap );
198
199 extern void glXDestroyGLXPixmap( Display *dpy, GLXPixmap pixmap );
200
201 extern Bool glXQueryExtension( Display *dpy, int *errorb, int *event );
202
203 extern Bool glXQueryVersion( Display *dpy, int *maj, int *min );
204
205 extern Bool glXIsDirect( Display *dpy, GLXContext ctx );
206
207 extern int glXGetConfig( Display *dpy, XVisualInfo *visual,
208 int attrib, int *value );
209
210 extern GLXContext glXGetCurrentContext( void );
211
212 extern GLXDrawable glXGetCurrentDrawable( void );
213
214 extern void glXWaitGL( void );
215
216 extern void glXWaitX( void );
217
218 extern void glXUseXFont( Font font, int first, int count, int list );
219
220
221
222 /* GLX 1.1 and later */
223 extern const char *glXQueryExtensionsString( Display *dpy, int screen );
224
225 extern const char *glXQueryServerString( Display *dpy, int screen, int name );
226
227 extern const char *glXGetClientString( Display *dpy, int name );
228
229
230
231 /*
232 * Mesa GLX Extensions
233 */
234
235 #ifdef GLX_MESA_pixmap_colormap
236 extern GLXPixmap glXCreateGLXPixmapMESA( Display *dpy, XVisualInfo *visual,
237 Pixmap pixmap, Colormap cmap );
238 #endif
239
240 #ifdef GLX_MESA_release_buffers
241 extern Bool glXReleaseBuffersMESA( Display *dpy, GLXDrawable d );
242 #endif
243
244 #ifdef GLX_MESA_copy_sub_buffer
245 extern void glXCopySubBufferMESA( Display *dpy, GLXDrawable drawable,
246 int x, int y, int width, int height );
247 #endif
248
249 #ifdef GLX_SGI_video_sync
250 extern int glXGetVideoSyncSGI(unsigned int *count);
251 extern int glXWaitVideoSyncSGI(int divisor, int remainder,
252 unsigned int *count);
253 #endif
254
255
256
257 #ifdef __cplusplus
258 }
259 #endif
260
261 #endif