e332fb5480c52f07b1e1822df056f3834cddffab
[mesa.git] / src / mesa / drivers / x11 / xmesaP.h
1 /*
2 * Mesa 3-D graphics library
3 * Version: 6.5
4 *
5 * Copyright (C) 1999-2006 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 #ifndef XMESAP_H
27 #define XMESAP_H
28
29
30 #ifdef XFree86Server
31 # include "xf86glx_util.h"
32 #elif defined(USE_XSHM)
33 # include <X11/extensions/XShm.h>
34 #endif
35 #include "GL/xmesa.h"
36 #include "mtypes.h"
37 #if defined(FX)
38 #include "GL/fxmesa.h"
39 #include "../glide/fxdrv.h"
40 #endif
41
42
43 extern _glthread_Mutex _xmesa_lock;
44
45
46 /* for PF_8R8G8B24 pixel format */
47 typedef struct {
48 GLubyte b;
49 GLubyte g;
50 GLubyte r;
51 } bgr_t;
52
53
54 struct xmesa_renderbuffer;
55
56
57 /* Function pointer for clearing color buffers */
58 typedef void (*ClearFunc)( GLcontext *ctx, struct xmesa_renderbuffer *xrb,
59 GLint x, GLint y, GLint width, GLint height );
60
61
62
63
64 /** Framebuffer pixel formats */
65 enum pixel_format {
66 PF_Index, /**< Color Index mode */
67 PF_Truecolor, /**< TrueColor or DirectColor, any depth */
68 PF_Dither_True, /**< TrueColor with dithering */
69 PF_8A8B8G8R, /**< 32-bit TrueColor: 8-A, 8-B, 8-G, 8-R */
70 PF_8R8G8B, /**< 32-bit TrueColor: 8-R, 8-G, 8-B bits */
71 PF_5R6G5B, /**< 16-bit TrueColor: 5-R, 6-G, 5-B bits */
72 PF_Dither, /**< Color-mapped RGB with dither */
73 PF_Lookup, /**< Color-mapped RGB without dither */
74 PF_HPCR, /**< HP Color Recovery (ad@lms.be 30/08/95) */
75 PF_1Bit, /**< monochrome dithering of RGB */
76 PF_Grayscale, /**< Grayscale or StaticGray */
77 PF_8R8G8B24, /**< 24-bit TrueColor: 8-R, 8-G, 8-B bits */
78 PF_Dither_5R6G5B, /**< 16-bit dithered TrueColor: 5-R, 6-G, 5-B */
79 PF_8A8R8G8B /**< 32-bit TrueColor: 8-A, 8-R, 8-G, 8-B */
80 };
81
82
83 /**
84 * Visual inforation, derived from GLvisual.
85 * Basically corresponds to an XVisualInfo.
86 */
87 struct xmesa_visual {
88 GLvisual mesa_visual; /* Device independent visual parameters */
89 XMesaDisplay *display; /* The X11 display */
90 #ifdef XFree86Server
91 GLint ColormapEntries;
92 GLint nplanes;
93 #else
94 XMesaVisualInfo visinfo; /* X's visual info (pointer to private copy) */
95 XVisualInfo *vishandle; /* Only used in fakeglx.c */
96 #endif
97 GLint BitsPerPixel; /* True bits per pixel for XImages */
98
99 GLboolean ximage_flag; /* Use XImage for back buffer (not pixmap)? */
100
101 enum pixel_format dithered_pf; /* Pixel format when dithering */
102 enum pixel_format undithered_pf;/* Pixel format when not dithering */
103
104 GLfloat RedGamma; /* Gamma values, 1.0 is default */
105 GLfloat GreenGamma;
106 GLfloat BlueGamma;
107
108 /* For PF_TRUECOLOR */
109 GLint rshift, gshift, bshift;/* Pixel color component shifts */
110 GLubyte Kernel[16]; /* Dither kernel */
111 unsigned long RtoPixel[512]; /* RGB to pixel conversion */
112 unsigned long GtoPixel[512];
113 unsigned long BtoPixel[512];
114 GLubyte PixelToR[256]; /* Pixel to RGB conversion */
115 GLubyte PixelToG[256];
116 GLubyte PixelToB[256];
117
118 /* For PF_HPCR */
119 short hpcr_rgbTbl[3][256];
120 GLboolean hpcr_clear_flag;
121 GLubyte hpcr_clear_ximage_pattern[2][16];
122 XMesaImage *hpcr_clear_ximage;
123 XMesaPixmap hpcr_clear_pixmap;
124
125 /* For PF_1BIT */
126 int bitFlip;
127 };
128
129
130 /**
131 * Context info, dDerived from GLcontext.
132 * Basically corresponds to a GLXContext.
133 */
134 struct xmesa_context {
135 GLcontext mesa; /* the core library context (containment) */
136 XMesaVisual xm_visual; /* Describes the buffers */
137 XMesaBuffer xm_buffer; /* current span/point/line/triangle buffer */
138
139 XMesaDisplay *display; /* == xm_visual->display */
140 GLboolean swapbytes; /* Host byte order != display byte order? */
141 GLboolean direct; /* Direct rendering context? */
142
143 enum pixel_format pixelformat;
144
145 GLubyte clearcolor[4]; /* current clearing color */
146 unsigned long clearpixel; /* current clearing pixel value */
147 };
148
149
150 /**
151 * Types of X/GLX drawables we might render into.
152 */
153 typedef enum {
154 WINDOW, /* An X window */
155 GLXWINDOW, /* GLX window */
156 PIXMAP, /* GLX pixmap */
157 PBUFFER /* GLX Pbuffer */
158 } BufferType;
159
160
161 /** Values for db_mode: */
162 /*@{*/
163 #define BACK_PIXMAP 1
164 #define BACK_XIMAGE 2
165 /*@}*/
166
167
168 /**
169 * An xmesa_renderbuffer represents the back or front color buffer.
170 * For the front color buffer:
171 * <drawable> is the X window
172 * For the back color buffer:
173 * Either <ximage> or <pixmap> will be used, never both.
174 * In any case, <drawable> always equals <pixmap>.
175 * For stand-alone Mesa, we could merge <drawable> and <pixmap> into one
176 * field. We don't do that for the server-side GLcore module because
177 * pixmaps and drawables are different and we'd need a bunch of casts.
178 */
179 struct xmesa_renderbuffer
180 {
181 struct gl_renderbuffer Base; /* Base class */
182
183 XMesaBuffer Parent; /**< The XMesaBuffer this renderbuffer belongs to */
184 XMesaDrawable drawable; /* Usually the X window ID */
185 XMesaPixmap pixmap; /* Back color buffer */
186 XMesaImage *ximage; /* The back buffer, if not using a Pixmap */
187
188 GLubyte *origin1; /* used for PIXEL_ADDR1 macro */
189 GLint width1;
190 GLushort *origin2; /* used for PIXEL_ADDR2 macro */
191 GLint width2;
192 GLubyte *origin3; /* used for PIXEL_ADDR3 macro */
193 GLint width3;
194 GLuint *origin4; /* used for PIXEL_ADDR4 macro */
195 GLint width4;
196
197 GLint bottom; /* used for FLIP macro, equals height - 1 */
198
199 ClearFunc clearFunc;
200 };
201
202
203 /**
204 * Framebuffer information, derived from.
205 * Basically corresponds to a GLXDrawable.
206 */
207 struct xmesa_buffer {
208 GLframebuffer mesa_buffer; /* depth, stencil, accum, etc buffers */
209 /* This MUST BE FIRST! */
210 GLboolean wasCurrent; /* was ever the current buffer? */
211 XMesaVisual xm_visual; /* the X/Mesa visual */
212
213 XMesaDisplay *display;
214 BufferType type; /* window, pixmap, pbuffer or glxwindow */
215
216 struct xmesa_renderbuffer *frontxrb; /* front color renderbuffer */
217 struct xmesa_renderbuffer *backxrb; /* back color renderbuffer */
218
219 XMesaColormap cmap; /* the X colormap */
220
221 unsigned long selectedEvents;/* for pbuffers only */
222
223 GLint db_mode; /* 0 = single buffered */
224 /* BACK_PIXMAP = use Pixmap for back buffer */
225 /* BACK_XIMAGE = use XImage for back buffer */
226
227 GLuint shm; /* X Shared Memory extension status: */
228 /* 0 = not available */
229 /* 1 = XImage support available */
230 /* 2 = Pixmap support available too */
231 #if defined(USE_XSHM) && !defined(XFree86Server)
232 XShmSegmentInfo shminfo;
233 #endif
234
235 XMesaImage *rowimage; /* Used for optimized span writing */
236 XMesaPixmap stipple_pixmap; /* For polygon stippling */
237 XMesaGC stipple_gc; /* For polygon stippling */
238
239 XMesaGC gc; /* scratch GC for span, line, tri drawing */
240 XMesaGC cleargc; /* GC for clearing the color buffer */
241 XMesaGC swapgc; /* GC for swapping the color buffers */
242
243 /* The following are here instead of in the XMesaVisual
244 * because they depend on the window's colormap.
245 */
246
247 /* For PF_DITHER, PF_LOOKUP, PF_GRAYSCALE */
248 unsigned long color_table[576]; /* RGB -> pixel value */
249
250 /* For PF_DITHER, PF_LOOKUP, PF_GRAYSCALE */
251 GLubyte pixel_to_r[65536]; /* pixel value -> red */
252 GLubyte pixel_to_g[65536]; /* pixel value -> green */
253 GLubyte pixel_to_b[65536]; /* pixel value -> blue */
254
255 /* Used to do XAllocColor/XFreeColors accounting: */
256 int num_alloced;
257 #if defined(XFree86Server)
258 Pixel alloced_colors[256];
259 #else
260 unsigned long alloced_colors[256];
261 #endif
262
263 #if defined( FX )
264 /* For 3Dfx Glide only */
265 GLboolean FXisHackUsable; /* Can we render into window? */
266 GLboolean FXwindowHack; /* Are we rendering into a window? */
267 fxMesaContext FXctx;
268 #endif
269
270 struct xmesa_buffer *Next; /* Linked list pointer: */
271 };
272
273
274 /**
275 * If pixelformat==PF_TRUECOLOR:
276 */
277 #define PACK_TRUECOLOR( PIXEL, R, G, B ) \
278 PIXEL = xmesa->xm_visual->RtoPixel[R] \
279 | xmesa->xm_visual->GtoPixel[G] \
280 | xmesa->xm_visual->BtoPixel[B]; \
281
282
283 /**
284 * If pixelformat==PF_TRUEDITHER:
285 */
286 #define PACK_TRUEDITHER( PIXEL, X, Y, R, G, B ) \
287 { \
288 int d = xmesa->xm_visual->Kernel[((X)&3) | (((Y)&3)<<2)]; \
289 PIXEL = xmesa->xm_visual->RtoPixel[(R)+d] \
290 | xmesa->xm_visual->GtoPixel[(G)+d] \
291 | xmesa->xm_visual->BtoPixel[(B)+d]; \
292 }
293
294
295
296 /**
297 * If pixelformat==PF_8A8B8G8R:
298 */
299 #define PACK_8A8B8G8R( R, G, B, A ) \
300 ( ((A) << 24) | ((B) << 16) | ((G) << 8) | (R) )
301
302
303 /**
304 * Like PACK_8A8B8G8R() but don't use alpha. This is usually an acceptable
305 * shortcut.
306 */
307 #define PACK_8B8G8R( R, G, B ) ( ((B) << 16) | ((G) << 8) | (R) )
308
309
310
311 /**
312 * If pixelformat==PF_8R8G8B:
313 */
314 #define PACK_8R8G8B( R, G, B) ( ((R) << 16) | ((G) << 8) | (B) )
315
316
317 /**
318 * If pixelformat==PF_5R6G5B:
319 */
320 #define PACK_5R6G5B( R, G, B) ( (((R) & 0xf8) << 8) | (((G) & 0xfc) << 3) | ((B) >> 3) )
321
322
323 /**
324 * If pixelformat==PF_8A8R8G8B:
325 */
326 #define PACK_8A8R8G8B( R, G, B, A ) \
327 ( ((A) << 24) | ((R) << 16) | ((G) << 8) | (B) )
328
329
330
331 /**
332 * If pixelformat==PF_DITHER:
333 *
334 * Improved 8-bit RGB dithering code contributed by Bob Mercier
335 * (mercier@hollywood.cinenet.net). Thanks Bob!
336 */
337 #ifdef DITHER666
338 # define DITH_R 6
339 # define DITH_G 6
340 # define DITH_B 6
341 # define DITH_MIX(r,g,b) (((r) * DITH_G + (g)) * DITH_B + (b))
342 #else
343 # define DITH_R 5
344 # define DITH_G 9
345 # define DITH_B 5
346 # define DITH_MIX(r,g,b) (((g) << 6) | ((b) << 3) | (r))
347 #endif
348 #define DITH_DX 4
349 #define DITH_DY 4
350 #define DITH_N (DITH_DX * DITH_DY)
351
352 #define _dither(C, c, d) (((unsigned)((DITH_N * (C - 1) + 1) * c + d)) >> 12)
353
354 #define MAXC 256
355 extern const int xmesa_kernel8[DITH_DY * DITH_DX];
356
357 /* Dither for random X,Y */
358 #define DITHER_SETUP \
359 int __d; \
360 unsigned long *ctable = XMESA_BUFFER(ctx->DrawBuffer)->color_table;
361
362 #define DITHER( X, Y, R, G, B ) \
363 (__d = xmesa_kernel8[(((Y)&3)<<2) | ((X)&3)], \
364 ctable[DITH_MIX(_dither(DITH_R, (R), __d), \
365 _dither(DITH_G, (G), __d), \
366 _dither(DITH_B, (B), __d))])
367
368 /* Dither for random X, fixed Y */
369 #define XDITHER_SETUP(Y) \
370 int __d; \
371 unsigned long *ctable = XMESA_BUFFER(ctx->DrawBuffer)->color_table; \
372 const int *kernel = &xmesa_kernel8[ ((Y)&3) << 2 ];
373
374 #define XDITHER( X, R, G, B ) \
375 (__d = kernel[(X)&3], \
376 ctable[DITH_MIX(_dither(DITH_R, (R), __d), \
377 _dither(DITH_G, (G), __d), \
378 _dither(DITH_B, (B), __d))])
379
380
381
382 /*
383 * Dithering for flat-shaded triangles. Precompute all 16 possible
384 * pixel values given the triangle's RGB color. Contributed by Martin Shenk.
385 */
386 #define FLAT_DITHER_SETUP( R, G, B ) \
387 GLushort ditherValues[16]; \
388 { \
389 unsigned long *ctable = XMESA_BUFFER(ctx->DrawBuffer)->color_table; \
390 int msdr = (DITH_N*((DITH_R)-1)+1) * (R); \
391 int msdg = (DITH_N*((DITH_G)-1)+1) * (G); \
392 int msdb = (DITH_N*((DITH_B)-1)+1) * (B); \
393 int i; \
394 for (i=0;i<16;i++) { \
395 int k = xmesa_kernel8[i]; \
396 int j = DITH_MIX( (msdr+k)>>12, (msdg+k)>>12, (msdb+k)>>12 );\
397 ditherValues[i] = (GLushort) ctable[j]; \
398 } \
399 }
400
401 #define FLAT_DITHER_ROW_SETUP(Y) \
402 GLushort *ditherRow = ditherValues + ( ((Y)&3) << 2);
403
404 #define FLAT_DITHER(X) ditherRow[(X)&3]
405
406
407
408 /**
409 * If pixelformat==PF_LOOKUP:
410 */
411 #define _dither_lookup(C, c) (((unsigned)((DITH_N * (C - 1) + 1) * c)) >> 12)
412
413 #define LOOKUP_SETUP \
414 unsigned long *ctable = XMESA_BUFFER(ctx->DrawBuffer)->color_table
415
416 #define LOOKUP( R, G, B ) \
417 ctable[DITH_MIX(_dither_lookup(DITH_R, (R)), \
418 _dither_lookup(DITH_G, (G)), \
419 _dither_lookup(DITH_B, (B)))]
420
421
422 /**
423 * If pixelformat==PF_HPCR:
424 *
425 * HP Color Recovery dithering (ad@lms.be 30/08/95)
426 * HP has on it's 8-bit 700-series computers, a feature called
427 * 'Color Recovery'. This allows near 24-bit output (so they say).
428 * It is enabled by selecting the 8-bit TrueColor visual AND
429 * corresponding colormap (see tkInitWindow) AND doing some special
430 * dither.
431 */
432 extern const short xmesa_HPCR_DRGB[3][2][16];
433
434 #define DITHER_HPCR( X, Y, R, G, B ) \
435 ( ((xmesa->xm_visual->hpcr_rgbTbl[0][R] + xmesa_HPCR_DRGB[0][(Y)&1][(X)&15]) & 0xE0) \
436 |(((xmesa->xm_visual->hpcr_rgbTbl[1][G] + xmesa_HPCR_DRGB[1][(Y)&1][(X)&15]) & 0xE0)>>3) \
437 | ((xmesa->xm_visual->hpcr_rgbTbl[2][B] + xmesa_HPCR_DRGB[2][(Y)&1][(X)&15])>>6) \
438 )
439
440
441
442 /**
443 * If pixelformat==PF_1BIT:
444 */
445 extern const int xmesa_kernel1[16];
446
447 #define SETUP_1BIT int bitFlip = xmesa->xm_visual->bitFlip
448 #define DITHER_1BIT( X, Y, R, G, B ) \
449 (( ((int)(R)+(int)(G)+(int)(B)) > xmesa_kernel1[(((Y)&3) << 2) | ((X)&3)] ) ^ bitFlip)
450
451
452
453 /**
454 * If pixelformat==PF_GRAYSCALE:
455 */
456 #define GRAY_RGB( R, G, B ) XMESA_BUFFER(ctx->DrawBuffer)->color_table[((R) + (G) + (B))/3]
457
458
459
460 /**
461 * Converts a GL window Y coord to an X window Y coord:
462 */
463 #define YFLIP(XRB, Y) ((XRB)->bottom - (Y))
464
465
466 /**
467 * Return the address of a 1, 2 or 4-byte pixel in the buffer's XImage:
468 * X==0 is left, Y==0 is bottom.
469 */
470 #define PIXEL_ADDR1(XRB, X, Y) \
471 ( (XRB)->origin1 - (Y) * (XRB)->width1 + (X) )
472
473 #define PIXEL_ADDR2(XRB, X, Y) \
474 ( (XRB)->origin2 - (Y) * (XRB)->width2 + (X) )
475
476 #define PIXEL_ADDR3(XRB, X, Y) \
477 ( (bgr_t *) ( (XRB)->origin3 - (Y) * (XRB)->width3 + 3 * (X) ))
478
479 #define PIXEL_ADDR4(XRB, X, Y) \
480 ( (XRB)->origin4 - (Y) * (XRB)->width4 + (X) )
481
482
483
484 /*
485 * External functions:
486 */
487
488 extern struct xmesa_renderbuffer *
489 xmesa_new_renderbuffer(GLcontext *ctx, GLuint name, const GLvisual *visual,
490 GLboolean backBuffer);
491
492 extern unsigned long
493 xmesa_color_to_pixel( GLcontext *ctx,
494 GLubyte r, GLubyte g, GLubyte b, GLubyte a,
495 GLuint pixelFormat );
496
497 extern void
498 xmesa_get_window_size(XMesaDisplay *dpy, XMesaBuffer b,
499 GLuint *width, GLuint *height);
500
501 extern void
502 xmesa_check_and_update_buffer_size(XMesaContext xmctx, XMesaBuffer drawBuffer);
503
504 extern void
505 xmesa_init_driver_functions( XMesaVisual xmvisual,
506 struct dd_function_table *driver );
507
508 extern void
509 xmesa_update_state( GLcontext *ctx, GLbitfield new_state );
510
511 extern void
512 xmesa_set_renderbuffer_funcs(struct xmesa_renderbuffer *xrb,
513 enum pixel_format pixelformat, GLint depth);
514
515 extern void
516 xmesa_destroy_buffers_on_display(XMesaDisplay *dpy);
517
518
519 /**
520 * Using a function instead of an ordinary cast is safer.
521 */
522 static INLINE struct xmesa_renderbuffer *
523 xmesa_renderbuffer(struct gl_renderbuffer *rb)
524 {
525 return (struct xmesa_renderbuffer *) rb;
526 }
527
528
529 /**
530 * Return pointer to XMesaContext corresponding to a Mesa GLcontext.
531 * Since we're using structure containment, it's just a cast!.
532 * XXX should use inlined function for better type safety.
533 */
534 static INLINE XMesaContext
535 XMESA_CONTEXT(GLcontext *ctx)
536 {
537 return (XMesaContext) ctx;
538 }
539
540
541 /**
542 * Return pointer to XMesaBuffer corresponding to a Mesa GLframebuffer.
543 * Since we're using structure containment, it's just a cast!.
544 * XXX should use inlined function for better type safety.
545 */
546 static INLINE XMesaBuffer
547 XMESA_BUFFER(GLframebuffer *b)
548 {
549 return (XMesaBuffer) b;
550 }
551
552
553 /* Plugged into the software rasterizer. Try to use internal
554 * swrast-style point, line and triangle functions.
555 */
556 extern void xmesa_choose_point( GLcontext *ctx );
557 extern void xmesa_choose_line( GLcontext *ctx );
558 extern void xmesa_choose_triangle( GLcontext *ctx );
559
560
561 extern void xmesa_register_swrast_functions( GLcontext *ctx );
562
563
564
565 /* XXX this is a hack to implement shared display lists with 3Dfx */
566 extern XMesaBuffer XMesaCreateWindowBuffer2( XMesaVisual v,
567 XMesaWindow w,
568 XMesaContext c );
569
570 /*
571 * These are the extra routines required for integration with XFree86.
572 * None of these routines should be user visible. -KEM
573 */
574 extern void XMesaSetVisualDisplay( XMesaDisplay *dpy, XMesaVisual v );
575 extern GLboolean XMesaForceCurrent(XMesaContext c);
576 extern GLboolean XMesaLoseCurrent(XMesaContext c);
577 extern void XMesaReset( void );
578
579
580 #define ENABLE_EXT_texure_compression_s3tc 0 /* SW texture compression */
581
582 #ifdef XFree86Server
583 #define ENABLE_EXT_timer_query 0
584 #elif defined(__STDC_VERSION__) && __STDC_VERSION__ >= 199901L
585 #define ENABLE_EXT_timer_query 1 /* should have 64-bit GLuint64EXT */
586 #else
587 #define ENABLE_EXT_timer_query 0 /* may not have 64-bit GLuint64EXT */
588 #endif
589
590 #endif