docs/README.3DFX

   1
   2                             3Dfx Glide device driver
   3
   4
   5
   6 Mesa-6.1 release notes:
   7 -----------------------
   8
   9 1) Glide2 support has been ceased; please visit the Glide SourceForge and
  10    help us improve Glide3.
  11 2) The current release is a WIP; among other things, the Linux build works
  12    only to some extent. Voodoo Rush not fully supported. Any help will be
  13    appreciated.
  14 3) Although Mesa is designed to work with any Glide3, it would benefit from
  15    interacting with newer Glide libraries, which can export functions like:
  16    `grGetRegistryOrEnvironmentStringExt', `grSetNumPendingBuffers', Texus2
  17    and pointcast palette. The latest Glide3 can be reached here:
  18         http://sourceforge.net/projects/glide/
  19
  20
  21
  22 Known supported HW/OS:
  23 ----------------------
  24
  25 Voodoo-based videocards/accelerators
  26 DOS (DJGPP), Windows9x/2k (MinGW/MSVC), Linux
  27
  28
  29
  30 How to compile:
  31 ---------------
  32
  33 DJGPP/MinGW:
  34    Place the Glide3 SDK in the top Mesa directory:
  35         $(MESA)/glide3/include/*.h
  36         $(MESA)/glide3/lib/
  37    Required headers:
  38         3dfx.h, g3ext.h, glide.h, glidesys.h, glideutl.h, sst1vid.h
  39    Required libraries:
  40         OS specific
  41    Type:
  42         make -f Makefile.DJ X86=1 FX=1
  43         or
  44         make -f Makefile.mgw X86=1 FX=1
  45    Look into the corresponding makefiles for further information.
  46
  47 Linux:
  48    Place the Glide3 SDK in /usr/local/glide
  49    Type:
  50         make linux-glide
  51         or
  52         make linux-x86-glide
  53
  54
  55
  56 Compilation defines:
  57 --------------------
  58
  59 FX_DEBUG
  60         enable driver debug code
  61 FX_TRAP_GLIDE
  62         enable Glide trace code
  63 FX_TC_NAPALM
  64         map GL_COMPRESSED_RGB[A] to FXT1. This will have effect on Napalm
  65         only (can coexist with FX_TC_NCC, but has higher priority)
  66 FX_TC_NCC
  67         map GL_COMPRESSED_RGB[A] to NCC. This will have effect on any 3dfx
  68         HW (can coexist with FX_TC_NAPALM, but has lesser priority)
  69 FX_COMPRESS_S3TC_AS_FXT1_HACK
  70         map S3TC to FXT1
  71 FX_RESCALE_BIG_TEXURES_HACK
  72         fake textures larger than HW can support
  73         (see MESA_FX_MAXLOD environment variable)
  74
  75
  76
  77 Environment variables:
  78 ----------------------
  79
  80 The following environment variables affect MesaFX. Those that affect Glide
  81 only, are beyond the scope of this section. Entries that don't have a "Value"
  82 field, can have any value whatsoever
  83         ex: set MESA_FX_IGNORE_CMBEXT=y
  84
  85 "Note" (*) means that the environment variable affects Glide, too; also, if
  86 the var is not found in the environment, it is searched in windoze registry.
  87 "Note" (!) means that the environment variable is not working as expected;
  88 may have undefined effects, might have effects only at Glide level or might
  89 not have any effect whatsoever. Caveat emptor! Those are to be revised soon.
  90
  91 It is recommended to leave the envvars alone, so that Mesa/Glide will run with
  92 default values. Use them only when you experience crashes or strange behavior.
  93
  94 FX_GLIDE_NUM_TMU
  95         OS: all
  96         HW: dual-TMU cards (some Voodoo1, Voodoo2, Avenger, Napalm)
  97         Desc: force single-TMU
  98         Note: (*)
  99         Value: "1"
 100 FX_GLIDE_SWAPPENDINGCOUNT
 101         OS: all
 102         HW: all
 103         Desc: max # of buffers allowed to build up
 104         Note: (*) (!)
 105         Value: "0", "1", "2" or "3"
 106 FX_GLIDE_SWAPINTERVAL
 107         OS: all
 108         HW: all
 109         Desc: number of vertical retraces to wait before swapping
 110         Note: (*) (!) works only at Glide-level?
 111 SSTH3_SLI_AA_CONFIGURATION
 112         OS: all
 113         HW: VSA100-based cards
 114         Desc: SLI/AA setup
 115         Note: (*) (!) works only at Glide-level?
 116         Value:
 117             1, 2, 4 chip cards
 118                 "0" - SLI & AA disable
 119                 "1" - SLI disabled, 2 sample AA enabled
 120             2, 4 chip cards
 121                 "2" - 2-way SLI enabled, AA disabled
 122                 "3" - 2-way SLI enabled, 2 sample AA enabled
 123                 "4" - SLI disabled, 4 sample AA enabled
 124             4 chip cards
 125                 "5" - 4-way SLI enabled, AA disabled
 126                 "6" - 4-way SLI enabled, 2 sample AA enabled
 127                 "7" - 2-way SLI enabled, 4 sample AA enabled
 128                 "8" - SLI disabled, 8 sample AA enabled
 129 SST_DUALHEAD
 130         OS: win32
 131         HW: ?
 132         Desc: ?
 133         Note: (!) disabled?
 134 MESA_FX_NO_SIGNALS
 135         OS: linux
 136         HW: all
 137         Desc: avoid installing signals
 138         Note: (!) untested!
 139 MESA_FX_INFO
 140         OS: all
 141         HW: all
 142         Desc: verbose to stderr
 143         Value: any; special value "r" to redirect stderr to MESA.LOG
 144 MESA_FX_POINTCAST
 145         OS: all
 146         HW: dual-TMU cards (some Voodoo1, Voodoo2, Avenger, Napalm)
 147         Desc: try to use pointcast palette
 148         Note: may give adverse effects on UMA cards (Avenger, Napalm)
 149 MESA_FX_IGNORE_PALEXT
 150         OS: all
 151         HW: all
 152         Desc: disable 6666 palette
 153 MESA_FX_IGNORE_PIXEXT
 154         OS: all
 155         HW: Napalm
 156         Desc: force 565 16bpp mode (traditional Voodoo, no 32/15bpp)
 157 MESA_FX_IGNORE_TEXFMT
 158         OS: all
 159         HW: Napalm
 160         Desc: disable 32bit textures
 161 MESA_FX_IGNORE_CMBEXT
 162         OS: all
 163         HW: Napalm
 164         Desc: disable Napalm combiners (color/alpha/texture)
 165         Note: this option allows dual-TMU cards perform single-pass
 166               trilinear, but some advanced (multi)texturing modes
 167               won't work (GL_EXT_texture_env_combine)
 168 MESA_FX_IGNORE_MIREXT
 169         OS: all
 170         HW: all
 171         Desc: disable mirror extension
 172 MESA_FX_IGNORE_TEXUMA
 173         OS: all
 174         HW: all
 175         Desc: disable UMA
 176 MESA_FX_IGNORE_TEXUS2
 177         OS: all
 178         HW: all
 179         Desc: disable Texus2
 180 MESA_FX_MAXLOD
 181         OS: all
 182         HW: non VSA-100 cards
 183         Desc: enable large texture support using SW rescaling
 184         Value:
 185             "9"  - 512x512 textures
 186             "10" - 1024x1024 textures
 187             "11" - 2048x2048 textures
 188
 189
 190
 191 Contact:
 192 --------
 193
 194 Daniel Borca <dborca 'at' users 'dot' sourceforge 'dot' net>
 195 Hiroshi Morii <koolsmoky 'at' users 'dot' sourceforge 'dot' net>
 196
 197
 198
 199 WARNING! The info below this line is outdated (yet some of it useful). WARNING!
 200 *******************************************************************************
 201
 202
 203
 204 Info for Mesa 4.1
 205 -----------------
 206
 207 The 3dfx Glide driver in Mesa is disabled by default.  Not too many people
 208 use this driver anymore and at some point down the road it will be dropped.
 209
 210 To use/enable the Glide driver either do this:
 211
 212 './configure --with-glide=DIR'    Where DIR is the location of Glide, like
 213                                   /usr/ or /usr/local
 214
 215 OR
 216
 217 'make linux-x86-glide'     If using the old-style Makefile system.
 218
 219 The rest of this file hasn't changed since Mesa 3.3.  Some of it's out of
 220 date, but some is still valid.
 221
 222
 223
 224 What do you need ?
 225 ------------------
 226
 227         - A PC with a 3Dfx Voodoo1/2 Graphics or Voodoo Rush based board
 228           (Pure3D, Monster 3D, R3D, Obsidian, Stingray 128/3D, etc.).
 229           The Quantum3D Obsidian3D-2 X-24 requires some special env. setting
 230           under Linux (more information in the "Useful Glide Environment
 231           Variables");
 232
 233         - The 3Dfx Glide library 2.3 or later for your OS (the 2.4 works fine).
 234           The Voodoo2 requires the Glide library 2.51. The Glide 3.1 is not
 235           compatible with the Glide 2.x so it doesn't work with the current
 236           version of the driver;
 237
 238         - A compiler supported by the Glide library (Micro$oft VC++ (tested),
 239           Watcom (tested), GCC for Linux (tested), etc.);
 240
 241         - It's nice to have two monitors - one for your normal graphics
 242           card and one for your 3Dfx card. If something goes wrong with
 243           an application using the 3Dfx hardware you can still see your
 244           normal screen in order to recover.
 245
 246
 247
 248 Tested on:
 249 ----------
 250         Windows 95 - David Bucciarelli
 251         Windows NT - Henri Fousse
 252         MS-DOS
 253         Linux - Daryll Strauss, Brian Paul, David Bucciarelli
 254         FreeBSD
 255         BeOS - Duncan Wilcox
 256         MacOS - Fazekas Miklos
 257
 258
 259 What is able to do ?
 260 --------------------
 261
 262         - It is able accelerate points, lines and polygon with flat
 263           shading, gouraud shading, Z-buffer, texture mapping, blending, fog and
 264           antialiasing (when possible). There is also the support for rendering
 265           in a window with a slow trick for the Voodoo Graphics (available only
 266           for Linux) and at full speed with the Voodoo Rush chipset.
 267           Under Linux is also possible to switch on-the-fly between the fullscreen
 268           and in-window rendering hack.
 269           There is also the support for using more than one Voodoo Graphics in the
 270           some application/PC (you can create one context for each board and use
 271           multiple video outputs for driving monitors, videoprojectors or HMDs).
 272           The driver is able to fallback to pure software rendering when afeature
 273           isn't supported by the Voodoo hardware (however software rendering is
 274           very slow compared to hardware supported rendering)
 275
 276
 277
 278 How to compile:
 279 ---------------
 280
 281 Linux:
 282 ------
 283         Here are the basic steps for using the 3Dfx hardware with Mesa
 284         on Linux:
 285
 286         - You'll need the Glide library and headers.  Mesa expects:
 287                 /usr/local/glide/include/*.h        // all the Glide headers
 288                 /usr/local/glide/lib/libglide2x.so
 289
 290           If your Glide libraries and headers are in a different directory
 291           you'll have to modify the Mesa-config and mklib.glide files.
 292
 293         - Unpack the MesaLib-3.1.tar.gz and MesaDemos-3.1.tar.gz archives;
 294
 295         - If you're going to use a newer Mesa/Glide driver than v0.27 then
 296           unpack the new driver archive over the Mesa directory.
 297
 298         - In the Mesa-3.1 directory type "make linux-glide"
 299
 300         - Compilation _should_ finish without errors;
 301
 302         - Set your LD_LIBRARY_PATH environment variable so that the
 303           libglide2x.so and Mesa library files can be found.  For example:
 304             setenv LD_LIBRARY_PATH "/usr/local/glide/lib:/SOMEDIR/Mesa-3.1/lib"
 305
 306         - You'll have to run Glide-based programs as root or set the suid
 307           bit on executables;
 308
 309         - Try a demo:
 310             cd gdemos
 311             su
 312             setenv MESA_GLX_FX f
 313             ./gears     (hit ESC to exit)
 314
 315         - You can find the demos especially designed for the Voodoo driver in
 316           in the Mesa-3.1/3Dfx/demos directory (type "make" in order to compile
 317           everything).
 318
 319 MacOS:
 320 ------
 321         Check the WEB page at http://valerie.inf.elte.hu/~boga/Mesa.html
 322
 323 MS Windows:
 324 -----------
 325
 326         For the MSVC++:
 327         - The glide2x.lib have to be in the default MSVC++ lib directory;
 328
 329         - The Glide headers have to be in the default MSVC++ include directory;
 330
 331         - You must have the vcvars32.bat script in your PATH;
 332
 333         - Go to the directory Mesa-3.1 and run the mesafx.bat;
 334
 335         - The script will compile everything (Mesa-3.1/lib/OpenGL32.{lib,dll},
 336           Mesa-3.1/lib/GLU32.{lib,dll}, Mesa-3.1/lib/GLUT32.{lib,dll} and
 337           Voodoo demos);
 338
 339         - At the end, you will be in the Mesa-3.1/3Dfx/demos directory;
 340
 341         - Try some demo (fire.exe, teapot.exe, etc.) in order to check if
 342           everything is OK (you can use Alt-Tab or Ctrl-F9 to switch between
 343           the Voodoo screen and the windows desktop);
 344
 345         - Remember to copy the Mesa OpenGL32.dll, GLU32.dll and GLUT32.dll in the
 346           some directory were you run your Mesa based applications.
 347
 348         - I think that you can easy change the Makefile.fx files in order
 349           to work with other kind of compilers;
 350
 351         - To discover how open the 3Dfx screen, read the sources under
 352           the Mesa-3.1/3Dfx/demos directory. You can use the GLUT library or
 353           the Diego Picciani's wgl emulator.
 354
 355         NOTE: the MSVC++ 5.0 optimizer is really buggy. Also if you install the
 356         SP3, you could have some problem (you can disable optimization in order
 357         solve these kind of problems).
 358
 359
 360 Doing more with Mesa & Linux Glide:
 361 -----------------------------------
 362
 363         The MESA_GLX_FX environment variable can be used to coax most
 364         GLX-based programs into using Glide (and the __GLUT library
 365         is GLX-based__).
 366
 367         Full-screen 3Dfx rendering:
 368         ---------------------------
 369
 370         1. Set the MESA_GLX_FX variable to "fullscreen":
 371
 372                 ksh:
 373                         export MESA_GLX_FX = "fullscreen"
 374                 csh:
 375                         setenv MESA_GLX_FX fullscreen
 376
 377         2. As root, run a GLX-based program (any GLUT demo on Linux).
 378
 379         3. Be careful:  once the 3Dfx screen appears you won't be able
 380         to see the GLUT windows on your X display.  This can make using
 381         the mouse tricky!  One solution is to hook up your 3Dfx card to
 382         a second monitor.  If you can do this then set these env vars
 383         first:
 384
 385                 setenv SST_VGA_PASS 1
 386                 setenv SST_NOSHUTDOWN
 387
 388         or for the Voodoo2:
 389
 390                 setenv SSTV2_VGA_PASS 1
 391                 setenv SSTV2_NOSHUTDOWN
 392
 393         Rendering into an X window with the help of the Voodoo hardware:
 394         ----------------------------------------------------------------
 395
 396         1. Start your X server in 16 bpp mode (XFree86:  startx -- -bpp 16)
 397            in order to have the best performance and the best visual
 398            quality. However you can use any visual depth supported by X.
 399
 400         2. Set the following environment variables:
 401                 export MESA_GLX_FX="window"     # to enable window rendering
 402                 export SST_VGA_PASS=1   # to stop video signal switching
 403                 export SST_NOSHUTDOWN=1 # to stop video signal switching
 404             OR
 405                 setenv MESA_GLX_FX window
 406                 setenv SST_VGA_PASS 1
 407                 setenv SST_NOSHUTDOWN 1
 408
 409         (the Voodoo2 requires to use "SSTV2_" instead "SST_").
 410
 411         3. As root, try running a GLX-based program
 412
 413         How does it work?  We use the 3Dfx hardware to do rendering then
 414         copy the image from the 3Dfx frame buffer into an X window when
 415         the SwapBuffers() function is called.  The problem with this
 416         idea is it's slow.  The image must be copied from the 3Dfx frame
 417         buffer to main memory then copied into the X window (and when the X
 418         visual depth doesn't match the Voodoo framebufffer bit per pixel, it
 419         is required also a pixel format translation).
 420
 421         NOTE: the in-window rendering feature only works with double-buffering.
 422
 423
 424         On the fly switching between in window rendering and full screen rendering
 425         --------------------------------------------------------------------------
 426
 427         The Mesa 2.6 has introduced the capability of switching
 428         on-the-fly between the fullscreen/fullspeed rendering and the in-window
 429         hack and vice versa. The on-the-fly switching requires a direct support
 430         by the application but it is really easy to add. You have to start
 431         your X server in 16 bpp mode and to add the following lines to your
 432         application:
 433
 434                 #if defined(FX) && define(XMESA)
 435                 #include <GL/xmesa.h>
 436
 437                 static int fullscreen=1;
 438                 #endif
 439
 440                 ...
 441
 442                 /* In the GLUT keyboard event callback */
 443
 444                 #if defined(FX) && !define(WIN32)
 445                   case ' ':
 446                     fullscreen=(!fullscreen);
 447                     XMesaSetFXmode(fullscreen ? XMESA_FX_FULLSCREEN : XMESA_FX_WINDOW);
 448                     break;
 449                 #endif
 450                 ...
 451
 452         See the 3Dfx/demos/tunnel.c program
 453         for an example.  You have to set the -DXMESA flag in the Makefile's COPTS
 454         to enable it.
 455
 456         Rendering into an X window with the X11 software driver:
 457         --------------------------------------------------------
 458
 459         Set the MESA_GLX_FX variable to "disable" your GLX-based program will use
 460         the X11 software driver (the 3Dfx hardware isn't used at all).
 461
 462
 463
 464 Useful Glide Environment Variables:
 465 -----------------------------------
 466
 467         - To disable the 3Dfx logo, set the FX_GLIDE_NO_SPLASH variable.
 468
 469         - To disable video signal switching:
 470                 setenv SST_VGA_PASS 1
 471                 setenv SST_NOSHUTDOWN
 472           or for the Voodoo2:
 473                 setenv SSTV2_VGA_PASS 1
 474                 setenv SSTV2_NOSHUTDOWN
 475
 476         - To set the default screen refresh rate:
 477                 setenv SST_SCREENREFRESH=75
 478
 479           the supported values are 60, 70, 72, 75, 80, 85, 90, 100, 120.
 480
 481         - To force the Mesa library to swap buffers as fast as possible,
 482           without any vertical blanking synchronization (useful for benchmarks):
 483                 setenv FX_GLIDE_SWAPINTERVAL 0
 484                 setenv SST_SWAP_EN_WAIT_ON_VIDSYNC 0
 485
 486         - You can slight improve the performances of your Voodoo1 board with
 487           the following env. var.:
 488                 setenv SST_FASTMEM 1
 489                 setenv SST_PCIRD 1
 490                 setenv SST_GRXCLK 57
 491
 492           (don't use this setting with the Quantum3D 100SB or with any other
 493           SLI configuration: it will hang everything !).
 494           The following setting can be used with the Voodoo2:
 495                 setenv SSTV2_FASTMEM_RAS_READS=1
 496                 setenv SSTV2_FASTPCIRD=1
 497                 setenv SSTV2_GRXCLK=95
 498
 499         - The Quantum3D Obsidian3D-2 X-24 requires some special env. setting
 500           in order to work under Linux:
 501
 502                 export SSTV2_FT_CLKDEL=5
 503                 export SSTV2_TF0_CLKDEL=7
 504                 export SSTV2_TF1_CLKDEL=7
 505                 export SSTV2_TF2_CLKDEL=7
 506                 export SSTV2_SLIM_VIN_CLKDEL=3
 507                 export SSTV2_SLIM_VOUT_CLKDEL=2
 508                 export SSTV2_SLIS_VIN_CLKDEL=3
 509                 export SSTV2_SLIS_VOUT_CLKDEL=2
 510
 511           (Thanks to Phil Ross for this trick).
 512
 513
 514
 515
 516 The Mesa/Voodoo Environment Variables:
 517 --------------------------------------
 518
 519         - Only for Windows/Voodoo Rush users, if you define the
 520           env. var. MESA_WGL_FX:
 521                 export MESA_WGL_FX=fullscreen
 522           you will get fullscreen rendering;
 523
 524         - Only for Windows/Voodoo Rush users, if you define the
 525           env. var. MESA_WGL_FX:
 526                 export MESA_WGL_FX=window
 527           you will get window rendering (default value);
 528
 529         - Only for Linux users, you can find more informations about
 530           the env. var. MESA_GLX_FX in the "Doing more with Mesa & Linux Glide"
 531           section;
 532
 533         - If you define the env. var. MESA_FX_SWAP_PENDING:
 534                 export MESA_FX_SWAP_PENDING=4
 535           you will able to set the maximum number of swapbuffers
 536           commands in the Voodoo FIFO after a swapbuffer (default value: 2);
 537
 538         - If you define the env. var. MESA_FX_INFO:
 539                 export MESA_FX_INFO=1
 540           you will get some useful statistic.
 541
 542         - If you define the env. var. MESA_FX_NO_SIGNALS:
 543                 export MESA_FX_NO_SIGNALS=1
 544           Mesa/FX will not install atexit() or signal() handlers.
 545
 546
 547
 548 Know BUGS and Problems:
 549 -----------------------
 550
 551         - fog doesn't work in the right way when using the glDepthRange() function;
 552
 553         - Maximum texture size: 256x256 (this is an hardware limit);
 554
 555         - Texture border aren't yet supported;
 556
 557         - A GL_BLEND in a glTexEnv() is not supported (it is an hardware limit);
 558
 559         - Use the glBindTexture extension (standard in OpenGL 1.1) for texture
 560           mapping (the old way: glTexImage inside a display list, download
 561           the texture map each time that you call the display list !!!);
 562
 563         - Stencil buffer and Accumulation buffer are emulated in software (they are not
 564           directly supported by the Hardware);
 565
 566         - Color index mode not implemented (this is an hardware limit);
 567
 568         - Thre is an know bug in the Linux Glide library so the in-window-rendering hack
 569           and any other operations that requires to read the Voodoo frame buffer
 570           (like the accumulation buffer support) doesn't work on Voodoo SLI cards.
 571
 572         - The driver switch to pure software (_slow_) rendering when:
 573
 574                 - Stencil enabled;
 575                 - Using the Accumulation buffer;
 576                 - Blend enabled and blend equation != GL_FUNC_ADD_EXT;
 577                 - Color logic operation enabled and color logic operation != GL_COPY;
 578                 - Using GL_SEPARATE_SPECULAR_COLOR;
 579                 - The four values of glColorMask() aren't the some;
 580                 - Texture 1D or 3D enabled;
 581                 - Texture function is GL_BLEND;
 582                 - Using the Multitexture extension with Voodoo cards with only one TMU;
 583                 - Using the Multitexture extension with Voodoo cards with more than
 584                    one TMU, and texture function isn't GL_MODULATE;
 585                 - Point size is != 1.0 or point params vector != (1.0,0.0,0.0);
 586                 - Line width != 1.0 or using stipple lines.
 587                 - Using polygon offset or stipple polygons;
 588
 589         NOTE: this is list is not yet complete.
 590
 591
 592 Hints and Special Features:
 593 ---------------------------
 594
 595         - Under Linux and with a Voodoo Graphics board, you can use
 596           XMesaSetFXmode(XMESA_FX_FULLSCREEN or XMESA_FX_WINDOW) in order to
 597           switch on the fly between fullscreen rendering and the in-window-rendering
 598           hack.
 599
 600         - The driver is able to use all the texture memory available: 2/4MB on
 601           Voodoo1 boards and 8MB (!) on high-end Voodoo1 and Voodoo2 boards.
 602
 603         - Trilinear filtering is fully supported on Voodoo boards with two TMUs
 604           (high-end Voodoo1 boards and Voodoo2 boards). When only one TMU is
 605           available the driver fallback to bilinear filter also if you ask
 606           for trilinear filtering.
 607
 608         - The Voodoo driver support multiple Voodoo Graphics boards in the
 609           some PC. Using this feature, you can write applications that use
 610           multiple monitors, videoprojectors or HMDs for the output. See
 611           Mesa-3.1/3Dfx/demos/tunnel2.c for an example of how setup one
 612           context for each board.
 613
 614         - The v0.19 introduces a new powerful texture memory manager: the
 615           texture memory is used as a cache of the set of all defined texture
 616           maps. You can now define several MBs of texture maps also with a 2MB
 617           of texture memory (the texture memory manager will do automatically
 618           all the swap out/swap in
 619           texture memory work). The new texture memory manager has also
 620           solved a lot of other bugs/no specs compliance/problems
 621           related to the texture memory usage.
 622
 623         - Use triangles and quads strip: they are a LOT faster than sparse
 624           triangles and quads.
 625
 626         - The Voodoo driver supports the GL_EXT_paletted_texture. it works
 627           only with GL_COLOR_INDEX8_EXT, GL_RGBA palettes and the alpha value
 628           is ignored because this is a limitation of the the current Glide
 629           version and of the Voodoo hardware. See Mesa-3.1/3Dfx/demos/paltex.c for
 630           a demo of this extension.
 631
 632         - The Voodoo driver directly supports 3Dfx Global Palette extension.
 633           It was written for GLQuake and I think that it isn't a good idea
 634           to use this extension for any other purpose (it is a trick). See
 635           Mesa-3.1/3Dfx/demos/glbpaltex.c for a demo of this extension.
 636
 637         - The Voodoo driver chooses the screen resolution according to the
 638           requested window size. If you open a 640x480 window, you will get
 639           a 640x480 screen resolution, if you open a 800x600 window, you
 640           will get a 800x600 screen resolution, etc.
 641           Most GLUT demos support the '-geometry' option, so you can choose
 642           the screen resolution: 'tunnel -geometry 800x600'.
 643           Clearly, you Voodoo board must have enough framebuffer RAM (otherwise
 644           the window creation will fail).
 645
 646         - The glGetString(GL_RENDERER) returns more information
 647           about the hardware configuration: "Mesa Glide <version>
 648           <Voodoo_Graphics|Voodoo_Rush|UNKNOWN> <num> CARD/<num> FB/
 649           <num> TM/<num> TMU/<NOSLI|SLI>"
 650           where: <num> CARD is the card used for the current context,
 651           <num> FB is the number of MB for the framebuffer,
 652           <num> TM is the number of MB for the texture memory,
 653           <num> TMU is the number of TMU. You can try to run
 654           Mesa/demos/glinfo in order to have an example of the output.
 655
 656 Did you find a lot BUGs and problems ? Good, send me an email.
 657
 658
 659
 660 FAQ:
 661 ----
 662
 663 For a complete FAQ check the Bernd Kreimeier's Linux 3Dfx HOWTO
 664 available at http://www.gamers.org/dEngine/xf3D (it includes also
 665 a lot of informations not strictly related to Linux, so it can be
 666 useful also if you don't use Linux)
 667
 668 1. What is 3Dfx?
 669
 670 3Dfx Interactive, Inc. is the company which builds the VooDoo 3-D graphics
 671 chipset (and others) used in popular PC cards such as the Diamond Monster 3D
 672 and the Orchid Righteous 3D (more informations at http://www.3dfx.com).
 673
 674
 675 2. What is Glide?
 676
 677 Glide is a "thin" programming interface for the 3Dfx hardware.  It was
 678 originally written for Windows/Intel but has been ported to Linux/Intel
 679 by Daryll Strauss.
 680
 681 3Dfx, Inc. should be applauded for allowing the Linux version of Glide
 682 to be written.
 683
 684 You can directly program with the Glide library if you wish.  You can
 685 obtain Glide from the "Developer" section of the 3Dfx website: www.3dfx.com
 686 There's a Linux/Glide newsgroup at news://news.3dfx.com/3dfx.glide.linux
 687
 688
 689 3. What is fxmesa?
 690
 691 "fxmesa" is the name of the Mesa device driver for the 3Dfx Glide library.
 692 It was written by David Bucciarelli and others.  It works on both Linux
 693 and Windows.  Basically, it allows you to write and run OpenGL-style programs
 694 on the 3Dfx hardware.
 695
 696
 697 4. What is GLQuake?
 698
 699 Quake is a very popular game from id software, Inc.  See www.idsoftware.com
 700 GLQuake is a version of Quake written for OpenGL.  There is now a Linux
 701 version of GLQuake with works with the Mesa/3Dfx/Glide combo.
 702
 703 Here's what you need to run GLQuake on Linux:
 704    PC with 100MHz Pentium or better
 705    a 3Dfx-based card
 706    Mesa 3.1 libraries:  libMesaGL.so  libMesaGLU.so
 707    Glide 2.4 libraries:  libglide2x.so  libtexus.so
 708    GLQuake for Linux.
 709
 710 Also, the windows version of GLQuake works fine with the Mesa OpenGL32.dll,
 711 you have only to copy the Mesa-3.1/lib/OpenGL32.dll in the GLQuake directory
 712 in order to test 'MesaQuake'.
 713
 714
 715 5. What is GLUT?
 716
 717 GLUT is Mark Kilgard's OpenGL Utility Toolkit.  It provides an API for
 718 writing portable OpenGL programs with support for multiple windows, pop-
 719 up menus, event handling, etc.
 720
 721 Check the Mark's home page for more informations (http://reality.sgi.com/mjk_asd).
 722
 723 Every OpenGL programmer should check out GLUT.
 724
 725 GLUT on Linux uses GLX.
 726
 727
 728 6. What is GLX?
 729
 730 GLX is the OpenGL extension to the X Window System.  I defines both a
 731 programming API (glX*() functions) and a network protocol.  Mesa implements
 732 an emulation of GLX on Linux.  A real GLX implementation would requires
 733 hooks into the X server.  The 3Dfx hardware can be used with GLX-based
 734 programs via the MESA_GLX_FX environment variable.
 735
 736
 737 7. Is the Voodoo driver able to use the 4Mb texture memory of
 738 the Pure3D boards ?
 739
 740 Yes, the Voodoo driver v0.20 includes the support for Voodoo
 741 Graphics boards with more than 2Mb of texture memory.
 742
 743
 744 8. Do the Voodoo driver support the Voodoo Rush under Windows ?
 745
 746 Yes, Diego Picciani has developed the support for the Voodoo
 747 Rush but David Bucciarelli has a Pure3D and a Monster3D and Brian Paul
 748 has a Monster3D, so the new versions of the Mesa/Voodoo sometime are
 749 not tested with the Voodoo Rush.
 750
 751
 752 9. Do the Voodoo driver support the Voodoo Rush under Linux ?
 753
 754 No because the Linux Glide doesn't (yet) support the Voodoo Rush.
 755
 756
 757 10. Can I sell my Mesa/Voodoo based software and include
 758 a binary copy of the Mesa in order to make the software
 759 working out of the box ?
 760
 761 Yes.
 762
 763
 764 11. Which is the best make target for compiling the Mesa for
 765 Linux GLQuake ('make linux-glide', 'make linux-386-glide', etc.) ?
 766
 767 'make linux-386-opt-glide' for Voodoo1 and 'make linux-386-opt-V2-glide'
 768 for Voodoo2 boards because it doesn't include the '-fPIC'
 769 option (4-5% faster).
 770
 771
 772 12. Can I use a Mesa compiled with a 'make linux-386-opt-V2-glide'
 773 for my applications/programs/demos ?
 774
 775 Yes, there is only one constrain: you can't run two Mesa applications
 776 at the some time. This isn't a big issue with the today Voodoo Graphics.
 777
 778
 779 Thanks to:
 780 ----------
 781
 782 Henri Fousse       (he has written several parts of the v0.15 and the old GLUT
 783                     emulator for Win);
 784
 785 Diego Picciani     (he has developed all the Voodoo Rush support and the wgl
 786                     emulator);
 787
 788 Daryll Strauss     (for the Linux Glide and the first Linux support);
 789
 790 Brian Paul         (of course);
 791
 792 Dave 'Zoid' Kirsch (for the Linux GLQuake and Linux Quake2test/Q2 ports)
 793
 794 Bernd Kreimeier    (for the Linux 3Dfx HOWTO and for pushing companies to offer
 795                     a better Linux support)
 796
 797 3Dfx and Quantum3D (for actively supporting Linux)
 798
 799 The most update places where find Mesa VooDoo driver related informations are
 800 the Mesa mailing list and my driver WEB page
 801 (http://www-hmw.caribel.pisa.it/fxmesa/index.shtml)
 802
 803
 804 David Bucciarelli (davibu@tin.it)
 805
 806 Humanware s.r.l.
 807 Via XXIV Maggio 62
 808 Pisa, Italy
 809 Tel./Fax +39-50-554108
 810 email: info.hmw@plus.it
 811 www: www-hmw.caribel.pisa.it