2 * Mesa 3-D graphics library
5 * Copyright (C) 1999-2006 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.
28 * Framebuffer and renderbuffer-related functions.
32 #include "glxheader.h"
36 #include "framebuffer.h"
37 #include "renderbuffer.h"
38 #include "pipe/p_state.h"
41 #if defined(USE_XSHM) && !defined(XFree86Server)
42 static volatile int mesaXErrorFlag
= 0;
45 * Catches potential Xlib errors.
48 mesaHandleXError(XMesaDisplay
*dpy
, XErrorEvent
*event
)
57 * Allocate a shared memory XImage back buffer for the given XMesaBuffer.
58 * Return: GL_TRUE if success, GL_FALSE if error
61 alloc_back_shm_ximage(XMesaBuffer b
, GLuint width
, GLuint height
)
64 * We have to do a _lot_ of error checking here to be sure we can
65 * really use the XSHM extension. It seems different servers trigger
66 * errors at different points if the extension won't work. Therefore
67 * we have to be very careful...
70 int (*old_handler
)(XMesaDisplay
*, XErrorEvent
*);
72 if (width
== 0 || height
== 0) {
73 /* this will be true the first time we're called on 'b' */
77 b
->backxrb
->ximage
= XShmCreateImage(b
->xm_visual
->display
,
78 b
->xm_visual
->visinfo
->visual
,
79 b
->xm_visual
->visinfo
->depth
,
80 ZPixmap
, NULL
, &b
->shminfo
,
82 if (b
->backxrb
->ximage
== NULL
) {
83 _mesa_warning(NULL
, "alloc_back_buffer: Shared memory error (XShmCreateImage), disabling.\n");
88 b
->shminfo
.shmid
= shmget(IPC_PRIVATE
, b
->backxrb
->ximage
->bytes_per_line
89 * b
->backxrb
->ximage
->height
, IPC_CREAT
|0777);
90 if (b
->shminfo
.shmid
< 0) {
91 _mesa_warning(NULL
, "shmget failed while allocating back buffer.\n");
92 XDestroyImage(b
->backxrb
->ximage
);
93 b
->backxrb
->ximage
= NULL
;
94 _mesa_warning(NULL
, "alloc_back_buffer: Shared memory error (shmget), disabling.\n");
99 b
->shminfo
.shmaddr
= b
->backxrb
->ximage
->data
100 = (char*)shmat(b
->shminfo
.shmid
, 0, 0);
101 if (b
->shminfo
.shmaddr
== (char *) -1) {
102 _mesa_warning(NULL
, "shmat() failed while allocating back buffer.\n");
103 XDestroyImage(b
->backxrb
->ximage
);
104 shmctl(b
->shminfo
.shmid
, IPC_RMID
, 0);
105 b
->backxrb
->ximage
= NULL
;
106 _mesa_warning(NULL
, "alloc_back_buffer: Shared memory error (shmat), disabling.\n");
111 b
->shminfo
.readOnly
= False
;
113 old_handler
= XSetErrorHandler(mesaHandleXError
);
114 /* This may trigger the X protocol error we're ready to catch: */
115 XShmAttach(b
->xm_visual
->display
, &b
->shminfo
);
116 XSync(b
->xm_visual
->display
, False
);
118 if (mesaXErrorFlag
) {
119 /* we are on a remote display, this error is normal, don't print it */
120 XFlush(b
->xm_visual
->display
);
122 XDestroyImage(b
->backxrb
->ximage
);
123 shmdt(b
->shminfo
.shmaddr
);
124 shmctl(b
->shminfo
.shmid
, IPC_RMID
, 0);
125 b
->backxrb
->ximage
= NULL
;
127 (void) XSetErrorHandler(old_handler
);
131 shmctl(b
->shminfo
.shmid
, IPC_RMID
, 0); /* nobody else needs it */
133 /* Finally, try an XShmPutImage to be really sure the extension works */
134 gc
= XCreateGC(b
->xm_visual
->display
, b
->frontxrb
->drawable
, 0, NULL
);
135 XShmPutImage(b
->xm_visual
->display
, b
->frontxrb
->drawable
, gc
,
136 b
->backxrb
->ximage
, 0, 0, 0, 0, 1, 1 /*one pixel*/, False
);
137 XSync(b
->xm_visual
->display
, False
);
138 XFreeGC(b
->xm_visual
->display
, gc
);
139 (void) XSetErrorHandler(old_handler
);
140 if (mesaXErrorFlag
) {
141 XFlush(b
->xm_visual
->display
);
143 XDestroyImage(b
->backxrb
->ximage
);
144 shmdt(b
->shminfo
.shmaddr
);
145 shmctl(b
->shminfo
.shmid
, IPC_RMID
, 0);
146 b
->backxrb
->ximage
= NULL
;
155 alloc_back_shm_ximage(XMesaBuffer b
, GLuint width
, GLuint height
)
157 /* Can't compile XSHM support */
165 * Setup an off-screen pixmap or Ximage to use as the back buffer.
166 * Input: b - the X/Mesa buffer
169 alloc_back_buffer(XMesaBuffer b
, GLuint width
, GLuint height
)
171 if (b
->db_mode
== BACK_XIMAGE
) {
172 /* Deallocate the old backxrb->ximage, if any */
173 if (b
->backxrb
->ximage
) {
174 #if defined(USE_XSHM) && !defined(XFree86Server)
176 XShmDetach(b
->xm_visual
->display
, &b
->shminfo
);
177 XDestroyImage(b
->backxrb
->ximage
);
178 shmdt(b
->shminfo
.shmaddr
);
182 XMesaDestroyImage(b
->backxrb
->ximage
);
183 b
->backxrb
->ximage
= NULL
;
186 if (width
== 0 || height
== 0)
189 /* Allocate new back buffer */
190 if (b
->shm
== 0 || !alloc_back_shm_ximage(b
, width
, height
)) {
191 /* Allocate a regular XImage for the back buffer. */
193 b
->backxrb
->ximage
= XMesaCreateImage(b
->xm_visual
->BitsPerPixel
,
194 width
, height
, NULL
);
196 b
->backxrb
->ximage
= XCreateImage(b
->xm_visual
->display
,
197 b
->xm_visual
->visinfo
->visual
,
198 GET_VISUAL_DEPTH(b
->xm_visual
),
199 ZPixmap
, 0, /* format, offset */
202 8, 0); /* pad, bytes_per_line */
204 if (!b
->backxrb
->ximage
) {
205 _mesa_warning(NULL
, "alloc_back_buffer: XCreateImage failed.\n");
208 b
->backxrb
->ximage
->data
= (char *) MALLOC(b
->backxrb
->ximage
->height
209 * b
->backxrb
->ximage
->bytes_per_line
);
210 if (!b
->backxrb
->ximage
->data
) {
211 _mesa_warning(NULL
, "alloc_back_buffer: MALLOC failed.\n");
212 XMesaDestroyImage(b
->backxrb
->ximage
);
213 b
->backxrb
->ximage
= NULL
;
216 b
->backxrb
->pixmap
= None
;
218 else if (b
->db_mode
== BACK_PIXMAP
) {
219 /* Free the old back pixmap */
220 if (b
->backxrb
->pixmap
) {
221 XMesaFreePixmap(b
->xm_visual
->display
, b
->backxrb
->pixmap
);
222 b
->backxrb
->pixmap
= 0;
225 if (width
> 0 && height
> 0) {
226 /* Allocate new back pixmap */
227 b
->backxrb
->pixmap
= XMesaCreatePixmap(b
->xm_visual
->display
,
228 b
->frontxrb
->drawable
,
230 GET_VISUAL_DEPTH(b
->xm_visual
));
233 b
->backxrb
->ximage
= NULL
;
239 xmesa_delete_renderbuffer(struct gl_renderbuffer
*rb
)
241 /* XXX Note: the ximage or Pixmap attached to this renderbuffer
242 * should probably get freed here, but that's currently done in
243 * XMesaDestroyBuffer().
250 * Reallocate renderbuffer storage for front color buffer.
251 * Called via gl_renderbuffer::AllocStorage()
254 xmesa_alloc_front_storage(GLcontext
*ctx
, struct gl_renderbuffer
*rb
,
255 GLenum internalFormat
, GLuint width
, GLuint height
)
257 struct xmesa_renderbuffer
*xrb
= xmesa_renderbuffer(rb
);
259 /* just clear these to be sure we don't accidentally use them */
265 /* for the FLIP macro: */
266 xrb
->bottom
= height
- 1;
270 rb
->InternalFormat
= internalFormat
;
272 if (!xrb
->Base
.surface
)
273 xrb
->Base
.surface
= xmesa_new_surface(ctx
, xrb
);
274 xrb
->Base
.surface
->width
= width
;
275 xrb
->Base
.surface
->height
= height
;
282 * Reallocate renderbuffer storage for back color buffer.
283 * Called via gl_renderbuffer::AllocStorage()
286 xmesa_alloc_back_storage(GLcontext
*ctx
, struct gl_renderbuffer
*rb
,
287 GLenum internalFormat
, GLuint width
, GLuint height
)
289 struct xmesa_renderbuffer
*xrb
= xmesa_renderbuffer(rb
);
291 /* reallocate the back buffer XImage or Pixmap */
293 alloc_back_buffer(xrb
->Parent
, width
, height
);
295 /* same as front buffer */
296 /* XXX why is this here? */
297 (void) xmesa_alloc_front_storage(ctx
, rb
, internalFormat
, width
, height
);
301 /* Needed by PIXELADDR1 macro */
302 xrb
->width1
= xrb
->ximage
->bytes_per_line
;
303 xrb
->origin1
= (GLubyte
*) xrb
->ximage
->data
+ xrb
->width1
* (height
- 1);
305 /* Needed by PIXELADDR2 macro */
306 xrb
->width2
= xrb
->ximage
->bytes_per_line
/ 2;
307 xrb
->origin2
= (GLushort
*) xrb
->ximage
->data
+ xrb
->width2
* (height
- 1);
309 /* Needed by PIXELADDR3 macro */
310 xrb
->width3
= xrb
->ximage
->bytes_per_line
;
311 xrb
->origin3
= (GLubyte
*) xrb
->ximage
->data
+ xrb
->width3
* (height
- 1);
313 /* Needed by PIXELADDR4 macro */
314 xrb
->width4
= xrb
->ximage
->width
;
315 xrb
->origin4
= (GLuint
*) xrb
->ximage
->data
+ xrb
->width4
* (height
- 1);
318 /* out of memory or buffer size is 0 x 0 */
319 xrb
->width1
= xrb
->width2
= xrb
->width3
= xrb
->width4
= 0;
326 if (!xrb
->Base
.surface
)
327 xrb
->Base
.surface
= xmesa_new_surface(ctx
, xrb
);
328 xrb
->Base
.surface
->width
= width
;
329 xrb
->Base
.surface
->height
= height
;
335 struct xmesa_renderbuffer
*
336 xmesa_new_renderbuffer(GLcontext
*ctx
, GLuint name
, const GLvisual
*visual
,
337 GLboolean backBuffer
)
339 struct xmesa_renderbuffer
*xrb
= CALLOC_STRUCT(xmesa_renderbuffer
);
342 _mesa_init_renderbuffer(&xrb
->Base
, name
);
344 xrb
->Base
.Delete
= xmesa_delete_renderbuffer
;
346 xrb
->Base
.AllocStorage
= xmesa_alloc_back_storage
;
348 xrb
->Base
.AllocStorage
= xmesa_alloc_front_storage
;
350 if (visual
->rgbMode
) {
351 xrb
->Base
.InternalFormat
= GL_RGBA
;
352 xrb
->Base
._BaseFormat
= GL_RGBA
;
353 xrb
->Base
.DataType
= GL_UNSIGNED_BYTE
;
354 xrb
->Base
.RedBits
= visual
->redBits
;
355 xrb
->Base
.GreenBits
= visual
->greenBits
;
356 xrb
->Base
.BlueBits
= visual
->blueBits
;
357 xrb
->Base
.AlphaBits
= visual
->alphaBits
;
360 xrb
->Base
.InternalFormat
= GL_COLOR_INDEX
;
361 xrb
->Base
._BaseFormat
= GL_COLOR_INDEX
;
362 xrb
->Base
.DataType
= GL_UNSIGNED_INT
;
363 xrb
->Base
.IndexBits
= visual
->indexBits
;
365 /* only need to set Red/Green/EtcBits fields for user-created RBs */
372 * Called via gl_framebuffer::Delete() method when this buffer
373 * is _really_ being deleted.
376 xmesa_delete_framebuffer(struct gl_framebuffer
*fb
)
378 XMesaBuffer b
= XMESA_BUFFER(fb
);
380 if (b
->num_alloced
> 0) {
381 /* If no other buffer uses this X colormap then free the colors. */
382 if (!xmesa_find_buffer(b
->display
, b
->cmap
, b
)) {
385 if (b
->frontxrb
->drawable
)
386 client
= CLIENT_ID(b
->frontxrb
->drawable
->id
);
387 (void)FreeColors(b
->cmap
, client
,
388 b
->num_alloced
, b
->alloced_colors
, 0);
390 XFreeColors(b
->display
, b
->cmap
,
391 b
->alloced_colors
, b
->num_alloced
, 0);
397 XMesaFreeGC(b
->display
, b
->gc
);
399 XMesaFreeGC(b
->display
, b
->cleargc
);
401 XMesaFreeGC(b
->display
, b
->swapgc
);
403 if (fb
->Visual
.doubleBufferMode
) {
404 /* free back ximage/pixmap/shmregion */
405 if (b
->backxrb
->ximage
) {
406 #if defined(USE_XSHM) && !defined(XFree86Server)
408 XShmDetach( b
->display
, &b
->shminfo
);
409 XDestroyImage( b
->backxrb
->ximage
);
410 shmdt( b
->shminfo
.shmaddr
);
414 XMesaDestroyImage( b
->backxrb
->ximage
);
415 b
->backxrb
->ximage
= NULL
;
417 if (b
->backxrb
->pixmap
) {
418 XMesaFreePixmap( b
->display
, b
->backxrb
->pixmap
);
419 if (b
->xm_visual
->hpcr_clear_flag
) {
420 XMesaFreePixmap( b
->display
,
421 b
->xm_visual
->hpcr_clear_pixmap
);
422 XMesaDestroyImage( b
->xm_visual
->hpcr_clear_ximage
);
428 _mesa_free( b
->rowimage
->data
);
429 b
->rowimage
->data
= NULL
;
430 XMesaDestroyImage( b
->rowimage
);
433 _mesa_free_framebuffer_data(fb
);