source: x/installing/mesa.xml@ 850837c5

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

  <!ENTITY mesa-download-http " ">
  <!ENTITY mesa-download-ftp  "ftp://ftp.freedesktop.org/pub/mesa/&mesa-version;/mesa-&mesa-version;.tar.xz">
  <!ENTITY mesa-md5sum        "83638efaa55d00075752fce57f91bf2d">
  <!ENTITY mesa-size          "7 MB">
  <!ENTITY mesa-buildsize     "306 MB (with tests and docs)">
  <!ENTITY mesa-time          "2.7 SBU (with tests and docs - all with parallelism = 4)">
]>

<sect1 id="mesa" xreflabel="Mesa-&mesa-version;">
  <?dbhtml filename="mesa.html"?>

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
  </sect1info>

  <title>Mesa-&mesa-version;</title>

  <indexterm zone="mesa">
    <primary sortas="a-Mesa">Mesa</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to Mesa</title>

    <para>
      <application>Mesa</application> is an OpenGL compatible 3D graphics
      library.
    </para>

    &lfs78_checked;

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>
          Download (HTTP): <ulink url="&mesa-download-http;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download (FTP): <ulink url="&mesa-download-ftp;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download MD5 sum: &mesa-md5sum;
        </para>
      </listitem>
      <listitem>
        <para>
          Download size: &mesa-size;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated disk space required: &mesa-buildsize;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated build time: &mesa-time;
        </para>
      </listitem>
    </itemizedlist>

    <bridgehead renderas="sect3">Additional Downloads</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>
          Recommended patch:
          <ulink
            url="&patch-root;/mesa-&mesa-version;-add_xdemos-1.patch"/>
          (installs 2 demo programs for testing Mesa - not needed if you
          install the <ulink url="ftp://ftp.freedesktop.org/pub/mesa/demos/">
          mesa-demos</ulink> package)
        </para>
      </listitem>
    </itemizedlist>

    <bridgehead renderas="sect3">Mesa Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="xorg7-lib"/> and
      <xref linkend="libdrm"/>
    </para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="elfutils"/> (required for Gallium3D radeonsi driver),
      <xref linkend="libvdpau"/> (to build VDPAU drivers),
      <xref linkend="llvm"/> (required for Gallium3D r300, r600 and radeonsi
      drivers and also for llvmpipe which is intended to be the fastest of the
      three sw rasterizers, see
      <ulink url="http://www.mesa3d.org/faq.html#part3"/>)
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="wayland"/> (required for <xref linkend='plasma5-build'/>),
      <ulink url="ftp://ftp.freedesktop.org/pub/mesa/demos/">mesa-demos</ulink>
      (provides more than 300 extra demos to test
      <application>Mesa</application>; this includes the same programs
      added by the patch above), and
      <ulink url="http://omxil.sourceforge.net/">Bellagio OpenMAX Integration
      Layer</ulink> (for mobile platforms)
    </para>

    <note>
      <para>
        The instructions below assume that <application>elfutils</application>
        and <application>LLVM</application> with the r600/amdgpu backend are
        installed. You will need to modify the instructions if you choose not
        to install them. Please note that <application>elfutils</application>
        and <application>LLVM</application> are <emphasis>required</emphasis>
        for Gallium3D r300, r600 and radeonsi drivers. For an explanation of
        Gallium3D please see
        <ulink url="https://en.wikipedia.org/wiki/Gallium3D"/>.
      </para>
    </note>

    <para condition="html" role="usernotes">User Notes:
      <ulink url="&blfs-wiki;/mesa"/>
    </para>
  </sect2>

  <sect2 role="installation">
    <title>Installation of Mesa</title>

    <para>
      If you have downloaded the xdemos patch (needed if testing the Xorg
      installation per BLFS instructions), apply it by running the following
      command:
    </para>

<screen><userinput>patch -Np1 -i ../mesa-&mesa-version;-add_xdemos-1.patch</userinput></screen>

    <para>
      Install <application>Mesa</application> by running the following
      commands:
    </para>

    <note>
      <para>Add wayland to the <option>--with-egl-platforms</option> option
      below if you plan on building <xref linkend='plasma5-build'/>.</para>
    </note>

