Gitiles
Code Review Sign In
gerrit-public.fairphone.software / fp2-dev / platform / external / mesa3d / acbc1e0c917cf0720c7b5c14ca4bab4fa8c75001 / . / docs / faq.html
blob: f60130dbbed39f49f36ab5fe5289f4defc22699e [file] [log] [blame]
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]1<html>
2
3<head><title>Mesa FAQ</title></head>
4
5<BODY text="#000000" bgcolor="#55bbff" link="#111188">
6
7
8<center>
9<h1>Mesa Frequently Asked Questions</h1>
Brian Paulacbc1e02003-11-26 18:10:31 +0000[diff] [blame^]10Last updated: 26 November 2003
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]11</center>
12
13<br>
14<br>
15<h2>Index</h2>
16<a href="#part1">1. High-level Questions and Answers</a>
17<br>
18<a href="#part2">2. Compilation and Installation Problems</a>
19<br>
20<a href="#part3">3. Runtime / Rendering Problems</a>
21<br>
22<a href="#part4">4. Developer Questions</a>
23<br>
24<br>
25<br>
26
27
28
29<a name="part1">
30</a><h1><a name="part1">1. High-level Questions and Answers</a></h1>
31
32<h2><a name="part1">1.1 What is Mesa?</a></h2>
33<p>
34<a name="part1">Mesa is an open-source implementation of the OpenGL specification.
Brian Paula376e332003-03-30 16:54:36 +0000[diff] [blame]35OpenGL is a programming library for writing interactive 3D applications.
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]36See the </a><a href="http://www.opengl.org/">OpenGL website</a> for more
37information.
38</p>
39<p>
Brian Paula376e332003-03-30 16:54:36 +0000[diff] [blame]40Mesa 5.x supports the OpenGL 1.4 specification.
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]41</p>
42
43
44<h2>1.2 Does Mesa support/use graphics hardware?</h2>
45<p>
Brian Paula376e332003-03-30 16:54:36 +0000[diff] [blame]46Yes. Specifically, Mesa serves as the OpenGL core for the open-source
47XFree86/DRI OpenGL drivers. See the <a href="http://dri.sf.net/">DRI
48website</a> for more information.
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]49</p>
50<p>
51There have been other hardware drivers for Mesa over the years (such as
52the 3Dfx Glide/Voodoo driver, an old S3 driver, etc) but the DRI drivers
53are the modern ones.
54</p>
55
Brian Paula376e332003-03-30 16:54:36 +0000[diff] [blame]56<h2>1.3 What purpose does Mesa (software-based rendering) serve today?</h2>
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]57<p>
Brian Paula376e332003-03-30 16:54:36 +0000[diff] [blame]58Hardware-accelerated OpenGL implementations are available for most popular
59operating systems today.
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]60Still, Mesa serves at least these purposes:
61</p>
62<ul>
Brian Paula376e332003-03-30 16:54:36 +0000[diff] [blame]63<li>Mesa is used as the core of the open-source XFree86/DRI hardware drivers.
64</li>
65<li>Mesa is quite portable and allows OpenGL to be used on systems
66 that have no other OpenGL solution.
67</li>
68<li>Software rendering with Mesa serves as a reference for validating the
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]69 hardware drivers.
Brian Paula376e332003-03-30 16:54:36 +0000[diff] [blame]70</li>
71<li>A software implementation of OpenGL is useful for experimentation,
72 such as testing new rendering techniques.
73</li>
74<li>Mesa can render images with deep color channels: 16-bit integer
75 and 32-bit floating point color channels are supported.
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]76 This capability is only now appearing in hardware.
Brian Paula376e332003-03-30 16:54:36 +0000[diff] [blame]77</li>
78<li>Mesa's internal limits (max lights, clip planes, texture size, etc) can be
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]79 changed for special needs (hardware limits are hard to overcome).
Brian Paula376e332003-03-30 16:54:36 +0000[diff] [blame]80</li>
81</ul>
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]82
83<h2>1.4 How do I upgrade my DRI installation to use a new Mesa release?</h2>
84<p>
Brian Paula376e332003-03-30 16:54:36 +0000[diff] [blame]85You don't! A copy of the Mesa source code lives inside the XFree86/DRI source
86tree and gets compiled into the individual DRI driver modules.
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]87If you try to install Mesa over an XFree86/DRI installation, you'll lose
Brian Paula376e332003-03-30 16:54:36 +0000[diff] [blame]88hardware rendering (because stand-alone Mesa's libGL.so is different than
89the XFree86 libGL.so).
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]90</p>
91<p>
92The DRI developers will incorporate the latest release of Mesa into the
93DRI drivers when the time is right.
94</p>
Brian Paul824a4fc2003-08-06 19:05:26 +0000[diff] [blame]95<p>
96To upgrade, either look for a new release of <a href="http://www.xfree86.org"
97target="_parent">XFree86</a> or visit the
98<a href="http://dri.sf.net" target="_parent">DRI website</a> to see
99if there's newer drivers.
100</p>
101
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]102
103<h2>1.5 Are there other open-source implementations of OpenGL?</h2>
104<p>
Brian Paul7df4f952003-11-25 21:13:26 +0000[diff] [blame]105Yes, SGI's <a href="http://oss.sgi.com/projects/ogl-sample/index.html"
106target="_parent">
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]107OpenGL Sample Implemenation (SI)</a> is available.
108The SI was written during the time that OpenGL was originally designed.
109Unfortunately, development of the SI has stagnated.
110Mesa is much more up to date with modern features and extensions.
111</p>
112<p>
Brian Paul7df4f952003-11-25 21:13:26 +0000[diff] [blame]113<a href="http://www.dsbox.com/minigl.html" target="_parent">miniGL</a>
114is a subset of OpenGL for PalmOS devices.
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]115
Brian Paul7df4f952003-11-25 21:13:26 +0000[diff] [blame]116<p>
117<a href="http://fabrice.bellard.free.fr/TinyGL/"
118target="_parent">TinyGL</a> is a subset of OpenGL.
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]119</p>
Brian Paul7df4f952003-11-25 21:13:26 +0000[diff] [blame]120
121<p>
122<a href="http://softgl.studierstube.org/" target="_parent">SoftGL</a>
123is an OpenGL subset for mobile devices.
124</p>
125
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]126<p>
Brian Paulacbc1e02003-11-26 18:10:31 +0000[diff] [blame^]127<a href="http://chromium.sourceforge.net/" target="_parent">Chromium</a>
128isn't a conventional OpenGL implementation (it's layered upon OpenGL),
129but it does export the OpenGL API. It allows tiled rendering, sort-last
130rendering, etc.
131</p>
132
133
134<p>
135There may be other open OpenGL implementations, but Mesa is the most
136popular and feature-complete.
Brian Paul0b27ace2003-03-08 17:38:57 +0000[diff] [blame]137</p>
138
139<br>
140<br>
141
142
143<a name="part2">
144</a><h1><a name="part2">2. Compilation and Installation Problems</a></h1>
145
146
147<h2><a name="part2">2.1 What's the easiest way to install Mesa?</a></h2>
148<p>
149<a name="part2">If you're using a Linux-based system, your distro CD most likely already
150has Mesa packages (like RPM or DEB) which you can easily install.
151</a></p>
152
153
154<h2><a name="part2">2.2 Running <code>configure; make</code> Doesn't Work</a></h2>
155<p>
156<a name="part2">Unfortunately, the GNU autoconf/automake/libtool system doesn't seem to work
157too well on non GNU/Linux systems, even after installing gmake, gcc, etc.
158For that reason, Mesa's <b>old-style</b> makefile system is still included.
159The old-style system uses good old traditional Makefiles. Try the following:
160</a></p><pre><a name="part2"> cd Mesa-x.y.z
161 cp Makefile.X11 Makefile
162 make
163</a></pre>
164<a name="part2">You'll see a list of system configurations from which to choose.
165For example:
166</a><pre><a name="part2"> make linux-x86
167</a></pre>
168<p>
169<a name="part2">If you're experienced with GNU autoconf/automake/libtool and think you can help
170with maintence, contact the Mesa developers.
171FYI, the Mesa developers generally don't use the autoconf/automake system.
172We're especially annoyed with the fact that a +5000-line script (libtool)
173is needed to make shared libraries (ugh).
174</a></p>
175
176<h2><a name="part2">2.3 Mesa still doesn't compile</a></h2>
177<p>
178<a name="part2">If the old-style Makefile system doesn't work either, make sure you have
179the most recent version of Mesa.
180Otherwise, file a bug report or post to the Mesa3d-users mailing list.
181Give as much info as possible when describing your problem.
182</a></p>
183
184
185<h2><a name="part2">2.4 I get undefined symbols such as bgnpolygon, v3f, etc...</a></h2>
186<p>
187<a name="part2">You're application is written in IRIS GL, not OpenGL.
188IRIS GL was the predecessor to OpenGL and is a different thing (almost)
189entirely.
190Mesa's not the solution.
191</a></p>
192
193
194<h2><a name="part2">2.5 Where is the GLUT library?</a></h2>
195<p>
196<a name="part2">GLUT (OpenGL Utility Toolkit) is in the separate MesaDemos-x.y.z.tar.gz file.
197If you don't already have GLUT installed, you should grab the MesaDemos
198package and unpack it before compiling Mesa.
199</a></p>
200
201
202
203<h2><a name="part2">2.6 What's the proper place for the libraries and headers?</a></h2>
204<p>
205<a name="part2">On Linux-based systems you'll want to follow the
206</a><a href="http://oss.sgi.com/projects/ogl-sample/ABI/index.html">Linux ABI</a>
207standard.
208Basically you'll want the following:
209</p>
210<ul>
211<li>/usr/include/GL/gl.h - the main OpenGL header
212</li><li>/usr/include/GL/glu.h - the OpenGL GLU (utility) header
213</li><li>/usr/include/GL/glx.h - the OpenGL GLX header
214</li><li>/usr/include/GL/glext.h - the OpenGL extensions header
215</li><li>/usr/include/GL/glxext.h - the OpenGL GLX extensions header
216</li><li>/usr/include/GL/osmesa.h - the Mesa off-screen rendering header
217</li><li>/usr/lib/libGL.so - a symlink to libGL.so.1
218</li><li>/usr/lib/libGL.so.1 - a symlink to libGL.so.1.xyz
219</li><li>/usr/lib/libGL.so.xyz - the actual OpenGL/Mesa library. xyz denotes the
220Mesa version number.
221</li><li>/usr/lib/libGLU.so - a symlink to libGLU.so.1
222</li><li>/usr/lib/libGLU.so.1 - a symlink to libGLU.so.1.3.xyz
223</li><li>/usr/lib/libGLU.so.xyz - the OpenGL Utility library. xyz denotes the Mesa
224version number.
225</li></ul>
226<p>
227After installing XFree86 and the DRI drivers, some of these files
228may be symlinks into the /usr/X11R6/ tree.
229</p>
230<p>
231The old-style Makefile system doesn't install the Mesa libraries; it's
232up to you to copy them (and the headers) to the right place.
233</p>
234<p>
235The GLUT header and library should go in the same directories.
236</p>
237<br>
238<br>
239
240
241<a name="part3">
242</a><h1><a name="part3">3. Runtime / Rendering Problems</a></h1>
243
244<h2><a name="part3">3.1 Rendering is slow / why isn't my graphics hardware being used?</a></h2>
245<p>
246<a name="part3">Stand-alone Mesa (downloaded as MesaLib-x.y.z.tar.gz) doesn't have any
247support for hardware acceleration (with the exception of the 3DFX Voodoo
248driver).
249</a></p>
250<p>
251<a name="part3">What you really want is a DRI or NVIDIA (or another vendor's OpenGL) driver
252for your particular hardware.
253</a></p>
254<p>
255<a name="part3">You can run the <code>glxinfo</code> program to learn about your OpenGL
256library.
257Look for the GL_VENDOR and GL_RENDERER values.
258That will identify who's OpenGL library you're using and what sort of
259hardware it has detected.
260</a></p>
261<p>
262<a name="part3">If your DRI-based driver isn't working, go to the
263</a><a href="http://dri.sf.net/">DRI website</a> for trouble-shooting information.
264</p>
265
266
267<h2>3.2 I'm seeing errors in depth (Z) buffering. Why?</h2>
268<p>
269Make sure the ratio of the far to near clipping planes isn't too great.
270Look
271<a href="http://www.sgi.com/software/opengl/advanced97/notes/node18.html">
272here</a> for details.
273</p>
274<p>
275Mesa uses a 16-bit depth buffer by default which is smaller and faster
276to clear than a 32-bit buffer but not as accurate.
277If you need a deeper you can modify the parameters to
278<code> glXChooseVisual</code> in your code.
279</p>
280
281
282<h2>3.3 Why Isn't depth buffering working at all?</h2>
283<p>
284Be sure you're requesting a depth buffered-visual. If you set the MESA_DEBUG
285environment variable it will warn you about trying to enable depth testing
286when you don't have a depth buffer.
287</p>
288<p>Specifically, make sure <code>glutInitDisplayMode</code> is being called
289with <code>GLUT_DEPTH</code> or <code>glXChooseVisual</code> is being
290called with a non-zero value for GLX_DEPTH_SIZE.
291</p>
292<p>This discussion applies to stencil buffers, accumulation buffers and
293alpha channels too.
294</p>
295
296
297<h2>3.4 Why does glGetString() always return NULL?</h2>
298<p>
299Be sure you have an active/current OpenGL rendering context before
300calling glGetString.
301</p>
302
303
304<h2>3.5 GL_POINTS and GL_LINES don't touch the right pixels</h2>
305<p>
306If you're trying to draw a filled region by using GL_POINTS or GL_LINES
307and seeing holes or gaps it's because of a float-to-int rounding problem.
308But this is not a bug.
309See Appendix H of the OpenGL Programming Guide - "OpenGL Correctness Tips".
310Basically, applying a translation of (0.375, 0.375, 0.0) to your coordinates
311will fix the problem.
312</p>
313
314<br>
315<br>
316
317
318<a name="part4">
319</a><h1><a name="part4">4. Developer Questions</a></h1>
320
321<h2><a name="part4">4.1 How can I contribute?</a></h2>
322<p>
323<a name="part4">First, join the Mesa3d-dev mailing list. That's where Mesa development
324is discussed.
325</a></p>
326<p>
327<a name="part4">The </a><a href="http://www.opengl.org/developers/documentation/specs.html">
328OpenGL Specification</a> is the bible for OpenGL implemention work.
329You should read it.
330</p>
331<p>Most of the Mesa development work involves implementing new OpenGL
332extensions, writing hardware drivers (for the DRI), and code optimization.
333</p>
334
335<h2>4.2 How do I write a new device driver?</h2>
336<p>
337Unfortunately, writing a device driver isn't easy.
338It requires detailed understanding of OpenGL, the Mesa code, and your
339target hardware/operating system.
3403D graphics are not simple.
341</p>
342<p>
343The best way to get started is to use an existing driver as your starting
344point.
345For a software driver, the X11 and OSMesa drivers are good examples.
346For a hardware driver, the Radeon and R200 DRI drivers are good examples.
347</p>
348<p>The DRI website has more information about writing hardware drivers.
349The process isn't well document because the Mesa driver interface changes
350over time, and we seldome have spare time for writing documentation.
351That being said, many people have managed to figure out the process.
352</p>
353<p>
354Joining the appropriate mailing lists and asking questions (and searching
355the archives) is a good way to get information.
356</p>
357
358
359</body>
360</html>