docs/sourcetree.html

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