<screen><userinput>GLL_DRV="nouveau,r300,r600,radeonsi,svga,swrast" &amp;&amp;

./autogen.sh CFLAGS='-O2' CXXFLAGS='-O2'    \
            --prefix=$XORG_PREFIX           \
            --sysconfdir=/etc               \
            --enable-texture-float          \
            --enable-gles1                  \
            --enable-gles2                  \
            --enable-osmesa                 \
            --enable-xa                     \
            --enable-gbm                    \
            --enable-glx-tls                \
            --with-egl-platforms="drm,x11"  \
            --with-gallium-drivers=$GLL_DRV &amp;&amp;

unset GLL_DRV &amp;&amp;

make</userinput></screen>

    <para>
      If you have applied the xdemos patch, build the demo programs by
      running the following command:
    </para>

<screen><userinput>make -C xdemos DEMOS_PREFIX=$XORG_PREFIX</userinput></screen>

    <para>
      To test the results, issue: <command>make check</command>.
    </para>

    <para>
      Now, as the <systemitem class="username">root</systemitem> user:
    </para>

<screen role="root"><userinput>make install</userinput></screen>

    <para>
      If you have built the demo programs, install them by running the
      following command as the
      <systemitem class="username">root</systemitem> user:
    </para>

<screen role="root"><userinput>make -C xdemos DEMOS_PREFIX=$XORG_PREFIX install</userinput></screen>

    <para>
      If desired, install the optional documentation by running
      the following commands as the
      <systemitem class="username">root</systemitem> user:
    </para>

