faq.html 12.6 KB
Newer Older
1 2 3 4 5 6 7 8
<!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>Mesa FAQ</title>
  <link rel="stylesheet" type="text/css" href="mesa.css">
</head>
<body>
9

10 11 12 13 14 15 16
<div class="header">
  <h1>The Mesa 3D Graphics Library</h1>
</div>

<iframe src="contents.html"></iframe>
<div class="content">

17 18
<center>
<h1>Mesa Frequently Asked Questions</h1>
19
Last updated: 19 September 2018
20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37
</center>

<br>
<br>
<h2>Index</h2>
<a href="#part1">1. High-level Questions and Answers</a>
<br>
<a href="#part2">2. Compilation and Installation Problems</a>
<br>
<a href="#part3">3. Runtime / Rendering Problems</a>
<br>
<a href="#part4">4. Developer Questions</a>
<br>
<br>
<br>



38
<h1 id="part1">1. High-level Questions and Answers</h1>
39

40
<h2>1.1 What is Mesa?</h2>
41
<p>
42
Mesa is an open-source implementation of the OpenGL specification.
Brian Paul's avatar
Brian Paul committed
43
OpenGL is a programming library for writing interactive 3D applications.
44
See the <a href="https://www.opengl.org/">OpenGL website</a> for more
45 46 47
information.
</p>
<p>
Andreas Boll's avatar
Andreas Boll committed
48
Mesa 9.x supports the OpenGL 3.1 specification.
49 50 51 52 53
</p>


<h2>1.2 Does Mesa support/use graphics hardware?</h2>
<p>
Brian Paul's avatar
Brian Paul committed
54
Yes.  Specifically, Mesa serves as the OpenGL core for the open-source DRI
55
drivers for X.org.
56
</p>
57
<ul>
58
  <li>See the <a href="https://dri.freedesktop.org/">DRI website</a>
59
  for more information.</li>
60
  <li>See <a href="https://01.org/linuxgraphics">01.org</a>
61
  for more information about Intel drivers.</li>
62
  <li>See <a href="https://nouveau.freedesktop.org">nouveau.freedesktop.org</a>
63
  for more information about Nouveau drivers.</li>
64
  <li>See <a href="https://www.x.org/wiki/RadeonFeature">www.x.org/wiki/RadeonFeature</a>
65 66
  for more information about Radeon drivers.</li>
</ul>
67

Brian Paul's avatar
Brian Paul committed
68
<h2>1.3 What purpose does Mesa serve today?</h2>
69
<p>
Brian Paul's avatar
Brian Paul committed
70 71
Hardware-accelerated OpenGL implementations are available for most popular
operating systems today.
72 73 74
Still, Mesa serves at least these purposes:
</p>
<ul>
75
<li>Mesa is used as the core of the open-source X.org DRI
Brian Paul's avatar
Brian Paul committed
76
    hardware drivers.
Brian Paul's avatar
Brian Paul committed
77 78 79 80 81
</li>
<li>Mesa is quite portable and allows OpenGL to be used on systems
    that have no other OpenGL solution.
</li>
<li>Software rendering with Mesa serves as a reference for validating the
82
    hardware drivers.
Brian Paul's avatar
Brian Paul committed
83 84 85 86 87 88
</li>
<li>A software implementation of OpenGL is useful for experimentation,
    such as testing new rendering techniques.
</li>
<li>Mesa can render images with deep color channels: 16-bit integer
    and 32-bit floating point color channels are supported.
89
    This capability is only now appearing in hardware.
Brian Paul's avatar
Brian Paul committed
90 91
</li>
<li>Mesa's internal limits (max lights, clip planes, texture size, etc) can be
92
    changed for special needs (hardware limits are hard to overcome).
Brian Paul's avatar
Brian Paul committed
93 94
</li>
</ul>
95

Brian Paul's avatar
Brian Paul committed
96

Andreas Boll's avatar
Andreas Boll committed
97
<h2>1.4 What's the difference between "Stand-Alone" Mesa and the DRI drivers?</h2>
Brian Paul's avatar
Brian Paul committed
98 99
<p>
<em>Stand-alone Mesa</em> is the original incarnation of Mesa.
Brian Paul's avatar
Brian Paul committed
100 101
On systems running the X Window System it does all its rendering through
the Xlib API:
102
</p>
Brian Paul's avatar
Brian Paul committed
103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128
<ul>
<li>The GLX API is supported, but it's really just an emulation of the
     real thing.
