Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / mesa3d / 580c503ca2b8ed36287bfb162fe0506d31d900e7 / . / docs / sourcetree.html
blob: 7013f65dd71dfefd7324e1aa1122ba785e36ad01 [file] [log] [blame]
Andreas Bollecd5c7c2012-06-12 09:05:03 +0200[diff] [blame]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>
Brian Pauled9bd822010-01-20 08:58:46 -0700[diff] [blame]9
Andreas Bollb5da52a2012-09-18 18:57:02 +0200[diff] [blame]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
Brian Pauled9bd822010-01-20 08:58:46 -0700[diff] [blame]17<h1>Mesa source code tree overview</h1>
18
19<p>
20This is a brief summary of Mesa's directory tree and what's contained in
21each 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>
Emil Velikov438086e2016-06-29 12:52:57 +0100[diff] [blame]30 <li><b>compiler</b> - Common utility sources for different compilers.
31 <ul>
32 <li><b>glsl</b> - the GLSL IR and compiler
33 <li><b>nir</b> - the NIR IR and compiler
34 <li><b>spriv</b> - the SPIR-V compiler
35 </ul>
Brian Pauled9bd822010-01-20 08:58:46 -0700[diff] [blame]36 <li><b>egl</b> - EGL library sources
37 <ul>
Brian Pauled9bd822010-01-20 08:58:46 -0700[diff] [blame]38 <li><b>drivers</b> - EGL drivers
39 <li><b>main</b> - main EGL library implementation. This is where all
40 the EGL API functions are implemented, like eglCreateContext().
41 </ul>
Andreas Bollbabc6382013-01-30 22:35:43 +0100[diff] [blame]42 <li><b>mapi</b> - Mesa APIs
Brian Pauled9bd822010-01-20 08:58:46 -0700[diff] [blame]43 <li><b>glapi</b> - OpenGL API dispatch layer. This is where all the
44 GL entrypoints like glClear, glBegin, etc. are generated, as well as
45 the GL dispatch table. All GL function calls jump through the
46 dispatch table to functions found in main/.
Andreas Bollbabc6382013-01-30 22:35:43 +0100[diff] [blame]47 <li><b>mesa</b> - Main Mesa sources
48 <ul>
Brian Pauled9bd822010-01-20 08:58:46 -0700[diff] [blame]49 <li><b>main</b> - The core Mesa code (mainly state management)
50 <li><b>drivers</b> - Mesa drivers (not used with Gallium)
51 <ul>
52 <li><b>common</b> - code which may be shared by all drivers
53 <li><b>dri</b> - Direct Rendering Infrastructure drivers
54 <ul>
55 <li><b>common</b> - code shared by all DRI drivers
56 <li><b>i915</b> - driver for Intel i915/i945
57 <li><b>i965</b> - driver for Intel i965
Andreas Bollf29f5e82012-06-25 21:54:03 +0200[diff] [blame]58 <li><b>radeon</b> - driver for ATI R100
59 <li><b>r200</b> - driver for ATI R200
Brian Pauled9bd822010-01-20 08:58:46 -0700[diff] [blame]60 <li>XXX more
61 </ul>
62 <li><b>x11</b> - Xlib-based software driver
63 <li><b>osmesa</b> - off-screen software driver
Brian Pauled9bd822010-01-20 08:58:46 -0700[diff] [blame]64 <li>XXX more
65 </ul>
66 <li><b>math</b> - vertex array translation and transformation code
67 (not used with Gallium)
Andreas Bollbabc6382013-01-30 22:35:43 +0100[diff] [blame]68 <li><b>program</b> - Vertex/fragment shader and GLSL compiler code
Brian Pauled9bd822010-01-20 08:58:46 -0700[diff] [blame]69 <li><b>sparc</b> - Assembly code/optimizations for SPARC systems
70 (not used with Gallium)
71 <li><b>state_tracker</b> - State tracker / driver for Gallium. This
72 is basically a Mesa device driver that speaks to Gallium. This
73 directory may be moved to src/mesa/drivers/gallium at some point.
74 <li><b>swrast</b> - Software rasterization module. For drawing points,
75 lines, triangles, bitmaps, images, etc. in software.
76 (not used with Gallium)
77 <li><b>swrast_setup</b> - Software primitive setup. Does things like
78 polygon culling, glPolygonMode, polygon offset, etc.
79 (not used with Gallium)
80 <li><b>tnl</b> - Software vertex Transformation 'n Lighting.
81 (not used with Gallium)
82 <li><b>tnl_dd</b> - TNL code for device drivers.
83 (not used with Gallium)
84 <li><b>vbo</b> - Vertex Buffer Object code. All drawing with
85 glBegin/glEnd, glDrawArrays, display lists, etc. goes through this
86 module. The results is a well-defined set of vertex arrays which
87 are passed to the device driver (or tnl module) for rendering.
Brian Pauled9bd822010-01-20 08:58:46 -0700[diff] [blame]88 <li><b>x86</b> - Assembly code/optimizations for 32-bit x86 systems
89 (not used with Gallium)
90 <li><b>x86-64</b> - Assembly code/optimizations for 64-bit x86 systems
91 (not used with Gallium)
92 </ul>
93 <li><b>gallium</b> - Gallium3D source code
94 <ul>
95 <li><b>include</b> - Gallium3D header files which define the Gallium3D
96 interfaces
97 <li><b>drivers</b> - Gallium3D device drivers
98 <ul>
Brian Pauled9bd822010-01-20 08:58:46 -0700[diff] [blame]99 <li><b>i915</b> - Driver for Intel i915/i945.
Brian Pauled9bd822010-01-20 08:58:46 -0700[diff] [blame]100 <li><b>llvmpipe</b> - Software driver using LLVM for runtime code generation.
Emil Velikov438086e2016-06-29 12:52:57 +0100[diff] [blame]101 <li><b>nouveau</b> - Driver for NVIDIA GPUs.
102 <li><b>radeon</b> - Shared module for the r600 and radeonsi drivers.
Andreas Bollf29f5e82012-06-25 21:54:03 +0200[diff] [blame]103 <li><b>radeonsi</b> - Driver for AMD Southern Island.
104 <li><b>r300</b> - Driver for ATI R300 - R500.
105 <li><b>r600</b> - Driver for ATI/AMD R600 - Northern Island.
Brian Pauled9bd822010-01-20 08:58:46 -0700[diff] [blame]106 <li><b>softpipe</b> - Software reference driver.
107 <li><b>svga</b> - Driver for VMware's SVGA virtual GPU.
108 <li><b>trace</b> - Driver for tracing Gallium calls.
109 <li>XXX more
110 </ul>
111 <li><b>auxiliary</b> - Gallium support code
112 <ul>
113 <li><b>draw</b> - Software vertex processing and primitive assembly
114 module. This includes vertex program execution, clipping, culling
115 and optional stages for drawing wide lines, stippled lines,
116 polygon stippling, two-sided lighting, etc.
117 Intended for use by drivers for hardware that does not have
118 vertex shaders.
119 Geometry shaders will also be implemented in this module.
120 <li><b>cso_cache</b> - Constant State Objects Cache. Used to filter out
121 redundant state changes between state trackers and drivers.
122 <li><b>gallivm</b> - LLVM module for Gallium. For LLVM-based
123 compilation, optimization and code generation for TGSI shaders.
124 Incomplete.
125 <li><b>pipebuffer</b> - utility module for managing buffers
126 <li><b>rbug</b> - Gallium remote debug utility
127 <li><b>rtasm</b> - run-time assembly/machine code generation.
128 Currently there's run-time code generation for x86/SSE, PowerPC
129 and Cell SPU.
130 <li><b>tgsi</b> - TG Shader Infrastructure. Code for encoding,
Nathan Kidd0691b372014-01-03 16:44:00 -0700[diff] [blame]131 manipulating and interpreting GPU programs.
Brian Pauled9bd822010-01-20 08:58:46 -0700[diff] [blame]132 <li><b>translate</b> - module for translating vertex data from one format
133 to another.
134 <li><b>util</b> - assorted utilities for arithmetic, hashing, surface
135 creation, memory management, 2D blitting, simple rendering, etc.
Emil Velikov438086e2016-06-29 12:52:57 +0100[diff] [blame]136 <li>XXX more
Brian Pauled9bd822010-01-20 08:58:46 -0700[diff] [blame]137 </ul>
138 <li><b>state_trackers</b> -
139 <ul>
Andreas Boll0aad2e42012-09-19 18:22:31 +0200[diff] [blame]140 <li><b>clover</b> - OpenCL state tracker
Chia-I Wucec2eeb2010-01-22 17:10:28 +0800[diff] [blame]141 <li><b>dri</b> - Meta state tracker for DRI drivers
Chia-I Wucec2eeb2010-01-22 17:10:28 +0800[diff] [blame]142 <li><b>glx</b> - Meta state tracker for GLX
Emil Velikov438086e2016-06-29 12:52:57 +0100[diff] [blame]143 <li><b>wgl</b> - Windows WGL state tracker
144 <li><b>xa</b> - XA state tracker
Andreas Boll0aad2e42012-09-19 18:22:31 +0200[diff] [blame]145 <li><b>xvmc</b> - XvMC state tracker
Emil Velikov438086e2016-06-29 12:52:57 +0100[diff] [blame]146 <li><b>vdpau</b> - VDPAU state tracker
147 <li><b>va</b> - VA-API state tracker
148 <li><b>omx</b> - OpenMAX state tracker
Brian Pauled9bd822010-01-20 08:58:46 -0700[diff] [blame]149 </ul>
150 <li><b>winsys</b> -
151 <ul>
152 <li><b>drm</b> -
Brian Pauled9bd822010-01-20 08:58:46 -0700[diff] [blame]153 <li><b>gdi</b> -
154 <li><b>xlib</b> -
155 </ul>
156 </ul>
157 </ul>
158 <ul>
Emil Velikov438086e2016-06-29 12:52:57 +0100[diff] [blame]159 <li><b>glx</b> - The GLX library code for building libGL using DRI drivers.
Brian Pauled9bd822010-01-20 08:58:46 -0700[diff] [blame]160 </ul>
Emil Velikov438086e2016-06-29 12:52:57 +0100[diff] [blame]161<li><b>lib</b> - hardlinks to most binaries as produced by <strong>make</strong>.
162 These (shortcuts) are used for development purposes in conjunction with
163 LD_LIBRARY_PATH and/or LIBGL_DRIVERS_PATH.
Brian Pauled9bd822010-01-20 08:58:46 -0700[diff] [blame]164</ul>
165
Andreas Bollb5da52a2012-09-18 18:57:02 +0200[diff] [blame]166</div>
Andreas Bollecd5c7c2012-06-12 09:05:03 +0200[diff] [blame]167</body>
168</html>