<screen role="root"><userinput>install -v -dm755 /usr/share/doc/mesa-&mesa-version; &amp;&amp;
cp -rfv docs/* /usr/share/doc/mesa-&mesa-version;</userinput></screen>

  </sect2>

  <sect2 role="commands">
    <title>Command Explanations</title>

    <para>
      <parameter>CFLAGS="-O2" CXXFLAGS="-O2"</parameter>: By default,
      <application>Autoconf</application> sets CFLAGS and CXXFLAGS to
      "-g -O2". That results in binaries and libraries being built with
      debugging symbols which make them bigger. Override the default
      flags to omit -g compiler flag so the final libraries are smaller.
    </para>

    <para>
      <parameter>--enable-texture-float</parameter>: This switch enables
      floating-point textures and render buffers. Please consult
      <filename>docs/patents.txt</filename> to see if there are
      any legal issues if you use this feature.
    </para>

    <para>
      <parameter>--enable-gles1</parameter>: This switch enables support for
      OpenGL ES 1.x API.
    </para>

    <para>
      <parameter>--enable-gles2</parameter>: This switch enables support for
      OpenGL ES 2.x API.
    </para>

    <para>
      <parameter>--enable-osmesa</parameter>: This switch enables building of
      the <filename class="libraryfile">libOSMesa</filename> library.
    </para>

    <para>
      <parameter>--enable-xa</parameter>: This switch enables building of the
      XA X Acceleration API (Required for VMware 3D Driver).
    </para>

    <para>
      <parameter>--enable-gbm</parameter>: This switch enables building of the
      <application>Mesa</application> Graphics Buffer Manager library.
    </para>

    <para>
      <parameter>--enable-glx-tls</parameter>: This switch enables TLS (Thread Local
      Storage) support in GLX.
    </para>

    <para>
      <parameter>--with-egl-platforms="..."</parameter>: This parameter
      controls which platforms EGL will be built for. Available
      platforms are drm, x11 and wayland.
    </para>

    <para>
      <parameter>--with-gallium-drivers="..."</parameter>: This parameter
      controls which Gallium3D drivers should be built. Available drivers
      are: i915, ilo, nouveau, r300, r600, radeonsi, svga and swrast. You
      will need to remove r300, r600 and radeonsi from the list if you did
      not install <application>elfutils</application> and
      <application>LLVM</application> with the r600/amdgpu backend.
    </para>

    <para>
      <option>--enable-r600-llvm-compiler</option>: Use this switch to
      enable an experimental R600 <application>LLVM</application> backend
      for graphics shaders which claims to speed up the driver.
    </para>

    <para>
      <option>--enable-sysfs</option>: Use this switch to enable simple PCI
      identification method, required for building DRI on systems without udev.
    </para>

  </sect2>

  <sect2 role="content">
    <title>Contents</title>

    <segmentedlist>
      <segtitle>Installed Programs</segtitle>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>
          glxgears and glxinfo
        </seg>
        <seg>
          libEGL.so,
          libgbm.so,
          libglapi.so,
          libGLESv1_CM.so,
          libGLESv2.so,
          libGL.so,
          libOSMesa.so,
          libxatracker.so,
          libXvMCnouveau.so,
          and libXvMCr600.so
        </seg>
        <seg>
          $XORG_PREFIX/{include/{EGL,GL,GLES,GLES2,GLES3,KHR},lib/{dri,vdpau}}
          and
          /usr/share/doc/mesa-&mesa-version; (optional)
        </seg>
      </seglistitem>
    </segmentedlist>

    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>

      <varlistentry id="glxgears">
        <term><command>glxgears</command></term>
        <listitem>
          <para>
            is a GL demo useful for troubleshooting graphics
            problems.
          </para>
          <indexterm zone="mesa glxgears">
            <primary sortas="b-glxgears">glxgears</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="glxinfo">
        <term><command>glxinfo</command></term>
        <listitem>
          <para>
            is a diagnostic program that displays information about the
            graphics hardware and installed GL libraries.
          </para>
          <indexterm zone="mesa glxinfo">
            <primary sortas="b-glxinfo">glxinfo</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libEGL">
        <term><filename class="libraryfile">libEGL.so</filename></term>
        <listitem>
          <para>
            provides a native platform graphics interface as
            defined by the EGL-1.4 specification.
          </para>
          <indexterm zone="mesa libEGL">
            <primary sortas="c-libGL">libEGL.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libgbm">
        <term><filename class="libraryfile">libgbm.so</filename></term>
        <listitem>
          <para>
            is the <application>Mesa</application> Graphics Buffer
            Manager library.
          </para>
          <indexterm zone="mesa libgbm">
            <primary sortas="c-libgbm">libgbm.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libGLESv1_CM">
        <term><filename class="libraryfile">libGLESv1_CM.so</filename></term>
        <listitem>
          <para>
            is the <application>Mesa</application> OpenGL ES 1.1 library.
          </para>
          <indexterm zone="mesa libGLESv1_CM">
            <primary sortas="c-libGLESv1_CM">libGLESv1_CM.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libGLES2">
        <term><filename class="libraryfile">libGLES2.so</filename></term>
        <listitem>
          <para>
            is the <application>Mesa</application> OpenGL ES 2.0 library.
          </para>
          <indexterm zone="mesa libGLES2">
            <primary sortas="c-libGLES2">libGLES2.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libGL">
        <term><filename class="libraryfile">libGL.so</filename></term>
        <listitem>
          <para>
            is the main <application>Mesa</application> OpenGL library.
          </para>
          <indexterm zone="mesa libGL">
            <primary sortas="c-libGL">libGL.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libOSMesa">
        <term><filename class="libraryfile">libOSMesa.so</filename></term>
        <listitem>
          <para>
            is the <application>Mesa</application> Off-screen Rendering library.
          </para>
          <indexterm zone="mesa libOSMesa">
            <primary sortas="c-libOSMesa">libOSMesa.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libxatracker">
        <term><filename class="libraryfile">libxatracker.so</filename></term>
        <listitem>
          <para>
            is the Xorg Gallium3D acceleration library.
          </para>
          <indexterm zone="mesa libxatracker">
            <primary sortas="c-libxatracker">libxatracker.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>
    </variablelist>

  </sect2>

</sect1>