docs: update calendar, add news item, and link releases notes for 20.1.0
[mesa.git] / docs / sourcetree.html
index 42675d9bb5d1ae499f7c73e5c932c584ba5e855c..0e726cf89b939b36652f86d01826e48b387ec2c3 100644 (file)
@@ -2,12 +2,19 @@
 <html lang="en">
 <head>
   <meta http-equiv="content-type" content="text/html; charset=utf-8">
-  <title>Mesa Source Tree</title>
+  <title>Source Code Tree</title>
   <link rel="stylesheet" type="text/css" href="mesa.css">
 </head>
 <body>
 
-<h1>Mesa source code tree overview</h1>
+<div class="header">
+  The Mesa 3D Graphics Library
+</div>
+
+<iframe src="contents.html"></iframe>
+<div class="content">
+
+<h1>Source Code Tree</h1>
 
 <p>
 This is a brief summary of Mesa's directory tree and what's contained in
@@ -20,47 +27,57 @@ each directory.
 <li><b>include</b> - Public OpenGL header files
 <li><b>src</b>
   <ul>
+  <li><b>amd</b> - AMD-specific sources
+    <ul>
+    <li><b>addrlib</b> - common sources for creating images
+    <li><b>common</b> - common code between RADV, radeonsi and ACO
+    <li><b>compiler</b> - ACO shader compiler
+    <li><b>llvm</b> - common code between RADV and radeonsi for compiling shaders using LLVM
+    <li><b>registers</b> - register definitions
+    <li><b>vulkan</b> - RADV Vulkan implementation for AMD Southern Island and newer
+    </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>
-       <li><b>common</b> - code which may be shared by all drivers
+        <li><b>common</b> - code which may be shared by all drivers
         <li><b>dri</b> - Direct Rendering Infrastructure drivers
            <ul>
-          <li><b>common</b> - code shared by all DRI drivers
-          <li><b>i915</b> - driver for Intel i915/i945
-          <li><b>i965</b> - driver for Intel i965
-          <li><b>radeon</b> - driver for ATI R100
-          <li><b>r200</b> - driver for ATI R200
-          <li>XXX more
+           <li><b>common</b> - code shared by all DRI drivers
+           <li><b>i915</b> - driver for Intel i915/i945
+           <li><b>i965</b> - driver for Intel i965
+           <li><b>radeon</b> - driver for ATI R100
+           <li><b>r200</b> - driver for ATI R200
+           <li>XXX more
            </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
+    <li><b>state_tracker</b> - Translator from Mesa to Gallium.  This
         is basically a Mesa device driver that speaks to Gallium.  This
         directory may be moved to src/mesa/drivers/gallium at some point.
     <li><b>swrast</b> - Software rasterization module.  For drawing points,
@@ -77,7 +94,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 +107,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.
@@ -110,7 +127,7 @@ each directory.
           vertex shaders.
           Geometry shaders will also be implemented in this module.
       <li><b>cso_cache</b> - Constant State Objects Cache.  Used to filter out
-          redundant state changes between state trackers and drivers.
+          redundant state changes between frontends and drivers.
       <li><b>gallivm</b> - LLVM module for Gallium.  For LLVM-based
            compilation, optimization and code generation for TGSI shaders.
            Incomplete.
@@ -120,22 +137,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> -
+    <li><b>frontends</b> -
        <ul>
-       <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>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>clover</b> - OpenCL frontend
+       <li><b>dri</b> - Meta frontend for DRI drivers
+       <li><b>glx</b> - Meta frontend for GLX
+       <li><b>wgl</b> - Windows WGL frontend
+       <li><b>xa</b> - XA frontend
+       <li><b>xvmc</b> - XvMC frontend
+       <li><b>vdpau</b> - VDPAU frontend
+       <li><b>va</b> - VA-API frontend
+       <li><b>omx_bellagio</b> - OpenMAX Bellagio frontend
        </ul>
     <li><b>winsys</b> -
        <ul>
@@ -146,19 +165,13 @@ each directory.
     </ul>
   </ul>
   <ul>
-  <li><b>glu</b> - The OpenGL Utility library
-     <ul>
-     <li><b>sgi</b> - GLU from SGI
-     <li><b>mesa</b> - Mesa version of GLU (deprecated)
-     </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 the build system.
+        These (shortcuts) are used for development purposes in conjunction with
+        LD_LIBRARY_PATH and/or LIBGL_DRIVERS_PATH.
 </ul>
 
-
+</div>
 </body>
 </html>