docs/README.WIN32

   1 File: docs/README.WIN32
   2
   3 Last updated: Apr 25, 2007
   4
   5 NOTE: This information only applies to Mesa 7.8 and older.  Nowadays
   6 it's probably better to use Scons to build for Windows.
   7
   8
   9 Quick Start
  10 ----- -----
  11
  12 Unzip the MesaLib, MesaGLUT, and MesaDemos ZIP files into the same
  13 directory.  The libs and demos build separately, so if you do not care
  14 about the demos or GLUT, you only need to unzip MesaLib.  If you unzip
  15 more than one ZIP file, they all need to be unzipped into the same
  16 directory.  Don't worry, you will not overwrite anything.
  17
  18 The Windows build system uses Microsoft Visual Studio.  Project files
  19 for a specific version of Visual Studio are in their own directory in
  20 the top-level "windows" directory.  For example, Visual Studio 8 files
  21 are in windows/VC8.
  22
  23 Support has been dropped for versions of Visual Studio prior to 8. The
  24 main reason is because Microsoft now provides a free compiler and
  25 developer environment.  Visual Studio Express can be found at
  26
  27 http://msdn.microsoft.com/vstudio/express/visualc/default.aspx
  28
  29 You'll also need the Platform SDK.  Instructions for obtaining and
  30 using the SDK with Visual Studio Express can be found at
  31
  32 http://msdn.microsoft.com/vstudio/express/visualc/usingpsdk/
  33
  34 The project files to build the core Mesa library, Windows Mesa
  35 drivers, OSMesa, and GLU are in the mesa directory.  The project files
  36 to build GLUT and some demo programs are in the progs directory.
  37
  38 Makefiles are no longer shipped or supported, but can be generated
  39 from the projects using Visual Studio.
  40
  41
  42 Windows Drivers
  43 ------- -------
  44
  45 At this time, only the GDI driver is known to work.  Most of the demos
  46 in progs/demos should work with this driver.
  47
  48 Source code also exists in the tree for other drivers in
  49 src/mesa/drivers/windows, but the status of this code is unknown.
  50
  51 The GDI driver operates basically by writing pixel spans into a DIB
  52 section and then blitting the DIB to the window.  The driver was
  53 recently cleaned up and rewitten and so may have bugs or may be
  54 missing some functionality.  The older versions of the CVS source may
  55 be useful in figuring out any problems, or report them to me.
  56
  57 To build Mesa with the GDI driver, build the mesa, gdi, and glu
  58 projects in the Visual Studio workspace found at
  59
  60         windows/VC8/mesa/mesa.sln
  61
  62 The osmesa DLL can also be built with the osmesa project.
  63
  64 The build system creates a lib top-level directory and copies
  65 resulting LIB and DLL files to this lib directory.  The files are:
  66
  67         OPENGL32.LIB, GLU32.LIB, OSMESA32.LIB
  68         OPENGL32.DLL, GLU32.DLL, OSMESA32.DLL
  69
  70 If the MesaDemos ZIP file was extracted, the DLL files are also copied
  71 to the demos directory.  This facilitates running the demos as described
  72 below.
  73
  74
  75 GLUT and Demos
  76 ---- --- -----
  77
  78 A Visual Studio workspace can be found at
  79
  80         windows/VC8/progs/progs.sln
  81
  82 It can be used to build GLUT and a few demos.  The GLUT lib and DLL
  83 are copied to the top-level lib directory, along with the Mesa libs.
  84
  85 The demo build system expects to find the LIB files in the top level
  86 lib directory, so you must build the Mesa libs first.  The demo
  87 executables are placed in the demos directory, because some of them
  88 rely on data files found there.  Also, the Mesa lib DLL's were copied
  89 there by the Mesa lib build process.  Therefore, you should be able to
  90 simply run the demo executables from the demo directory.
  91
  92 If you want to run the demos from the Visual Studio, you may have to
  93 change the startup directory and explicitly state where the executables are.
  94
  95 You may also build all the demo programs by using a makefile.  Go to
  96 the progs/demos directory and make sure you have executed VCVARS32.BAT
  97 or whatever setup script is appropriate for your compiler.  Then,
  98
  99         nmake -f Makefile.win
 100
 101 should build all the demos.
 102
 103
 104 Build System Notes
 105 ----- ------ -----
 106
 107 VC8
 108 ---
 109
 110 No notes.
 111
 112
 113 General
 114 -------
 115
 116 After building, you can copy the above DLL files to a place in your
 117 PATH such as $SystemRoot/SYSTEM32.  If you don't like putting things
 118 in a system directory, place them in the same directory as the
 119 executable(s).  Be careful about accidentially overwriting files of
 120 the same name in the SYSTEM32 directory.
 121
 122 The DLL files are built so that the external entry points use the
 123 stdcall calling convention.
 124
 125 Static LIB files are not built.  The LIB files that are built with are
 126 the linker import files associated with the DLL files.
 127
 128 The si-glu sources are used to build the GLU libs.  This was done
 129 mainly to get the better tessellator code.
 130
 131 To build "mangled" Mesa, add the preprocessor define USE_MGL_NAMESPACE
 132 to the project settings.  You will also need to edit src/mesa.def to
 133 change all the gl* symbols to mgl*.  Because this is easy to do with a
 134 global replace operation in a text editor, no additional mangled
 135 version of mesa.def is maintained or shipped.
 136
 137 If you have a Windows-related build problem or question, please post
 138 to the mesa-dev or mesa-users list.