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