<li>The GLX wire protocol is not supported and there's no OpenGL extension
    loaded by the X server.
<li>There is no hardware acceleration.
<li>The OpenGL library, libGL.so, contains everything (the programming API,
    the GLX functions and all the rendering code).
</ul>
<p>
Alternately, Mesa acts as the core for a number of OpenGL hardware drivers
within the DRI (Direct Rendering Infrastructure):
<ul>
<li>The libGL.so library provides the GL and GLX API functions, a GLX
    protocol encoder, and a device driver loader.
<li>The device driver modules (such as r200_dri.so) contain a built-in
    copy of the core Mesa code.
<li>The X server loads the GLX module.
    The GLX module decodes incoming GLX protocol and dispatches the commands
    to a rendering module.
    For the DRI, this module is basically a software Mesa renderer.
</ul>



<h2>1.5 How do I upgrade my DRI installation to use a new Mesa release?</h2>
129
<p>
Brian Paul's avatar
Brian Paul committed
130 131 132 133
This wasn't easy in the past.
Now, the DRI drivers are included in the Mesa tree and can be compiled
separately from the X server.
Just follow the Mesa <a href="install.html">compilation instructions</a>.
Brian Paul's avatar
Brian Paul committed
134 135
</p>

136

Brian Paul's avatar
Brian Paul committed
137
<h2>1.6 Are there other open-source implementations of OpenGL?</h2>
138
<p>
139
Yes, SGI's <a href="http://oss.sgi.com/projects/ogl-sample/index.html">
Nathan Kidd's avatar
Nathan Kidd committed
140
OpenGL Sample Implementation (SI)</a> is available.
141 142 143 144
The SI was written during the time that OpenGL was originally designed.
Unfortunately, development of the SI has stagnated.
Mesa is much more up to date with modern features and extensions.
</p>
145 146

<p>
147
<a href="https://sourceforge.net/projects/ogl-es/">Vincent</a> is
148 149
an open-source implementation of OpenGL ES for mobile devices.

150
<p>
151
<a href="http://www.dsbox.com/minigl.html">miniGL</a>
Brian Paul's avatar
Brian Paul committed
152
is a subset of OpenGL for PalmOS devices.
153

Brian Paul's avatar
Brian Paul committed
154
<p>
155
<a href="http://bellard.org/TinyGL/">TinyGL</a>
156
is a subset of OpenGL.
157
</p>
Brian Paul's avatar
Brian Paul committed
158 159

<p>
160
<a href="https://sourceforge.net/projects/softgl/">SoftGL</a>
Brian Paul's avatar
Brian Paul committed
161 162 163
is an OpenGL subset for mobile devices.
</p>

164
<p>
165
<a href="http://chromium.sourceforge.net/">Chromium</a>
Brian Paul's avatar
Brian Paul committed
166 167 168 169 170
isn't a conventional OpenGL implementation (it's layered upon OpenGL),
but it does export the OpenGL API.  It allows tiled rendering, sort-last
rendering, etc.
</p>

171
<p>
172 173
<a href="http://www.ticalc.org/archives/files/fileinfo/361/36173.html">ClosedGL</a>
is an OpenGL subset library for TI graphing calculators.
174 175
</p>

Brian Paul's avatar
Brian Paul committed
176 177 178
<p>
There may be other open OpenGL implementations, but Mesa is the most
popular and feature-complete.
179 180
</p>

Brian Paul's avatar
Brian Paul committed
181 182


183 184 185 186
<br>
<br>


187
<h1 id="part2">2. Compilation and Installation Problems</h1>
188 189


190
<h2>2.1 What's the easiest way to install Mesa?</h2>
191
<p>
192
If you're using a Linux-based system, your distro CD most likely already
193
has Mesa packages (like RPM or DEB) which you can easily install.
194
</p>
195 196


197
<h2>2.2 I get undefined symbols such as bgnpolygon, v3f, etc...</h2>
198
<p>
199
You're application is written in IRIS GL, not OpenGL.
200 201 202
IRIS GL was the predecessor to OpenGL and is a different thing (almost)
entirely.
Mesa's not the solution.
203
</p>
204 205


