docs: document glMultiDrawElements() fix
[mesa.git] / docs / README.3DFX
index 4b8e13fb9cc612670804873c95115ddbf5add94b..037e8fa7cc6c3a32977cfc2ec026679fc35a4eac 100644 (file)
@@ -3,47 +3,46 @@
 
 
 
-Mesa-6.0 release notes:
------------------------
-
-1) Glide2 support has been ceased; in order to keep Voodoo Graphics
-   and Voodoo Rush compatibility, please visit the Glide SourceForge
-   and help us to fix Glide3 for those cards.
-2) The current release is a WIP; among other things, the Linux build works
-   only to some extent. Any help will be appreciated.
-3) Glide3 can be found at http://sourceforge.net/projects/glide/
+Requirements:
+-------------
 
+A Voodoo-based videocard/accelerator
+DOS (with DJGPP), Windows9x/2k (with MinGW), Linux
+Glide3x library for your OS
 
-
-Known supported HW/OS:
-----------------------
-
-Voodoo Graphics, Voodoo^2, Voodoo Banshee, Voodoo3, Voodoo4, Voodoo5
-DOS (DJGPP), Windows9x/2k (MinGW/MSVC), Linux
+http://sourceforge.net/projects/glide/
 
 
 
 How to compile:
 ---------------
 
-DJGPP/MinGW/MSVC:
+DJGPP:
    Place the Glide3 SDK in the top Mesa directory:
-       $(MESA)/glide3/include/*.h
+       $(MESA)/glide3/include/
+               3dfx.h, g3ext.h, glide.h, glidesys.h, glideutl.h, sst1vid.h
        $(MESA)/glide3/lib/
-   Required headers:
-       3dfx.h, g3ext.h, glide.h, glidesys.h, glideutl.h, sst1vid.h
-   Required libraries:
-       OS specific
+               libgld3x.a, libgld3i.a, glide3x.dxe
    Type:
-       make -f Makefile.DJ HAVE_MMX=1 HAVE_3DNOW=1 FX=1
-       or
-       make -f Makefile.mgw HAVE_MMX=1 HAVE_3DNOW=1 FX=1
-       or
-       nmake -f Makefile.wfx
-   Look into the corresponding makefiles for further information.
+       make -f Makefile.DJ X86=1 FX=1
+   Look into the makefile for further information.
+
+MinGW:
+   Place the Glide3 SDK in the top Mesa directory:
+       $(MESA)/glide3/include/
+               3dfx.h, g3ext.h, glide.h, glidesys.h, glideutl.h, sst1vid.h
+       $(MESA)/glide3/lib/
+               libglide3x.a, glide3x.dll
+   Type:
+       make -f Makefile.mgw X86=1 FX=1
+   Look into the makefile for further information.
 
 Linux:
    Place the Glide3 SDK in /usr/local/glide
+       /usr/local/glide/include/
+               3dfx.h, g3ext.h, glide.h, glidesys.h, glideutl.h, sst1vid.h
+       /usr/local/glide/lib/
+               libglide3x.a, libglide3x.so
    Type:
        make linux-glide
        or
@@ -51,11 +50,30 @@ Linux:
 
 
 
-Tuning:
--------
+Compilation defines:
+--------------------
+
+FX_DEBUG
+       enable driver debug code
+FX_TRAP_GLIDE
+       enable Glide trace code
+FX_PACKEDCOLOR
+       use packed color in vertex structure
+FX_TC_NAPALM
+       map GL_COMPRESSED_RGB[A] to FXT1. Works with VSA100-based cards only.
+FX_COMPRESS_S3TC_AS_FXT1_HACK
+       map S3TC to FXT1
+FX_RESCALE_BIG_TEXURES_HACK
+       fake textures larger than HW can support
+       (see MESA_FX_MAXLOD environment variable)
+
+
+
+Environment variables:
+----------------------
 
 The following environment variables affect MesaFX. Those that affect Glide
-only, are beyond the scope of this file. Entries that don't have a "Value"
+only, are beyond the scope of this section. Entries that don't have a "Value"
 field, can have any value whatsoever
        ex: set MESA_FX_IGNORE_CMBEXT=y
 
@@ -70,7 +88,7 @@ default values. Use them only when you experience crashes or strange behavior.
 
 FX_GLIDE_NUM_TMU
        OS: all
-       HW: TMU cards (Voodoo2, Avenger, Napalm)
+       HW: dual-TMU cards (Voodoo2, Avenger, Napalm)
        Desc: force single-TMU
        Note: (*)
        Value: "1"
@@ -79,7 +97,7 @@ FX_GLIDE_SWAPPENDINGCOUNT
        HW: all
        Desc: max # of buffers allowed to build up
        Note: (*) (!)
-       Value: "0", "1", "2" or "3"
+       Value: "0", "1", "2", "3", "4", "5" or "6"
 FX_GLIDE_SWAPINTERVAL
        OS: all
        HW: all
@@ -118,6 +136,16 @@ MESA_FX_INFO
        HW: all
        Desc: verbose to stderr
        Value: any; special value "r" to redirect stderr to MESA.LOG
+MESA_FX_NOSNAP
+       OS: all
+       HW: Voodoo1, Rush, Banshee
+       Desc: do not snap vertices inside Mesa
+       Note: to be used with Glide3x that snaps vertices internally
+MESA_FX_POINTCAST
+       OS: all
+       HW: dual-TMU cards (some Voodoo1, Voodoo2, Avenger, Napalm)
+       Desc: try to use pointcast palette
+       Note: may give adverse effects on UMA cards (Avenger, Napalm)
 MESA_FX_IGNORE_PALEXT
        OS: all
        HW: all
@@ -134,8 +162,9 @@ MESA_FX_IGNORE_CMBEXT
        OS: all
        HW: Napalm
        Desc: disable Napalm combiners (color/alpha/texture)
-       Note: this means advanced (multi)texturing modes won't
-             work, but disabling this turns on REAL trilinear
+       Note: this option allows dual-TMU cards perform single-pass
+             trilinear, but some advanced (multi)texturing modes
+             won't work (GL_EXT_texture_env_combine)
 MESA_FX_IGNORE_MIREXT
        OS: all
        HW: all
@@ -156,14 +185,33 @@ MESA_FX_MAXLOD
            "9"  - 512x512 textures
            "10" - 1024x1024 textures
            "11" - 2048x2048 textures
+MESA_FX_ALLOW_VP
+       OS: all
+       HW: all
+       Desc: allow vertex program extensions
+MESA_GLX_FX
+       OS: linux
+       HW: Voodoo1, Rush, Voodoo2
+       Desc: display mode
+       Note: (!) experimental
+       Value:
+           "w" - windowed mode
+           "f" - fullscreen mode
+           "d" - disable glide driver
+       OS: win32
+       HW: Rush, Banshee, Avenger, Napalm
+       Desc: display mode
+       Note: (!) experimental
+       Value:
+           "w" - windowed mode
 
 
 
 Contact:
 --------
 
-Daniel Borca <dborca@users.sourceforge.net>
-Hiroshi Morii <koolsmoky@users.sourceforge.net>
+Daniel Borca <dborca 'at' users 'dot' sourceforge 'dot' net>
+Hiroshi Morii <koolsmoky 'at' users 'dot' sourceforge 'dot' net>