-<HTML>
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html lang="en">
+<head>
+ <meta http-equiv="content-type" content="text/html; charset=utf-8">
+ <title>Compiling and Installing</title>
+ <link rel="stylesheet" type="text/css" href="mesa.css">
+</head>
+<body>
-<TITLE>Compiling and Installing</TITLE>
+<div class="header">
+ The Mesa 3D Graphics Library
+</div>
-<link rel="stylesheet" type="text/css" href="mesa.css"></head>
+<iframe src="contents.html"></iframe>
+<div class="content">
-<BODY>
-
-
-<H1>Compiling and Installing</H1>
+<h1>Compiling and Installing</h1>
<ol>
-<li><a href="#unix-x11">Unix / X11</a>
+<li><a href="#prereq-general">Prerequisites for building</a>
<ul>
- <li><a href="#prereq-general">General prerequisites for building</a>
- <li><a href="#prereq-dri">Prerequisites for DRI and hardware acceleration</a>
- <li><a href="#autoconf">Building with autoconf</a>
- <li><a href="#traditional">Building with traditional Makefiles</a>
- <li><a href="#libs">The Libraries</a>
- <li><a href="#install">Installing the header and library files
- <li><a href="#pkg-config">Building OpenGL programs with pkg-config
+ <li><a href="#prereq-general">General prerequisites</a>
+ <li><a href="#prereq-dri">For DRI and hardware acceleration</a>
</ul>
-<li><a href="#windows">Windows</a>
-<li><a href="#scons">Building with SCons</a>
-<li><a href="#other">Other</a>
+<li><a href="#meson">Building with meson</a>
+<li><a href="#scons">Building with SCons (Windows/Linux)</a>
+<li><a href="#android">Building with AOSP (Android)</a>
+<li><a href="#libs">Library Information</a>
+<li><a href="#pkg-config">Building OpenGL programs with pkg-config</a>
</ol>
-<br>
-<a name="unix-x11">
-<H2>1. Unix/X11 Compilation and Installation</H1>
+<h2 id="prereq-general">1. Prerequisites for building</h2>
+<h3>1.1 General</h3>
-<a name="prereq-general">
-<h3>1.1 General prerequisites for building</h3>
+<h4>Build system</h4>
<ul>
-<li>lex / yacc - for building the GLSL compiler.
-On Linux systems, flex and bison are used.
-Versions 2.5.35 and 2.4.1, respectively, (or later) should work.
-<br>
-<br>
-On Windows with MinGW, install flex and bison with:
-<pre>mingw-get install msys-flex msys-bison</pre>
+<li><a href="https://mesonbuild.com">meson</a> is required when building on *nix platforms and is supported on windows.
+<li><a href="http://www.scons.org/">SCons</a> is an alternative for building on
+Windows and Linux.
</li>
-<li>python - Python is needed for building the Gallium components.
-Version 2.6.4 or later should work.
-<br>
-<br>
-To build OpenGL ES 1.1 and 2.0 you'll also need
-<a href="http://xmlsoft.org/sources/win32/python/libxml2-python-2.7.7.win32-py2.7.exe">libxml2-python</a>.
+<li>Android Build system when building as native Android component. Meson
+is used when when building ARC.
</li>
</ul>
-
-<a name="prereq-dri">
-<h3>1.2 Prerequisites for DRI and hardware acceleration</h3>
-
+<h4>Compiler</h4>
<p>
-The following are required for DRI-based hardware acceleration with Mesa:
+The following compilers are known to work, if you know of others or you're
+willing to maintain support for other compiler get in touch.
</p>
<ul>
-<li><a href="http://xorg.freedesktop.org/releases/individual/proto/">dri2proto</a> version 1.99.3 or later
-<li>Linux 2.6.28
-<li><a href="http://dri.freedesktop.org/libdrm/" target="_parent">libDRM</a>
-version 2.4.15 or later
-<li>Xorg server version 1.5 or later
+<li>GCC 4.2.0 or later (some parts of Mesa may require later versions)
+<li>clang - exact minimum requirement is currently unknown.
+<li>Microsoft Visual Studio 2015 or later is required, for building on Windows.
</ul>
-</p>
-<p>
-If you're using a fedora distro the following command should install all
-the needed dependencies:
-<pre>
- sudo yum install flex bison imake libtool xorg-x11-proto-devel libdrm-devel \
- gcc-c++ xorg-x11-server-devel libXi-devel libXmu-devel libXdamage-devel git \
- expat-devel llvm-devel
-</pre>
-<a name="autoconf">
-<h3>1.3 Building with Autoconf</h3>
+<h4>Third party/extra tools.</h4>
+<ul>
+<li><a href="https://www.python.org/">Python</a> - Python is required.
+When building with scons 2.7 is required.
+When building with meson 3.5 or newer is required.
+</li>
+<li><a href="http://www.makotemplates.org/">Python Mako module</a> -
+Python Mako module is required. Version 0.8.0 or later should work.
+</li>
+<li>lex / yacc - for building the Mesa IR and GLSL compiler.
<p>
-Mesa may be <a href="autoconf.html">built using autoconf</a>.
-This should work well on most GNU-based systems.
-If that fails the traditional Mesa build system is available.
-
+On Linux systems, flex and bison versions 2.5.35 and 2.4.1, respectively,
+(or later) should work.
+On Windows with MinGW, install flex and bison with:
+<pre>mingw-get install msys-flex msys-bison</pre>
+For MSVC on Windows, install
+<a href="http://winflexbison.sourceforge.net/">Win flex-bison</a>.
+</p>
+</ul>
+<p><strong>Note</strong>: Some versions can be buggy (eg. flex 2.6.2) so do try others if things fail.</p>
-<a name="traditional">
-<h3>1.4 Building with traditional Makefiles</h3>
+<h3 id="prereq-dri">1.2 Requirements</h3>
<p>
-The traditional Mesa build system is based on a collection of pre-defined
-system configurations.
-</p>
-<p>
-To see the list of configurations, just type <code>make</code>.
-Then choose a configuration from the list and type <code>make</code>
-<em>configname</em>.
+The requirements depends on the features selected at configure stage.
+Check/install the respective -devel package as prompted by the configure error
+message.
</p>
<p>
-Mesa may be built in several different ways using the predefined configurations:
-</p>
-<ul>
-<li><b><em>Stand-alone/Xlib mode</em></b> - Mesa will be compiled as
-a software renderer using Xlib to do all rendering.
-The libGL.so library will be a self-contained rendering library that will
-allow you to run OpenGL/GLX applications on any X server (regardless of
-whether it supports the GLX X server extension).
-You will <em>not</em> be able to use hardware 3D acceleration.
-<p>
-To compile stand-alone Mesa type <code>make</code> in the top-level directory.
-You'll see a list of supported system configurations.
-Choose one from the list (such as linux-x86), and type:
+Here are some common ways to retrieve most/all of the dependencies based on
+the packaging tool used by your distro.
</p>
+
<pre>
- make linux-x86
+ zypper source-install --build-deps-only Mesa # openSUSE/SLED/SLES
+ yum-builddep mesa # yum Fedora, OpenSuse(?)
+ dnf builddep mesa # dnf Fedora
+ apt-get build-dep mesa # Debian and derivatives
+ ... # others
</pre>
-<p>This will produce libGL.so and several other libraries</p>
-</li>
-<li><b><em>DRI/accelerated</em></b> - The DRI hardware drivers for
-accelerated OpenGL rendering (for ATI, Intel, Matrox, etc) will be built.
-The libGL.so library will support the GLX extension and will load/use
-the DRI hardware drivers.
+<h2 id="meson">2. Building with meson</h2>
+<p><string>Meson >= 0.46.0 is required</string></p>
<p>
-Build Mesa and the DRI hardware drivers by running
-</p>
-<pre>
- make linux-dri
-</pre>
-<p>
-There are also <code>linux-dri-x86</code>, <code>linux-dri-x86-64</code>,
-and <code>linux-ppc</code> configurations which are optimized for those
-architectures.
+Meson is the latest build system in mesa, it is currently able to build for
+*nix systems like Linux and BSD, macOS, Haiku, and Windows.
</p>
+
<p>
-Make sure you have the prerequisite versions of DRM and Xserver mentioned
-above.
+The general approach is:
</p>
+<pre>
+ meson builddir/
+ ninja -C builddir/
+ sudo ninja -C builddir/ install
+</pre>
-</li>
-
-</ul>
-
+<p>On windows you can also use the visual studio backend</p>
+<pre>
+ meson builddir --backend=vs
+ cd builddir
+ msbuild mesa.sln /m
+</pre>
<p>
-Later, if you want to rebuild for a different configuration run
-<code>make realclean</code> before rebuilding.
+Please read the <a href="meson.html">detailed meson instructions</a>
+for more information
</p>
-<a name="libs">
-<h3>1.5 The libraries</h3>
+
+<h2 id="scons">3. Building with SCons (Windows/Linux)</h2>
<p>
-When compilation has finished, look in the top-level <code>lib/</code>
-(or <code>lib64/</code>) directory.
-You'll see a set of library files similar to this:
+To build Mesa with SCons on Linux or Windows do
</p>
<pre>
-lrwxrwxrwx 1 brian users 10 Mar 26 07:53 libGL.so -> libGL.so.1*
-lrwxrwxrwx 1 brian users 19 Mar 26 07:53 libGL.so.1 -> libGL.so.1.5.060100*
--rwxr-xr-x 1 brian users 3375861 Mar 26 07:53 libGL.so.1.5.060100*
-lrwxrwxrwx 1 brian users 11 Mar 26 07:53 libGLU.so -> libGLU.so.1*
-lrwxrwxrwx 1 brian users 20 Mar 26 07:53 libGLU.so.1 -> libGLU.so.1.3.060100*
--rwxr-xr-x 1 brian users 549269 Mar 26 07:53 libGLU.so.1.3.060100*
-lrwxrwxrwx 1 brian users 12 Mar 26 07:53 libglut.so -> libglut.so.3*
-lrwxrwxrwx 1 brian users 16 Mar 26 07:53 libglut.so.3 -> libglut.so.3.7.1*
--rwxr-xr-x 1 brian users 597754 Mar 26 07:53 libglut.so.3.7.1*
-lrwxrwxrwx 1 brian users 14 Mar 26 07:53 libOSMesa.so -> libOSMesa.so.6*
-lrwxrwxrwx 1 brian users 23 Mar 26 07:53 libOSMesa.so.6 -> libOSMesa.so.6.1.060100*
--rwxr-xr-x 1 brian users 23871 Mar 26 07:53 libOSMesa.so.6.1.060100*
+ scons
</pre>
-
<p>
-<b>libGL</b> is the main OpenGL library (i.e. Mesa).
-<br>
-<b>libGLU</b> is the OpenGL Utility library.
-<br>
-<b>libglut</b> is the GLUT library.
-<br>
-<b>libOSMesa</b> is the OSMesa (Off-Screen) interface library.
+The build output will be placed in
+build/<i>platform</i>-<i>machine</i>-<i>debug</i>/..., where <i>platform</i> is for
+example linux or windows, <i>machine</i> is x86 or x86_64, optionally followed
+by -debug for debug builds.
</p>
<p>
-If you built the DRI hardware drivers, you'll also see the DRI drivers:
+To build Mesa with SCons for Windows on Linux using the MinGW crosscompiler toolchain do
</p>
<pre>
--rwxr-xr-x 1 brian users 16895413 Jul 21 12:11 i915_dri.so
--rwxr-xr-x 1 brian users 11849858 Jul 21 12:12 r200_dri.so
--rwxr-xr-x 1 brian users 16050488 Jul 21 12:11 r300_dri.so
--rwxr-xr-x 1 brian users 11757388 Jul 21 12:12 radeon_dri.so
+ scons platform=windows toolchain=crossmingw machine=x86 libgl-gdi
</pre>
-
<p>
-If you built with Gallium support, look in lib/gallium/ for Gallium-based
-versions of libGL and device drivers.
+This will create:
</p>
+<ul>
+<li>build/windows-x86-debug/gallium/targets/libgl-gdi/opengl32.dll — Mesa + Gallium + softpipe (or llvmpipe), binary compatible with Windows's opengl32.dll
+</ul>
+<p>
+Put them all in the same directory to test them.
+Additional information is available in <a href="README.WIN32">README.WIN32</a>.
+</p>
-<a name="install">
-<H3>1.6 Installing the header and library files</H3>
-<p>
-The standard location for the OpenGL header files on Unix-type systems is
-in <code>/usr/include/GL/</code>.
-The standard location for the libraries is <code>/usr/lib/</code>.
-For more information see, the
-<a href="http://oss.sgi.com/projects/ogl-sample/ABI/" target="_parent">
-Linux/OpenGL ABI specification</a>.
-</p>
-<p>
-If you'd like Mesa to co-exist with another implementation of OpenGL that's
-already installed, you'll have to choose different directories, like
-<code>/usr/local/include/GL/</code> and <code>/usr/local/lib/</code>.
-</p>
+<h2 id="android">4. Building with AOSP (Android)</h2>
<p>
-To install Mesa's headers and libraries, run <code>make install</code>.
-But first, check the Mesa/configs/default file and examine the values
-of the <b>INSTALL_DIR</b> and <b>DRI_DRIVER_INSTALL_DIR</b> variables.
-Change them if needed, then run <code>make install</code>.
+Currently one can build Mesa for Android as part of the AOSP project, yet
+your experience might vary.
</p>
<p>
-The variable
-<b>DESTDIR</b> may also be used to install the contents to a temporary
-staging directory.
-This can be useful for package management.
-For example: <code>make install DESTDIR=/somepath/</code>
+In order to achieve that one should update their local manifest to point to the
+upstream repo, set the appropriate BOARD_GPU_DRIVERS and build the
+libGLES_mesa library.
</p>
<p>
-Note: at runtime you can use the LD_LIBRARY_PATH environment variable
-(on Linux at least) to switch
-between the Mesa libraries and other vendor's libraries whenever you want.
-This is a handy way to compare multiple OpenGL implementations.
+FINISHME: Improve on the instructions add references to Rob H repos/Jenkins,
+Android-x86 and/or other resources.
</p>
-<a name="pkg-config">
-<H3>1.7 Building OpenGL programs with pkg-config</H3>
+<h2 id="libs">5. Library Information</h2>
<p>
-Running <code>make install</code> will install package configuration files
-for the pkg-config utility.
+When compilation has finished, look in the top-level <code>lib/</code>
+(or <code>lib64/</code>) directory.
+You'll see a set of library files similar to this:
</p>
+<pre>
+lrwxrwxrwx 1 brian users 10 Mar 26 07:53 libGL.so -> libGL.so.1*
+lrwxrwxrwx 1 brian users 19 Mar 26 07:53 libGL.so.1 -> libGL.so.1.5.060100*
+-rwxr-xr-x 1 brian users 3375861 Mar 26 07:53 libGL.so.1.5.060100*
+lrwxrwxrwx 1 brian users 14 Mar 26 07:53 libOSMesa.so -> libOSMesa.so.6*
+lrwxrwxrwx 1 brian users 23 Mar 26 07:53 libOSMesa.so.6 -> libOSMesa.so.6.1.060100*
+-rwxr-xr-x 1 brian users 23871 Mar 26 07:53 libOSMesa.so.6.1.060100*
+</pre>
<p>
-When compiling your OpenGL application you can use pkg-config to determine
-the proper compiler and linker flags.
+<b>libGL</b> is the main OpenGL library (i.e. Mesa), while <b>libOSMesa</b>
+is the OSMesa (Off-Screen) interface library.
</p>
<p>
-For example, compiling and linking a GLUT application can be done with:
+If you built the DRI hardware drivers, you'll also see the DRI drivers:
</p>
<pre>
- gcc `pkg-config --cflags --libs glut` mydemo.c -o mydemo
+-rwxr-xr-x 1 brian users 16895413 Jul 21 12:11 i915_dri.so
+-rwxr-xr-x 1 brian users 16895413 Jul 21 12:11 i965_dri.so
+-rwxr-xr-x 1 brian users 11849858 Jul 21 12:12 r200_dri.so
+-rwxr-xr-x 1 brian users 11757388 Jul 21 12:12 radeon_dri.so
</pre>
-<br>
-
-<a name="windows">
-<H2>2. Windows Compilation and Installation</H1>
-
<p>
-Please see the <a href="#scons">instructions on building with SCons</a>.
+If you built with Gallium support, look in lib/gallium/ for Gallium-based
+versions of libGL and device drivers.
</p>
-
-<a name="scons">
-<H2>3. Building with SCons</H1>
+<h2 id="pkg-config">6. Building OpenGL programs with pkg-config</h2>
<p>
-To build Mesa with SCons on Linux or Windows do
+Running <code>ninja install</code> will install package configuration files
+for the pkg-config utility.
</p>
-<pre>
- scons
-</pre>
+
<p>
-The build output will be placed in
-build/<i>platform</i>-<i>machine</i>-<i>debug</i>/..., where <i>platform</i> is for
-example linux or windows, <i>machine</i> is x86 or x86_64, optionally followed
-by -debug for debug builds.
+When compiling your OpenGL application you can use pkg-config to determine
+the proper compiler and linker flags.
</p>
<p>
-To build Mesa with SCons for Windows on Linux using the MinGW crosscompiler toolchain do
+For example, compiling and linking a GLUT application can be done with:
</p>
<pre>
- scons platform=windows toolchain=crossmingw machine=x86 mesagdi libgl-gdi
+ gcc `pkg-config --cflags --libs glut` mydemo.c -o mydemo
</pre>
-<p>
-This will create:
-</p>
-<ul>
-<li>build/windows-x86-debug/mesa/drivers/windows/gdi/opengl32.dll — Mesa + swrast, binary compatible with Windows's opengl32.dll
-<li>build/windows-x86-debug/gallium/targets/libgl-gdi/opengl32.dll — Mesa + Gallium + softpipe, binary compatible with Windows's opengl32.dll
-</ul>
-<p>
-Put them all in the same directory to test them.
-</p>
-
-
-<a name="other">
-<H2>4. Other systems</H1>
-
-<p>
-Documentation for other environments (some may be very out of date):
-</p>
-
-<UL>
-<li><A HREF="README.VMS">README.VMS</A> - VMS
-<LI><A HREF="README.CYGWIN">README.CYGWIN</A> - Cygwin
-<LI><A HREF="README.WIN32">README.WIN32</A> - Win32
-</UL>
-
-
-
+</div>
</body>
</html>
projects / mesa.git / blobdiff