Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / mesa3d / 0c65604eeb50bdd47865e11645a78e989128ed9b / . / docs / faq.html
blob: 9aee4ee00d0882f17ab8aee98c086cc683809471 [file] [log] [blame]
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]1<html>
2
3<head><title>Mesa FAQ</title></head>
4
Brian Paul36da0452005-01-20 03:55:10 +0000[diff] [blame]5<link rel="stylesheet" type="text/css" href="mesa.css"></head>
6
7<BODY>
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]8
9
10<center>
11<h1>Mesa Frequently Asked Questions</h1>
Brian Paul0c656042006-06-08 19:59:41 +0000[diff] [blame^]12Last updated: 8 June 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
49drivers for XFree86/X.org. See the <a href="http://dri.sf.net/">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:
Brian Paul65b79052004-11-22 17:49:15 +0000[diff] [blame]92<ul>
93<li>The GLX API is supported, but it's really just an emulation of the
94 real thing.
95<li>The GLX wire protocol is not supported and there's no OpenGL extension
96 loaded by the X server.
97<li>There is no hardware acceleration.
98<li>The OpenGL library, libGL.so, contains everything (the programming API,
99 the GLX functions and all the rendering code).
100</ul>
101</p>
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
Brian Paul65b79052004-11-22 17:49:15 +0000[diff] [blame]190<h2><a name="part2">2.2 Running <code>configure; make</code> doesn't Work</a></h2>
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]191<p>
Brian Paul65b79052004-11-22 17:49:15 +0000[diff] [blame]192Mesa no longer supports GNU autoconf/automake. Why?
193<ul>
194<li>It seemed to seldom work on anything but Linux
195<li>The config files were hard to maintain and hard to understand
196<li>libtool caused a lot of grief
197</ul>
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]198
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]199<p>
Brian Paul7e4cc1c2005-10-24 23:33:27 +0000[diff] [blame]200Now Mesa again uses a conventional Makefile system (as it did originally).
Brian Paul65b79052004-11-22 17:49:15 +0000[diff] [blame]201Basically, each Makefile in the tree includes one of the configuration
202files from the config/ directory.
203The config files specify all the variables for a variety of popular systems.
204</p>
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]205
206
Brian Paul65b79052004-11-22 17:49:15 +0000[diff] [blame]207<h2><a name="part2">2.3 I get undefined symbols such as bgnpolygon, v3f, etc...</a></h2>
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]208<p>
209<a name="part2">You're application is written in IRIS GL, not OpenGL.
210IRIS GL was the predecessor to OpenGL and is a different thing (almost)
211entirely.
212Mesa's not the solution.
213</a></p>
214
215
Brian Paul65b79052004-11-22 17:49:15 +0000[diff] [blame]216<h2><a name="part2">2.4 Where is the GLUT library?</a></h2>
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]217<p>
Brian Paul7e4cc1c2005-10-24 23:33:27 +0000[diff] [blame]218<a name="part2">GLUT (OpenGL Utility Toolkit) is in the separate MesaGLUT-x.y.z.tar.gz file.
219If you don't already have GLUT installed, you should grab the MesaGLUT
220package and compile it with the rest of Mesa.
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]221</a></p>
222
223
224
Brian Paul65b79052004-11-22 17:49:15 +0000[diff] [blame]225<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]226<p>
227<a name="part2">On Linux-based systems you'll want to follow the
Brian Paulfc528e22003-12-31 20:59:51 +0000[diff] [blame]228</a><a href="http://oss.sgi.com/projects/ogl-sample/ABI/index.html"
229target="_parent">Linux ABI</a> standard.
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]230Basically you'll want the following:
231</p>
232<ul>
233<li>/usr/include/GL/gl.h - the main OpenGL header
234</li><li>/usr/include/GL/glu.h - the OpenGL GLU (utility) header
235</li><li>/usr/include/GL/glx.h - the OpenGL GLX header
236</li><li>/usr/include/GL/glext.h - the OpenGL extensions header
237</li><li>/usr/include/GL/glxext.h - the OpenGL GLX extensions header
238</li><li>/usr/include/GL/osmesa.h - the Mesa off-screen rendering header
239</li><li>/usr/lib/libGL.so - a symlink to libGL.so.1
240</li><li>/usr/lib/libGL.so.1 - a symlink to libGL.so.1.xyz
241</li><li>/usr/lib/libGL.so.xyz - the actual OpenGL/Mesa library. xyz denotes the
242Mesa version number.
243</li><li>/usr/lib/libGLU.so - a symlink to libGLU.so.1
244</li><li>/usr/lib/libGLU.so.1 - a symlink to libGLU.so.1.3.xyz
245</li><li>/usr/lib/libGLU.so.xyz - the OpenGL Utility library. xyz denotes the Mesa
246version number.
247</li></ul>
248<p>
Brian Paul7e4cc1c2005-10-24 23:33:27 +0000[diff] [blame]249After installing XFree86/X.org and the DRI drivers, some of these files
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]250may be symlinks into the /usr/X11R6/ tree.
251</p>
252<p>
253The old-style Makefile system doesn't install the Mesa libraries; it's
254up to you to copy them (and the headers) to the right place.
255</p>
256<p>
257The GLUT header and library should go in the same directories.
258</p>
259<br>
260<br>
261
262
263<a name="part3">
264</a><h1><a name="part3">3. Runtime / Rendering Problems</a></h1>
265
266<h2><a name="part3">3.1 Rendering is slow / why isn't my graphics hardware being used?</a></h2>
267<p>
268<a name="part3">Stand-alone Mesa (downloaded as MesaLib-x.y.z.tar.gz) doesn't have any
269support for hardware acceleration (with the exception of the 3DFX Voodoo
270driver).
271</a></p>
272<p>
273<a name="part3">What you really want is a DRI or NVIDIA (or another vendor's OpenGL) driver
274for your particular hardware.
275</a></p>
276<p>
277<a name="part3">You can run the <code>glxinfo</code> program to learn about your OpenGL
278library.
279Look for the GL_VENDOR and GL_RENDERER values.
280That will identify who's OpenGL library you're using and what sort of
281hardware it has detected.
282</a></p>
283<p>
284<a name="part3">If your DRI-based driver isn't working, go to the
Brian Paulfc528e22003-12-31 20:59:51 +0000[diff] [blame]285</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]286</p>
287
288
289<h2>3.2 I'm seeing errors in depth (Z) buffering. Why?</h2>
290<p>
291Make sure the ratio of the far to near clipping planes isn't too great.
292Look
Brian Paulfc528e22003-12-31 20:59:51 +0000[diff] [blame]293<a href="http://www.sgi.com/software/opengl/advanced97/notes/node18.html"
294target="_parent">
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]295here</a> for details.
296</p>
297<p>
298Mesa uses a 16-bit depth buffer by default which is smaller and faster
299to clear than a 32-bit buffer but not as accurate.
300If you need a deeper you can modify the parameters to
301<code> glXChooseVisual</code> in your code.
302</p>
303
304
305<h2>3.3 Why Isn't depth buffering working at all?</h2>
306<p>
307Be sure you're requesting a depth buffered-visual. If you set the MESA_DEBUG
308environment variable it will warn you about trying to enable depth testing
309when you don't have a depth buffer.
310</p>
311<p>Specifically, make sure <code>glutInitDisplayMode</code> is being called
312with <code>GLUT_DEPTH</code> or <code>glXChooseVisual</code> is being
313called with a non-zero value for GLX_DEPTH_SIZE.
314</p>
315<p>This discussion applies to stencil buffers, accumulation buffers and
316alpha channels too.
317</p>
318
319
320<h2>3.4 Why does glGetString() always return NULL?</h2>
321<p>
322Be sure you have an active/current OpenGL rendering context before
323calling glGetString.
324</p>
325
326
327<h2>3.5 GL_POINTS and GL_LINES don't touch the right pixels</h2>
328<p>
329If you're trying to draw a filled region by using GL_POINTS or GL_LINES
330and seeing holes or gaps it's because of a float-to-int rounding problem.
331But this is not a bug.
332See Appendix H of the OpenGL Programming Guide - "OpenGL Correctness Tips".
333Basically, applying a translation of (0.375, 0.375, 0.0) to your coordinates
334will fix the problem.
335</p>
336
337<br>
338<br>
339
340
341<a name="part4">
342</a><h1><a name="part4">4. Developer Questions</a></h1>
343
344<h2><a name="part4">4.1 How can I contribute?</a></h2>
345<p>
346<a name="part4">First, join the Mesa3d-dev mailing list. That's where Mesa development
347is discussed.
348</a></p>
349<p>
Brian Paulfc528e22003-12-31 20:59:51 +0000[diff] [blame]350<a name="part4">The </a><a href="http://www.opengl.org/developers/documentation/specs.html" target="_parent">
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]351OpenGL Specification</a> is the bible for OpenGL implemention work.
352You should read it.
353</p>
354<p>Most of the Mesa development work involves implementing new OpenGL
355extensions, writing hardware drivers (for the DRI), and code optimization.
356</p>
357
358<h2>4.2 How do I write a new device driver?</h2>
359<p>
360Unfortunately, writing a device driver isn't easy.
361It requires detailed understanding of OpenGL, the Mesa code, and your
362target hardware/operating system.
3633D graphics are not simple.
364</p>
365<p>
366The best way to get started is to use an existing driver as your starting
367point.
368For a software driver, the X11 and OSMesa drivers are good examples.
369For a hardware driver, the Radeon and R200 DRI drivers are good examples.
370</p>
371<p>The DRI website has more information about writing hardware drivers.
372The process isn't well document because the Mesa driver interface changes
373over time, and we seldome have spare time for writing documentation.
374That being said, many people have managed to figure out the process.
375</p>
376<p>
377Joining the appropriate mailing lists and asking questions (and searching
378the archives) is a good way to get information.
379</p>
380
381
Brian Paul0c656042006-06-08 19:59:41 +0000[diff] [blame^]382<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]383<p>
384The <a href="http://oss.sgi.com/projects/ogl-sample/registry/EXT/texture_compression_s3tc.txt" target="_parent">specification for the extension</a>
385indicates that there are intellectual property (IP) and/or patent issues
386to be dealt with.
387</p>
388<p>We've been unsucessful in getting a response from S3 (or whoever owns
389the IP nowadays) to indicate whether or not an open source project can
390implement the extension (specifically the compression/decompression
391algorithms).
392</p>
393<p>
Brian Paul0c656042006-06-08 19:59:41 +0000[diff] [blame^]394In the mean time, a 3rd party <a href=
395"http://homepage.hispeed.ch/rscheidegger/dri_experimental/s3tc_index.html"
396target="_parent">plug-in library</a> is available.
Brian Paulfc528e22003-12-31 20:59:51 +0000[diff] [blame]397</p>
398
399
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]400</body>
401</html>