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