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