src/mesa/drivers/x11/xmesaP.h

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