docs/sourcetree.html

   1 <HTML>
   2
   3 <TITLE>Mesa Source Tree</TITLE>
   4
   5 <link rel="stylesheet" type="text/css" href="mesa.css"></head>
   6
   7 <BODY>
   8
   9 <h1>Mesa source code tree overview</h1>
  10
  11 <p>
  12 This is a brief summary of Mesa's directory tree and what's contained in
  13 each directory.
  14 </p>
  15
  16
  17 <ul>
  18 <li><b>docs</b> - Documentation
  19 <li><b>include</b> - Public OpenGL header files
  20 <li><b>src</b>
  21   <ul>
  22   <li><b>egl</b> - EGL library sources
  23     <ul>
  24     <li><b>docs</b> - EGL documentation
  25     <li><b>drivers</b> - EGL drivers
  26     <li><b>glsl</b> - the GLSL compiler
  27     <li><b>main</b> - main EGL library implementation.  This is where all
  28         the EGL API functions are implemented, like eglCreateContext().
  29     </ul>
  30   <li><b>mesa</b> - Main Mesa sources
  31     <ul>
  32     <li><b>glapi</b> - OpenGL API dispatch layer.  This is where all the
  33         GL entrypoints like glClear, glBegin, etc. are generated, as well as
  34         the GL dispatch table.  All GL function calls jump through the
  35         dispatch table to functions found in main/.
  36     <li><b>main</b> - The core Mesa code (mainly state management)
  37     <li><b>drivers</b> - Mesa drivers (not used with Gallium)
  38         <ul>
  39         <li><b>common</b> - code which may be shared by all drivers
  40         <li><b>dri</b> - Direct Rendering Infrastructure drivers
  41            <ul>
  42            <li><b>common</b> - code shared by all DRI drivers
  43            <li><b>i915</b> - driver for Intel i915/i945
  44            <li><b>i965</b> - driver for Intel i965
  45            <li>XXX more
  46            </ul>
  47         <li><b>x11</b> - Xlib-based software driver
  48         <li><b>osmesa</b> - off-screen software driver
  49         <li><b>glslcompiler</b> - a stand-alone GLSL compiler driver
  50         <li>XXX more
  51         </ul>
  52     <li><b>es</b> - OpenGL ES overlay, parallelly buildable with the core Mesa
  53     <li><b>math</b> - vertex array translation and transformation code
  54         (not used with Gallium)
  55     <li><b>ppc</b> - Assembly code/optimizations for PPC systems
  56         (not used with Gallium)
  57     <li><b>shader</b> - Vertex/fragment shader and GLSL compiler code
  58     <li><b>sparc</b> - Assembly code/optimizations for SPARC systems
  59         (not used with Gallium)
  60     <li><b>state_tracker</b> - State tracker / driver for Gallium.  This
  61         is basically a Mesa device driver that speaks to Gallium.  This
  62         directory may be moved to src/mesa/drivers/gallium at some point.
  63     <li><b>swrast</b> - Software rasterization module.  For drawing points,
  64         lines, triangles, bitmaps, images, etc. in software.
  65         (not used with Gallium)
  66     <li><b>swrast_setup</b> - Software primitive setup.  Does things like
  67         polygon culling, glPolygonMode, polygon offset, etc.
  68         (not used with Gallium)
  69     <li><b>tnl</b> - Software vertex Transformation 'n Lighting.
  70         (not used with Gallium)
  71     <li><b>tnl_dd</b> - TNL code for device drivers.
  72         (not used with Gallium)
  73     <li><b>vbo</b> - Vertex Buffer Object code.  All drawing with
  74         glBegin/glEnd, glDrawArrays, display lists, etc. goes through this
  75         module.  The results is a well-defined set of vertex arrays which
  76         are passed to the device driver (or tnl module) for rendering.
  77     <li><b>vf</b> - vertex format conversion (currently unused)
  78     <li><b>x86</b> - Assembly code/optimizations for 32-bit x86 systems
  79         (not used with Gallium)
  80     <li><b>x86-64</b> - Assembly code/optimizations for 64-bit x86 systems
  81         (not used with Gallium)
  82     </ul>
  83   <li><b>gallium</b> - Gallium3D source code
  84     <ul>
  85     <li><b>include</b> - Gallium3D header files which define the Gallium3D
  86         interfaces
  87     <li><b>drivers</b> - Gallium3D device drivers
  88       <ul>
  89       <li><b>cell</b> - Driver for Cell processor.
  90       <li><b>i915</b> - Driver for Intel i915/i945.
  91       <li><b>i965</b> - Driver for Intel i965.
  92       <li><b>llvmpipe</b> - Software driver using LLVM for runtime code generation.
  93       <li><b>nv*</b> - Drivers for NVIDIA GPUs.
  94       <li><b>r300</b> - Driver for ATI/AMD R300.
  95       <li><b>softpipe</b> - Software reference driver.
  96       <li><b>svga</b> - Driver for VMware's SVGA virtual GPU.
  97       <li><b>trace</b> - Driver for tracing Gallium calls.
  98       <li>XXX more
  99       </ul>
 100     <li><b>auxiliary</b> - Gallium support code
 101       <ul>
 102       <li><b>draw</b> - Software vertex processing and primitive assembly
 103           module.  This includes vertex program execution, clipping, culling
 104           and optional stages for drawing wide lines, stippled lines,
 105           polygon stippling, two-sided lighting, etc.
 106           Intended for use by drivers for hardware that does not have
 107           vertex shaders.
 108           Geometry shaders will also be implemented in this module.
 109       <li><b>cso_cache</b> - Constant State Objects Cache.  Used to filter out
 110           redundant state changes between state trackers and drivers.
 111       <li><b>gallivm</b> - LLVM module for Gallium.  For LLVM-based
 112            compilation, optimization and code generation for TGSI shaders.
 113            Incomplete.
 114       <li><b>pipebuffer</b> - utility module for managing buffers
 115       <li><b>rbug</b> - Gallium remote debug utility
 116       <li><b>rtasm</b> - run-time assembly/machine code generation.
 117           Currently there's run-time code generation for x86/SSE, PowerPC
 118           and Cell SPU.
 119       <li><b>tgsi</b> - TG Shader Infrastructure.  Code for encoding,
 120           manipulating and interpretting GPU programs.
 121       <li><b>translate</b> - module for translating vertex data from one format
 122           to another.
 123       <li><b>util</b> - assorted utilities for arithmetic, hashing, surface
 124           creation, memory management, 2D blitting, simple rendering, etc.
 125       </ul>
 126     <li><b>state_trackers</b> -
 127        <ul>
 128        <li><b>dri</b> - Meta state tracker for DRI drivers
 129        <li><b>egl</b> - Meta state tracker for EGL drivers
 130        <li><b>es</b> - OpenGL ES 1.x and 2.x state trackers
 131        <li><b>g3dvl</b> -
 132        <li><b>glx</b> - Meta state tracker for GLX
 133        <li><b>python</b> -
 134        <li><b>vega</b> - OpenVG 1.x state tracker
 135        <li><b>wgl</b> -
 136        <li><b>xorg</b> - Meta state tracker for Xorg video drivers
 137        </ul>
 138     <li><b>winsys</b> -
 139        <ul>
 140        <li><b>drm</b> -
 141        <li><b>g3dvl</b> -
 142        <li><b>gdi</b> -
 143        <li><b>xlib</b> -
 144        </ul>
 145     </ul>
 146   </ul>
 147   <ul>
 148   <li><b>glu</b> - The OpenGL Utility library
 149      <ul>
 150      <li><b>sgi</b> - GLU from SGI
 151      <li><b>mesa</b> - Mesa version of GLU (deprecated)
 152      </ul>
 153   <li><b>glx</b> - The GLX library code for building libGL.  This is used for
 154          direct rendering drivers.  It will dynamically load one of the
 155          xxx_dri.so drivers.
 156   <li><b>glw</b> - Widgets for Xt/Motif.
 157   <li><b>glew</b> - OpenGL Extension Wrangler library (used by demo programs)
 158   </ul>
 159 <li><b>progs</b> - OpenGL test and demonstration programs
 160 <li><b>lib</b> - where the GL libraries are placed
 161 </ul>
 162
 163
 164 </BODY>
 165 </HTML>