shading.html 6.72 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

10
<h1>Shading Language Support</h1>
11 12 13 14 15 16 17

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

Brian's avatar
Brian committed
18 19 20 21
<p>
Contents
</p>
<ul>
22
<li><a href="#envvars">Environment variables</a>
23
<li><a href="#glsl120">GLSL 1.20 support</a>
Brian's avatar
Brian committed
24
<li><a href="#unsup">Unsupported Features</a>
Brian's avatar
Brian committed
25
<li><a href="#notes">Implementation Notes</a>
Brian's avatar
Brian committed
26
<li><a href="#hints">Programming Hints</a>
27
<li><a href="#standalone">Stand-alone GLSL Compiler</a>
Brian's avatar
Brian committed
28
<li><a href="#implementation">Compiler Implementation</a>
Brian's avatar
Brian committed
29
<li><a href="#validation">Compiler Validation</a>
Brian's avatar
Brian committed
30 31 32
</ul>


33
<h2 id="envvars">Environment Variables</h2>
34 35 36

<p>
The <b>MESA_GLSL</b> environment variable can be set to a comma-separated
37 38
list of keywords to control some aspects of the GLSL compiler and shader
execution.  These are generally used for debugging.
39 40
</p>
<ul>
41 42
<li><b>dump</b> - print GLSL shader code to stdout at link time
<li><b>log</b> - log all GLSL shaders to files.
43 44
    The filenames will be "shader_X.vert" or "shader_X.frag" where X
    the shader ID.
45 46 47 48
<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
49 50
    the vertex position with ftransform() and passes through the color and
    texcoord[0] attributes.
51
<li><b>nopfrag</b> - force fragment shader to be a simple shader that passes
52
    through the color attribute.
53
<li><b>useprog</b> - log glUseProgram calls to stderr
54 55 56 57 58 59
</ul>
<p>
Example:  export MESA_GLSL=dump,nopt
</p>


60
<h2 id="glsl120">GLSL Version</h2>
Brian Paul's avatar
Brian Paul committed
61 62

<p>
63 64 65 66 67 68
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
69
<ul>
70 71 72 73
<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
74 75 76
</ul>


77
<h2 id="unsup">Unsupported Features</h2>
78

79 80
<p>XXX update this section</p>

81
<p>
82
The following features of the shading language are not yet fully supported
83 84 85 86
in Mesa:
</p>

<ul>
87 88 89
<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
90
<li>gl_ClipVertex
Brian's avatar
Brian committed
91 92
<li>The gl_Color and gl_SecondaryColor varying vars are interpolated
    without perspective correction
93 94 95 96 97 98 99
</ul>

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


100
<h2 id="notes">Implementation Notes</h2>
101 102 103 104

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

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


123
<h2 id="hints">Programming Hints</h2>
124 125 126 127 128 129 130 131 132 133 134

<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
135
</li>
136 137 138
</ul>


139
<h2 id="standalone">Stand-alone GLSL Compiler</h2>
Brian's avatar
Brian committed
140 141

<p>
142 143
The stand-alone GLSL compiler program can be used to compile GLSL shaders
into low-level GPU code.
Brian's avatar
Brian committed
144 145 146 147
</p>

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

167 168 169 170 171 172 173 174
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
175

176
<h2 id="implementation">Compiler Implementation</h2>
Brian's avatar
Brian committed
177 178 179

<p>
The source code for Mesa's shading language compiler is in the
180
<code>src/glsl/</code> directory.
Brian's avatar
Brian committed
181 182 183
</p>

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

Andreas Boll's avatar
Andreas Boll committed
221 222
<dt>EmitCondCodes</dt>
<dd>
Brian's avatar
Brian committed
223 224 225 226 227
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
228
</dd>
Brian's avatar
Brian committed
229

Andreas Boll's avatar
Andreas Boll committed
230 231
<dt>EmitComments</dt>
<dd>
Brian's avatar
Brian committed
232 233
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
234 235
</dd>
</dl>
Brian's avatar
Brian committed
236 237


238
<h2 id="validation">Compiler Validation</h2>
Brian's avatar
Brian committed
239 240

<p>
241
Developers working on the GLSL compiler should test frequently to avoid
Brian's avatar
Brian committed
242 243
regressions.
</p>
244

Brian's avatar
Brian committed
245
<p>
Andreas Boll's avatar
Andreas Boll committed
246
The <a href="http://piglit.freedesktop.org/" target="_parent">Piglit</a> project
247 248 249
has many GLSL tests and the
<a href="http://glean.sf.net" target="_parent">Glean</a> glsl1 test 
tests GLSL features.
Brian's avatar
Brian committed
250 251
</p>

252 253 254
<p>
The Mesa demos repository also has some good GLSL tests.
</p>
Brian's avatar
Brian committed
255

256 257
</body>
</html>