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