shading.html 6.81 KB
Newer Older
1 2 3 4 5 6 7 8
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
  <meta http-equiv="content-type" content="text/html; charset=utf-8">
  <title>Shading Language Support</title>
  <link rel="stylesheet" type="text/css" href="mesa.css">
</head>
<body>
9

Andreas Boll's avatar
Andreas Boll committed
10 11 12 13 14 15 16
<div class="header">
  <h1>The Mesa 3D Graphics Library</h1>
</div>

<iframe src="contents.html"></iframe>
<div class="content">

17
<h1>Shading Language Support</h1>
18 19 20

<p>
This page describes the features and status of Mesa's support for the
21
<a href="http://opengl.org/documentation/glsl/">
22 23 24
OpenGL Shading Language</a>.
</p>

Brian's avatar
Brian committed
25 26 27 28
<p>
Contents
</p>
<ul>
29
<li><a href="#envvars">Environment variables</a>
30
<li><a href="#glsl120">GLSL 1.20 support</a>
Brian's avatar
Brian committed
31
<li><a href="#unsup">Unsupported Features</a>
Brian's avatar
Brian committed
32
<li><a href="#notes">Implementation Notes</a>
Brian's avatar
Brian committed
33
<li><a href="#hints">Programming Hints</a>
34
<li><a href="#standalone">Stand-alone GLSL Compiler</a>
Brian's avatar
Brian committed
35
<li><a href="#implementation">Compiler Implementation</a>
Brian's avatar
Brian committed
36
<li><a href="#validation">Compiler Validation</a>
Brian's avatar
Brian committed
37 38 39
</ul>


40
<h2 id="envvars">Environment Variables</h2>
41 42 43

<p>
The <b>MESA_GLSL</b> environment variable can be set to a comma-separated
44 45
list of keywords to control some aspects of the GLSL compiler and shader
execution.  These are generally used for debugging.
46 47
</p>
<ul>
48 49
<li><b>dump</b> - print GLSL shader code to stdout at link time
<li><b>log</b> - log all GLSL shaders to files.
50 51
    The filenames will be "shader_X.vert" or "shader_X.frag" where X
    the shader ID.
52 53 54 55
<li><b>nopt</b> - disable compiler optimizations
<li><b>opt</b> - force compiler optimizations
<li><b>uniform</b> - print message to stdout when glUniform is called
<li><b>nopvert</b> - force vertex shaders to be a simple shader that just transforms
56 57
    the vertex position with ftransform() and passes through the color and
    texcoord[0] attributes.
58
<li><b>nopfrag</b> - force fragment shader to be a simple shader that passes
59
    through the color attribute.
60
<li><b>useprog</b> - log glUseProgram calls to stderr
61 62 63 64 65 66
</ul>
<p>
Example:  export MESA_GLSL=dump,nopt
</p>


67
<h2 id="glsl120">GLSL Version</h2>
Brian Paul's avatar
Brian Paul committed
68 69

<p>
70 71 72 73 74 75
The GLSL compiler currently supports version 1.20 of the shading language.
</p>

<p>
Several GLSL extensions are also supported:
</p>
Brian Paul's avatar
Brian Paul committed
76
<ul>
77 78 79 80
<li>GL_ARB_draw_buffers
<li>GL_ARB_texture_rectangle
<li>GL_ARB_fragment_coord_conventions
<li>GL_EXT_texture_array
Brian Paul's avatar
Brian Paul committed
81 82 83
</ul>


84
<h2 id="unsup">Unsupported Features</h2>
85

86 87
<p>XXX update this section</p>

88
<p>
89
The following features of the shading language are not yet fully supported
90 91 92 93
in Mesa:
</p>

<ul>
94 95 96
<li>Linking of multiple shaders does not always work.  Currently, linking
    is implemented through shader concatenation and re-compiling.  This
    doesn't always work because of some #pragma and preprocessor issues.
Brian's avatar
Brian committed
97
<li>gl_ClipVertex
Brian's avatar
Brian committed
98 99
<li>The gl_Color and gl_SecondaryColor varying vars are interpolated
    without perspective correction
100 101 102 103 104 105 106
</ul>

<p>
All other major features of the shading language should function.
</p>


107
<h2 id="notes">Implementation Notes</h2>
108 109 110 111

<ul>
<li>Shading language programs are compiled into low-level programs
    very similar to those of GL_ARB_vertex/fragment_program.
Brian's avatar
Brian committed
112
<li>All vector types (vec2, vec3, vec4, bvec2, etc) currently occupy full
113
    float[4] registers.
Brian's avatar
Brian committed
114 115
<li>Float constants and variables are packed so that up to four floats
    can occupy one program parameter/register.
116 117 118 119 120
<li>All function calls are inlined.
<li>Shaders which use too many registers will not compile.
<li>The quality of generated code is pretty good, register usage is fair.
<li>Shader error detection and reporting of errors (InfoLog) is not
    very good yet.
Brian's avatar
Brian committed
121 122
<li>The ftransform() function doesn't necessarily match the results of
    fixed-function transformation.
123 124 125 126 127 128 129
</ul>

<p>
These issues will be addressed/resolved in the future.
</p>


130
<h2 id="hints">Programming Hints</h2>
131 132 133 134 135 136 137 138 139 140 141

