src/mesa/drivers/x11/xmesaP.h

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