Blame - docs/install.html - platform/external/mesa3d

blob: 7a690c9ef9b423352b51ed3340172cf6b2777ca4 [file] [log] [blame]

Andreas Boll	ecd5c7c	2012-06-12 09:05:03 +0200	[diff] [blame]	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>
Brian Paul	0b27ace	2003-03-08 17:38:57 +0000	[diff] [blame]	9
Andreas Boll	b5da52a	2012-09-18 18:57:02 +0200	[diff] [blame]	10	<div class="header">
				11	<h1>The Mesa 3D Graphics Library</h1>
				12	</div>
				13
				14	<iframe src="contents.html"></iframe>
				15	<div class="content">
				16
Andreas Boll	ecd5c7c	2012-06-12 09:05:03 +0200	[diff] [blame]	17	<h1>Compiling and Installing</h1>
Brian Paul	5f37abf	2003-09-05 14:47:07 +0000	[diff] [blame]	18
				19	<ol>
Brian Paul	7103a18	2012-04-19 09:56:36 -0600	[diff] [blame]	20	<li><a href="#prereq-general">Prerequisites for building</a>
Brian Paul	49a3fab	2008-12-30 07:57:16 -0700	[diff] [blame]	21	<ul>
Brian Paul	7103a18	2012-04-19 09:56:36 -0600	[diff] [blame]	22	<li><a href="#prereq-general">General prerequisites</a>
				23	<li><a href="#prereq-dri">For DRI and hardware acceleration</a>
