source: x/installing/mesalib.xml@ 4a32d87

gnome
Last change on this file since 4a32d87 was 4a32d87, checked in by Christopher Gregory <cjg@…>, 10 years ago

Changed mesalib page to include support for wayland. Changed ulink for wayland to an xref.

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/branches/gnome@13521 af4574ff-66df-0310-9fd7-8a98e5e911e0
  • Property mode set to 100644
File size: 16.2 KB
Line 
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3 "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4 <!ENTITY % general-entities SYSTEM "../../general.ent">
5 %general-entities;
6
7 <!ENTITY mesalib-download-http " ">
8 <!ENTITY mesalib-download-ftp
9 "ftp://ftp.freedesktop.org/pub/mesa/&mesalib-version;/MesaLib-&mesalib-version;.tar.bz2">
10<!-- <!ENTITY mesalib-download-ftp
11 "ftp://ftp.freedesktop.org/pub/mesa/&mesalib-version;/MesaLib-&mesalib-version;.tar.bz2">-->
12 <!ENTITY mesalib-md5sum "11d3542da1b703618634be840a87b0b2">
13 <!ENTITY mesalib-size "6.9 MB">
14 <!ENTITY mesalib-buildsize "313 MB (additional 1.6 MB for the docs)">
15 <!ENTITY mesalib-time "4.4 SBU">
16
17]>
18
19<sect1 id="mesalib" xreflabel="MesaLib-&mesalib-version;">
20 <?dbhtml filename="mesalib.html"?>
21
22 <sect1info>
23 <othername>$LastChangedBy$</othername>
24 <date>$Date$</date>
25 </sect1info>
26
27 <title>MesaLib-&mesalib-version;</title>
28
29 <indexterm zone="mesalib">
30 <primary sortas="a-MesaLib">MesaLib</primary>
31 </indexterm>
32
33 <sect2 role="package">
34 <title>Introduction to MesaLib</title>
35
36 <para>
37 <application>Mesa</application> is an OpenGL compatible 3D graphics
38 library.
39 </para>
40
41 &lfs75_checked;
42
43 <bridgehead renderas="sect3">Package Information</bridgehead>
44 <itemizedlist spacing="compact">
45 <listitem>
46 <para>
47 Download (HTTP): <ulink url="&mesalib-download-http;"/>
48 </para>
49 </listitem>
50 <listitem>
51 <para>
52 Download (FTP): <ulink url="&mesalib-download-ftp;"/>
53 </para>
54 </listitem>
55 <listitem>
56 <para>
57 Download MD5 sum: &mesalib-md5sum;
58 </para>
59 </listitem>
60 <listitem>
61 <para>
62 Download size: &mesalib-size;
63 </para>
64 </listitem>
65 <listitem>
66 <para>
67 Estimated disk space required: &mesalib-buildsize;
68 </para>
69 </listitem>
70 <listitem>
71 <para>
72 Estimated build time: &mesalib-time;
73 </para>
74 </listitem>
75 </itemizedlist>
76
77 <bridgehead renderas="sect3">Additional Patch</bridgehead>
78 <itemizedlist spacing="compact">
79 <listitem>
80 <para>
81 Recommended patch:
82 <ulink url="&patch-root;/MesaLib-&mesalib-version;-add_xdemos-1.patch"/>
83 (Needed if testing the Xorg installation per BLFS instructions).
84 </para>
85 </listitem>
86 </itemizedlist>
87
88 <bridgehead renderas="sect3">MesaLib Dependencies</bridgehead>
89
90 <bridgehead renderas="sect4">Required</bridgehead>
91 <para role="required">
92 <xref linkend="libxml2"/>,
93 <xref linkend="xorg7-lib"/>, and
94 <xref linkend="libdrm"/>
95 </para>
96
97 <bridgehead renderas="sect4">Recommended</bridgehead>
98 <para role="recommended">
99 <xref linkend="elfutils"/> (required for radeon 3d drivers),
100 <xref linkend="libvdpau"/> (to build VDPAU drivers),
101 <xref linkend="llvm"/> (required for radeon 3d drivers and also for
102 llvmpipe which is intended to be the fastest of the three sw rasterizers,
103 see <ulink url="http://www.mesa3d.org/faq.html#part3"></ulink> )
104 </para>
105
106 <bridgehead renderas="sect4">Optional</bridgehead>
107 <para role="optional">
108 <ulink url="ftp://ftp.freedesktop.org/pub/mesa/demos/">mesa-demos</ulink>
109 provides more than 300 extra demos to test
110 <application>MesaLib</application>; two of them overwrites the ones
111 included by
112 <filename>MesaLib-&mesalib-version;-add_xdemos-1.patch</filename>;
113 to avoid that, install in a different prefix or add, e.g.
114 <option>--program-prefix=md</option> to configure, and
115 <xref linkend="wayland"/>
116 </para>
117
118 <note>
119 <para>
120 The instructions below assume that <application>elfutils</application>
121 and <application>LLVM</application> are installed. You will
122 need to modify the instructions if you choose not to install them.
123 Please note that <application>elfutils</application> and
124 <application>LLVM</application> are <emphasis>required</emphasis>
125 for Radeon 3D drivers. For an explanation of gallium please see
126 <ulink url="https://en.wikipedia.org/wiki/Gallium3D"></ulink>.
127 </para>
128 </note>
129
130 <note>
131 <para>
132 The <application>libxml2</application>
133 <application>Python</application> module must have been built
134 during the installation of <application>libxml2</application>
135 or else <application>MesaLib</application> build will fail.
136 </para>
137 </note>
138
139 <para condition="html" role="usernotes">User Notes:
140 <ulink url="&blfs-wiki;/mesalib"/>
141 </para>
142 </sect2>
143
144 <sect2 role="installation">
145 <title>Installation of MesaLib</title>
146
147 <note>
148 <para>
149 Unlike other packages, the
150 <filename>MesaLib-&mesalib-version;.tar.bz2</filename>
151 archive will extract to the
152 <filename class="directory">Mesa-&mesalib-version;</filename>
153 directory.
154 </para>
155 </note>
156
157 <para>
158 If you have downloaded the recommended patch, apply it by running the
159 following command:
160 </para>
161
162<screen><userinput>patch -Np1 -i ../MesaLib-&mesalib-version;-add_xdemos-1.patch</userinput></screen>
163
164 <para>
165 Install <application>MesaLib</application> by running the following
166 commands:
167 </para>
168
169<screen><userinput>./autogen.sh CFLAGS="-O2" CXXFLAGS="-O2" \
170 --prefix=$XORG_PREFIX \
171 --sysconfdir=/etc \
172 --enable-texture-float \
173 --enable-gles1 \
174 --enable-gles2 \
175 --enable-osmesa \
176 --enable-xa \
177 --enable-gbm \
178 --disable-gallium-egl \
179 --enable-gallium-gbm \
180 --enable-shared-glapi \
181 --enable-glx-tls \
182 --with-egl-platforms="x11,wayland,drm" \
183 --with-gallium-drivers="nouveau,r300,r600,radeonsi,swrast" &amp;&amp;
184make</userinput></screen>
185
186 <para>
187 If you have applied the recommended patch, build the demo programs by
188 running the following command:
189 </para>
190
191<screen><userinput>make -C xdemos DEMOS_PREFIX=$XORG_PREFIX</userinput></screen>
192
193 <para>
194 This package does not come with a test suite.
195 </para>
196
197 <para>
198 Now, as the <systemitem class="username">root</systemitem> user:
199 </para>
200
201<screen role="root"><userinput>make install</userinput></screen>
202
203 <para>
204 If you have built the demo programs, install them by running the
205 following command as the
206 <systemitem class="username">root</systemitem> user:
207 </para>
208
209<screen role="root"><userinput>make -C xdemos DEMOS_PREFIX=$XORG_PREFIX install</userinput></screen>
210
211 <para>
212 If desired, install the optional documentation by running
213 the following commands as the
214 <systemitem class="username">root</systemitem> user:
215 </para>
216
217<screen role="root"><userinput>install -v -dm755 /usr/share/doc/MesaLib-&mesalib-version; &amp;&amp;
218cp -rfv docs/* /usr/share/doc/MesaLib-&mesalib-version;</userinput></screen>
219
220 </sect2>
221
222 <sect2 role="commands">
223 <title>Command Explanations</title>
224
225 <para>
226 <parameter>CFLAGS="-O2" CXXFLAGS="-O2"</parameter>: By default,
227 <application>Autoconf</application> sets CFLAGS and CXXFLAGS to
228 "-g -O2". That results in binaries and libraries being built with
229 debugging symbols which make them bigger. Override the default
230 flags to omit -g compiler flag so the final libraries are smaller.
231 </para>
232
233 <para>
234 <parameter>--enable-texture-float</parameter>: This switch enables
235 floating-point textures and render buffers. Please consult
236 <filename>docs/patents.txt</filename> to see if there are
237 any legal issues if you use this feature.
238 </para>
239
240 <para>
241 <parameter>--enable-gles1</parameter>: This switch enables support for
242 OpenGL ES 1.x API.
243 </para>
244
245 <para>
246 <parameter>--enable-gles2</parameter>: This switch enables support for
247 OpenGL ES 2.x API.
248 </para>
249
250 <para>
251 <parameter>--disable-gallium-egl</parameter>: This switch disables
252 the egl_gallium loader so that on Intel 915 and 965 hardware we
253 avoid harmless error messages at runtime. The real Gallium drivers
254 will be built as DRI drivers, which egl_dri2 loader will load just fine.
255 </para>
256
257 <para>
258 <parameter>--enable-openvg</parameter>: This switch enables support for
259 OpenVG API. In order to use this switch you will need to replace
260 <parameter>--disable-gallium-egl</parameter> with
261 <parameter>--enable-gallium-egl</parameter>.
262 </para>
263
264 <para>
265 <parameter>--enable-osmesa</parameter>: This switch enables building of
266 the <filename class="libraryfile">libOSMesa</filename> library.
267 </para>
268
269 <para>
270 <parameter>--enable-xa</parameter>: This switch enables building of the
271 XA X Acceleration API (Required for VMware 3D Driver).
272 </para>
273
274 <para>
275 <parameter>--enable-gbm</parameter>: This switch enables building of the
276 <application>Mesa</application> Graphics Buffer Manager library.
277 </para>
278
279 <para>
280 <parameter>--enable-gallium-egl</parameter>: This switch enables optional
281 EGL state tracker for Gallium.
282 </para>
283
284 <para>
285 <parameter>--enable-gallium-gbm</parameter>: This switch enables optional
286 GBM state tracker for Gallium.
287 </para>
288
289 <para>
290 <parameter>--enable-glx-tls</parameter>: This switch enables TLS (Thread Local
291 Storage) support in GLX.
292 </para>
293
294 <para>
295 <parameter>--enable-shared-glapi</parameter>: This switch makes libGL
296 use the shared libglapi which is required if applications mix
297 OpenGL and OpenGL ES.
298 </para>
299
300 <para>
301 <parameter>--with-egl-platforms="..."</parameter>: This parameter
302 controls for which platforms EGL should be built. Available
303 platforms are drm, x11 and wayland.
304 </para>
305
306 <para>
307 <parameter>--with-gallium-drivers="..."</parameter>: This parameter
308 controls which Gallium drivers should be built. Available drivers
309 are: i915, ilo, nouveau, r300, r600, radeonsi, svga and swrast. You
310 will need to remove r300, r600 and radeonsi from the list if you did
311 not install <application>elfutils</application> and
312 <application>LLVM</application>.
313 </para>
314
315 <para>
316 <option>--enable-r600-llvm-compiler</option>: Use this switch to
317 enable experimental R600 <application>LLVM</application> backend
318 for graphics shaders which claims to speed up the driver.
319 </para>
320
321 </sect2>
322
323 <sect2 role="content">
324 <title>Contents</title>
325
326 <segmentedlist>
327 <segtitle>Installed Programs</segtitle>
328 <segtitle>Installed Libraries</segtitle>
329 <segtitle>Installed Directories</segtitle>
330
331 <seglistitem>
332 <seg>
333 glxgears and glxinfo
334 </seg>
335 <seg>
336 libGL.so,
337 libEGL.so,
338 libGLESv1_CM.so,
339 libGLESv2.so,
340 libOSMesa.so,
341 libgbm.so,
342 libglapi.so,
343 libxatracker.so,
344 libwayland-egl.so,
345 <!--libXvMCnouveau.so and libXvMCr600.so--> and
346 several libs under /usr/lib/{dri,egl,gallium-pipe,gbm,vdpau}
347 </seg>
348 <seg>
349 $XORG_PREFIX/include/EGL,
350 $XORG_PREFIX/include/GL,
351 $XORG_PREFIX/include/GLES,
352 $XORG_PREFIX/include/GLES2,
353 $XORG_PREFIX/include/GLES3,
354 $XORG_PREFIX/include/KHR,
355 $XORG_PREFIX/include/VG,
356 $XORG_PREFIX/lib/dri,
357 $XORG_PREFIX/lib/egl,
358 $XORG_PREFIX/lib/gallium-pipe,
359 $XORG_PREFIX/lib/gbm,
360 $XORG_PREFIX/lib/vdpau, and
361 /usr/share/doc/MesaLib-&mesalib-version; (optional)
362 </seg>
363 </seglistitem>
364 </segmentedlist>
365
366 <variablelist>
367 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
368 <?dbfo list-presentation="list"?>
369 <?dbhtml list-presentation="table"?>
370
371 <varlistentry id="glxgears">
372 <term><command>glxgears</command></term>
373 <listitem>
374 <para>
375 is a GL demo useful for troubleshooting graphics
376 problems.
377 </para>
378 <indexterm zone="mesalib glxgears">
379 <primary sortas="b-glxgears">glxgears</primary>
380 </indexterm>
381 </listitem>
382 </varlistentry>
383
384 <varlistentry id="glxinfo">
385 <term><command>glxinfo</command></term>
386 <listitem>
387 <para>
388 is a diagnostic program that displays information about the
389 graphics hardware and installed GL libraries.
390 </para>
391 <indexterm zone="mesalib glxinfo">
392 <primary sortas="b-glxinfo">glxinfo</primary>
393 </indexterm>
394 </listitem>
395 </varlistentry>
396
397 <varlistentry id="libEGL">
398 <term><filename class="libraryfile">libEGL.so</filename></term>
399 <listitem>
400 <para>
401 provides a native platform graphics interface as
402 defined by the EGL-1.4 specification.
403 </para>
404 <indexterm zone="mesalib libEGL">
405 <primary sortas="c-libGL">libEGL.so</primary>
406 </indexterm>
407 </listitem>
408 </varlistentry>
409
410 <varlistentry id="libgbm">
411 <term><filename class="libraryfile">libgbm.so</filename></term>
412 <listitem>
413 <para>
414 is the <application>Mesa</application> Graphics Buffer
415 Manager library.
416 </para>
417 <indexterm zone="mesalib libgbm">
418 <primary sortas="c-libgbm">libgbm.so</primary>
419 </indexterm>
420 </listitem>
421 </varlistentry>
422
423 <varlistentry id="libGLESv1_CM">
424 <term><filename class="libraryfile">libGLESv1_CM.so</filename></term>
425 <listitem>
426 <para>
427 is the <application>Mesa</application> OpenGL ES 1.1 library.
428 </para>
429 <indexterm zone="mesalib libGLESv1_CM">
430 <primary sortas="c-libGLESv1_CM">libGLESv1_CM.so</primary>
431 </indexterm>
432 </listitem>
433 </varlistentry>
434
435 <varlistentry id="libGLES2">
436 <term><filename class="libraryfile">libGLES2.so</filename></term>
437 <listitem>
438 <para>
439 is the <application>Mesa</application> OpenGL ES 2.0 library.
440 </para>
441 <indexterm zone="mesalib libGLES2">
442 <primary sortas="c-libGLES2">libGLES2.so</primary>
443 </indexterm>
444 </listitem>
445 </varlistentry>
446
447 <varlistentry id="libGL">
448 <term><filename class="libraryfile">libGL.so</filename></term>
449 <listitem>
450 <para>
451 is the main <application>Mesa</application> OpenGL library.
452 </para>
453 <indexterm zone="mesalib libGL">
454 <primary sortas="c-libGL">libGL.so</primary>
455 </indexterm>
456 </listitem>
457 </varlistentry>
458
459 <varlistentry id="libwayland-egl">
460 <term><filename class="libraryfile">libwayland-egl.so</filename></term>
461 <listitem>
462 <para>
463 is the <application>Mesa</application> Wayland framebuffer library.
464 </para>
465 <indexterm zone="mesalib libwayland-egl">
466 <primary sortas="c-libwayland-egl">libwayland-egl.so</primary>
467 </indexterm>
468 </listitem>
469 </varlistentry>
470
471 <varlistentry id="libOSMesa">
472 <term><filename class="libraryfile">libOSMesa.so</filename></term>
473 <listitem>
474 <para>
475 is the <application>Mesa</application> Off-screen Rendering library.
476 </para>
477 <indexterm zone="mesalib libOSMesa">
478 <primary sortas="c-libOSMesa">libOSMesa.so</primary>
479 </indexterm>
480 </listitem>
481 </varlistentry>
482
483 <varlistentry id="libxatracker">
484 <term><filename class="libraryfile">libxatracker.so</filename></term>
485 <listitem>
486 <para>
487 is the Xorg Gallium3D acceleration library.
488 </para>
489 <indexterm zone="mesalib libxatracker">
490 <primary sortas="c-libxatracker">libxatracker.so</primary>
491 </indexterm>
492 </listitem>
493 </varlistentry>
494 </variablelist>
495
496 </sect2>
497
498</sect1>
Note: See TracBrowser for help on using the repository browser.