docs/llvmpipe.html: Minor edits
[mesa.git] / docs / sourcetree.html
index 6a1f0398368fa685ab5902af5ce96413af76edb5..07c8ece6ea451c4066c8ef17b9315ec6ad66a0c2 100644 (file)
@@ -7,6 +7,13 @@
 </head>
 <body>
 
+<div class="header">
+  <h1>The Mesa 3D Graphics Library</h1>
+</div>
+
+<iframe src="contents.html"></iframe>
+<div class="content">
+
 <h1>Mesa source code tree overview</h1>
 
 <p>
@@ -20,20 +27,25 @@ each directory.
 <li><b>include</b> - Public OpenGL header files
 <li><b>src</b>
   <ul>
+  <li><b>compiler</b> - Common utility sources for different compilers.
+    <ul>
+    <li><b>glsl</b> - the GLSL IR and compiler
+    <li><b>nir</b> - the NIR IR and compiler
+    <li><b>spirv</b> - the SPIR-V compiler
+    </ul>
   <li><b>egl</b> - EGL library sources
     <ul>
-    <li><b>docs</b> - EGL documentation
     <li><b>drivers</b> - EGL drivers
-    <li><b>glsl</b> - the GLSL compiler
     <li><b>main</b> - main EGL library implementation.  This is where all
         the EGL API functions are implemented, like eglCreateContext().
     </ul>
-  <li><b>mesa</b> - Main Mesa sources
-    <ul>
+  <li><b>mapi</b> - Mesa APIs
     <li><b>glapi</b> - OpenGL API dispatch layer.  This is where all the
         GL entrypoints like glClear, glBegin, etc. are generated, as well as
         the GL dispatch table.  All GL function calls jump through the
         dispatch table to functions found in main/.
+  <li><b>mesa</b> - Main Mesa sources
+    <ul>
     <li><b>main</b> - The core Mesa code (mainly state management)
     <li><b>drivers</b> - Mesa drivers (not used with Gallium)
         <ul>
@@ -49,15 +61,11 @@ each directory.
            </ul>
         <li><b>x11</b> - Xlib-based software driver
         <li><b>osmesa</b> - off-screen software driver
-       <li><b>glslcompiler</b> - a stand-alone GLSL compiler driver
         <li>XXX more
         </ul>
-    <li><b>es</b> - OpenGL ES overlay, parallelly buildable with the core Mesa
     <li><b>math</b> - vertex array translation and transformation code
         (not used with Gallium)
-    <li><b>ppc</b> - Assembly code/optimizations for PPC systems
-        (not used with Gallium)
-    <li><b>shader</b> - Vertex/fragment shader and GLSL compiler code
+    <li><b>program</b> - Vertex/fragment shader and GLSL compiler code
     <li><b>sparc</b> - Assembly code/optimizations for SPARC systems
         (not used with Gallium)
     <li><b>state_tracker</b> - State tracker / driver for Gallium.  This
@@ -77,7 +85,6 @@ each directory.
         glBegin/glEnd, glDrawArrays, display lists, etc. goes through this
         module.  The results is a well-defined set of vertex arrays which
         are passed to the device driver (or tnl module) for rendering.
-    <li><b>vf</b> - vertex format conversion (currently unused)
     <li><b>x86</b> - Assembly code/optimizations for 32-bit x86 systems
         (not used with Gallium)
     <li><b>x86-64</b> - Assembly code/optimizations for 64-bit x86 systems
@@ -91,7 +98,8 @@ each directory.
       <ul>
       <li><b>i915</b> - Driver for Intel i915/i945.
       <li><b>llvmpipe</b> - Software driver using LLVM for runtime code generation.
-      <li><b>nv*</b> - Drivers for NVIDIA GPUs.
+      <li><b>nouveau</b> - Driver for NVIDIA GPUs.
+      <li><b>radeon</b> - Shared module for the r600 and radeonsi drivers.
       <li><b>radeonsi</b> - Driver for AMD Southern Island.
       <li><b>r300</b> - Driver for ATI R300 - R500.
       <li><b>r600</b> - Driver for ATI/AMD R600 - Northern Island.
@@ -120,22 +128,24 @@ each directory.
           Currently there's run-time code generation for x86/SSE, PowerPC
           and Cell SPU.
       <li><b>tgsi</b> - TG Shader Infrastructure.  Code for encoding,
-          manipulating and interpretting GPU programs.
+          manipulating and interpreting GPU programs.
       <li><b>translate</b> - module for translating vertex data from one format
           to another.
       <li><b>util</b> - assorted utilities for arithmetic, hashing, surface
           creation, memory management, 2D blitting, simple rendering, etc.
+      <li>XXX more
       </ul>
     <li><b>state_trackers</b> -
        <ul>
+       <li><b>clover</b> - OpenCL state tracker
        <li><b>dri</b> - Meta state tracker for DRI drivers
-       <li><b>egl</b> - Meta state tracker for EGL drivers
-       <li><b>es</b> - OpenGL ES 1.x and 2.x state trackers
        <li><b>glx</b> - Meta state tracker for GLX
+       <li><b>wgl</b> - Windows WGL state tracker
+       <li><b>xa</b> - XA state tracker
+       <li><b>xvmc</b> - XvMC state tracker
        <li><b>vdpau</b> - VDPAU state tracker
-       <li><b>vega</b> - OpenVG 1.x state tracker
-       <li><b>wgl</b> -
-       <li><b>xorg</b> - Meta state tracker for Xorg video drivers
+       <li><b>va</b> - VA-API state tracker
+       <li><b>omx_bellagio</b> - OpenMAX Bellagio state tracker
        </ul>
     <li><b>winsys</b> -
        <ul>
@@ -146,14 +156,13 @@ each directory.
     </ul>
   </ul>
   <ul>
-  <li><b>glx</b> - The GLX library code for building libGL.  This is used for
-         direct rendering drivers.  It will dynamically load one of the 
-         xxx_dri.so drivers.
+  <li><b>glx</b> - The GLX library code for building libGL using DRI drivers.
   </ul>
-<li><b>progs</b> - OpenGL test and demonstration programs
-<li><b>lib</b> - where the GL libraries are placed
+<li><b>lib</b> - hardlinks to most binaries as produced by <strong>make</strong>.
+        These (shortcuts) are used for development purposes in conjunction with
+        LD_LIBRARY_PATH and/or LIBGL_DRIVERS_PATH.
 </ul>
 
-
+</div>
 </body>
 </html>