src/mesa/drivers/x11/xmesaP.h

   1 /* $Id: xmesaP.h,v 1.10 2000/05/19 13:08:01 brianp Exp $ */
   2
   3 /*
   4  * Mesa 3-D graphics library
   5  * Version:  3.3
   6  *
   7  * Copyright (C) 1999-2000  Brian Paul   All Rights Reserved.
   8  *
   9  * Permission is hereby granted, free of charge, to any person obtaining a
  10  * copy of this software and associated documentation files (the "Software"),
  11  * to deal in the Software without restriction, including without limitation
  12  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  13  * and/or sell copies of the Software, and to permit persons to whom the
  14  * Software is furnished to do so, subject to the following conditions:
  15  *
  16  * The above copyright notice and this permission notice shall be included
  17  * in all copies or substantial portions of the Software.
  18  *
  19  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  20  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  21  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  22  * BRIAN PAUL BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
  23  * AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  24  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  25  */
  26
  27
  28 #ifndef XMESAP_H
  29 #define XMESAP_H
  30
  31
  32 #ifdef XFree86Server
  33 # include "GL/xf86glx.h"
  34 # include "xf86glx_util.h"
  35 #else
  36 # ifdef GLX_DIRECT_RENDERING
  37 #  include "dri_mesa.h"
  38 # endif
  39 # ifdef USE_XSHM
  40 #  include <X11/extensions/XShm.h>
  41 # endif
  42 #endif
  43 #include "GL/xmesa.h"
  44 #include "types.h"
  45 #if defined(FX) && !defined(GLX_DIRECT_RENDERING)
  46 #include "GL/fxmesa.h"
  47 #include "../FX/fxdrv.h"
  48 #endif
  49
  50
  51 #if defined(GLX_DIRECT_RENDERING) && !defined(XFree86Server)
  52 #  include "xdriP.h"
  53 #else
  54 #  define DRI_DRAWABLE_ARG
  55 #  define DRI_DRAWABLE_PARM
  56 #  define DRI_CTX_ARG
  57 #endif
  58
  59
  60 /* for PF_8R8G8B24 pixel format */
  61 typedef struct {
  62    GLubyte b;
  63    GLubyte g;
  64    GLubyte r;
  65 } bgr_t;
  66
  67
  68 /* Function pointer for clearing color buffers */
  69 typedef void (*clear_func)( GLcontext *ctx,
  70                             GLboolean all, GLint x, GLint y,
  71                             GLint width, GLint height );
  72
  73
  74 /*
  75  * "Derived" from gl_visual.  Basically corresponds to an XVisualInfo.
  76  */
  77 struct xmesa_visual {
  78    GLvisual *gl_visual;         /* Device independent visual parameters */
  79    XMesaDisplay *display;       /* The X11 display */
  80 #ifdef XFree86Server
  81    GLint screen_depth;          /* The depth of the screen */
  82 #else
  83    XVisualInfo *vishandle;      /* The pointer returned by glXChooseVisual */
  84 #endif
  85    XMesaVisualInfo visinfo;     /* X's visual info */
  86    GLint BitsPerPixel;          /* True bits per pixel for XImages */
  87
  88    GLint level;                 /* 0=normal, 1=overlay, etc */
  89    GLint VisualCaveat;          /* for GLX_EXT_visual_rating extension */
  90
  91    GLboolean ximage_flag;       /* Use XImage for back buffer (not pixmap)? */
  92
  93    GLuint dithered_pf;          /* Pixel format when dithering */
  94    GLuint undithered_pf;        /* Pixel format when not dithering */
  95
  96    GLfloat RedGamma;            /* Gamma values, 1.0 is default */
  97    GLfloat GreenGamma;
  98    GLfloat BlueGamma;
  99
 100    GLint rmult, gmult, bmult;   /* Range of color values */
 101    GLint index_bits;            /* Bits per pixel in CI mode */
 102
 103    /* For PF_TRUECOLOR */
 104    GLint rshift, gshift, bshift;/* Pixel color component shifts */
 105    GLubyte Kernel[16];          /* Dither kernel */
 106    unsigned long RtoPixel[512]; /* RGB to pixel conversion */
 107    unsigned long GtoPixel[512];
 108    unsigned long BtoPixel[512];
 109    GLubyte PixelToR[256];       /* Pixel to RGB conversion */
 110    GLubyte PixelToG[256];
 111    GLubyte PixelToB[256];
 112
 113    /* For PF_HPCR */
 114    short       hpcr_rgbTbl[3][256];
 115    GLboolean   hpcr_clear_flag;
 116    GLubyte     hpcr_clear_ximage_pattern[2][16];
 117    XMesaImage *hpcr_clear_ximage;
 118    XMesaPixmap hpcr_clear_pixmap;
 119
 120    /* For PF_1BIT */
 121    int bitFlip;
 122 };
 123
 124
 125
 126 /*
 127  * "Derived" from gl_context.  Basically corresponds to a GLXContext.
 128  */
 129 struct xmesa_context {
 130    GLcontext *gl_ctx;           /* the core library context */
 131    XMesaVisual xm_visual;       /* Describes the buffers */
 132    XMesaBuffer xm_buffer;       /* current draw framebuffer */
 133    XMesaBuffer xm_read_buffer;  /* current read framebuffer */
 134    GLboolean use_read_buffer;   /* read from the xm_read_buffer/ */
 135
 136    XMesaDisplay *display;       /* == xm_visual->display */
 137    GLboolean swapbytes;         /* Host byte order != display byte order? */
 138    GLboolean direct;            /* Direct rendering context? */
 139
 140    GLuint pixelformat;          /* Current pixel format */
 141
 142    GLubyte red, green, blue, alpha;     /* current drawing color */
 143    unsigned long pixel;                 /* current drawing pixel value */
 144
 145    GLubyte clearcolor[4];               /* current clearing color */
 146    unsigned long clearpixel;            /* current clearing pixel value */
 147
 148 #if defined(GLX_DIRECT_RENDERING) && !defined(XFree86Server)
 149   __DRIcontextPrivate *driContextPriv; /* back pointer to DRI context
 150                                         * used for locking
 151                                         */
 152   void *private;                        /* device-specific private context */
 153 #endif
 154 };
 155
 156
 157
 158 /*
 159  * "Derived" from gl_buffer.  Basically corresponds to a GLXDrawable.
 160  */
 161 struct xmesa_buffer {
 162    GLboolean wasCurrent;        /* was ever the current buffer? */
 163    GLframebuffer *gl_buffer;    /* depth, stencil, accum, etc buffers */
 164    XMesaVisual xm_visual;       /* the X/Mesa visual */
 165
 166    XMesaContext xm_context;     /* the context associated with this buffer */
 167    XMesaDisplay *display;
 168    GLboolean pixmap_flag;       /* is the buffer a Pixmap? */
 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    GLint db_state;              /* 0 = single buffered */
 179                                 /* BACK_PIXMAP = use Pixmap for back buffer */
 180                                 /* BACK_XIMAGE = use XImage for back buffer */
 181
 182 #ifndef XFree86Server
 183    GLuint shm;                  /* X Shared Memory extension status:    */
 184                                 /*    0 = not available                 */
 185                                 /*    1 = XImage support available      */
 186                                 /*    2 = Pixmap support available too  */
 187 #ifdef USE_XSHM
 188    XShmSegmentInfo shminfo;
 189 #endif
 190 #endif
 191
 192    XMesaImage *rowimage;        /* Used for optimized span writing */
 193
 194    GLuint width, height;        /* size of buffer */
 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 gc1;                 /* GC for infrequent color changes */
 210    XMesaGC gc2;                 /* GC for frequent color changes */
 211    XMesaGC cleargc;             /* GC for clearing the color buffer */
 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    unsigned long alloced_colors[256];
 228
 229 #if defined(GLX_DIRECT_RENDERING) && !defined(XFree86Server)
 230   __DRIdrawablePrivate *driDrawPriv;    /* back pointer to DRI drawable
 231                                          * used for direct access to framebuffer
 232                                          */
 233   void *private;                        /* device-specific private drawable */
 234 #endif
 235
 236 #if defined( FX ) && !defined(GLX_DIRECT_RENDERING)
 237    /* For 3Dfx Glide only */
 238    GLboolean FXisHackUsable;    /* Can we render into window? */
 239    GLboolean FXwindowHack;      /* Are we rendering into a window? */
 240    fxMesaContext FXctx;
 241 #endif
 242
 243    /* functions for clearing the front and back color buffers */
 244    clear_func front_clear_func;
 245    clear_func back_clear_func;
 246
 247    struct xmesa_buffer *Next;   /* Linked list pointer: */
 248 };
 249
 250
 251
 252 /* Values for xmesa->dest: */
 253 #define FRONT_PIXMAP    1
 254 #define BACK_PIXMAP     2
 255 #define BACK_XIMAGE     4
 256
 257
 258 /* Values for xmesa->pixelformat: */
 259 #define PF_INDEX          1     /* Color Index mode */
 260 #define PF_TRUECOLOR      2     /* TrueColor or DirectColor, any depth */
 261 #define PF_TRUEDITHER     3     /* TrueColor with dithering */
 262 #define PF_8A8B8G8R       4     /* 32-bit TrueColor:  8-A, 8-B, 8-G, 8-R */
 263 #define PF_8R8G8B         5     /* 32-bit TrueColor:  8-R, 8-G, 8-B bits */
 264 #define PF_5R6G5B         6     /* 16-bit TrueColor:  5-R, 6-G, 5-B bits */
 265 #define PF_DITHER         7     /* Color-mapped RGB with dither */
 266 #define PF_LOOKUP         8     /* Color-mapped RGB without dither */
 267 #define PF_HPCR           9     /* HP Color Recovery (ad@lms.be 30/08/95) */
 268 #define PF_1BIT          10     /* monochrome dithering of RGB */
 269 #define PF_GRAYSCALE     11     /* Grayscale or StaticGray */
 270 #define PF_8R8G8B24      12     /* 24-bit TrueColor: 8-R, 8-G, 8-B bits */
 271 #define PF_DITHER_5R6G5B 13     /* 16-bit dithered TrueColor: 5-R, 6-G, 5-B */
 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
 325 /*
 326  * If pixelformat==PF_DITHER:
 327  *
 328  * Improved 8-bit RGB dithering code contributed by Bob Mercier
 329  * (mercier@hollywood.cinenet.net).  Thanks Bob!
 330  */
 331 #undef _R
 332 #undef _G
 333 #undef _B
 334 #undef _D
 335 #ifdef DITHER666
 336 # define _R   6
 337 # define _G   6
 338 # define _B   6
 339 # define _MIX(r,g,b)  (((r)*_G+(g))*_B+(b))
 340 #else
 341 # define _R     5
 342 # define _G     9
 343 # define _B     5
 344 # define _MIX(r,g,b)    ( ((g)<<6) | ((b)<<3) | (r) )
 345 #endif
 346 #define _DX     4
 347 #define _DY     4
 348 #define _D      (_DX*_DY)
 349
 350 /*#define _DITH(C,c,d)  (((unsigned)((_D*(C-1)+1)*c+d))/(_D*256))*/
 351 #define _DITH(C,c,d)    (((unsigned)((_D*(C-1)+1)*c+d)) >> 12)
 352
 353 #define MAXC    256
 354 static int kernel8[_DY*_DX] = {
 355     0 * MAXC,  8 * MAXC,  2 * MAXC, 10 * MAXC,
 356    12 * MAXC,  4 * MAXC, 14 * MAXC,  6 * MAXC,
 357     3 * MAXC, 11 * MAXC,  1 * MAXC,  9 * MAXC,
 358    15 * MAXC,  7 * MAXC, 13 * MAXC,  5 * MAXC,
 359 };
 360 /*static int __d;*/
 361
 362 /* Dither for random X,Y */
 363 #define DITHER_SETUP                                            \
 364         int __d;                                                \
 365         unsigned long *ctable = xmesa->xm_buffer->color_table;
 366
 367 #define DITHER( X, Y, R, G, B )                         \
 368         (__d = kernel8[(((Y)&3)<<2) | ((X)&3)],         \
 369          ctable[_MIX(_DITH(_R, (R), __d),               \
 370                      _DITH(_G, (G), __d),               \
 371                      _DITH(_B, (B), __d))])
 372
 373 /* Dither for random X, fixed Y */
 374 #define XDITHER_SETUP(Y)                                        \
 375         int __d;                                                \
 376         unsigned long *ctable = xmesa->xm_buffer->color_table;  \
 377         int *kernel = &kernel8[ ((Y)&3) << 2 ];
 378
 379 #define XDITHER( X, R, G, B )                           \
 380         (__d = kernel[(X)&3],                           \
 381         ctable[_MIX(_DITH(_R, (R), __d),                \
 382                     _DITH(_G, (G), __d),                \
 383                     _DITH(_B, (B), __d))])
 384
 385
 386
 387 /*
 388  * Dithering for flat-shaded triangles.  Precompute all 16 possible
 389  * pixel values given the triangle's RGB color.  Contributed by Martin Shenk.
 390  */
 391 static GLushort DitherValues[16];   /* array of (up to) 16-bit pixel values */
 392
 393 #define FLAT_DITHER_SETUP( R, G, B )                                    \
 394         {                                                               \
 395            unsigned long *ctable = xmesa->xm_buffer->color_table;       \
 396            int msdr = (_D*((_R)-1)+1) * (R);                            \
 397            int msdg = (_D*((_G)-1)+1) * (G);                            \
 398            int msdb = (_D*((_B)-1)+1) * (B);                            \
 399            int i;                                                       \
 400            for (i=0;i<16;i++) {                                         \
 401               int k = kernel8[i];                                       \
 402               int j = _MIX( (msdr+k)>>12, (msdg+k)>>12, (msdb+k)>>12 ); \
 403               DitherValues[i] = (GLushort) ctable[j];                   \
 404            }                                                            \
 405         }
 406
 407 #define FLAT_DITHER_ROW_SETUP(Y)                                        \
 408         GLushort *ditherRow = DitherValues + ( ((Y)&3) << 2);
 409
 410 #define FLAT_DITHER(X)  ditherRow[(X)&3]
 411
 412
 413
 414 /*
 415  * If pixelformat==PF_LOOKUP:
 416  */
 417 #define _DITH0(C,c)     (((unsigned)((_D*(C-1)+1)*c)) >> 12)
 418
 419 #define LOOKUP_SETUP                                            \
 420         unsigned long *ctable = xmesa->xm_buffer->color_table
 421
 422 #define LOOKUP( R, G, B )                       \
 423         ctable[_MIX(_DITH0(_R, (R)),            \
 424                     _DITH0(_G, (G)),            \
 425                     _DITH0(_B, (B)))]
 426
 427
 428
 429 /*
 430  * If pixelformat==PF_HPCR:
 431  *
 432  *      HP Color Recovery dithering               (ad@lms.be 30/08/95)
 433  *      HP has on it's 8-bit 700-series computers, a feature called
 434  *      'Color Recovery'.  This allows near 24-bit output (so they say).
 435  *      It is enabled by selecting the 8-bit  TrueColor  visual AND
 436  *      corresponding  colormap (see tkInitWindow) AND doing some special
 437  *      dither.
 438  */
 439 static const short HPCR_DRGB[3][2][16] = {
 440 {
 441     { 16, -4,  1,-11, 14, -6,  3, -9, 15, -5,  2,-10, 13, -7,  4, -8},
 442     {-15,  5,  0, 12,-13,  7, -2, 10,-14,  6, -1, 11,-12,  8, -3,  9}
 443 },
 444 {
 445     {-11, 15, -7,  3, -8, 14, -4,  2,-10, 16, -6,  4, -9, 13, -5,  1},
 446     { 12,-14,  8, -2,  9,-13,  5, -1, 11,-15,  7, -3, 10,-12,  6,  0}
 447 },
 448 {
 449     {  6,-18, 26,-14,  2,-22, 30,-10,  8,-16, 28,-12,  4,-20, 32, -8},
 450     { -4, 20,-24, 16,  0, 24,-28, 12, -6, 18,-26, 14, -2, 22,-30, 10}
 451 }
 452 };
 453
 454 #define DITHER_HPCR( X, Y, R, G, B )                                       \
 455   ( ((xmesa->xm_visual->hpcr_rgbTbl[0][R] + HPCR_DRGB[0][(Y)&1][(X)&15]) & 0xE0)     \
 456   |(((xmesa->xm_visual->hpcr_rgbTbl[1][G] + HPCR_DRGB[1][(Y)&1][(X)&15]) & 0xE0)>>3) \
 457   | ((xmesa->xm_visual->hpcr_rgbTbl[2][B] + HPCR_DRGB[2][(Y)&1][(X)&15])>>6)       \
 458   )
 459
 460
 461
 462 /*
 463  * If pixelformat==PF_1BIT:
 464  */
 465 static int const kernel1[16] = {
 466    0*47,  9*47,  4*47, 12*47,     /* 47 = (255*3)/16 */
 467    6*47,  2*47, 14*47,  8*47,
 468   10*47,  1*47,  5*47, 11*47,
 469    7*47, 13*47,  3*47, 15*47 };
 470
 471 #define SETUP_1BIT  int bitFlip = xmesa->xm_visual->bitFlip
 472 #define DITHER_1BIT( X, Y, R, G, B )    \
 473         (( ((int)(R)+(int)(G)+(int)(B)) > kernel1[(((Y)&3) << 2) | ((X)&3)] ) ^ bitFlip)
 474
 475
 476
 477 /*
 478  * If pixelformat==PF_GRAYSCALE:
 479  */
 480 #define GRAY_RGB( R, G, B )   xmesa->xm_buffer->color_table[((R) + (G) + (B))/3]
 481
 482
 483
 484 #define XIMAGE None
 485
 486
 487 /*
 488  * Converts a GL window Y coord to an X window Y coord:
 489  */
 490 #define FLIP(BUFFER, Y)  ((BUFFER)->bottom-(Y))
 491
 492
 493 /*
 494  * Return the address of a 1, 2 or 4-byte pixel in the back XImage:
 495  * X==0 is left, Y==0 is bottom.
 496  */
 497 #define PIXELADDR1( BUFFER, X, Y )  \
 498    ( (BUFFER)->ximage_origin1 - (Y) * (BUFFER)->ximage_width1 + (X) )
 499
 500 #define PIXELADDR2( BUFFER, X, Y )  \
 501    ( (BUFFER)->ximage_origin2 - (Y) * (BUFFER)->ximage_width2 + (X) )
 502
 503 #define PIXELADDR3( BUFFER, X, Y )  \
 504    ( (bgr_t *) ( (BUFFER)->ximage_origin3 - (Y) * (BUFFER)->ximage_width3 + 3 * (X) ))
 505
 506 #define PIXELADDR4( BUFFER, X, Y )  \
 507    ( (BUFFER)->ximage_origin4 - (Y) * (BUFFER)->ximage_width4 + (X) )
 508
 509
 510
 511 /*
 512  * External functions:
 513  */
 514
 515 extern unsigned long
 516 xmesa_color_to_pixel( XMesaContext xmesa, GLubyte r, GLubyte g, GLubyte b, GLubyte a,
 517                       GLuint pixelFormat );
 518
 519 extern void xmesa_alloc_back_buffer( XMesaBuffer b );
 520
 521 extern void xmesa_update_state( GLcontext *ctx );
 522
 523 extern points_func xmesa_get_points_func( GLcontext *ctx );
 524
 525 extern line_func xmesa_get_line_func( GLcontext *ctx );
 526
 527 extern triangle_func xmesa_get_triangle_func( GLcontext *ctx );
 528
 529
 530 /* XXX this is a hack to implement shared display lists with 3Dfx */
 531 extern XMesaBuffer XMesaCreateWindowBuffer2( XMesaVisual v,
 532                                              XMesaWindow w,
 533                                              XMesaContext c
 534                                              DRI_DRAWABLE_ARG
 535                                            );
 536
 537 /*
 538  * These are the extra routines required for integration with XFree86.
 539  * None of these routines should be user visible. -KEM
 540  */
 541 extern void XMesaSetVisualDisplay( XMesaDisplay *dpy, XMesaVisual v );
 542 extern GLboolean XMesaForceCurrent(XMesaContext c);
 543 extern GLboolean XMesaLoseCurrent(XMesaContext c);
 544 extern void XMesaReset( void );
 545
 546 #endif