docs/install.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
   2 <html lang="en">
   3 <head>
   4   <meta http-equiv="content-type" content="text/html; charset=utf-8">
   5   <title>Compiling and Installing</title>
   6   <link rel="stylesheet" type="text/css" href="mesa.css">
   7 </head>
   8 <body>
   9
  10 <div class="header">
  11   <h1>The Mesa 3D Graphics Library</h1>
  12 </div>
  13
  14 <iframe src="contents.html"></iframe>
  15 <div class="content">
  16
  17 <h1>Compiling and Installing</h1>
  18
  19 <ol>
  20 <li><a href="#prereq-general">Prerequisites for building</a>
  21   <ul>
  22   <li><a href="#prereq-general">General prerequisites</a>
  23   <li><a href="#prereq-dri">For DRI and hardware acceleration</a>
  24   </ul>
  25 <li><a href="#autoconf">Building with autoconf (Linux/Unix/X11)</a>
  26 <li><a href="#scons">Building with SCons (Windows/Linux)</a>
  27 <li><a href="#other">Building for other systems</a>
  28 <li><a href="#libs">Library Information</a>
  29 <li><a href="#pkg-config">Building OpenGL programs with pkg-config</a>
  30 </ol>
  31
  32
  33 <h1 id="prereq-general">1. Prerequisites for building</h1>
  34
  35 <h2>1.1 General</h2>
  36 <ul>
  37 <li><a href="http://www.python.org/">Python</a> - Python is required.
  38 Version 2.6.4 or later should work.
  39 </li>
  40 <br>
  41 <li><a href="http://www.makotemplates.org/">Python Mako module</a> -
  42 Python Mako module is required. Version 0.3.4 or later should work.
  43 </li>
  44 </br>
  45 <li><a href="http://www.scons.org/">SCons</a> is required for building on
  46 Windows and optional for Linux (it's an alternative to autoconf/automake.)
  47 </li>
  48 <br>
  49 <li>lex / yacc - for building the GLSL compiler.
  50 <br>
  51 <br>
  52 On Linux systems, flex and bison are used.
  53 Versions 2.5.35 and 2.4.1, respectively, (or later) should work.
  54 <br>
  55 <br>
  56 On Windows with MinGW, install flex and bison with:
  57 <pre>mingw-get install msys-flex msys-bison</pre>
  58 For MSVC on Windows, install
  59 <a href="http://winflexbison.sourceforge.net/">Win flex-bison</a>.
  60 </li>
  61 <br>
  62 <li>For building on Windows, Microsoft Visual Studio 2013 or later is required.
  63 </li>
  64 </ul>
  65
  66
  67 <h3 id="prereq-dri">1.2 For DRI and hardware acceleration</h3>
  68
  69 <p>
  70 The following are required for DRI-based hardware acceleration with Mesa:
  71 </p>
  72
  73 <ul>
  74 <li><a href="http://xorg.freedesktop.org/releases/individual/proto/">
  75 dri2proto</a> version 2.6 or later
  76 <li><a href="http://dri.freedesktop.org/libdrm/">libDRM</a> latest version
  77 <li>Xorg server version 1.5 or later
  78 <li>Linux 2.6.28 or later
  79 </ul>
  80 <p>
  81 If you're using a fedora distro the following command should install all
  82 the needed dependencies:
  83 </p>
  84 <pre>
  85   sudo yum install flex bison imake libtool xorg-x11-proto-devel libdrm-devel \
  86   gcc-c++ xorg-x11-server-devel libXi-devel libXmu-devel libXdamage-devel git \
  87   expat-devel llvm-devel python-mako
  88 </pre>
  89
  90
  91
  92 <h1 id="autoconf">2. Building with autoconf (Linux/Unix/X11)</h1>
  93
  94 <p>
  95 The primary method to build Mesa on Unix systems is with autoconf.
  96 </p>
  97
  98 <p>
  99 The general approach is the standard:
 100 </p>
 101 <pre>
 102   ./configure
 103   make
 104   sudo make install
 105 </pre>
 106 <p>
 107 But please read the <a href="autoconf.html">detailed autoconf instructions</a>
 108 for more details.
 109 </p>
 110
 111
 112
 113 <h1 id="scons">3. Building with SCons (Windows/Linux)</h1>
 114
 115 <p>
 116 To build Mesa with SCons on Linux or Windows do
 117 </p>
 118 <pre>
 119     scons
 120 </pre>
 121 <p>
 122 The build output will be placed in
 123 build/<i>platform</i>-<i>machine</i>-<i>debug</i>/..., where <i>platform</i> is for
 124 example linux or windows, <i>machine</i> is x86 or x86_64, optionally followed
 125 by -debug for debug builds.
 126 </p>
 127
 128 <p>
 129 To build Mesa with SCons for Windows on Linux using the MinGW crosscompiler toolchain do
 130 </p>
 131 <pre>
 132     scons platform=windows toolchain=crossmingw machine=x86 libgl-gdi
 133 </pre>
 134 <p>
 135 This will create:
 136 </p>
 137 <ul>
 138 <li>build/windows-x86-debug/gallium/targets/libgl-gdi/opengl32.dll &mdash; Mesa + Gallium + softpipe (or llvmpipe), binary compatible with Windows's opengl32.dll
 139 </ul>
 140 <p>
 141 Put them all in the same directory to test them.
 142 </p>
 143
 144
 145
 146 <h1 id="other">4. Building for other systems</h1>
 147
 148 <p>
 149 Documentation for other environments (some may be very out of date):
 150 </p>
 151
 152 <ul>
 153 <li><a href="README.VMS">README.VMS</a> - VMS
 154 <li><a href="README.CYGWIN">README.CYGWIN</a> - Cygwin
 155 <li><a href="README.WIN32">README.WIN32</a> - Win32
 156 </ul>
 157
 158
 159
 160 <h1 id="libs">5. Library Information</h1>
 161
 162 <p>
 163 When compilation has finished, look in the top-level <code>lib/</code>
 164 (or <code>lib64/</code>) directory.
 165 You'll see a set of library files similar to this:
 166 </p>
 167 <pre>
 168 lrwxrwxrwx    1 brian    users          10 Mar 26 07:53 libGL.so -> libGL.so.1*
 169 lrwxrwxrwx    1 brian    users          19 Mar 26 07:53 libGL.so.1 -> libGL.so.1.5.060100*
 170 -rwxr-xr-x    1 brian    users     3375861 Mar 26 07:53 libGL.so.1.5.060100*
 171 lrwxrwxrwx    1 brian    users          14 Mar 26 07:53 libOSMesa.so -> libOSMesa.so.6*
 172 lrwxrwxrwx    1 brian    users          23 Mar 26 07:53 libOSMesa.so.6 -> libOSMesa.so.6.1.060100*
 173 -rwxr-xr-x    1 brian    users       23871 Mar 26 07:53 libOSMesa.so.6.1.060100*
 174 </pre>
 175
 176 <p>
 177 <b>libGL</b> is the main OpenGL library (i.e. Mesa).
 178 <br>
 179 <b>libOSMesa</b> is the OSMesa (Off-Screen) interface library.
 180 </p>
 181
 182 <p>
 183 If you built the DRI hardware drivers, you'll also see the DRI drivers:
 184 </p>
 185 <pre>
 186 -rwxr-xr-x   1 brian users 16895413 Jul 21 12:11 i915_dri.so
 187 -rwxr-xr-x   1 brian users 16895413 Jul 21 12:11 i965_dri.so
 188 -rwxr-xr-x   1 brian users 11849858 Jul 21 12:12 r200_dri.so
 189 -rwxr-xr-x   1 brian users 11757388 Jul 21 12:12 radeon_dri.so
 190 </pre>
 191
 192 <p>
 193 If you built with Gallium support, look in lib/gallium/ for Gallium-based
 194 versions of libGL and device drivers.
 195 </p>
 196
 197
 198 <h1 id="pkg-config">6. Building OpenGL programs with pkg-config</h1>
 199
 200 <p>
 201 Running <code>make install</code> will install package configuration files
 202 for the pkg-config utility.
 203 </p>
 204
 205 <p>
 206 When compiling your OpenGL application you can use pkg-config to determine
 207 the proper compiler and linker flags.
 208 </p>
 209
 210 <p>
 211 For example, compiling and linking a GLUT application can be done with:
 212 </p>
 213 <pre>
 214    gcc `pkg-config --cflags --libs glut` mydemo.c -o mydemo
 215 </pre>
 216
 217 <br>
 218
 219 </div>
 220 </body>
 221 </html>