xm_api.h revision 0526100a5cbd928fa28d38abdafd6beb024b0828 
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/mtypes.h"
61#include "state_tracker/st_context.h"
62#include "state_tracker/st_public.h"
63#include "pipe/p_thread.h"
64
65
66# include <X11/Xlib.h>
67# include <X11/Xlibint.h>
68# include <X11/Xutil.h>
69# ifdef USE_XSHM  /* was SHM */
70#  include <sys/ipc.h>
71#  include <sys/shm.h>
72#  include <X11/extensions/XShm.h>
73# endif
74
75typedef struct xmesa_buffer *XMesaBuffer;
76typedef struct xmesa_context *XMesaContext;
77typedef struct xmesa_visual *XMesaVisual;
78
79
80
81/*
82 * Create a new X/Mesa visual.
83 * Input:  display - X11 display
84 *         visinfo - an XVisualInfo pointer
85 *         rgb_flag - GL_TRUE = RGB mode,
86 *                    GL_FALSE = color index mode
87 *         alpha_flag - alpha buffer requested?
88 *         db_flag - GL_TRUE = double-buffered,
89 *                   GL_FALSE = single buffered
90 *         stereo_flag - stereo visual?
91 *         ximage_flag - GL_TRUE = use an XImage for back buffer,
92 *                       GL_FALSE = use an off-screen pixmap for back buffer
93 *         depth_size - requested bits/depth values, or zero
94 *         stencil_size - requested bits/stencil values, or zero
95 *         accum_red_size - requested bits/red accum values, or zero
96 *         accum_green_size - requested bits/green accum values, or zero
97 *         accum_blue_size - requested bits/blue accum values, or zero
98 *         accum_alpha_size - requested bits/alpha accum values, or zero
99 *         num_samples - number of samples/pixel if multisampling, or zero
100 *         level - visual level, usually 0
101 *         visualCaveat - ala the GLX extension, usually GLX_NONE_EXT
102 * Return;  a new XMesaVisual or 0 if error.
103 */
104extern XMesaVisual XMesaCreateVisual( Display *display,
105                                      XVisualInfo * visinfo,
106                                      GLboolean rgb_flag,
107                                      GLboolean alpha_flag,
108                                      GLboolean db_flag,
109                                      GLboolean stereo_flag,
110                                      GLboolean ximage_flag,
111                                      GLint depth_size,
112                                      GLint stencil_size,
113                                      GLint accum_red_size,
114                                      GLint accum_green_size,
115                                      GLint accum_blue_size,
116                                      GLint accum_alpha_size,
117                                      GLint num_samples,
118                                      GLint level,
119                                      GLint visualCaveat );
120
121/*
122 * Destroy an XMesaVisual, but not the associated XVisualInfo.
123 */
124extern void XMesaDestroyVisual( XMesaVisual v );
125
126
127
128/*
129 * Create a new XMesaContext for rendering into an X11 window.
130 *
131 * Input:  visual - an XMesaVisual
132 *         share_list - another XMesaContext with which to share display
133 *                      lists or NULL if no sharing is wanted.
134 * Return:  an XMesaContext or NULL if error.
135 */
136extern XMesaContext XMesaCreateContext( XMesaVisual v,
137					XMesaContext share_list );
138
139
140/*
141 * Destroy a rendering context as returned by XMesaCreateContext()
142 */
143extern void XMesaDestroyContext( XMesaContext c );
144
145
146
147/*
148 * Create an XMesaBuffer from an X window.
149 */
150extern XMesaBuffer XMesaCreateWindowBuffer( XMesaVisual v, Window w );
151
152
153/*
154 * Create an XMesaBuffer from an X pixmap.
155 */
156extern XMesaBuffer XMesaCreatePixmapBuffer( XMesaVisual v,
157					    Pixmap p,
158					    Colormap cmap );
159
160
161/*
162 * Destroy an XMesaBuffer, but not the corresponding window or pixmap.
163 */
164extern void XMesaDestroyBuffer( XMesaBuffer b );
165
166
167/*
168 * Return the XMesaBuffer handle which corresponds to an X drawable, if any.
169 *
170 * New in Mesa 2.3.
171 */
172extern XMesaBuffer XMesaFindBuffer( Display *dpy,
173				    Drawable d );
174
175
176
177/*
178 * Bind two buffers (read and draw) to a context and make the
179 * context the current one.
180 * New in Mesa 3.3
181 */
182extern GLboolean XMesaMakeCurrent2( XMesaContext c,
183                                    XMesaBuffer drawBuffer,
184                                    XMesaBuffer readBuffer );
185
186
187/*
188 * Unbind the current context from its buffer.
189 */
190extern GLboolean XMesaUnbindContext( XMesaContext c );
191
192
193/*
194 * Return a handle to the current context.
195 */
196extern XMesaContext XMesaGetCurrentContext( void );
197
198
199/*
200 * Swap the front and back buffers for the given buffer.  No action is
201 * taken if the buffer is not double buffered.
202 */
203extern void XMesaSwapBuffers( XMesaBuffer b );
204
205
206/*
207 * Copy a sub-region of the back buffer to the front buffer.
208 *
209 * New in Mesa 2.6
210 */
211extern void XMesaCopySubBuffer( XMesaBuffer b,
212				int x,
213				int y,
214				int width,
215				int height );
216
217
218
219
220
221/*
222 * Flush/sync a context
223 */
224extern void XMesaFlush( XMesaContext c );
225
226
227
228/*
229 * Scan for XMesaBuffers whose window/pixmap has been destroyed, then free
230 * any memory used by that buffer.
231 *
232 * New in Mesa 2.3.
233 */
234extern void XMesaGarbageCollect( void );
235
236
237
238/*
239 * Create a pbuffer.
240 * New in Mesa 4.1
241 */
242extern XMesaBuffer XMesaCreatePBuffer(XMesaVisual v, Colormap cmap,
243                                      unsigned int width, unsigned int height);
244
245
246
247/*
248 * Texture from Pixmap
249 * New in Mesa 7.1
250 */
251extern void
252XMesaBindTexImage(Display *dpy, XMesaBuffer drawable, int buffer,
253                  const int *attrib_list);
254
255extern void
256XMesaReleaseTexImage(Display *dpy, XMesaBuffer drawable, int buffer);
257
258
259extern XMesaBuffer
260XMesaCreatePixmapTextureBuffer(XMesaVisual v, Pixmap p,
261                               Colormap cmap,
262                               int format, int target, int mipmap);
263
264
265
266
267/***********************************************************************
268 */
269
270extern pipe_mutex _xmesa_lock;
271
272extern struct xmesa_buffer *XMesaBufferList;
273
274
275/**
276 * Visual inforation, derived from GLvisual.
277 * Basically corresponds to an XVisualInfo.
278 */
279struct xmesa_visual {
280   GLvisual mesa_visual;	/* Device independent visual parameters */
281   Display *display;	/* The X11 display */
282   XVisualInfo * visinfo;	/* X's visual info (pointer to private copy) */
283   XVisualInfo *vishandle;	/* Only used in fakeglx.c */
284   GLint BitsPerPixel;		/* True bits per pixel for XImages */
285
286   GLboolean ximage_flag;	/* Use XImage for back buffer (not pixmap)? */
287};
288
289
290/**
291 * Context info, derived from st_context.
292 * Basically corresponds to a GLXContext.
293 */
294struct xmesa_context {
295   struct st_context *st;
296   XMesaVisual xm_visual;	/** pixel format info */
297   XMesaBuffer xm_buffer;	/** current drawbuffer */
298   XMesaBuffer xm_read_buffer;  /** current readbuffer */
299};
300
301
302/**
303 * Types of X/GLX drawables we might render into.
304 */
305typedef enum {
306   WINDOW,          /* An X window */
307   GLXWINDOW,       /* GLX window */
308   PIXMAP,          /* GLX pixmap */
309   PBUFFER          /* GLX Pbuffer */
310} BufferType;
311
312
313/**
314 * Framebuffer information, derived from.
315 * Basically corresponds to a GLXDrawable.
316 */
317struct xmesa_buffer {
318   struct st_framebuffer *stfb;
319
320   GLboolean wasCurrent;	/* was ever the current buffer? */
321   XMesaVisual xm_visual;	/* the X/Mesa visual */
322   Drawable drawable;	/* Usually the X window ID */
323   Colormap cmap;		/* the X colormap */
324   BufferType type;             /* window, pixmap, pbuffer or glxwindow */
325
326   GLboolean largestPbuffer;    /**< for pbuffers */
327   GLboolean preservedContents; /**< for pbuffers */
328
329   XImage *tempImage;
330   unsigned long selectedEvents;/* for pbuffers only */
331
332   GLuint shm;			/* X Shared Memory extension status:	*/
333				/*    0 = not available			*/
334				/*    1 = XImage support available	*/
335				/*    2 = Pixmap support available too	*/
336#if defined(USE_XSHM)
337   XShmSegmentInfo shminfo;
338#endif
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
350
351
352/** cast wrapper */
353static INLINE XMesaContext
354xmesa_context(GLcontext *ctx)
355{
356   return (XMesaContext) ctx->DriverCtx;
357}
358
359
360/** cast wrapper */
361static INLINE XMesaBuffer
362xmesa_buffer(GLframebuffer *fb)
363{
364   struct st_framebuffer *stfb = (struct st_framebuffer *) fb;
365   return (XMesaBuffer) st_framebuffer_private(stfb);
366}
367
368
369extern void
370xmesa_delete_framebuffer(struct gl_framebuffer *fb);
371
372extern XMesaBuffer
373xmesa_find_buffer(Display *dpy, Colormap cmap, XMesaBuffer notThis);
374
375extern void
376xmesa_get_window_size(Display *dpy, XMesaBuffer b,
377                      GLuint *width, GLuint *height);
378
379extern void
380xmesa_check_and_update_buffer_size(XMesaContext xmctx, XMesaBuffer drawBuffer);
381
382extern void
383xmesa_destroy_buffers_on_display(Display *dpy);
384
385static INLINE GLuint
386xmesa_buffer_width(XMesaBuffer b)
387{
388   return b->stfb->Base.Width;
389}
390
391static INLINE GLuint
392xmesa_buffer_height(XMesaBuffer b)
393{
394   return b->stfb->Base.Height;
395}
396
397extern int
398xmesa_check_for_xshm(Display *display);
399
400
401#endif
402