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="#meson">Building with meson</a>
  26 <li><a href="#autoconf">Building with autoconf (Linux/Unix/X11)</a>
  27 <li><a href="#scons">Building with SCons (Windows/Linux)</a>
  28 <li><a href="#android">Building with AOSP (Android)</a>
  29 <li><a href="#libs">Library Information</a>
  30 <li><a href="#pkg-config">Building OpenGL programs with pkg-config</a>
  31 </ol>
  32
  33
  34 <h1 id="prereq-general">1. Prerequisites for building</h1>
  35
  36 <h2>1.1 General</h2>
  37
  38 <p>
  39 Build system.
  40 </p>
  41
  42 <ul>
  43 <li><a href="https://mesonbuild.com">meson</a> is recommended when building on *nix platforms.
  44 <li>Autoconf is another option when building on *nix platforms.
  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 or meson.)
  47 </li>
  48 <li>Android Build system when building as native Android component. Autoconf
  49 is used when when building ARC.
  50 </li>
  51 </ul>
  52
  53
  54 <p>
  55 The following compilers are known to work, if you know of others or you're
  56 willing to maintain support for other compiler get in touch.
  57 </p>
  58
  59 <ul>
  60 <li>GCC 4.2.0 or later (some parts of Mesa may require later versions)
  61 <li>clang - exact minimum requirement is currently unknown.
  62 <li>Microsoft Visual Studio 2015 or later is required, for building on Windows.
  63 </ul>
  64
  65
  66 <p>
  67 Third party/extra tools.
  68 <br>
  69 <strong>Note</strong>: These should not be required, when building from a release tarball. If
  70 you think you've spotted a bug let developers know by filing a
  71 <a href="bugs.html">bug report</a>.
  72 </p>
  73
  74
  75 <ul>
  76 <li><a href="https://www.python.org/">Python</a> - Python is required.
  77 Version 2.7 or later should work.
  78 </li>
  79 <li><a href="http://www.makotemplates.org/">Python Mako module</a> -
  80 Python Mako module is required. Version 0.8.0 or later should work.
  81 </li>
  82 <li>lex / yacc - for building the Mesa IR and GLSL compiler.
  83 <div>
  84 On Linux systems, flex and bison versions 2.5.35 and 2.4.1, respectively,
  85 (or later) should work.
  86 On Windows with MinGW, install flex and bison with:
  87 <pre>mingw-get install msys-flex msys-bison</pre>
  88 For MSVC on Windows, install
  89 <a href="http://winflexbison.sourceforge.net/">Win flex-bison</a>.
  90 </div>
  91 </ul>
  92 <p><strong>Note</strong>: Some versions can be buggy (eg. flex 2.6.2) so do try others if things fail.</p>
  93
  94
  95 <h3 id="prereq-dri">1.2 Requirements</h3>
  96
  97 <p>
  98 The requirements depends on the features selected at configure stage.
  99 Check/install the respective -devel package as prompted by the configure error
 100 message.
 101 </p>
 102
 103 <p>
 104 Here are some common ways to retrieve most/all of the dependencies based on
 105 the packaging tool used by your distro.
 106 </p>
 107
 108 <pre>
 109   zypper source-install --build-deps-only Mesa # openSUSE/SLED/SLES
 110   yum-builddep mesa # yum Fedora, OpenSuse(?)
 111   dnf builddep mesa # dnf Fedora
 112   apt-get build-dep mesa # Debian and derivatives
 113   ... # others
 114 </pre>
 115
 116 <h1 id="meson">2. Building with meson</h1>
 117
 118 <p>
 119 Meson is the latest build system in mesa, it is currently able to build for
 120 *nix systems like Linux and BSD, and will be able to build for windows as well.
 121 </p>
 122
 123 <p>
 124 The general approach is:
 125 </p>
 126 <pre>
 127   meson builddir/
 128   ninja -C builddir/
 129   sudo ninja -C builddir/ install
 130 </pre>
 131 <p>
 132 Please read the <a href="meson.html">detailed meson instructions</a>
 133 for more information
 134 </p>
 135
 136 <h1 id="autoconf">3. Building with autoconf (Linux/Unix/X11)</h1>
 137
 138 <p>
 139 Although meson is recommended, another supported way to build on *nix systems
 140 is with autoconf.
 141 </p>
 142
 143 <p>
 144 The general approach is the standard:
 145 </p>
 146 <pre>
 147   ./configure
 148   make
 149   sudo make install
 150 </pre>
 151 <p>
 152 But please read the <a href="autoconf.html">detailed autoconf instructions</a>
 153 for more details.
 154 </p>
 155
 156
 157
 158 <h1 id="scons">4. Building with SCons (Windows/Linux)</h1>
 159
 160 <p>
 161 To build Mesa with SCons on Linux or Windows do
 162 </p>
 163 <pre>
 164     scons
 165 </pre>
 166 <p>
 167 The build output will be placed in
 168 build/<i>platform</i>-<i>machine</i>-<i>debug</i>/..., where <i>platform</i> is for
 169 example linux or windows, <i>machine</i> is x86 or x86_64, optionally followed
 170 by -debug for debug builds.
 171 </p>
 172
 173 <p>
 174 To build Mesa with SCons for Windows on Linux using the MinGW crosscompiler toolchain do
 175 </p>
 176 <pre>
 177     scons platform=windows toolchain=crossmingw machine=x86 libgl-gdi
 178 </pre>
 179 <p>
 180 This will create:
 181 </p>
 182 <ul>
 183 <li>build/windows-x86-debug/gallium/targets/libgl-gdi/opengl32.dll &mdash; Mesa + Gallium + softpipe (or llvmpipe), binary compatible with Windows's opengl32.dll
 184 </ul>
 185 <p>
 186 Put them all in the same directory to test them.
 187
 188 Additional information is available in <a href="README.WIN32">README.WIN32</a>.
 189
 190 </p>
 191
 192
 193
 194 <h1 id="android">5. Building with AOSP (Android)</h1>
 195
 196 <p>
 197 Currently one can build Mesa for Android as part of the AOSP project, yet
 198 your experience might vary.
 199 </p>
 200
 201 <p>
 202 In order to achieve that one should update their local manifest to point to the
 203 upstream repo, set the appropriate BOARD_GPU_DRIVERS and build the
 204 libGLES_mesa library.
 205 </p>
 206
 207 <p>
 208 FINISHME: Improve on the instructions add references to Rob H repos/Jenkins,
 209 Android-x86 and/or other resources.
 210 </p>
 211
 212
 213 <h1 id="libs">6. Library Information</h1>
 214
 215 <p>
 216 When compilation has finished, look in the top-level <code>lib/</code>
 217 (or <code>lib64/</code>) directory.
 218 You'll see a set of library files similar to this:
 219 </p>
 220 <pre>
 221 lrwxrwxrwx    1 brian    users          10 Mar 26 07:53 libGL.so -> libGL.so.1*
 222 lrwxrwxrwx    1 brian    users          19 Mar 26 07:53 libGL.so.1 -> libGL.so.1.5.060100*
 223 -rwxr-xr-x    1 brian    users     3375861 Mar 26 07:53 libGL.so.1.5.060100*
 224 lrwxrwxrwx    1 brian    users          14 Mar 26 07:53 libOSMesa.so -> libOSMesa.so.6*
 225 lrwxrwxrwx    1 brian    users          23 Mar 26 07:53 libOSMesa.so.6 -> libOSMesa.so.6.1.060100*
 226 -rwxr-xr-x    1 brian    users       23871 Mar 26 07:53 libOSMesa.so.6.1.060100*
 227 </pre>
 228
 229 <p>
 230 <b>libGL</b> is the main OpenGL library (i.e. Mesa).
 231 <br>
 232 <b>libOSMesa</b> is the OSMesa (Off-Screen) interface library.
 233 </p>
 234
 235 <p>
 236 If you built the DRI hardware drivers, you'll also see the DRI drivers:
 237 </p>
 238 <pre>
 239 -rwxr-xr-x   1 brian users 16895413 Jul 21 12:11 i915_dri.so
 240 -rwxr-xr-x   1 brian users 16895413 Jul 21 12:11 i965_dri.so
 241 -rwxr-xr-x   1 brian users 11849858 Jul 21 12:12 r200_dri.so
 242 -rwxr-xr-x   1 brian users 11757388 Jul 21 12:12 radeon_dri.so
 243 </pre>
 244
 245 <p>
 246 If you built with Gallium support, look in lib/gallium/ for Gallium-based
 247 versions of libGL and device drivers.
 248 </p>
 249
 250
 251 <h1 id="pkg-config">7. Building OpenGL programs with pkg-config</h1>
 252
 253 <p>
 254 Running <code>make install</code> will install package configuration files
 255 for the pkg-config utility.
 256 </p>
 257
 258 <p>
 259 When compiling your OpenGL application you can use pkg-config to determine
 260 the proper compiler and linker flags.
 261 </p>
 262
 263 <p>
 264 For example, compiling and linking a GLUT application can be done with:
 265 </p>
 266 <pre>
 267    gcc `pkg-config --cflags --libs glut` mydemo.c -o mydemo
 268 </pre>
 269
 270 <br>
 271
 272 </div>
 273 </body>
 274 </html>