Brian Paul	49a3fab	2008-12-30 07:57:16 -0700	[diff] [blame]	24	</ul>
Brian Paul	7103a18	2012-04-19 09:56:36 -0600	[diff] [blame]	25	<li><a href="#autoconf">Building with autoconf (Linux/Unix/X11)</a>
Brian Paul	adc58e9	2012-06-01 09:19:36 -0600	[diff] [blame]	26	<li><a href="#scons">Building with SCons (Windows/Linux)</a>
Emil Velikov	0fa854a	2016-06-29 13:13:25 +0100	[diff] [blame]	27	<li><a href="#android">Building with AOSP (Android)</a>
Brian Paul	7103a18	2012-04-19 09:56:36 -0600	[diff] [blame]	28	<li><a href="#libs">Library Information</a>
Andreas Boll	df2be22	2012-06-12 09:05:22 +0200	[diff] [blame]	29	<li><a href="#pkg-config">Building OpenGL programs with pkg-config</a>
Brian Paul	5f37abf	2003-09-05 14:47:07 +0000	[diff] [blame]	30	</ol>
Brian Paul	0b27ace	2003-03-08 17:38:57 +0000	[diff] [blame]	31
Brian Paul	8bd70a7	2008-05-27 13:27:57 -0600	[diff] [blame]	32
Andreas Boll	cc41888	2012-06-12 09:05:33 +0200	[diff] [blame]	33	<h1 id="prereq-general">1. Prerequisites for building</h1>
Brian Paul	32a11e5	2011-04-04 11:30:46 -0600	[diff] [blame]	34
Brian Paul	7103a18	2012-04-19 09:56:36 -0600	[diff] [blame]	35	<h2>1.1 General</h2>
Emil Velikov	0fa854a	2016-06-29 13:13:25 +0100	[diff] [blame]	36
				37	<p>
				38	Build system.
				39	</p>
				40
				41	<ul>
				42	<li>Autoconf is required when building on *nix platforms.
				43	<li><a href="http://www.scons.org/">SCons</a> is required for building on
				44	Windows and optional for Linux (it's an alternative to autoconf/automake.)
				45	</li>
				46	<li>Android Build system when building as native Android component. Autoconf
				47	is used when when building ARC.
				48	</li>
				49	</ul>
				50
				51
				52	<p>
				53	The following compilers are known to work, if you know of others or you're
				54	willing to maintain support for other compiler get in touch.
				55	</p>
				56
				57	<ul>
				58	<li>GCC 4.2.0 or later (some parts of Mesa may require later versions)
				59	<li>clang - exact minimum requirement is currently unknown.
				60	<li>Microsoft Visual Studio 2013 Update 4 or later is required, for building on Windows.
				61	</ul>
				62
				63
				64	<p>
				65	Third party/extra tools.
				66	<br>
				67	<strong>Note</strong>: These should not be required, when building from a release tarball. If
				68	you think you've spotted a bug let developers know by filing a
				69	<a href="bugs.html">bug report</a>.
				70	</p>
				71
				72
Brian Paul	32a11e5	2011-04-04 11:30:46 -0600	[diff] [blame]	73	<ul>
Brian Paul	7568825	2014-05-19 07:54:30 -0600	[diff] [blame]	74	<li><a href="http://www.python.org/">Python</a> - Python is required.
				75	Version 2.6.4 or later should work.
				76	</li>
Samuel Iglesias Gonsalvez	2b37bea	2014-11-21 08:53:21 +0100	[diff] [blame]	77	<li><a href="http://www.makotemplates.org/">Python Mako module</a> -
Samuel Iglesias Gonsálvez	98ceb60	2015-11-25 16:33:47 +0100	[diff] [blame]	78	Python Mako module is required. Version 0.3.4 or later should work.
Samuel Iglesias Gonsalvez	2b37bea	2014-11-21 08:53:21 +0100	[diff] [blame]	79	</li>
Emil Velikov	0fa854a	2016-06-29 13:13:25 +0100	[diff] [blame]	80	<li>lex / yacc - for building the Mesa IR and GLSL compiler.
				81	<div>
				82	On Linux systems, flex and bison versions 2.5.35 and 2.4.1, respectively,
				83	(or later) should work.
Brian Paul	4f869e9	2012-03-05 13:02:59 -0700	[diff] [blame]	84	On Windows with MinGW, install flex and bison with:
				85	<pre>mingw-get install msys-flex msys-bison</pre>
Jose Fonseca	9c1c657	2015-03-19 13:30:19 +0000	[diff] [blame]	86	For MSVC on Windows, install
				87	<a href="http://winflexbison.sourceforge.net/">Win flex-bison</a>.
Emil Velikov	0fa854a	2016-06-29 13:13:25 +0100	[diff] [blame]	88	</div>
Brian Paul	32a11e5	2011-04-04 11:30:46 -0600	[diff] [blame]	89	</ul>
Emil Velikov	0fa854a	2016-06-29 13:13:25 +0100	[diff] [blame]	90	<p><strong>Note</strong>: Some versions can be buggy (eg. flex 2.6.2) so do try others if things fail.</p>
Brian Paul	32a11e5	2011-04-04 11:30:46 -0600	[diff] [blame]	91
				92
Emil Velikov	0fa854a	2016-06-29 13:13:25 +0100	[diff] [blame]	93	<h3 id="prereq-dri">1.2 Requirements</h3>
Brian Paul	5f37abf	2003-09-05 14:47:07 +0000	[diff] [blame]	94
				95	<p>
Emil Velikov	0fa854a	2016-06-29 13:13:25 +0100	[diff] [blame]	96	The requirements depends on the features selected at configure stage.
				97	Check/install the respective -devel package as prompted by the configure error
				98	message.
Brian Paul	8bd70a7	2008-05-27 13:27:57 -0600	[diff] [blame]	99	</p>
				100
Alex Hultman	c3fe44c	2012-03-16 09:46:42 -0600	[diff] [blame]	101	<p>
Emil Velikov	0fa854a	2016-06-29 13:13:25 +0100	[diff] [blame]	102	Here are some common ways to retrieve most/all of the dependencies based on
				103	the packaging tool used by your distro.
Andreas Boll	df2be22	2012-06-12 09:05:22 +0200	[diff] [blame]	104	</p>
Emil Velikov	0fa854a	2016-06-29 13:13:25 +0100	[diff] [blame]	105
Alex Hultman	c3fe44c	2012-03-16 09:46:42 -0600	[diff] [blame]	106	<pre>
Emil Velikov	0fa854a	2016-06-29 13:13:25 +0100	[diff] [blame]	107	zypper source-install --build-deps-only Mesa # openSUSE/SLED/SLES
				108	yum-builddep mesa # yum Fedora, OpenSuse(?)
				109	dnf builddep mesa # dnf Fedora
				110	apt-get build-dep mesa # Debian and derivatives
				111	... # others
Alex Hultman	c3fe44c	2012-03-16 09:46:42 -0600	[diff] [blame]	112	</pre>
Brian Paul	8bd70a7	2008-05-27 13:27:57 -0600	[diff] [blame]	113
				114
Andreas Boll	210a27d	2012-06-12 09:05:36 +0200	[diff] [blame]	115	<h1 id="autoconf">2. Building with autoconf (Linux/Unix/X11)</h1>
Brian Paul	8bd70a7	2008-05-27 13:27:57 -0600	[diff] [blame]	116
				117	<p>
Brian Paul	7103a18	2012-04-19 09:56:36 -0600	[diff] [blame]	118	The primary method to build Mesa on Unix systems is with autoconf.
				119	</p>
Brian Paul	8bd70a7	2008-05-27 13:27:57 -0600	[diff] [blame]	120
				121	<p>
Brian Paul	7103a18	2012-04-19 09:56:36 -0600	[diff] [blame]	122	The general approach is the standard:
Andreas Boll	df2be22	2012-06-12 09:05:22 +0200	[diff] [blame]	123	</p>
Brian Paul	7103a18	2012-04-19 09:56:36 -0600	[diff] [blame]	124	<pre>
				125	./configure
				126	make
				127	sudo make install
				128	</pre>
Andreas Boll	df2be22	2012-06-12 09:05:22 +0200	[diff] [blame]	129	<p>
Brian Paul	7103a18	2012-04-19 09:56:36 -0600	[diff] [blame]	130	But please read the <a href="autoconf.html">detailed autoconf instructions</a>
				131	for more details.
				132	</p>
				133
				134
				135
Andreas Boll	210a27d	2012-06-12 09:05:36 +0200	[diff] [blame]	136	<h1 id="scons">3. Building with SCons (Windows/Linux)</h1>
Brian Paul	7103a18	2012-04-19 09:56:36 -0600	[diff] [blame]	137
				138	<p>
				139	To build Mesa with SCons on Linux or Windows do
				140	</p>
				141	<pre>
				142	scons
				143	</pre>
				144	<p>
				145	The build output will be placed in
				146	build/<i>platform</i>-<i>machine</i>-<i>debug</i>/..., where <i>platform</i> is for
				147	example linux or windows, <i>machine</i> is x86 or x86_64, optionally followed
				148	by -debug for debug builds.
				149	</p>
				150
				151	<p>
				152	To build Mesa with SCons for Windows on Linux using the MinGW crosscompiler toolchain do
				153	</p>
				154	<pre>
Jose Fonseca	17b2825	2015-03-03 14:52:15 +0000	[diff] [blame]	155	scons platform=windows toolchain=crossmingw machine=x86 libgl-gdi
Brian Paul	7103a18	2012-04-19 09:56:36 -0600	[diff] [blame]	156	</pre>
				157	<p>
				158	This will create:
				159	</p>
				160	<ul>
Jose Fonseca	17b2825	2015-03-03 14:52:15 +0000	[diff] [blame]	161	<li>build/windows-x86-debug/gallium/targets/libgl-gdi/opengl32.dll — Mesa + Gallium + softpipe (or llvmpipe), binary compatible with Windows's opengl32.dll
Brian Paul	7103a18	2012-04-19 09:56:36 -0600	[diff] [blame]	162	</ul>
				163	<p>
				164	Put them all in the same directory to test them.
Emil Velikov	0fa854a	2016-06-29 13:13:25 +0100	[diff] [blame]	165
				166	Additional information is available in <a href="README.WIN32">README.WIN32</a>.
				167
Brian Paul	7103a18	2012-04-19 09:56:36 -0600	[diff] [blame]	168	</p>
				169
				170
				171
Emil Velikov	0fa854a	2016-06-29 13:13:25 +0100	[diff] [blame]	172	<h1 id="android">4. Building with AOSP (Android)</h1>
Brian Paul	7103a18	2012-04-19 09:56:36 -0600	[diff] [blame]	173
				174	<p>
Emil Velikov	0fa854a	2016-06-29 13:13:25 +0100	[diff] [blame]	175	Currently one can build Mesa for Android as part of the AOSP project, yet
				176	your experience might vary.
Brian Paul	7103a18	2012-04-19 09:56:36 -0600	[diff] [blame]	177	</p>
				178
Emil Velikov	0fa854a	2016-06-29 13:13:25 +0100	[diff] [blame]	179	<p>
				180	In order to achieve that one should update their local manifest to point to the
				181	upstream repo, set the approapriate BOARD_GPU_DRIVERS and build the
				182	libGLES_mesa library.
				183	</p>
Brian Paul	7103a18	2012-04-19 09:56:36 -0600	[diff] [blame]	184
Emil Velikov	0fa854a	2016-06-29 13:13:25 +0100	[diff] [blame]	185	<p>
				186	FINISHME: Improve on the instructions add references to Rob H repos/Jenkins,
				187	Android-x86 and/or other resources.
				188	</p>
Brian Paul	7103a18	2012-04-19 09:56:36 -0600	[diff] [blame]	189
				190
Andreas Boll	210a27d	2012-06-12 09:05:36 +0200	[diff] [blame]	191	<h1 id="libs">5. Library Information</h1>
Brian Paul	7103a18	2012-04-19 09:56:36 -0600	[diff] [blame]	192
				193	<p>
				194	When compilation has finished, look in the top-level <code>lib/</code>
				195	(or <code>lib64/</code>) directory.
				196	You'll see a set of library files similar to this:
				197	</p>
				198	<pre>
				199	lrwxrwxrwx 1 brian users 10 Mar 26 07:53 libGL.so -> libGL.so.1*
				200	lrwxrwxrwx 1 brian users 19 Mar 26 07:53 libGL.so.1 -> libGL.so.1.5.060100*
				201	-rwxr-xr-x 1 brian users 3375861 Mar 26 07:53 libGL.so.1.5.060100*
Brian Paul	7103a18	2012-04-19 09:56:36 -0600	[diff] [blame]	202	lrwxrwxrwx 1 brian users 14 Mar 26 07:53 libOSMesa.so -> libOSMesa.so.6*
				203	lrwxrwxrwx 1 brian users 23 Mar 26 07:53 libOSMesa.so.6 -> libOSMesa.so.6.1.060100*
				204	-rwxr-xr-x 1 brian users 23871 Mar 26 07:53 libOSMesa.so.6.1.060100*
				205	</pre>
				206
				207	<p>
				208	<b>libGL</b> is the main OpenGL library (i.e. Mesa).
				209	<br>
Brian Paul	7103a18	2012-04-19 09:56:36 -0600	[diff] [blame]	210	<b>libOSMesa</b> is the OSMesa (Off-Screen) interface library.
				211	</p>
				212
				213	<p>
				214	If you built the DRI hardware drivers, you'll also see the DRI drivers:
				215	</p>
				216	<pre>
				217	-rwxr-xr-x 1 brian users 16895413 Jul 21 12:11 i915_dri.so
				218	-rwxr-xr-x 1 brian users 16895413 Jul 21 12:11 i965_dri.so
				219	-rwxr-xr-x 1 brian users 11849858 Jul 21 12:12 r200_dri.so
Brian Paul	7103a18	2012-04-19 09:56:36 -0600	[diff] [blame]	220	-rwxr-xr-x 1 brian users 11757388 Jul 21 12:12 radeon_dri.so
				221	</pre>
				222
				223	<p>
				224	If you built with Gallium support, look in lib/gallium/ for Gallium-based
				225	versions of libGL and device drivers.
				226	</p>
				227
				228
Andreas Boll	210a27d	2012-06-12 09:05:36 +0200	[diff] [blame]	229	<h1 id="pkg-config">6. Building OpenGL programs with pkg-config</h1>
Brian	5bba58c	2007-09-12 10:11:49 -0600	[diff] [blame]	230
				231	<p>
				232	Running <code>make install</code> will install package configuration files
				233	for the pkg-config utility.
				234	</p>
				235
				236	<p>
				237	When compiling your OpenGL application you can use pkg-config to determine
				238	the proper compiler and linker flags.
				239	</p>
				240
				241	<p>
				242	For example, compiling and linking a GLUT application can be done with:
				243	</p>
				244	<pre>
				245	gcc `pkg-config --cflags --libs glut` mydemo.c -o mydemo
				246	</pre>
				247
				248	<br>
Brian Paul	5f37abf	2003-09-05 14:47:07 +0000	[diff] [blame]	249
Andreas Boll	b5da52a	2012-09-18 18:57:02 +0200	[diff] [blame]	250	</div>
Brian Paul	0b27ace	2003-03-08 17:38:57 +0000	[diff] [blame]	251	</body>
				252	</html>