shading.html 6.69 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="#support">GLSL 1.40 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="support">GLSL Version</h2>
Brian Paul's avatar
Brian Paul committed
68 69

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

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


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

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

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

<ul>
93 94 95
<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
96 97
<li>The gl_Color and gl_SecondaryColor varying vars are interpolated
    without perspective correction
98 99 100 101 102 103 104
</ul>

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


105
<h2 id="notes">Implementation Notes</h2>
106 107 108 109

<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
110
<li>All vector types (vec2, vec3, vec4, bvec2, etc) currently occupy full
111
    float[4] registers.
Brian's avatar
Brian committed
112 113
<li>Float constants and variables are packed so that up to four floats
    can occupy one program parameter/register.
114 115 116 117 118
<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
119 120
<li>The ftransform() function doesn't necessarily match the results of
    fixed-function transformation.
121 122 123 124 125 126 127
</ul>

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


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

<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
140
</li>
141 142 143
</ul>


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

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

<p>
This tool is useful for:
Andreas Boll's avatar
Andreas Boll committed
153
</p>
Brian's avatar
Brian committed
154 155 156 157 158 159 160
<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>
161
After building Mesa, the compiler can be found at src/glsl/glsl_compiler
Brian's avatar
Brian committed
162 163 164 165 166 167 168
</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
169
    src/glsl/glsl_compiler --dump-ast myshader.vert
Brian's avatar
Brian committed
170 171
</pre>

172 173 174 175 176 177 178 179
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
180

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

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

<p>
189
XXX provide some info about the compiler....
Brian's avatar
Brian committed
190 191 192 193 194 195 196 197
</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
198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216
<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
217 218 219
<dl>
<dt>EmitHighLevelInstructions</dt>
<dd>
Brian's avatar
Brian committed
220 221 222 223
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
224
</dd>
Brian's avatar
Brian committed
225

Andreas Boll's avatar
Andreas Boll committed
226 227
<dt>EmitCondCodes</dt>
<dd>
Brian's avatar
Brian committed
228 229 230 231 232
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
233
</dd>
Brian's avatar
Brian committed
234

Andreas Boll's avatar
Andreas Boll committed
235 236
<dt>EmitComments</dt>
<dd>
Brian's avatar
Brian committed
237 238
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
239 240
</dd>
</dl>
Brian's avatar
Brian committed
241 242


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

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

Brian's avatar
Brian committed
250
<p>
251
The <a href="http://piglit.freedesktop.org/">Piglit</a> project
252
has many GLSL tests.
Brian's avatar
Brian committed
253 254
</p>

255 256 257
<p>
The Mesa demos repository also has some good GLSL tests.
</p>
Brian's avatar
Brian committed
258

Andreas Boll's avatar
Andreas Boll committed
259
</div>
260 261
</body>
</html>