206
<h2>2.3 Where is the GLUT library?</h2>
207
<p>
208
GLUT (OpenGL Utility Toolkit) is no longer in the separate MesaGLUT-x.y.z.tar.gz file.
209 210
If you don't already have GLUT installed, you should grab 
<a href="http://freeglut.sourceforge.net/">freeglut</a>.
211
</p>
212 213


214
<h2>2.4 Where is the GLw library?</h2>
215
<p>
216
GLw (OpenGL widget library) is now available from a separate <a href="https://cgit.freedesktop.org/mesa/glw/">git repository</a>.  Unless you're using very old Xt/Motif applications with OpenGL, you shouldn't need it.
217
</p>
218

219

220
<h2>2.5 What's the proper place for the libraries and headers?</h2>
221
<p>
222
On Linux-based systems you'll want to follow the
223
<a href="http://oss.sgi.com/projects/ogl-sample/ABI/index.html">Linux ABI</a> standard.
224 225 226 227 228 229 230 231 232 233 234 235 236 237 238
Basically you'll want the following:
</p>
<ul>
<li>/usr/include/GL/gl.h - the main OpenGL header
</li><li>/usr/include/GL/glu.h - the OpenGL GLU (utility) header
</li><li>/usr/include/GL/glx.h - the OpenGL GLX header
</li><li>/usr/include/GL/glext.h - the OpenGL extensions header
</li><li>/usr/include/GL/glxext.h - the OpenGL GLX extensions header
</li><li>/usr/include/GL/osmesa.h - the Mesa off-screen rendering header
</li><li>/usr/lib/libGL.so - a symlink to libGL.so.1
</li><li>/usr/lib/libGL.so.1 - a symlink to libGL.so.1.xyz
</li><li>/usr/lib/libGL.so.xyz - the actual OpenGL/Mesa library.  xyz denotes the
Mesa version number.
</li></ul>
<p>
Andreas Boll's avatar
Andreas Boll committed
239 240 241 242 243 244 245 246 247 248 249
When configuring Mesa, there are three autoconf options that affect the install
location that you should take care with: <code>--prefix</code>,
<code>--libdir</code>, and <code>--with-dri-driverdir</code>. To install Mesa
into the system location where it will be available for all programs to use, set
<code>--prefix=/usr</code>. Set <code>--libdir</code> to where your Linux
distribution installs system libraries, usually either <code>/usr/lib</code> or
<code>/usr/lib64</code>. Set <code>--with-dri-driverdir</code> to the directory
where your Linux distribution installs DRI drivers. To find your system's DRI
driver directory, try executing <code>find /usr -type d -name dri</code>. For
example, if the <code>find</code> command listed <code>/usr/lib64/dri</code>,
then set <code>--with-dri-driverdir=/usr/lib64/dri</code>.
250 251
</p>
<p>
Andreas Boll's avatar
Andreas Boll committed
252 253 254
After determining the correct values for the install location, configure Mesa
with <code>./configure --prefix=/usr --libdir=xxx --with-dri-driverdir=xxx</code>
and then install with <code>sudo make install</code>.
255 256 257 258 259
</p>
<br>
<br>


260
<h1 id="part3">3. Runtime / Rendering Problems</h1>
261

262
<h2>3.1 Rendering is slow / why isn't my graphics hardware being used?</h2>
263
<p>
Andreas Boll's avatar
Andreas Boll committed
264 265
If Mesa can't use its hardware accelerated drivers it falls back on one of its software renderers.
(eg. classic swrast, softpipe or llvmpipe)
266
</p>
267
<p>
268
You can run the <code>glxinfo</code> program to learn about your OpenGL
269
library.
Andreas Boll's avatar
Andreas Boll committed
270 271
Look for the <code>OpenGL vendor</code> and <code>OpenGL renderer</code> values.
That will identify who's OpenGL library with which driver you're using and what sort of
272
hardware it has detected.
273
</p>
274
<p>
Andreas Boll's avatar
Andreas Boll committed
275 276 277
If you're using a hardware accelerated driver you want <code>direct rendering: Yes</code>.
</p>
<p>
278
If your DRI-based driver isn't working, go to the
279
<a href="https://dri.freedesktop.org/">DRI website</a> for trouble-shooting information.
280 281 282 283 284 285 286
</p>


