Gitiles
Code Review Sign In
gerrit-public.fairphone.software / fp2-dev / platform / external / mesa3d / c3fe44c5f9e8e99059d2fe4d85f24cdae89875e2 / . / docs / install.html
blob: 46d0b4c7b01886711354dcd1dfe5e55231043d34 [file] [log] [blame]
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]1<HTML>
2
Brian Paul49a3fab2008-12-30 07:57:16 -0700[diff] [blame]3<TITLE>Compiling and Installing</TITLE>
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]4
Brian Paul36da0452005-01-20 03:55:10 +0000[diff] [blame]5<link rel="stylesheet" type="text/css" href="mesa.css"></head>
6
7<BODY>
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]8
Brian Paul5f37abf2003-09-05 14:47:07 +0000[diff] [blame]9
Brian Paul49a3fab2008-12-30 07:57:16 -0700[diff] [blame]10<H1>Compiling and Installing</H1>
Brian Paul5f37abf2003-09-05 14:47:07 +0000[diff] [blame]11
12<ol>
13<li><a href="#unix-x11">Unix / X11</a>
Brian Paul49a3fab2008-12-30 07:57:16 -0700[diff] [blame]14 <ul>
Brian Paul32a11e52011-04-04 11:30:46 -0600[diff] [blame]15 <li><a href="#prereq-general">General prerequisites for building</a>
16 <li><a href="#prereq-dri">Prerequisites for DRI and hardware acceleration</a>
Brian Paul49a3fab2008-12-30 07:57:16 -0700[diff] [blame]17 <li><a href="#autoconf">Building with autoconf</a>
18 <li><a href="#traditional">Building with traditional Makefiles</a>
19 <li><a href="#libs">The Libraries</a>
Brian Paul49a3fab2008-12-30 07:57:16 -0700[diff] [blame]20 <li><a href="#install">Installing the header and library files
21 <li><a href="#pkg-config">Building OpenGL programs with pkg-config
22 </ul>
Brian Paul5f37abf2003-09-05 14:47:07 +0000[diff] [blame]23<li><a href="#windows">Windows</a>
Brian Paul32a11e52011-04-04 11:30:46 -0600[diff] [blame]24<li><a href="#scons">Building with SCons</a>
Brian Paul5f37abf2003-09-05 14:47:07 +0000[diff] [blame]25<li><a href="#other">Other</a>
26</ol>
Brian Paul49a3fab2008-12-30 07:57:16 -0700[diff] [blame]27<br>
Brian Paul5f37abf2003-09-05 14:47:07 +0000[diff] [blame]28
29
30<a name="unix-x11">
31<H2>1. Unix/X11 Compilation and Installation</H1>
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]32
Brian Paul8bd70a72008-05-27 13:27:57 -0600[diff] [blame]33
Brian Paul32a11e52011-04-04 11:30:46 -0600[diff] [blame]34<a name="prereq-general">
35<h3>1.1 General prerequisites for building</h3>
36
37<ul>
38<li>lex / yacc - for building the GLSL compiler.
39On Linux systems, flex and bison are used.
40Versions 2.5.35 and 2.4.1, respectively, (or later) should work.
Brian Paul4f869e92012-03-05 13:02:59 -0700[diff] [blame]41<br>
42<br>
43On Windows with MinGW, install flex and bison with:
44<pre>mingw-get install msys-flex msys-bison</pre>
Brian Paul32a11e52011-04-04 11:30:46 -0600[diff] [blame]45</li>
46<li>python - Python is needed for building the Gallium components.
47Version 2.6.4 or later should work.
Brian Paul4f869e92012-03-05 13:02:59 -0700[diff] [blame]48<br>
49<br>
50To build OpenGL ES 1.1 and 2.0 you'll also need
51<a href="http://xmlsoft.org/sources/win32/python/libxml2-python-2.7.7.win32-py2.7.exe">libxml2-python</a>.
Brian Paul32a11e52011-04-04 11:30:46 -0600[diff] [blame]52</li>
53</ul>
54
55
56<a name="prereq-dri">
57<h3>1.2 Prerequisites for DRI and hardware acceleration</h3>
Brian Paul5f37abf2003-09-05 14:47:07 +0000[diff] [blame]58
59<p>
Brian Paul90692482009-10-08 20:49:32 -0600[diff] [blame]60The following are required for DRI-based hardware acceleration with Mesa:
Brian Paul8bd70a72008-05-27 13:27:57 -0600[diff] [blame]61</p>
62
Brian Paul49a3fab2008-12-30 07:57:16 -0700[diff] [blame]63<ul>
Brian Pauld0c2cbd2009-01-08 17:19:51 -0700[diff] [blame]64<li><a href="http://xorg.freedesktop.org/releases/individual/proto/">dri2proto</a> version 1.99.3 or later
Brian Paul2c56dd72009-01-10 11:52:55 -0700[diff] [blame]65<li>Linux 2.6.28
66<li><a href="http://dri.freedesktop.org/libdrm/" target="_parent">libDRM</a>
Brian Paul90692482009-10-08 20:49:32 -0600[diff] [blame]67version 2.4.15 or later
Brian Paul2c56dd72009-01-10 11:52:55 -0700[diff] [blame]68<li>Xorg server version 1.5 or later
Brian Paul49a3fab2008-12-30 07:57:16 -0700[diff] [blame]69</ul>
Brian Paul8bd70a72008-05-27 13:27:57 -0600[diff] [blame]70</p>
Alex Hultmanc3fe44c2012-03-16 09:46:42 -0600[diff] [blame^]71<p>
72If you're using a fedora distro the following command should install all
73the needed dependencies:
74<pre>
75 sudo yum install flex bison imake libtool xorg-x11-proto-devel libdrm-devel \
76 gcc-c++ xorg-x11-server-devel libXi-devel libXmu-devel libXdamage-devel git \
77 expat-devel llvm-devel
78</pre>
Brian Paul8bd70a72008-05-27 13:27:57 -0600[diff] [blame]79
80
Brian Paul49a3fab2008-12-30 07:57:16 -0700[diff] [blame]81<a name="autoconf">
Brian Paul32a11e52011-04-04 11:30:46 -0600[diff] [blame]82<h3>1.3 Building with Autoconf</h3>
Brian Paul8bd70a72008-05-27 13:27:57 -0600[diff] [blame]83
84<p>
85Mesa may be <a href="autoconf.html">built using autoconf</a>.
86This should work well on most GNU-based systems.
Brian Paul49a3fab2008-12-30 07:57:16 -0700[diff] [blame]87If that fails the traditional Mesa build system is available.
Brian Paul8bd70a72008-05-27 13:27:57 -0600[diff] [blame]88
89
90
Brian Paul49a3fab2008-12-30 07:57:16 -0700[diff] [blame]91<a name="traditional">
Brian Paul32a11e52011-04-04 11:30:46 -0600[diff] [blame]92<h3>1.4 Building with traditional Makefiles</h3>
Brian Paul8bd70a72008-05-27 13:27:57 -0600[diff] [blame]93
94<p>
95The traditional Mesa build system is based on a collection of pre-defined
96system configurations.
97</p>
98<p>
Brian Paul49a3fab2008-12-30 07:57:16 -0700[diff] [blame]99To see the list of configurations, just type <code>make</code>.
100Then choose a configuration from the list and type <code>make</code>
101<em>configname</em>.
Brian Paul8bd70a72008-05-27 13:27:57 -0600[diff] [blame]102</p>
103
104<p>
105Mesa may be built in several different ways using the predefined configurations:
Brian Paul5f37abf2003-09-05 14:47:07 +0000[diff] [blame]106</p>
Brian Paulf87bb142005-07-21 18:45:44 +0000[diff] [blame]107<ul>
Brian Paul5dbd0a42006-06-08 23:42:07 +0000[diff] [blame]108<li><b><em>Stand-alone/Xlib mode</em></b> - Mesa will be compiled as
Brian Paulf87bb142005-07-21 18:45:44 +0000[diff] [blame]109a software renderer using Xlib to do all rendering.
Brian Paul5dbd0a42006-06-08 23:42:07 +0000[diff] [blame]110The libGL.so library will be a self-contained rendering library that will
111allow you to run OpenGL/GLX applications on any X server (regardless of
112whether it supports the GLX X server extension).
Brian Pauld9eff8b2006-07-12 20:14:43 +0000[diff] [blame]113You will <em>not</em> be able to use hardware 3D acceleration.
Brian Paulb0eee792003-03-16 16:43:04 +0000[diff] [blame]114<p>
Brian Paul49a3fab2008-12-30 07:57:16 -0700[diff] [blame]115To compile stand-alone Mesa type <code>make</code> in the top-level directory.
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]116You'll see a list of supported system configurations.
Brian Paul5f37abf2003-09-05 14:47:07 +0000[diff] [blame]117Choose one from the list (such as linux-x86), and type:
118</p>
119<pre>
120 make linux-x86
121</pre>
Brian Paulf87bb142005-07-21 18:45:44 +0000[diff] [blame]122<p>This will produce libGL.so and several other libraries</p>
123</li>
124
Brian Paul5dbd0a42006-06-08 23:42:07 +0000[diff] [blame]125<li><b><em>DRI/accelerated</em></b> - The DRI hardware drivers for
126accelerated OpenGL rendering (for ATI, Intel, Matrox, etc) will be built.
127The libGL.so library will support the GLX extension and will load/use
128the DRI hardware drivers.
129
Brian Paul5dbd0a42006-06-08 23:42:07 +0000[diff] [blame]130
131<p>
132Build Mesa and the DRI hardware drivers by running
Brian Paulf87bb142005-07-21 18:45:44 +0000[diff] [blame]133</p>
134<pre>
Brian Paul5dbd0a42006-06-08 23:42:07 +0000[diff] [blame]135 make linux-dri
Brian Paulf87bb142005-07-21 18:45:44 +0000[diff] [blame]136</pre>
137<p>
138There are also <code>linux-dri-x86</code>, <code>linux-dri-x86-64</code>,
Brian Paul5dbd0a42006-06-08 23:42:07 +0000[diff] [blame]139and <code>linux-ppc</code> configurations which are optimized for those
140architectures.
Brian Paulf87bb142005-07-21 18:45:44 +0000[diff] [blame]141</p>
Brian Paul8bd70a72008-05-27 13:27:57 -0600[diff] [blame]142<p>
143Make sure you have the prerequisite versions of DRM and Xserver mentioned
144above.
145</p>
Brian Paulf87bb142005-07-21 18:45:44 +0000[diff] [blame]146
147</li>
Brian Paul8bd70a72008-05-27 13:27:57 -0600[diff] [blame]148
Brian Paulf87bb142005-07-21 18:45:44 +0000[diff] [blame]149</ul>
150
151
152<p>
153Later, if you want to rebuild for a different configuration run
Brian Paul26f334a2004-03-26 15:20:08 +0000[diff] [blame]154<code>make realclean</code> before rebuilding.
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]155</p>
156
Brian Paul26f334a2004-03-26 15:20:08 +0000[diff] [blame]157
Brian Paul49a3fab2008-12-30 07:57:16 -0700[diff] [blame]158<a name="libs">
Brian Paul32a11e52011-04-04 11:30:46 -0600[diff] [blame]159<h3>1.5 The libraries</h3>
Brian Paul5f37abf2003-09-05 14:47:07 +0000[diff] [blame]160
161<p>
Brian Paulf87bb142005-07-21 18:45:44 +0000[diff] [blame]162When compilation has finished, look in the top-level <code>lib/</code>
Brian Pauld9eff8b2006-07-12 20:14:43 +0000[diff] [blame]163(or <code>lib64/</code>) directory.
Brian Paul5f37abf2003-09-05 14:47:07 +0000[diff] [blame]164You'll see a set of library files similar to this:
165</p>
166<pre>
Brian Paul26f334a2004-03-26 15:20:08 +0000[diff] [blame]167lrwxrwxrwx 1 brian users 10 Mar 26 07:53 libGL.so -> libGL.so.1*
168lrwxrwxrwx 1 brian users 19 Mar 26 07:53 libGL.so.1 -> libGL.so.1.5.060100*
169-rwxr-xr-x 1 brian users 3375861 Mar 26 07:53 libGL.so.1.5.060100*
170lrwxrwxrwx 1 brian users 11 Mar 26 07:53 libGLU.so -> libGLU.so.1*
171lrwxrwxrwx 1 brian users 20 Mar 26 07:53 libGLU.so.1 -> libGLU.so.1.3.060100*
172-rwxr-xr-x 1 brian users 549269 Mar 26 07:53 libGLU.so.1.3.060100*
173lrwxrwxrwx 1 brian users 12 Mar 26 07:53 libglut.so -> libglut.so.3*
174lrwxrwxrwx 1 brian users 16 Mar 26 07:53 libglut.so.3 -> libglut.so.3.7.1*
175-rwxr-xr-x 1 brian users 597754 Mar 26 07:53 libglut.so.3.7.1*
Brian Paul26f334a2004-03-26 15:20:08 +0000[diff] [blame]176lrwxrwxrwx 1 brian users 14 Mar 26 07:53 libOSMesa.so -> libOSMesa.so.6*
177lrwxrwxrwx 1 brian users 23 Mar 26 07:53 libOSMesa.so.6 -> libOSMesa.so.6.1.060100*
178-rwxr-xr-x 1 brian users 23871 Mar 26 07:53 libOSMesa.so.6.1.060100*
Brian Paul5f37abf2003-09-05 14:47:07 +0000[diff] [blame]179</pre>
180
181<p>
182<b>libGL</b> is the main OpenGL library (i.e. Mesa).
183<br>
184<b>libGLU</b> is the OpenGL Utility library.
185<br>
186<b>libglut</b> is the GLUT library.
Brian Paul26f334a2004-03-26 15:20:08 +0000[diff] [blame]187<br>
Brian Paul26f334a2004-03-26 15:20:08 +0000[diff] [blame]188<b>libOSMesa</b> is the OSMesa (Off-Screen) interface library.
Brian Paul5f37abf2003-09-05 14:47:07 +0000[diff] [blame]189</p>
190
Brian Paulf87bb142005-07-21 18:45:44 +0000[diff] [blame]191<p>
192If you built the DRI hardware drivers, you'll also see the DRI drivers:
193</p>
194<pre>
Brian Paul8bd70a72008-05-27 13:27:57 -0600[diff] [blame]195-rwxr-xr-x 1 brian users 16895413 Jul 21 12:11 i915_dri.so
Brian Paulf87bb142005-07-21 18:45:44 +0000[diff] [blame]196-rwxr-xr-x 1 brian users 11849858 Jul 21 12:12 r200_dri.so
Brian Paul8bd70a72008-05-27 13:27:57 -0600[diff] [blame]197-rwxr-xr-x 1 brian users 16050488 Jul 21 12:11 r300_dri.so
Brian Paulf87bb142005-07-21 18:45:44 +0000[diff] [blame]198-rwxr-xr-x 1 brian users 11757388 Jul 21 12:12 radeon_dri.so
Brian Paulf87bb142005-07-21 18:45:44 +0000[diff] [blame]199</pre>
200
Brian Paul5f37abf2003-09-05 14:47:07 +0000[diff] [blame]201<p>
Brian Paul32a11e52011-04-04 11:30:46 -0600[diff] [blame]202If you built with Gallium support, look in lib/gallium/ for Gallium-based
203versions of libGL and device drivers.
Brian Paul5f37abf2003-09-05 14:47:07 +0000[diff] [blame]204</p>
205
Brian Paul5f37abf2003-09-05 14:47:07 +0000[diff] [blame]206
207
Brian Paul49a3fab2008-12-30 07:57:16 -0700[diff] [blame]208<a name="install">
Brian Paul8bd70a72008-05-27 13:27:57 -0600[diff] [blame]209<H3>1.6 Installing the header and library files</H3>
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]210
211<p>
212The standard location for the OpenGL header files on Unix-type systems is
213in <code>/usr/include/GL/</code>.
214The standard location for the libraries is <code>/usr/lib/</code>.
215For more information see, the
216<a href="http://oss.sgi.com/projects/ogl-sample/ABI/" target="_parent">
217Linux/OpenGL ABI specification</a>.
218</p>
219
220<p>
221If you'd like Mesa to co-exist with another implementation of OpenGL that's
222already installed, you'll have to choose different directories, like
223<code>/usr/local/include/GL/</code> and <code>/usr/local/lib/</code>.
224</p>
225
226<p>
Brian Pauld9eff8b2006-07-12 20:14:43 +0000[diff] [blame]227To install Mesa's headers and libraries, run <code>make install</code>.
228But first, check the Mesa/configs/default file and examine the values
229of the <b>INSTALL_DIR</b> and <b>DRI_DRIVER_INSTALL_DIR</b> variables.
Dan Nicholsonf5557c32007-09-12 09:57:53 -0600[diff] [blame]230Change them if needed, then run <code>make install</code>.
231</p>
232
233<p>
234The variable
235<b>DESTDIR</b> may also be used to install the contents to a temporary
236staging directory.
237This can be useful for package management.
238For example: <code>make install DESTDIR=/somepath/</code>
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]239</p>
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]240
241<p>
Brian Pauld9eff8b2006-07-12 20:14:43 +0000[diff] [blame]242Note: at runtime you can use the LD_LIBRARY_PATH environment variable
243(on Linux at least) to switch
244between the Mesa libraries and other vendor's libraries whenever you want.
Brian Paul5f37abf2003-09-05 14:47:07 +0000[diff] [blame]245This is a handy way to compare multiple OpenGL implementations.
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]246</p>
247
Brian Paul5f37abf2003-09-05 14:47:07 +0000[diff] [blame]248
Brian Paul49a3fab2008-12-30 07:57:16 -0700[diff] [blame]249<a name="pkg-config">
250<H3>1.7 Building OpenGL programs with pkg-config</H3>
Brian5bba58c2007-09-12 10:11:49 -0600[diff] [blame]251
252<p>
253Running <code>make install</code> will install package configuration files
254for the pkg-config utility.
255</p>
256
257<p>
258When compiling your OpenGL application you can use pkg-config to determine
259the proper compiler and linker flags.
260</p>
261
262<p>
263For example, compiling and linking a GLUT application can be done with:
264</p>
265<pre>
266 gcc `pkg-config --cflags --libs glut` mydemo.c -o mydemo
267</pre>
268
269<br>
Brian Paul5f37abf2003-09-05 14:47:07 +0000[diff] [blame]270
271<a name="windows">
272<H2>2. Windows Compilation and Installation</H1>
273
274<p>
José Fonsecaebe07962009-06-17 10:12:11 +0100[diff] [blame]275Please see the <a href="#scons">instructions on building with SCons</a>.
Brian Paul5f37abf2003-09-05 14:47:07 +0000[diff] [blame]276</p>
277
278
279
José Fonsecaebe07962009-06-17 10:12:11 +0100[diff] [blame]280<a name="scons">
281<H2>3. Building with SCons</H1>
282
283<p>
284To build Mesa with SCons on Linux or Windows do
285</p>
286<pre>
287 scons
288</pre>
289<p>
290The build output will be placed in
291build/<i>platform</i>-<i>machine</i>-<i>debug</i>/..., where <i>platform</i> is for
292example linux or windows, <i>machine</i> is x86 or x86_64, optionally followed
293by -debug for debug builds.
294</p>
295
296<p>
José Fonsecaebe07962009-06-17 10:12:11 +0100[diff] [blame]297To build Mesa with SCons for Windows on Linux using the MinGW crosscompiler toolchain do
298</p>
299<pre>
José Fonseca282ecaf2011-08-29 13:56:20 +0100[diff] [blame]300 scons platform=windows toolchain=crossmingw machine=x86 mesagdi libgl-gdi
José Fonsecaebe07962009-06-17 10:12:11 +0100[diff] [blame]301</pre>
302<p>
303This will create:
304</p>
305<ul>
José Fonseca282ecaf2011-08-29 13:56:20 +0100[diff] [blame]306<li>build/windows-x86-debug/mesa/drivers/windows/gdi/opengl32.dll &mdash; Mesa + swrast, binary compatible with Windows's opengl32.dll
José Fonsecac4e0ae32010-03-10 12:09:16 +0000[diff] [blame]307<li>build/windows-x86-debug/gallium/targets/libgl-gdi/opengl32.dll &mdash; Mesa + Gallium + softpipe, binary compatible with Windows's opengl32.dll
José Fonsecaebe07962009-06-17 10:12:11 +0100[diff] [blame]308</ul>
309<p>
310Put them all in the same directory to test them.
311</p>
312
313
Brian Paul5f37abf2003-09-05 14:47:07 +0000[diff] [blame]314<a name="other">
José Fonsecaebe07962009-06-17 10:12:11 +0100[diff] [blame]315<H2>4. Other systems</H1>
Brian Paul5f37abf2003-09-05 14:47:07 +0000[diff] [blame]316
317<p>
318Documentation for other environments (some may be very out of date):
319</p>
320
321<UL>
Brian Paul49a3fab2008-12-30 07:57:16 -0700[diff] [blame]322<li><A HREF="README.VMS">README.VMS</A> - VMS
Guillem Jover8fd39be2011-10-04 08:46:35 +0200[diff] [blame]323<LI><A HREF="README.CYGWIN">README.CYGWIN</A> - Cygwin
324<LI><A HREF="README.WIN32">README.WIN32</A> - Win32
Brian Paul5f37abf2003-09-05 14:47:07 +0000[diff] [blame]325</UL>
326
327
328
329
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]330</body>
331</html>