Blame - docs/install.html - chromium.googlesource.com/chromiumos/third_party/mesa

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