<h2>3.2 I'm seeing errors in depth (Z) buffering.  Why?</h2>
<p>
Make sure the ratio of the far to near clipping planes isn't too great.
Look
287
<a href="https://www.opengl.org/resources/faq/technical/depthbuffer.htm#0040">here</a>
288
for details.
289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333
</p>
<p>
Mesa uses a 16-bit depth buffer by default which is smaller and faster
to clear than a 32-bit buffer but not as accurate.
If you need a deeper you can modify the parameters to
<code> glXChooseVisual</code> in your code.
</p>


<h2>3.3 Why Isn't depth buffering working at all?</h2>
<p>
Be sure you're requesting a depth buffered-visual.  If you set the MESA_DEBUG
environment variable it will warn you about trying to enable depth testing
when you don't have a depth buffer.
</p>
<p>Specifically, make sure <code>glutInitDisplayMode</code> is being called
with <code>GLUT_DEPTH</code> or <code>glXChooseVisual</code> is being
called with a non-zero value for GLX_DEPTH_SIZE.
</p>
<p>This discussion applies to stencil buffers, accumulation buffers and
alpha channels too.
</p>


<h2>3.4 Why does glGetString() always return NULL?</h2>
<p>
Be sure you have an active/current OpenGL rendering context before
calling glGetString.
</p>


<h2>3.5 GL_POINTS and GL_LINES don't touch the right pixels</h2>
<p>
If you're trying to draw a filled region by using GL_POINTS or GL_LINES
and seeing holes or gaps it's because of a float-to-int rounding problem.
But this is not a bug.
See Appendix H of the OpenGL Programming Guide - "OpenGL Correctness Tips".
Basically, applying a translation of (0.375, 0.375, 0.0) to your coordinates
will fix the problem.
</p>

<br>
<br>


334
<h1 id="part4">4. Developer Questions</h1>
335

336
<h2>4.1 How can I contribute?</h2>
337
<p>
Andreas Boll's avatar
Andreas Boll committed
338
First, join the <a href="lists.html">mesa-dev mailing list</a>.
Brian Paul's avatar
Brian Paul committed
339
That's where Mesa development is discussed.
340
</p>
341
<p>
342
The <a href="https://www.opengl.org/documentation">
Nathan Kidd's avatar
Nathan Kidd committed
343
OpenGL Specification</a> is the bible for OpenGL implementation work.
344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359
You should read it.
</p>
<p>Most of the Mesa development work involves implementing new OpenGL
extensions, writing hardware drivers (for the DRI), and code optimization.
</p>

<h2>4.2 How do I write a new device driver?</h2>
<p>
Unfortunately, writing a device driver isn't easy.
It requires detailed understanding of OpenGL, the Mesa code, and your
target hardware/operating system.
3D graphics are not simple.
</p>
<p>
The best way to get started is to use an existing driver as your starting
point.
Andreas Boll's avatar
Andreas Boll committed
360 361
For a classic hardware driver, the i965 driver is a good example.
For a Gallium3D hardware driver, the r300g, r600g and the i915g are good examples.
362 363 364
</p>
<p>The DRI website has more information about writing hardware drivers.
The process isn't well document because the Mesa driver interface changes
Nathan Kidd's avatar
Nathan Kidd committed
365
over time, and we seldom have spare time for writing documentation.
366 367 368 369 370 371 372 373
That being said, many people have managed to figure out the process.
</p>
<p>
Joining the appropriate mailing lists and asking questions (and searching
the archives) is a good way to get information.
</p>


374
<h2>4.3 Why isn't GL_EXT_texture_compression_s3tc implemented in Mesa?</h2>
375
<p>
376 377 378
Oh but it is! Prior to 2nd October 2017, the Mesa project did not include s3tc
support due to intellectual property (IP) and/or patent issues around the s3tc
algorithm.
379
</p>
380 381
<p>
As of Mesa 17.3.0, Mesa now officially supports s3tc, as the patent has expired.
382 383
</p>
<p>
384 385
In versions prior to this, a 3rd party <a href="https://dri.freedesktop.org/wiki/S3TC">
plug-in library</a> was required.
386 387
</p>

388
</div>
389 390
</body>
</html>