docs/README.DJ

   1                         Mesa 6.1 DOS/DJGPP Port v1.6
   2                         ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
   3
   4
   5
   6 Description:
   7 ~~~~~~~~~~~~
   8
   9 Well, guess what... this is the DOS port of Mesa 6.1, for DJGPP fans... Whoa!
  10 The driver has its origins in ddsample.c, written by Brian Paul and found by me
  11 in Mesa 3.4.2.
  12
  13
  14
  15 Legal:
  16 ~~~~~~
  17
  18 Mesa copyright applies, provided this package is used within Mesa. For anything
  19 else, see GPL.
  20
  21
  22
  23 Installation:
  24 ~~~~~~~~~~~~~
  25
  26 Unzip and type:
  27
  28         make -f Makefile.DJ [OPTIONS...]
  29
  30 Available options:
  31
  32      Environment variables:
  33         CPU             optimize for the given processor.
  34                         default = pentium
  35         GLU=[mesa|sgi]  specify GLU directory; can be `sgi' (requires GNU/C++)
  36                         or `mesa'.
  37                         default = mesa
  38         GLIDE           path to Glide3 SDK; used with FX.
  39                         default = $(TOP)/glide3
  40         FX=1            build for 3dfx Glide3. Note that this disables
  41                         compilation of most DMesa code and requires fxMesa.
  42                         As a consequence, you'll need the DJGPP Glide3
  43                         library to build any application.
  44                         default = no
  45         HAVE_X86=1      optimize for i386.
  46                         default = no
  47         HAVE_MMX=1      allow MMX specializations, provided your assembler
  48                         supports MMX instruction set. However, the true CPU
  49                         capabilities are checked at run-time to avoid lockups.
  50                         default = no
  51         HAVE_SSE=1      (see HAVE_MMX)
  52                         default = no
  53         HAVE_3DNOW=1    (see HAVE_MMX)
  54                         default = no
  55
  56      Targets:
  57         all:            build everything
  58         libgl:          build GL
  59         libglu:         build GLU
  60         libglut:        build GLUT
  61         clean:          remove object files
  62         realclean:      remove all generated files
  63
  64
  65
  66 Tested on:
  67         CPU:            AMD Athlon XP 1800+
  68         Mainboard:      GA-7VTXE w/ 512 MB DDRAM
  69         Video card:     Voodoo5 6000 AGP w/ 128 MB SDRAM
  70         DJGPP:          djdev 2.04 + gcc v3.3.2 + make v3.80
  71         OS:             DOS and Win98SE
  72
  73
  74
  75 FAQ:
  76 ~~~~
  77
  78 1. Compilation
  79
  80    Q) `make' barfs and exits because it cannot find some stupid file.
  81    A) You need LFN support.
  82    A) When compiling for Glide (FX=1), pay attention to Glide path.
  83
  84    Q) Libraries built OK, but linker complains about `vsnprintf' every time I
  85       compile some demo.
  86    A) Upgrade to DJGPP 2.04.
  87    A) Add `vsnprintf.c' to the CORE_SOURCES in `src/Makefile.DJ' (untested!).
  88    A) Patch `src/mesa/main/imports.c' with the following line:
  89         #define vsnprintf(buf, max, fmt, arg) vsprintf(buf, fmt, arg)
  90       This hack should be safe in 90% of the cases, but if anything goes wrong,
  91       don't come back to me crying.
  92
  93    Q) `make' complains about DXE3 or something, yet it builds the libraries.
  94    A) DXE3 refers to the DJGPP dynamic modules. You'll need either the latest
  95       DJGPP distro, or download the separate package from my web page. Read the
  96       DXE3 documentation on how to use them.
  97    A) When compiling for Glide (FX=1), make sure `glide3x.dxe' can be found in
  98       LD_LIBRARY_PATH (or top `lib' directory).
  99
 100 2. Using Mesa for DJGPP
 101
 102    Q) DMesa is so SLOOOW! The Win32 OpenGL performs so much better...
 103    A) Is that a question? If you have a 3dfx Voodoo^2 or higher card, you're
 104       lucky (check http://sourceforge.net/projects/glide for the DJGPP port).
 105       If you haven't, sorry; everything is done in software. Suggestions?
 106
 107    Q) I tried to set refresh rate w/ DMesa, but without success.
 108    A) Refresh rate control works only for VESA 3.0 and the 3dfx driver (in
 109       which case FX_GLIDE_REFRESH will be overwritten if it is defined and
 110       is not 0).
 111
 112    Q) I made a simple application and it does nothing. It exits right away. Not
 113       even a blank screen.
 114    A) The pure software drivers (VESA/VGA) support only double-buffered modes.
 115    A) Another weird "feature" is that buffer width must be multiple of 8 (I'm a
 116       lazy programmer and I found that the easiest way to keep buffer handling
 117       at peak performance ;-).
 118
 119    Q) I'm getting a "bad font!" fatal error.
 120    A) By default, DOS GLUT compiles with GLUT_IMPORT_LIB, to cope with variable
 121       access inside dynamic modules (same mechanism used for Win32 _DLL). Since
 122       -DGLUT_IMPORT_LIB affects Mesa's `glut.h', your apps must be compiled the
 123       same way GLUT was compiled (either with or without defining it). If you
 124       want to use another `glut.h' when building your own demos, or just don't
 125       feel happy about this, make sure you remove the line with GLUT_IMPORT_LIB
 126       from `Mesa/src/glut/dos/Makefile.DJ' before (re)making GLUT. Beware, this
 127       means you will never EVER be able to safely use `glut.dxe'!
 128
 129    Q) How do I query for a list of available video modes to choose as a visual?
 130    A) This is an ugly hack, for which I'm sure I'll burn in hell.
 131       First, query for a list of modes:
 132         n = DMesaGetIntegerv(DMESA_GET_VIDEO_MODES, NULL);
 133       If `n' is strictly positive, you allocate an array of pointers to a given
 134       struct (which is guaranteed to be extended only - not changed in future):
 135         struct {
 136                 int xres, yres;
 137                 int bpp;
 138         } **l = malloc(n * sizeof(void **));
 139       Now pass the newly allocated buffer to fill in:
 140         DMesaGetIntegerv(DMESA_GET_VIDEO_MODES, (GLint *)l);
 141       And collect the info:
 142         for (i = 0; i < n; i++) {
 143             printf("%dx%d:%d\n", l[i]->xres, l[i]->yres, l[i]->bpp);
 144         }
 145
 146    Q) The GLUT is incomplete.
 147    A) See below.
 148
 149
 150
 151 libGLUT (the toolkit):
 152 ~~~~~~~~~~~~~~~~~~~~~~
 153
 154 Well, this "skeletal" GLUT implementation was taken from AllegGL project and
 155 heavily changed. Thanks should go to Bernhard Tschirren, Mark Kilgard, Brian
 156 Paul and probably others (or probably not ;-). GLUT functionality will be
 157 extended only on an "as needed" basis.
 158
 159 GLUT talks to hardware via PC_HW package which was put together from various
 160 pieces I wrote long time ago. It consists from the keyboard, mouse and timer
 161 drivers.
 162
 163 My keyboard driver used only scancodes; as GLUT requires ASCII values for keys,
 164 I borrowed the translation tables (and maybe more) from Allegro -- many thanks
 165 to Shawn Hargreaves et co. Ctrl-Alt-Del (plus Ctrl-Alt-End, for Windows users)
 166 will shut down the GLUT engine unconditionally: it will raise SIGINT, which in
 167 turn will (hopefully) call the destructors, thus cleaning up your/my mess ;-)
 168 NB: since the DJGPP guys ensured signal handlers won't go beyond program's
 169 space (and since dynamic modules shall) the SIGINT can't be hooked (well, it
 170 can, but it is useless), therefore you must live with the 'Exiting due to
 171 signal SIGINT' message...
 172
 173 The mouse driver is far from complete (lack of drawing, etc), but is enough to
 174 make almost all the demos work. Supports the CuteMouse WheelAPI.
 175
 176 The timer is pretty versatile for it supports multiple timers with different
 177 frequencies. While not being the most accurate timer in the known universe, I
 178 think it's OK. Take this example: you have timer A with a very high rate, and
 179 then you have timer B with very low rate compared to A; now, A ticks OK, but
 180 timer B will probably loose precision!
 181
 182 As an addition, stdout and stderr are redirected and dumped upon exit. This
 183 means that `printf' can be safely called during graphics. A bit of a hack, I
 184 know, because all messages come in bulk, but I think it's better than nothing.
 185 "Borrowed" from LIBRHUTI (Robert Hoehne).
 186
 187 Window creating defaults: (0, 0, 300, 300), 16bpp. However, the video mode is
 188 chosen in such a way that first window will fit. If you need high resolution
 189 with small windows, set initial position far to the right (or way down); then
 190 you can move them back to any position right before the main loop.
 191
 192 The following environment variables can customize GLUT behaviour:
 193         GLUT_FPS                - print frames/second statistics to stderr
 194         DMESA_GLUT_REFRESH      - set vertical screen refresh rate (VESA3)
 195         DMESA_GLUT_BPP          - set default bits per pixel (VGA needs 8)
 196         DMESA_GLUT_ALPHA        - set default alpha bits (8)
 197         DMESA_GLUT_DEPTH        - set default depth bits (16)
 198         DMESA_GLUT_STENCIL      - set default stencil bits (8)
 199         DMESA_GLUT_ACCUM        - set default accum bits (16)
 200
 201
 202
 203 History:
 204 ~~~~~~~~
 205
 206 v1.0 (mar-2002)
 207         initial release
 208
 209 v1.1 (sep-2002)
 210         + added 3dfx Glide3 support
 211         + added refresh rate control
 212         + added fonts in GLUT
 213         * lots of minor changes
 214
 215 v1.2 (nov-2002)
 216         * synced w/ Mesa-4.1
 217         - removed dmesadxe.h
 218
 219 v1.3 (mar-2003)
 220         + enabled OpenGL 1.4 support
 221         + added MMX clear/blit routines
 222         + enabled SGI's GLU compilation
 223         + added samples makefile
 224         + added new GLUT functions
 225         + added color-index modes
 226         + added Matrox Millennium MGA2064W driver
 227         + added 8bit FakeColor (thanks to Neil Funk)
 228         + added VGA support (to keep Ben Decker happy)
 229         ! fixed some compilation errors (reported by Chan Kar Heng)
 230         * optimized driver for faster callback access... yeah, right :)
 231         * overhauled virtual buffer and internal video drivers
 232         * better fxMesa integration
 233         * revamped GLUT
 234         * switched to DXE3
 235
 236 v1.4 (dec-2003)
 237         + enabled GLUT fonts with DXE
 238         + truly added multi-window support in GLUT (for Adrian Woodward)
 239         * accomodated makefiles with the new sourcetree
 240         * fixed some ALPHA issues
 241         * minor changes to PC_HW/timer interface
 242         x hacked and slashed the 3dfx driver (w/ help from Hiroshi Morii)
 243
 244 v1.5 (jan-2004)
 245         + added interface to query available "visuals" (GLFW - Marcus Geelnard)
 246         + added GLUT timer callback
 247         - removed Matrox Millennium MGA2064W driver
 248         x more changes to the 3dfx driver
 249
 250 v1.6 (???-2004)
 251         + added DMesaGetProcAddress and glutGetProcAddress
 252         ! fixed a horrible bug in VGA initialization routine
 253
 254
 255
 256 Contact:
 257 ~~~~~~~~
 258
 259 Name:   Borca Daniel
 260 E-mail: dborca@users.sourceforge.net
 261 WWW:    http://www.geocities.com/dborca/