2 * Mesa 3-D graphics library
5 * Copyright (C) 1999-2007 Brian Paul All Rights Reserved.
7 * Permission is hereby granted, free of charge, to any person obtaining a
8 * copy of this software and associated documentation files (the "Software"),
9 * to deal in the Software without restriction, including without limitation
10 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
11 * and/or sell copies of the Software, and to permit persons to whom the
12 * Software is furnished to do so, subject to the following conditions:
14 * The above copyright notice and this permission notice shall be included
15 * in all copies or substantial portions of the Software.
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
18 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
20 * BRIAN PAUL BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
21 * AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
22 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
27 * Mesa/X11 interface. This header file serves as the documentation for
28 * the Mesa/X11 interface functions.
30 * Note: this interface isn't intended for user programs. It's primarily
31 * just for implementing the pseudo-GLX interface.
37 In addition to the usual X calls to select a visual, create a colormap
38 and create a window, you must do the following to use the X/Mesa interface:
40 1. Call XMesaCreateVisual() to make an XMesaVisual from an XVisualInfo.
42 2. Call XMesaCreateContext() to create an X/Mesa rendering context, given
45 3. Call XMesaCreateWindowBuffer() to create an XMesaBuffer from an X window
48 4. Call XMesaMakeCurrent() to bind the XMesaBuffer to an XMesaContext and
49 to make the context the current one.
51 5. Make gl* calls to render your graphics.
53 6. Use XMesaSwapBuffers() when double buffering to swap front/back buffers.
55 7. Before the X window is destroyed, call XMesaDestroyBuffer().
57 8. Before exiting, call XMesaDestroyVisual and XMesaDestroyContext.
68 #include <GL/vms_x_fix.h>
76 #include <X11/Xutil.h>
81 #include <pragmas/xlib_pragmas.h>
82 extern struct Library
*XLibBase
;
86 #define XMESA_MAJOR_VERSION 6
87 #define XMESA_MINOR_VERSION 3
92 * Values passed to XMesaGetString:
94 #define XMESA_VERSION 1
95 #define XMESA_EXTENSIONS 2
99 * Values passed to XMesaSetFXmode:
101 #define XMESA_FX_WINDOW 1
102 #define XMESA_FX_FULLSCREEN 2
106 typedef struct xmesa_context
*XMesaContext
;
108 typedef struct xmesa_visual
*XMesaVisual
;
110 typedef struct xmesa_buffer
*XMesaBuffer
;
115 * Create a new X/Mesa visual.
116 * Input: display - X11 display
117 * visinfo - an XVisualInfo pointer
118 * rgb_flag - GL_TRUE = RGB mode,
119 * GL_FALSE = color index mode
120 * alpha_flag - alpha buffer requested?
121 * db_flag - GL_TRUE = double-buffered,
122 * GL_FALSE = single buffered
123 * stereo_flag - stereo visual?
124 * ximage_flag - GL_TRUE = use an XImage for back buffer,
125 * GL_FALSE = use an off-screen pixmap for back buffer
126 * depth_size - requested bits/depth values, or zero
127 * stencil_size - requested bits/stencil values, or zero
128 * accum_red_size - requested bits/red accum values, or zero
129 * accum_green_size - requested bits/green accum values, or zero
130 * accum_blue_size - requested bits/blue accum values, or zero
131 * accum_alpha_size - requested bits/alpha accum values, or zero
132 * num_samples - number of samples/pixel if multisampling, or zero
133 * level - visual level, usually 0
134 * visualCaveat - ala the GLX extension, usually GLX_NONE_EXT
135 * Return; a new XMesaVisual or 0 if error.
137 extern XMesaVisual
XMesaCreateVisual( XMesaDisplay
*display
,
138 XMesaVisualInfo visinfo
,
140 GLboolean alpha_flag
,
142 GLboolean stereo_flag
,
143 GLboolean ximage_flag
,
146 GLint accum_red_size
,
147 GLint accum_green_size
,
148 GLint accum_blue_size
,
149 GLint accum_alpha_size
,
152 GLint visualCaveat
);
155 * Destroy an XMesaVisual, but not the associated XVisualInfo.
157 extern void XMesaDestroyVisual( XMesaVisual v
);
162 * Create a new XMesaContext for rendering into an X11 window.
164 * Input: visual - an XMesaVisual
165 * share_list - another XMesaContext with which to share display
166 * lists or NULL if no sharing is wanted.
167 * Return: an XMesaContext or NULL if error.
169 extern XMesaContext
XMesaCreateContext( XMesaVisual v
,
170 XMesaContext share_list
);
174 * Destroy a rendering context as returned by XMesaCreateContext()
176 extern void XMesaDestroyContext( XMesaContext c
);
182 * Create an XMesaBuffer from an X window.
184 extern XMesaBuffer
XMesaCreateWindowBuffer( XMesaVisual v
, XMesaWindow w
);
188 * Create an XMesaBuffer from an X pixmap.
190 extern XMesaBuffer
XMesaCreatePixmapBuffer( XMesaVisual v
,
192 XMesaColormap cmap
);
196 * Destroy an XMesaBuffer, but not the corresponding window or pixmap.
198 extern void XMesaDestroyBuffer( XMesaBuffer b
);
202 * Return the XMesaBuffer handle which corresponds to an X drawable, if any.
206 extern XMesaBuffer
XMesaFindBuffer( XMesaDisplay
*dpy
,
212 * Bind a buffer to a context and make the context the current one.
214 extern GLboolean
XMesaMakeCurrent( XMesaContext c
,
219 * Bind two buffers (read and draw) to a context and make the
220 * context the current one.
223 extern GLboolean
XMesaMakeCurrent2( XMesaContext c
,
224 XMesaBuffer drawBuffer
,
225 XMesaBuffer readBuffer
);
229 * Unbind the current context from its buffer.
231 extern GLboolean
XMesaUnbindContext( XMesaContext c
);
235 * Return a handle to the current context.
237 extern XMesaContext
XMesaGetCurrentContext( void );
241 * Return handle to the current (draw) buffer.
243 extern XMesaBuffer
XMesaGetCurrentBuffer( void );
247 * Return handle to the current read buffer.
250 extern XMesaBuffer
XMesaGetCurrentReadBuffer( void );
254 * Swap the front and back buffers for the given buffer. No action is
255 * taken if the buffer is not double buffered.
257 extern void XMesaSwapBuffers( XMesaBuffer b
);
261 * Copy a sub-region of the back buffer to the front buffer.
265 extern void XMesaCopySubBuffer( XMesaBuffer b
,
273 * Return a pointer to the Pixmap or XImage being used as the back
274 * color buffer of an XMesaBuffer. This function is a way to get "under
275 * the hood" of X/Mesa so one can manipulate the back buffer directly.
276 * Input: b - the XMesaBuffer
277 * Output: pixmap - pointer to back buffer's Pixmap, or 0
278 * ximage - pointer to back buffer's XImage, or NULL
279 * Return: GL_TRUE = context is double buffered
280 * GL_FALSE = context is single buffered
282 extern GLboolean
XMesaGetBackBuffer( XMesaBuffer b
,
284 XMesaImage
**ximage
);
289 * Return the depth buffer associated with an XMesaBuffer.
290 * Input: b - the XMesa buffer handle
291 * Output: width, height - size of buffer in pixels
292 * bytesPerValue - bytes per depth value (2 or 4)
293 * buffer - pointer to depth buffer values
294 * Return: GL_TRUE or GL_FALSE to indicate success or failure.
298 extern GLboolean
XMesaGetDepthBuffer( XMesaBuffer b
,
301 GLint
*bytesPerValue
,
307 * Flush/sync a context
309 extern void XMesaFlush( XMesaContext c
);
314 * Get an X/Mesa-specific string.
315 * Input: name - either XMESA_VERSION or XMESA_EXTENSIONS
317 extern const char *XMesaGetString( XMesaContext c
, int name
);
322 * Scan for XMesaBuffers whose window/pixmap has been destroyed, then free
323 * any memory used by that buffer.
327 extern void XMesaGarbageCollect( void );
332 * Return a dithered pixel value.
333 * Input: c - XMesaContext
334 * x, y - window coordinate
335 * red, green, blue, alpha - color components in [0,1]
336 * Return: pixel value
340 extern unsigned long XMesaDitherColor( XMesaContext xmesa
,
351 * 3Dfx Glide driver only!
352 * Set 3Dfx/Glide full-screen or window rendering mode.
353 * Input: mode - either XMESA_FX_WINDOW (window rendering mode) or
354 * XMESA_FX_FULLSCREEN (full-screen rendering mode)
355 * Return: GL_TRUE if success
356 * GL_FALSE if invalid mode or if not using 3Dfx driver
360 extern GLboolean
XMesaSetFXmode( GLint mode
);
365 * Reallocate the back/depth/stencil/accum/etc/ buffers associated with
366 * buffer <b> if its size has changed.
370 extern void XMesaResizeBuffers( XMesaBuffer b
);
378 extern XMesaBuffer
XMesaCreatePBuffer(XMesaVisual v
, XMesaColormap cmap
,
379 unsigned int width
, unsigned int height
);
384 * Texture from Pixmap
388 XMesaBindTexImage(XMesaDisplay
*dpy
, XMesaBuffer drawable
, int buffer
,
389 const int *attrib_list
);
392 XMesaReleaseTexImage(XMesaDisplay
*dpy
, XMesaBuffer drawable
, int buffer
);
396 XMesaCreatePixmapTextureBuffer(XMesaVisual v
, XMesaPixmap p
,
398 int format
, int target
, int mipmap
);