Gitiles
Code Review Sign In
gerrit-public.fairphone.software / fp2-dev / platform / external / mesa3d / 32a11e5324dcad267d21188ae21bdc8f0b0f29a1 / . / docs / install.html
blob: bfa3bb8f8425aba7cf565182329a7a2683d9ddca [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.
41</li>
42<li>python - Python is needed for building the Gallium components.
43Version 2.6.4 or later should work.
44</li>
45</ul>
46
47
48<a name="prereq-dri">
49<h3>1.2 Prerequisites for DRI and hardware acceleration</h3>
Brian Paul5f37abf2003-09-05 14:47:07 +0000[diff] [blame]50
51<p>
Brian Paul90692482009-10-08 20:49:32 -0600[diff] [blame]52The following are required for DRI-based hardware acceleration with Mesa:
Brian Paul8bd70a72008-05-27 13:27:57 -0600[diff] [blame]53</p>
54
Brian Paul49a3fab2008-12-30 07:57:16 -0700[diff] [blame]55<ul>
Brian Pauld0c2cbd2009-01-08 17:19:51 -0700[diff] [blame]56<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]57<li>Linux 2.6.28
58<li><a href="http://dri.freedesktop.org/libdrm/" target="_parent">libDRM</a>
Brian Paul90692482009-10-08 20:49:32 -0600[diff] [blame]59version 2.4.15 or later
Brian Paul2c56dd72009-01-10 11:52:55 -0700[diff] [blame]60<li>Xorg server version 1.5 or later
Brian Paul49a3fab2008-12-30 07:57:16 -0700[diff] [blame]61</ul>
Brian Paul8bd70a72008-05-27 13:27:57 -0600[diff] [blame]62</p>
63
64
Brian Paul49a3fab2008-12-30 07:57:16 -0700[diff] [blame]65<a name="autoconf">
Brian Paul32a11e52011-04-04 11:30:46 -0600[diff] [blame^]66<h3>1.3 Building with Autoconf</h3>
Brian Paul8bd70a72008-05-27 13:27:57 -0600[diff] [blame]67
68<p>
69Mesa may be <a href="autoconf.html">built using autoconf</a>.
70This should work well on most GNU-based systems.
Brian Paul49a3fab2008-12-30 07:57:16 -0700[diff] [blame]71If that fails the traditional Mesa build system is available.
Brian Paul8bd70a72008-05-27 13:27:57 -0600[diff] [blame]72
73
74
Brian Paul49a3fab2008-12-30 07:57:16 -0700[diff] [blame]75<a name="traditional">
Brian Paul32a11e52011-04-04 11:30:46 -0600[diff] [blame^]76<h3>1.4 Building with traditional Makefiles</h3>
Brian Paul8bd70a72008-05-27 13:27:57 -0600[diff] [blame]77
78<p>
79The traditional Mesa build system is based on a collection of pre-defined
80system configurations.
81</p>
82<p>
Brian Paul49a3fab2008-12-30 07:57:16 -0700[diff] [blame]83To see the list of configurations, just type <code>make</code>.
84Then choose a configuration from the list and type <code>make</code>
85<em>configname</em>.
Brian Paul8bd70a72008-05-27 13:27:57 -0600[diff] [blame]86</p>
87
88<p>
89Mesa may be built in several different ways using the predefined configurations:
Brian Paul5f37abf2003-09-05 14:47:07 +0000[diff] [blame]90</p>
Brian Paulf87bb142005-07-21 18:45:44 +0000[diff] [blame]91<ul>
Brian Paul5dbd0a42006-06-08 23:42:07 +0000[diff] [blame]92<li><b><em>Stand-alone/Xlib mode</em></b> - Mesa will be compiled as
Brian Paulf87bb142005-07-21 18:45:44 +0000[diff] [blame]93a software renderer using Xlib to do all rendering.
Brian Paul5dbd0a42006-06-08 23:42:07 +0000[diff] [blame]94The libGL.so library will be a self-contained rendering library that will
95allow you to run OpenGL/GLX applications on any X server (regardless of
96whether it supports the GLX X server extension).
Brian Pauld9eff8b2006-07-12 20:14:43 +0000[diff] [blame]97You will <em>not</em> be able to use hardware 3D acceleration.
Brian Paulb0eee792003-03-16 16:43:04 +0000[diff] [blame]98<p>
Brian Paul49a3fab2008-12-30 07:57:16 -0700[diff] [blame]99To compile stand-alone Mesa type <code>make</code> in the top-level directory.
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]100You'll see a list of supported system configurations.
Brian Paul5f37abf2003-09-05 14:47:07 +0000[diff] [blame]101Choose one from the list (such as linux-x86), and type:
102</p>
103<pre>
104 make linux-x86
105</pre>
Brian Paulf87bb142005-07-21 18:45:44 +0000[diff] [blame]106<p>This will produce libGL.so and several other libraries</p>
107</li>
108
Brian Paul5dbd0a42006-06-08 23:42:07 +0000[diff] [blame]109<li><b><em>DRI/accelerated</em></b> - The DRI hardware drivers for
110accelerated OpenGL rendering (for ATI, Intel, Matrox, etc) will be built.
111The libGL.so library will support the GLX extension and will load/use
112the DRI hardware drivers.
113
Brian Paul5dbd0a42006-06-08 23:42:07 +0000[diff] [blame]114
115<p>
116Build Mesa and the DRI hardware drivers by running
Brian Paulf87bb142005-07-21 18:45:44 +0000[diff] [blame]117</p>
118<pre>
Brian Paul5dbd0a42006-06-08 23:42:07 +0000[diff] [blame]119 make linux-dri
Brian Paulf87bb142005-07-21 18:45:44 +0000[diff] [blame]120</pre>
121<p>
122There are also <code>linux-dri-x86</code>, <code>linux-dri-x86-64</code>,
Brian Paul5dbd0a42006-06-08 23:42:07 +0000[diff] [blame]123and <code>linux-ppc</code> configurations which are optimized for those
124architectures.
Brian Paulf87bb142005-07-21 18:45:44 +0000[diff] [blame]125</p>
Brian Paul8bd70a72008-05-27 13:27:57 -0600[diff] [blame]126<p>
127Make sure you have the prerequisite versions of DRM and Xserver mentioned
128above.
129</p>
Brian Paulf87bb142005-07-21 18:45:44 +0000[diff] [blame]130
131</li>
Brian Paul8bd70a72008-05-27 13:27:57 -0600[diff] [blame]132
Brian Paulf87bb142005-07-21 18:45:44 +0000[diff] [blame]133</ul>
134
135
136<p>
137Later, if you want to rebuild for a different configuration run
Brian Paul26f334a2004-03-26 15:20:08 +0000[diff] [blame]138<code>make realclean</code> before rebuilding.
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]139</p>
140
Brian Paul26f334a2004-03-26 15:20:08 +0000[diff] [blame]141
Brian Paul49a3fab2008-12-30 07:57:16 -0700[diff] [blame]142<a name="libs">
Brian Paul32a11e52011-04-04 11:30:46 -0600[diff] [blame^]143<h3>1.5 The libraries</h3>
Brian Paul5f37abf2003-09-05 14:47:07 +0000[diff] [blame]144
145<p>
Brian Paulf87bb142005-07-21 18:45:44 +0000[diff] [blame]146When compilation has finished, look in the top-level <code>lib/</code>
Brian Pauld9eff8b2006-07-12 20:14:43 +0000[diff] [blame]147(or <code>lib64/</code>) directory.
Brian Paul5f37abf2003-09-05 14:47:07 +0000[diff] [blame]148You'll see a set of library files similar to this:
149</p>
150<pre>
Brian Paul26f334a2004-03-26 15:20:08 +0000[diff] [blame]151lrwxrwxrwx 1 brian users 10 Mar 26 07:53 libGL.so -> libGL.so.1*
152lrwxrwxrwx 1 brian users 19 Mar 26 07:53 libGL.so.1 -> libGL.so.1.5.060100*
153-rwxr-xr-x 1 brian users 3375861 Mar 26 07:53 libGL.so.1.5.060100*
154lrwxrwxrwx 1 brian users 11 Mar 26 07:53 libGLU.so -> libGLU.so.1*
155lrwxrwxrwx 1 brian users 20 Mar 26 07:53 libGLU.so.1 -> libGLU.so.1.3.060100*
156-rwxr-xr-x 1 brian users 549269 Mar 26 07:53 libGLU.so.1.3.060100*
157lrwxrwxrwx 1 brian users 12 Mar 26 07:53 libglut.so -> libglut.so.3*
158lrwxrwxrwx 1 brian users 16 Mar 26 07:53 libglut.so.3 -> libglut.so.3.7.1*
159-rwxr-xr-x 1 brian users 597754 Mar 26 07:53 libglut.so.3.7.1*
160lrwxrwxrwx 1 brian users 11 Mar 26 08:04 libGLw.so -> libGLw.so.1*
161lrwxrwxrwx 1 brian users 15 Mar 26 08:04 libGLw.so.1 -> libGLw.so.1.0.0*
162-rwxr-xr-x 1 brian users 20750 Mar 26 08:04 libGLw.so.1.0.0*
163lrwxrwxrwx 1 brian users 14 Mar 26 07:53 libOSMesa.so -> libOSMesa.so.6*
164lrwxrwxrwx 1 brian users 23 Mar 26 07:53 libOSMesa.so.6 -> libOSMesa.so.6.1.060100*
165-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]166</pre>
167
168<p>
169<b>libGL</b> is the main OpenGL library (i.e. Mesa).
170<br>
171<b>libGLU</b> is the OpenGL Utility library.
172<br>
173<b>libglut</b> is the GLUT library.
Brian Paul26f334a2004-03-26 15:20:08 +0000[diff] [blame]174<br>
175<b>libGLw</b> is the Xt/Motif OpenGL drawing area widget library.
176<br>
177<b>libOSMesa</b> is the OSMesa (Off-Screen) interface library.
Brian Paul5f37abf2003-09-05 14:47:07 +0000[diff] [blame]178</p>
179
Brian Paulf87bb142005-07-21 18:45:44 +0000[diff] [blame]180<p>
181If you built the DRI hardware drivers, you'll also see the DRI drivers:
182</p>
183<pre>
Brian Paul8bd70a72008-05-27 13:27:57 -0600[diff] [blame]184-rwxr-xr-x 1 brian users 15607851 Jul 21 12:11 ffb_dri.so
185-rwxr-xr-x 1 brian users 15148747 Jul 21 12:11 i810_dri.so
186-rwxr-xr-x 1 brian users 14497814 Jul 21 12:11 i830_dri.so
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 11320803 Jul 21 12:11 mach64_dri.so
189-rwxr-xr-x 1 brian users 11418014 Jul 21 12:12 mga_dri.so
190-rwxr-xr-x 1 brian users 11064426 Jul 21 12:12 r128_dri.so
191-rwxr-xr-x 1 brian users 11849858 Jul 21 12:12 r200_dri.so
Brian Paul8bd70a72008-05-27 13:27:57 -0600[diff] [blame]192-rwxr-xr-x 1 brian users 16050488 Jul 21 12:11 r300_dri.so
Brian Paulf87bb142005-07-21 18:45:44 +0000[diff] [blame]193-rwxr-xr-x 1 brian users 11757388 Jul 21 12:12 radeon_dri.so
194-rwxr-xr-x 1 brian users 11232304 Jul 21 12:13 s3v_dri.so
195-rwxr-xr-x 1 brian users 11062970 Jul 21 12:13 savage_dri.so
196-rwxr-xr-x 1 brian users 11214212 Jul 21 12:13 sis_dri.so
197-rwxr-xr-x 1 brian users 11368736 Jul 21 12:13 tdfx_dri.so
198-rwxr-xr-x 1 brian users 10598868 Jul 21 12:13 trident_dri.so
199-rwxr-xr-x 1 brian users 10997120 Jul 21 12:13 unichrome_dri.so
200</pre>
201
Brian Paul5f37abf2003-09-05 14:47:07 +0000[diff] [blame]202<p>
Brian Paul32a11e52011-04-04 11:30:46 -0600[diff] [blame^]203If you built with Gallium support, look in lib/gallium/ for Gallium-based
204versions of libGL and device drivers.
Brian Paul5f37abf2003-09-05 14:47:07 +0000[diff] [blame]205</p>
206
Brian Paul5f37abf2003-09-05 14:47:07 +0000[diff] [blame]207
208
Brian Paul49a3fab2008-12-30 07:57:16 -0700[diff] [blame]209<a name="install">
Brian Paul8bd70a72008-05-27 13:27:57 -0600[diff] [blame]210<H3>1.6 Installing the header and library files</H3>
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]211
212<p>
213The standard location for the OpenGL header files on Unix-type systems is
214in <code>/usr/include/GL/</code>.
215The standard location for the libraries is <code>/usr/lib/</code>.
216For more information see, the
217<a href="http://oss.sgi.com/projects/ogl-sample/ABI/" target="_parent">
218Linux/OpenGL ABI specification</a>.
219</p>
220
221<p>
222If you'd like Mesa to co-exist with another implementation of OpenGL that's
223already installed, you'll have to choose different directories, like
224<code>/usr/local/include/GL/</code> and <code>/usr/local/lib/</code>.
225</p>
226
227<p>
Brian Pauld9eff8b2006-07-12 20:14:43 +0000[diff] [blame]228To install Mesa's headers and libraries, run <code>make install</code>.
229But first, check the Mesa/configs/default file and examine the values
230of the <b>INSTALL_DIR</b> and <b>DRI_DRIVER_INSTALL_DIR</b> variables.
Dan Nicholsonf5557c32007-09-12 09:57:53 -0600[diff] [blame]231Change them if needed, then run <code>make install</code>.
232</p>
233
234<p>
235The variable
236<b>DESTDIR</b> may also be used to install the contents to a temporary
237staging directory.
238This can be useful for package management.
239For example: <code>make install DESTDIR=/somepath/</code>
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]240</p>
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]241
242<p>
Brian Pauld9eff8b2006-07-12 20:14:43 +0000[diff] [blame]243Note: at runtime you can use the LD_LIBRARY_PATH environment variable
244(on Linux at least) to switch
245between the Mesa libraries and other vendor's libraries whenever you want.
Brian Paul5f37abf2003-09-05 14:47:07 +0000[diff] [blame]246This is a handy way to compare multiple OpenGL implementations.
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]247</p>
248
Brian Paul5f37abf2003-09-05 14:47:07 +0000[diff] [blame]249
Brian Paul49a3fab2008-12-30 07:57:16 -0700[diff] [blame]250<a name="pkg-config">
251<H3>1.7 Building OpenGL programs with pkg-config</H3>
Brian5bba58c2007-09-12 10:11:49 -0600[diff] [blame]252
253<p>
254Running <code>make install</code> will install package configuration files
255for the pkg-config utility.
256</p>
257
258<p>
259When compiling your OpenGL application you can use pkg-config to determine
260the proper compiler and linker flags.
261</p>
262
263<p>
264For 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>
Brian Paul5f37abf2003-09-05 14:47:07 +0000[diff] [blame]271
272<a name="windows">
273<H2>2. Windows Compilation and Installation</H1>
274
275<p>
José Fonsecaebe07962009-06-17 10:12:11 +0100[diff] [blame]276Please see the <a href="#scons">instructions on building with SCons</a>.
277Alternatively see <a href="README.WIN32">README.WIN32</a> file.
Brian Paul5f37abf2003-09-05 14:47:07 +0000[diff] [blame]278</p>
279
280
281
José Fonsecaebe07962009-06-17 10:12:11 +0100[diff] [blame]282<a name="scons">
283<H2>3. Building with SCons</H1>
284
285<p>
286To build Mesa with SCons on Linux or Windows do
287</p>
288<pre>
289 scons
290</pre>
291<p>
292The build output will be placed in
293build/<i>platform</i>-<i>machine</i>-<i>debug</i>/..., where <i>platform</i> is for
294example linux or windows, <i>machine</i> is x86 or x86_64, optionally followed
295by -debug for debug builds.
296</p>
297
298<p>
José Fonsecaebe07962009-06-17 10:12:11 +0100[diff] [blame]299To build Mesa with SCons for Windows on Linux using the MinGW crosscompiler toolchain do
300</p>
301<pre>
302 scons platform=windows toolchain=crossmingw machine=x86 statetrackers=mesa drivers=softpipe,trace winsys=gdi
José Fonsecaebe07962009-06-17 10:12:11 +0100[diff] [blame]303</pre>
304<p>
305This will create:
306</p>
307<ul>
José Fonsecac4e0ae32010-03-10 12:09:16 +0000[diff] [blame]308<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]309<li>build/windows-x86-debug/glut/glx/glut32.dll
310<li>progs/build/windows-x86-debug/wgl/wglinfo.exe
311<li>progs/build/windows-x86-debug/trivial/tri.exe
312<li>and many other samples in progs/build/windows-x86-debug/...
313</ul>
314<p>
315Put them all in the same directory to test them.
316</p>
317
318
Brian Paul5f37abf2003-09-05 14:47:07 +0000[diff] [blame]319<a name="other">
José Fonsecaebe07962009-06-17 10:12:11 +0100[diff] [blame]320<H2>4. Other systems</H1>
Brian Paul5f37abf2003-09-05 14:47:07 +0000[diff] [blame]321
322<p>
323Documentation for other environments (some may be very out of date):
324</p>
325
326<UL>
Brian Paul49a3fab2008-12-30 07:57:16 -0700[diff] [blame]327<li><A HREF="README.VMS">README.VMS</A> - VMS
Brian Paul5f37abf2003-09-05 14:47:07 +0000[diff] [blame]328<LI><A HREF="README.GGI">README.GGI</A> - GGI
329<LI><A HREF="README.3DFX">README.3DFX</A> - 3Dfx/Glide driver
330<LI><A HREF="README.AMIWIN">README.AMIWIN</A> - Amiga Amiwin
331<LI><A HREF="README.BEOS">README.BEOS</A> - BeOS
332<LI><A HREF="README.D3D">README.D3D</A> - Direct3D driver
333<LI><A HREF="README.DJ">README.DJ</A> - DJGPP
334<LI><A HREF="README.LYNXOS">README.LYNXOS</A> - LynxOS
335<LI><A HREF="README.MINGW32">README.MINGW32</A> - Mingw32
336<LI><A HREF="README.NeXT">README.NeXT</A> - NeXT
337<LI><A HREF="README.OpenStep">README.OpenStep</A> - OpenStep
338<LI><A HREF="README.OS2">README.OS2</A> - OS/2
339<LI><A HREF="README.WINDML">README.WINDML</A> - WindML
340</UL>
341
342
343
344
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]345</body>
346</html>