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