xm_api.h revision 997a2547d10890dbc00f2c48191cde58a2ee37c8 
1/*
2 * Mesa 3-D graphics library
3 * Version:  7.1
4 *
5 * Copyright (C) 1999-2007  Brian Paul   All Rights Reserved.
6 *
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:
13 *
14 * The above copyright notice and this permission notice shall be included
15 * in all copies or substantial portions of the Software.
16 *
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.
23 */
24
25
26
27/* Sample Usage:
28
29In addition to the usual X calls to select a visual, create a colormap
30and create a window, you must do the following to use the X/Mesa interface:
31
321. Call XMesaCreateVisual() to make an XMesaVisual from an XVisualInfo.
33
342. Call XMesaCreateContext() to create an X/Mesa rendering context, given
35   the XMesaVisual.
36
373. Call XMesaCreateWindowBuffer() to create an XMesaBuffer from an X window
38   and XMesaVisual.
39
404. Call XMesaMakeCurrent() to bind the XMesaBuffer to an XMesaContext and
41   to make the context the current one.
42
435. Make gl* calls to render your graphics.
44
456. Use XMesaSwapBuffers() when double buffering to swap front/back buffers.
46
477. Before the X window is destroyed, call XMesaDestroyBuffer().
48
498. Before exiting, call XMesaDestroyVisual and XMesaDestroyContext.
50
51*/
52
53
54
55
56#ifndef XMESA_H
57#define XMESA_H
58
59
60#include "main/core.h" /* for gl_config */
61#include "state_tracker/st_api.h"
62#include "os/os_thread.h"
63
64#include "state_tracker/xlib_sw_winsys.h"
65
66# include <X11/Xlib.h>
67# include <X11/Xlibint.h>
68# include <X11/Xutil.h>
69
70typedef struct xmesa_display *XMesaDisplay;
71typedef struct xmesa_buffer *XMesaBuffer;
72typedef struct xmesa_context *XMesaContext;
73typedef struct xmesa_visual *XMesaVisual;
74
75
76struct xmesa_display {
77   pipe_mutex mutex;
78
79   Display *display;
80   struct pipe_screen *screen;
81   struct st_manager *smapi;
82
83   struct pipe_context *pipe;
84};
85
86
87/*
88 * Create a new X/Mesa visual.
89 * Input:  display - X11 display
90 *         visinfo - an XVisualInfo pointer
91 *         rgb_flag - GL_TRUE = RGB mode,
92 *                    GL_FALSE = color index mode
93 *         alpha_flag - alpha buffer requested?
94 *         db_flag - GL_TRUE = double-buffered,
95 *                   GL_FALSE = single buffered
96 *         stereo_flag - stereo visual?
97 *         ximage_flag - GL_TRUE = use an XImage for back buffer,
98 *                       GL_FALSE = use an off-screen pixmap for back buffer
99 *         depth_size - requested bits/depth values, or zero
100 *         stencil_size - requested bits/stencil values, or zero
101 *         accum_red_size - requested bits/red accum values, or zero
102 *         accum_green_size - requested bits/green accum values, or zero
103 *         accum_blue_size - requested bits/blue accum values, or zero
104 *         accum_alpha_size - requested bits/alpha accum values, or zero
105 *         num_samples - number of samples/pixel if multisampling, or zero
106 *         level - visual level, usually 0
107 *         visualCaveat - ala the GLX extension, usually GLX_NONE_EXT
108 * Return;  a new XMesaVisual or 0 if error.
109 */
110extern XMesaVisual XMesaCreateVisual( Display *display,
111                                      XVisualInfo * visinfo,
112                                      GLboolean rgb_flag,
113                                      GLboolean alpha_flag,
114                                      GLboolean db_flag,
115                                      GLboolean stereo_flag,
116                                      GLboolean ximage_flag,
117                                      GLint depth_size,
118                                      GLint stencil_size,
119                                      GLint accum_red_size,
120                                      GLint accum_green_size,
121                                      GLint accum_blue_size,
122                                      GLint accum_alpha_size,
123                                      GLint num_samples,
124                                      GLint level,
125                                      GLint visualCaveat );
126
127/*
128 * Destroy an XMesaVisual, but not the associated XVisualInfo.
129 */
130extern void XMesaDestroyVisual( XMesaVisual v );
131
132
133
134/*
135 * Create a new XMesaContext for rendering into an X11 window.
136 *
137 * Input:  visual - an XMesaVisual
138 *         share_list - another XMesaContext with which to share display
139 *                      lists or NULL if no sharing is wanted.
140 * Return:  an XMesaContext or NULL if error.
141 */
142extern XMesaContext XMesaCreateContext( XMesaVisual v,
143					XMesaContext share_list );
144
145
146/*
147 * Destroy a rendering context as returned by XMesaCreateContext()
148 */
149extern void XMesaDestroyContext( XMesaContext c );
150
151
152
153/*
154 * Create an XMesaBuffer from an X window.
155 */
156extern XMesaBuffer XMesaCreateWindowBuffer( XMesaVisual v, Window w );
157
158
159/*
160 * Create an XMesaBuffer from an X pixmap.
161 */
162extern XMesaBuffer XMesaCreatePixmapBuffer( XMesaVisual v,
163					    Pixmap p,
164					    Colormap cmap );
165
166
167/*
168 * Destroy an XMesaBuffer, but not the corresponding window or pixmap.
169 */
170extern void XMesaDestroyBuffer( XMesaBuffer b );
171
172
173/*
174 * Return the XMesaBuffer handle which corresponds to an X drawable, if any.
175 *
176 * New in Mesa 2.3.
177 */
178extern XMesaBuffer XMesaFindBuffer( Display *dpy,
179				    Drawable d );
180
181
182
183/*
184 * Bind two buffers (read and draw) to a context and make the
185 * context the current one.
186 * New in Mesa 3.3
187 */
188extern GLboolean XMesaMakeCurrent2( XMesaContext c,
189                                    XMesaBuffer drawBuffer,
190                                    XMesaBuffer readBuffer );
191
192
193/*
194 * Unbind the current context from its buffer.
195 */
196extern GLboolean XMesaUnbindContext( XMesaContext c );
197
198
199/*
200 * Return a handle to the current context.
201 */
202extern XMesaContext XMesaGetCurrentContext( void );
203
204
205/*
206 * Swap the front and back buffers for the given buffer.  No action is
207 * taken if the buffer is not double buffered.
208 */
209extern void XMesaSwapBuffers( XMesaBuffer b );
210
211
212/*
213 * Copy a sub-region of the back buffer to the front buffer.
214 *
215 * New in Mesa 2.6
216 */
217extern void XMesaCopySubBuffer( XMesaBuffer b,
218				int x,
219				int y,
220				int width,
221				int height );
222
223
224
225
226
227/*
228 * Flush/sync a context
229 */
230extern void XMesaFlush( XMesaContext c );
231
232
233
234/*
235 * Scan for XMesaBuffers whose window/pixmap has been destroyed, then free
236 * any memory used by that buffer.
237 *
238 * New in Mesa 2.3.
239 */
240extern void XMesaGarbageCollect( void );
241
242
243
244/*
245 * Create a pbuffer.
246 * New in Mesa 4.1
247 */
248extern XMesaBuffer XMesaCreatePBuffer(XMesaVisual v, Colormap cmap,
249                                      unsigned int width, unsigned int height);
250
251
252
253/*
254 * Texture from Pixmap
255 * New in Mesa 7.1
256 */
257extern void
258XMesaBindTexImage(Display *dpy, XMesaBuffer drawable, int buffer,
259                  const int *attrib_list);
260
261extern void
262XMesaReleaseTexImage(Display *dpy, XMesaBuffer drawable, int buffer);
263
264
265extern XMesaBuffer
266XMesaCreatePixmapTextureBuffer(XMesaVisual v, Pixmap p,
267                               Colormap cmap,
268                               int format, int target, int mipmap);
269
270
271extern void
272XMesaCopyContext(XMesaContext src, XMesaContext dst, unsigned long mask);
273
274
275/***********************************************************************
276 */
277
278/**
279 * Visual inforation, derived from GLvisual.
280 * Basically corresponds to an XVisualInfo.
281 */
282struct xmesa_visual {
283   struct gl_config mesa_visual;/* Device independent visual parameters */
284   int screen, visualID, visualType;
285   Display *display;	/* The X11 display */
286   XVisualInfo * visinfo;	/* X's visual info (pointer to private copy) */
287   XVisualInfo *vishandle;	/* Only used in fakeglx.c */
288   GLint BitsPerPixel;		/* True bits per pixel for XImages */
289
290   GLboolean ximage_flag;	/* Use XImage for back buffer (not pixmap)? */
291
292   struct st_visual stvis;
293};
294
295
296/**
297 * Context info, derived from st_context.
298 * Basically corresponds to a GLXContext.
299 */
300struct xmesa_context {
301   struct st_context_iface *st;
302   XMesaVisual xm_visual;	/** pixel format info */
303   XMesaBuffer xm_buffer;	/** current drawbuffer */
304   XMesaBuffer xm_read_buffer;  /** current readbuffer */
305};
306
307
308/**
309 * Types of X/GLX drawables we might render into.
310 */
311typedef enum {
312   WINDOW,          /* An X window */
313   GLXWINDOW,       /* GLX window */
314   PIXMAP,          /* GLX pixmap */
315   PBUFFER          /* GLX Pbuffer */
316} BufferType;
317
318
319/**
320 * Framebuffer information, derived from.
321 * Basically corresponds to a GLXDrawable.
322 */
323struct xmesa_buffer {
324   struct st_framebuffer_iface *stfb;
325   struct xlib_drawable ws;
326
327   GLboolean wasCurrent;	/* was ever the current buffer? */
328   XMesaVisual xm_visual;	/* the X/Mesa visual */
329   Drawable drawable;	/* Usually the X window ID */
330   Colormap cmap;		/* the X colormap */
331   BufferType type;             /* window, pixmap, pbuffer or glxwindow */
332
333   GLboolean largestPbuffer;    /**< for pbuffers */
334   GLboolean preservedContents; /**< for pbuffers */
335
336   XImage *tempImage;
337   unsigned long selectedEvents;/* for pbuffers only */
338
339
340   GC gc;			/* scratch GC for span, line, tri drawing */
341
342   /* GLX_EXT_texture_from_pixmap */
343   GLint TextureTarget; /** GLX_TEXTURE_1D_EXT, for example */
344   GLint TextureFormat; /** GLX_TEXTURE_FORMAT_RGB_EXT, for example */
345   GLint TextureMipmap; /** 0 or 1 */
346
347   struct xmesa_buffer *Next;	/* Linked list pointer: */
348
349   unsigned width, height;
350};
351
352
353
354extern const char *
355xmesa_get_name(void);
356
357extern void
358xmesa_init(Display *dpy);
359
360extern XMesaBuffer
361xmesa_find_buffer(Display *dpy, Colormap cmap, XMesaBuffer notThis);
362
363extern void
364xmesa_get_window_size(Display *dpy, XMesaBuffer b,
365                      GLuint *width, GLuint *height);
366
367extern void
368xmesa_notify_invalid_buffer(XMesaBuffer b);
369
370extern void
371xmesa_check_buffer_size(XMesaBuffer b);
372
373extern void
374xmesa_destroy_buffers_on_display(Display *dpy);
375
376static INLINE GLuint
377xmesa_buffer_width(XMesaBuffer b)
378{
379   return b->width;
380}
381
382static INLINE GLuint
383xmesa_buffer_height(XMesaBuffer b)
384{
385   return b->height;
386}
387
388extern boolean xmesa_strict_invalidate;
389
390#endif
391