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