Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / mesa3d / df2be226d9ca6772eb4615ce0670e66667b86691 / . / docs / faq.html
blob: 333ba8d7ecd81b2e1081db04ae1e07ad9304d5c9 [file] [log] [blame]
Andreas Bollecd5c7c2012-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>Mesa FAQ</title>
6 <link rel="stylesheet" type="text/css" href="mesa.css">
7</head>
8<body>
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]9
10<center>
11<h1>Mesa Frequently Asked Questions</h1>
Brian Pauld5299bf2006-08-21 14:26:06 +0000[diff] [blame]12Last updated: 21 August 2006
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]13</center>
14
15<br>
16<br>
17<h2>Index</h2>
18<a href="#part1">1. High-level Questions and Answers</a>
19<br>
20<a href="#part2">2. Compilation and Installation Problems</a>
21<br>
22<a href="#part3">3. Runtime / Rendering Problems</a>
23<br>
24<a href="#part4">4. Developer Questions</a>
25<br>
26<br>
27<br>
28
29
30
31<a name="part1">
32</a><h1><a name="part1">1. High-level Questions and Answers</a></h1>
33
34<h2><a name="part1">1.1 What is Mesa?</a></h2>
35<p>
36<a name="part1">Mesa is an open-source implementation of the OpenGL specification.
Brian Paula376e332003-03-30 16:54:36 +0000[diff] [blame]37OpenGL is a programming library for writing interactive 3D applications.
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]38See the </a><a href="http://www.opengl.org/">OpenGL website</a> for more
39information.
40</p>
41<p>
Brian Paul7e4cc1c2005-10-24 23:33:27 +0000[diff] [blame]42Mesa 6.x supports the OpenGL 1.5 specification.
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]43</p>
44
45
46<h2>1.2 Does Mesa support/use graphics hardware?</h2>
47<p>
Brian Paul7e4cc1c2005-10-24 23:33:27 +0000[diff] [blame]48Yes. Specifically, Mesa serves as the OpenGL core for the open-source DRI
Brian Pauld5299bf2006-08-21 14:26:06 +0000[diff] [blame]49drivers for XFree86/X.org. See the <a href="http://dri.freedesktop.org/">DRI
Brian Paula376e332003-03-30 16:54:36 +0000[diff] [blame]50website</a> for more information.
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]51</p>
52<p>
53There have been other hardware drivers for Mesa over the years (such as
54the 3Dfx Glide/Voodoo driver, an old S3 driver, etc) but the DRI drivers
55are the modern ones.
56</p>
57
Brian Paul65b79052004-11-22 17:49:15 +0000[diff] [blame]58<h2>1.3 What purpose does Mesa serve today?</h2>
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]59<p>
Brian Paula376e332003-03-30 16:54:36 +0000[diff] [blame]60Hardware-accelerated OpenGL implementations are available for most popular
61operating systems today.
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]62Still, Mesa serves at least these purposes:
63</p>
64<ul>
Brian Paul7e4cc1c2005-10-24 23:33:27 +0000[diff] [blame]65<li>Mesa is used as the core of the open-source XFree86/X.org DRI
66 hardware drivers.
Brian Paula376e332003-03-30 16:54:36 +0000[diff] [blame]67</li>
68<li>Mesa is quite portable and allows OpenGL to be used on systems
69 that have no other OpenGL solution.
70</li>
71<li>Software rendering with Mesa serves as a reference for validating the
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]72 hardware drivers.
Brian Paula376e332003-03-30 16:54:36 +0000[diff] [blame]73</li>
74<li>A software implementation of OpenGL is useful for experimentation,
75 such as testing new rendering techniques.
76</li>
77<li>Mesa can render images with deep color channels: 16-bit integer
78 and 32-bit floating point color channels are supported.
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]79 This capability is only now appearing in hardware.
Brian Paula376e332003-03-30 16:54:36 +0000[diff] [blame]80</li>
81<li>Mesa's internal limits (max lights, clip planes, texture size, etc) can be
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]82 changed for special needs (hardware limits are hard to overcome).
Brian Paula376e332003-03-30 16:54:36 +0000[diff] [blame]83</li>
84</ul>
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]85
Brian Paul65b79052004-11-22 17:49:15 +0000[diff] [blame]86
87<h2>1.4 What's the difference between"Stand-Alone" Mesa and the DRI drivers?</h2>
88<p>
89<em>Stand-alone Mesa</em> is the original incarnation of Mesa.
Brian Paul7e4cc1c2005-10-24 23:33:27 +0000[diff] [blame]90On systems running the X Window System it does all its rendering through
91the Xlib API:
Andreas Bolldf2be222012-06-12 09:05:22 +0200[diff] [blame^]92</p>
Brian Paul65b79052004-11-22 17:49:15 +0000[diff] [blame]93<ul>
94<li>The GLX API is supported, but it's really just an emulation of the
95 real thing.
96<li>The GLX wire protocol is not supported and there's no OpenGL extension
97 loaded by the X server.
98<li>There is no hardware acceleration.
99<li>The OpenGL library, libGL.so, contains everything (the programming API,
100 the GLX functions and all the rendering code).
101</ul>
Brian Paul65b79052004-11-22 17:49:15 +0000[diff] [blame]102<p>
103Alternately, Mesa acts as the core for a number of OpenGL hardware drivers
104within the DRI (Direct Rendering Infrastructure):
105<ul>
106<li>The libGL.so library provides the GL and GLX API functions, a GLX
107 protocol encoder, and a device driver loader.
108<li>The device driver modules (such as r200_dri.so) contain a built-in
109 copy of the core Mesa code.
110<li>The X server loads the GLX module.
111 The GLX module decodes incoming GLX protocol and dispatches the commands
112 to a rendering module.
113 For the DRI, this module is basically a software Mesa renderer.
114</ul>
115
116
117
118<h2>1.5 How do I upgrade my DRI installation to use a new Mesa release?</h2>
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]119<p>
Brian Paul7e4cc1c2005-10-24 23:33:27 +0000[diff] [blame]120This wasn't easy in the past.
121Now, the DRI drivers are included in the Mesa tree and can be compiled
122separately from the X server.
123Just follow the Mesa <a href="install.html">compilation instructions</a>.
Brian Paul824a4fc2003-08-06 19:05:26 +0000[diff] [blame]124</p>
125
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]126
Brian Paul65b79052004-11-22 17:49:15 +0000[diff] [blame]127<h2>1.6 Are there other open-source implementations of OpenGL?</h2>
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]128<p>
Brian Paul7df4f952003-11-25 21:13:26 +0000[diff] [blame]129Yes, SGI's <a href="http://oss.sgi.com/projects/ogl-sample/index.html"
130target="_parent">
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]131OpenGL Sample Implemenation (SI)</a> is available.
132The SI was written during the time that OpenGL was originally designed.
133Unfortunately, development of the SI has stagnated.
134Mesa is much more up to date with modern features and extensions.
135</p>
Brian Paul186d4d82004-04-27 12:55:08 +0000[diff] [blame]136
137<p>
138<a href="http://ogl-es.sourceforge.net" target="_parent">Vincent</a> is
139an open-source implementation of OpenGL ES for mobile devices.
140
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]141<p>
Brian Paul7df4f952003-11-25 21:13:26 +0000[diff] [blame]142<a href="http://www.dsbox.com/minigl.html" target="_parent">miniGL</a>
143is a subset of OpenGL for PalmOS devices.
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]144
Brian Paul7df4f952003-11-25 21:13:26 +0000[diff] [blame]145<p>
146<a href="http://fabrice.bellard.free.fr/TinyGL/"
147target="_parent">TinyGL</a> is a subset of OpenGL.
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]148</p>
Brian Paul7df4f952003-11-25 21:13:26 +0000[diff] [blame]149
150<p>
151<a href="http://softgl.studierstube.org/" target="_parent">SoftGL</a>
152is an OpenGL subset for mobile devices.
153</p>
154
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]155<p>
Brian Paulacbc1e02003-11-26 18:10:31 +0000[diff] [blame]156<a href="http://chromium.sourceforge.net/" target="_parent">Chromium</a>
157isn't a conventional OpenGL implementation (it's layered upon OpenGL),
158but it does export the OpenGL API. It allows tiled rendering, sort-last
159rendering, etc.
160</p>
161
Brian Paulacbc1e02003-11-26 18:10:31 +0000[diff] [blame]162<p>
Brian Paul0c656042006-06-08 19:59:41 +0000[diff] [blame]163<a href="http://www.ticalc.org/archives/files/fileinfo/361/36173.html"
164target="_parent">ClosedGL</a> is an OpenGL subset library for TI
165graphing calculators.
166</p>
167
168<p>
Brian Paulacbc1e02003-11-26 18:10:31 +0000[diff] [blame]169There may be other open OpenGL implementations, but Mesa is the most
170popular and feature-complete.
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]171</p>
172
Brian Paul65b79052004-11-22 17:49:15 +0000[diff] [blame]173
174
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]175<br>
176<br>
177
178
179<a name="part2">
180</a><h1><a name="part2">2. Compilation and Installation Problems</a></h1>
181
182
183<h2><a name="part2">2.1 What's the easiest way to install Mesa?</a></h2>
184<p>
185<a name="part2">If you're using a Linux-based system, your distro CD most likely already
186has Mesa packages (like RPM or DEB) which you can easily install.
187</a></p>
188
189
Dan Nicholson4c5a2b32007-12-23 16:38:18 -0800[diff] [blame]190<h2><a name="part2">2.2 I get undefined symbols such as bgnpolygon, v3f, etc...</a></h2>
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]191<p>
192<a name="part2">You're application is written in IRIS GL, not OpenGL.
193IRIS GL was the predecessor to OpenGL and is a different thing (almost)
194entirely.
195Mesa's not the solution.
196</a></p>
197
198
Dan Nicholson4c5a2b32007-12-23 16:38:18 -0800[diff] [blame]199<h2><a name="part2">2.3 Where is the GLUT library?</a></h2>
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]200<p>
José Fonseca9a7f84d2011-07-14 17:28:52 +0100[diff] [blame]201<a name="part2">GLUT (OpenGL Utility Toolkit) is no longer in the separate MesaGLUT-x.y.z.tar.gz file.
202If you don't already have GLUT installed, you should grab
203<a href="http://freeglut.sourceforge.net/">freeglut</a>.
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]204</a></p>
205
206
Kenneth Graunkec5481922011-08-05 16:59:04 -0700[diff] [blame]207<h2><a name="part2">2.4 Where is the GLw library?</a></h2>
208<p>
209<a name="part2">GLw (OpenGL widget library) is now available from a separate <a href="http://cgit.freedesktop.org/mesa/glw/">git repository</a>. Unless you're using very old Xt/Motif applications with OpenGL, you shouldn't need it.
210</a></p>
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]211
Kenneth Graunkec5481922011-08-05 16:59:04 -0700[diff] [blame]212
213<h2><a name="part2">2.5 What's the proper place for the libraries and headers?</a></h2>
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]214<p>
215<a name="part2">On Linux-based systems you'll want to follow the
Brian Paulfc528e22003-12-31 20:59:51 +0000[diff] [blame]216</a><a href="http://oss.sgi.com/projects/ogl-sample/ABI/index.html"
217target="_parent">Linux ABI</a> standard.
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]218Basically you'll want the following:
219</p>
220<ul>
221<li>/usr/include/GL/gl.h - the main OpenGL header
222</li><li>/usr/include/GL/glu.h - the OpenGL GLU (utility) header
223</li><li>/usr/include/GL/glx.h - the OpenGL GLX header
224</li><li>/usr/include/GL/glext.h - the OpenGL extensions header
225</li><li>/usr/include/GL/glxext.h - the OpenGL GLX extensions header
226</li><li>/usr/include/GL/osmesa.h - the Mesa off-screen rendering header
227</li><li>/usr/lib/libGL.so - a symlink to libGL.so.1
228</li><li>/usr/lib/libGL.so.1 - a symlink to libGL.so.1.xyz
229</li><li>/usr/lib/libGL.so.xyz - the actual OpenGL/Mesa library. xyz denotes the
230Mesa version number.
231</li><li>/usr/lib/libGLU.so - a symlink to libGLU.so.1
232</li><li>/usr/lib/libGLU.so.1 - a symlink to libGLU.so.1.3.xyz
233</li><li>/usr/lib/libGLU.so.xyz - the OpenGL Utility library. xyz denotes the Mesa
234version number.
235</li></ul>
236<p>
Brian Paul7e4cc1c2005-10-24 23:33:27 +0000[diff] [blame]237After installing XFree86/X.org and the DRI drivers, some of these files
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]238may be symlinks into the /usr/X11R6/ tree.
239</p>
240<p>
241The old-style Makefile system doesn't install the Mesa libraries; it's
242up to you to copy them (and the headers) to the right place.
243</p>
244<p>
245The GLUT header and library should go in the same directories.
246</p>
247<br>
248<br>
249
250
251<a name="part3">
252</a><h1><a name="part3">3. Runtime / Rendering Problems</a></h1>
253
254<h2><a name="part3">3.1 Rendering is slow / why isn't my graphics hardware being used?</a></h2>
255<p>
256<a name="part3">Stand-alone Mesa (downloaded as MesaLib-x.y.z.tar.gz) doesn't have any
257support for hardware acceleration (with the exception of the 3DFX Voodoo
258driver).
259</a></p>
260<p>
261<a name="part3">What you really want is a DRI or NVIDIA (or another vendor's OpenGL) driver
262for your particular hardware.
263</a></p>
264<p>
265<a name="part3">You can run the <code>glxinfo</code> program to learn about your OpenGL
266library.
267Look for the GL_VENDOR and GL_RENDERER values.
268That will identify who's OpenGL library you're using and what sort of
269hardware it has detected.
270</a></p>
271<p>
272<a name="part3">If your DRI-based driver isn't working, go to the
Brian Paulfc528e22003-12-31 20:59:51 +0000[diff] [blame]273</a><a href="http://dri.sf.net/" target="_parent">DRI website</a> for trouble-shooting information.
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]274</p>
275
276
277<h2>3.2 I'm seeing errors in depth (Z) buffering. Why?</h2>
278<p>
279Make sure the ratio of the far to near clipping planes isn't too great.
280Look
Brian Pauld5299bf2006-08-21 14:26:06 +0000[diff] [blame]281<a href="http://www.opengl.org/resources/faq/technical/depthbuffer.htm#0040"
282target="_parent"> here</a> for details.
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]283</p>
284<p>
285Mesa uses a 16-bit depth buffer by default which is smaller and faster
286to clear than a 32-bit buffer but not as accurate.
287If you need a deeper you can modify the parameters to
288<code> glXChooseVisual</code> in your code.
289</p>
290
291
292<h2>3.3 Why Isn't depth buffering working at all?</h2>
293<p>
294Be sure you're requesting a depth buffered-visual. If you set the MESA_DEBUG
295environment variable it will warn you about trying to enable depth testing
296when you don't have a depth buffer.
297</p>
298<p>Specifically, make sure <code>glutInitDisplayMode</code> is being called
299with <code>GLUT_DEPTH</code> or <code>glXChooseVisual</code> is being
300called with a non-zero value for GLX_DEPTH_SIZE.
301</p>
302<p>This discussion applies to stencil buffers, accumulation buffers and
303alpha channels too.
304</p>
305
306
307<h2>3.4 Why does glGetString() always return NULL?</h2>
308<p>
309Be sure you have an active/current OpenGL rendering context before
310calling glGetString.
311</p>
312
313
314<h2>3.5 GL_POINTS and GL_LINES don't touch the right pixels</h2>
315<p>
316If you're trying to draw a filled region by using GL_POINTS or GL_LINES
317and seeing holes or gaps it's because of a float-to-int rounding problem.
318But this is not a bug.
319See Appendix H of the OpenGL Programming Guide - "OpenGL Correctness Tips".
320Basically, applying a translation of (0.375, 0.375, 0.0) to your coordinates
321will fix the problem.
322</p>
323
Tom Fogal9a8781b2009-08-13 19:51:57 -0600[diff] [blame]324<h2>3.6 How can I change the maximum framebuffer size in Mesa's
325<tt>swrast</tt> backend?</h2>
326<p>
327These can be overridden by using the <tt>--with-max-width</tt> and
328<tt>--with-max-height</tt> options. The two need not be equal.
329</p><p>
330Do note that Mesa uses these values to size some internal buffers,
331so increasing these sizes will cause Mesa to require additional
332memory. Furthermore, increasing these limits beyond <tt>4096</tt>
333may introduce rasterization artifacts; see the leading comments in
334<tt>src/mesa/swrast/s_tritemp.h</tt>.
335</p>
336
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]337<br>
338<br>
339
340
341<a name="part4">
342</a><h1><a name="part4">4. Developer Questions</a></h1>
343
Brian Pauld5299bf2006-08-21 14:26:06 +0000[diff] [blame]344<h2>4.1 How can I contribute?</a></h2>
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]345<p>
Dan Nicholsonf71032b2007-12-14 09:59:16 -0800[diff] [blame]346First, join the <a href="http://www.mesa3d.org/lists.html">Mesa3d-dev
Brian Pauld5299bf2006-08-21 14:26:06 +0000[diff] [blame]347mailing list</a>.
348That's where Mesa development is discussed.
Dan Nicholsonf71032b2007-12-14 09:59:16 -0800[diff] [blame]349</p>
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]350<p>
Dan Nicholsonf71032b2007-12-14 09:59:16 -0800[diff] [blame]351The <a href="http://www.opengl.org/documentation" target="_parent">
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]352OpenGL Specification</a> is the bible for OpenGL implemention work.
353You should read it.
354</p>
355<p>Most of the Mesa development work involves implementing new OpenGL
356extensions, writing hardware drivers (for the DRI), and code optimization.
357</p>
358
359<h2>4.2 How do I write a new device driver?</h2>
360<p>
361Unfortunately, writing a device driver isn't easy.
362It requires detailed understanding of OpenGL, the Mesa code, and your
363target hardware/operating system.
3643D graphics are not simple.
365</p>
366<p>
367The best way to get started is to use an existing driver as your starting
368point.
369For a software driver, the X11 and OSMesa drivers are good examples.
370For a hardware driver, the Radeon and R200 DRI drivers are good examples.
371</p>
372<p>The DRI website has more information about writing hardware drivers.
373The process isn't well document because the Mesa driver interface changes
374over time, and we seldome have spare time for writing documentation.
375That being said, many people have managed to figure out the process.
376</p>
377<p>
378Joining the appropriate mailing lists and asking questions (and searching
379the archives) is a good way to get information.
380</p>
381
382
Brian Paul0c656042006-06-08 19:59:41 +0000[diff] [blame]383<h2>4.3 Why isn't GL_EXT_texture_compression_s3tc implemented in Mesa?</h2>
Brian Paulfc528e22003-12-31 20:59:51 +0000[diff] [blame]384<p>
385The <a href="http://oss.sgi.com/projects/ogl-sample/registry/EXT/texture_compression_s3tc.txt" target="_parent">specification for the extension</a>
386indicates that there are intellectual property (IP) and/or patent issues
387to be dealt with.
388</p>
389<p>We've been unsucessful in getting a response from S3 (or whoever owns
390the IP nowadays) to indicate whether or not an open source project can
391implement the extension (specifically the compression/decompression
392algorithms).
393</p>
394<p>
Brian Paul0c656042006-06-08 19:59:41 +0000[diff] [blame]395In the mean time, a 3rd party <a href=
396"http://homepage.hispeed.ch/rscheidegger/dri_experimental/s3tc_index.html"
397target="_parent">plug-in library</a> is available.
Brian Paulfc528e22003-12-31 20:59:51 +0000[diff] [blame]398</p>
399
400
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]401</body>
402</html>