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