<ul>
<li>Use the built-in library functions whenever possible.
    For example, instead of writing this:
<pre>
        float x = 1.0 / sqrt(y);
</pre>
    Write this:
<pre>
        float x = inversesqrt(y);
</pre>
Brian's avatar
Brian committed
142
</li>
143 144 145
</ul>


146
<h2 id="standalone">Stand-alone GLSL Compiler</h2>
Brian's avatar
Brian committed
147 148

<p>
149 150
The stand-alone GLSL compiler program can be used to compile GLSL shaders
into low-level GPU code.
Brian's avatar
Brian committed
151 152 153 154
</p>

<p>
This tool is useful for:
Andreas Boll's avatar
Andreas Boll committed
155
</p>
Brian's avatar
Brian committed
156 157 158 159 160 161 162
<ul>
<li>Inspecting GPU code to gain insight into compilation
<li>Generating initial GPU code for subsequent hand-tuning
<li>Debugging the GLSL compiler itself
</ul>

<p>
163
After building Mesa, the compiler can be found at src/glsl/glsl_compiler
Brian's avatar
Brian committed
164 165 166 167 168 169 170
</p>

<p>
Here's an example of using the compiler to compile a vertex shader and
emit GL_ARB_vertex_program-style instructions:
</p>
<pre>
Sam Hocevar's avatar
Sam Hocevar committed
171
    src/glsl/glsl_compiler --dump-ast myshader.vert
Brian's avatar
Brian committed
172 173
</pre>

174 175 176 177 178 179 180 181
Options include
<ul>
<li><b>--dump-ast</b> - dump GPU code
<li><b>--dump-hir</b> - dump high-level IR code
<li><b>--dump-lir</b> - dump low-level IR code
<li><b>--link</b> - ???
</ul>

Brian's avatar
Brian committed
182

183
<h2 id="implementation">Compiler Implementation</h2>
Brian's avatar
Brian committed
184 185 186

<p>
The source code for Mesa's shading language compiler is in the
187
<code>src/glsl/</code> directory.
Brian's avatar
Brian committed
188 189 190
</p>

<p>
191
XXX provide some info about the compiler....
Brian's avatar
Brian committed
192 193 194 195 196 197 198 199
</p>

<p>
The final vertex and fragment programs may be interpreted in software
(see prog_execute.c) or translated into a specific hardware architecture
(see drivers/dri/i915/i915_fragprog.c for example).
</p>

Brian's avatar
Brian committed
200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218
<h3>Code Generation Options</h3>

<p>
Internally, there are several options that control the compiler's code
generation and instruction selection.
These options are seen in the gl_shader_state struct and may be set
by the device driver to indicate its preferences:

<pre>
struct gl_shader_state
{
   ...
   /** Driver-selectable options: */
   GLboolean EmitHighLevelInstructions;
   GLboolean EmitCondCodes;
   GLboolean EmitComments;
};
</pre>

Andreas Boll's avatar
Andreas Boll committed
219 220 221
<dl>
<dt>EmitHighLevelInstructions</dt>
<dd>
Brian's avatar
Brian committed
222 223 224 225
This option controls instruction selection for loops and conditionals.
If the option is set high-level IF/ELSE/ENDIF, LOOP/ENDLOOP, CONT/BRK
instructions will be emitted.
Otherwise, those constructs will be implemented with BRA instructions.
Andreas Boll's avatar
Andreas Boll committed
226
</dd>
Brian's avatar
Brian committed
227

Andreas Boll's avatar
Andreas Boll committed
228 229
<dt>EmitCondCodes</dt>
<dd>
Brian's avatar
Brian committed
230 231 232 233 234
If set, condition codes (ala GL_NV_fragment_program) will be used for
branching and looping.
Otherwise, ordinary registers will be used (the IF instruction will
examine the first operand's X component and do the if-part if non-zero).
This option is only relevant if EmitHighLevelInstructions is set.
Andreas Boll's avatar
Andreas Boll committed
235
</dd>
Brian's avatar
Brian committed
236

Andreas Boll's avatar
Andreas Boll committed
237 238
<dt>EmitComments</dt>
<dd>
Brian's avatar
Brian committed
239 240
If set, instructions will be annoted with comments to help with debugging.
Extra NOP instructions will also be inserted.
Andreas Boll's avatar
Andreas Boll committed
241 242
</dd>
</dl>
Brian's avatar
Brian committed
243 244


245
<h2 id="validation">Compiler Validation</h2>
Brian's avatar
Brian committed
246 247

<p>
248
Developers working on the GLSL compiler should test frequently to avoid
Brian's avatar
Brian committed
249 250
regressions.
</p>
251

Brian's avatar
Brian committed
252
<p>
253
The <a href="http://piglit.freedesktop.org/">Piglit</a> project
254
has many GLSL tests and the
255
<a href="http://glean.sf.net">Glean</a> glsl1 test tests GLSL features.
Brian's avatar
Brian committed
256 257
</p>

258 259 260
<p>
The Mesa demos repository also has some good GLSL tests.
</p>
Brian's avatar
Brian committed
261

Andreas Boll's avatar
Andreas Boll committed
262
</div>
263 264
</body>
</html>