shading.html 6.75 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>
Brian Paul's avatar
Brian Paul committed
23
<li><a href="#120">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>


Brian Paul's avatar
Brian Paul committed
33

34 35 36 37 38
<a name="envvars">
<h2>Environment Variables</h2>

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


Brian Paul's avatar
Brian Paul committed
62
<a name="120">
63
<h2>GLSL Version</h2>
Brian Paul's avatar
Brian Paul committed
64 65

<p>
66 67 68 69 70 71
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
72
<ul>
73 74 75 76
<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
77 78 79
</ul>


Brian's avatar
Brian committed
80
<a name="unsup">
81 82
<h2>Unsupported Features</h2>

83 84
<p>XXX update this section</p>

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

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

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


Brian's avatar
Brian committed
104
<a name="notes">
105 106 107 108 109
<h2>Implementation Notes</h2>

<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>


Brian's avatar
Brian committed
128
<a name="hints">
129 130 131 132 133 134 135 136 137 138 139 140
<h2>Programming Hints</h2>

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


Brian's avatar
Brian committed
145
<a name="standalone">
146
<h2>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

Brian's avatar
Brian committed
183 184 185 186 187 188 189


<a name="implementation">
<h2>Compiler Implementation</h2>

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

<p>
194
XXX provide some info about the compiler....
Brian's avatar
Brian committed
195 196 197 198 199 200 201 202
</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
203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243
<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>

<ul>
<li>EmitHighLevelInstructions
<br>
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.
</li>

<li>EmitCondCodes
<br>
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.
</li>

<li>EmitComments
<br>
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
244
</li>
Brian's avatar
Brian committed
245
</ul>
Brian's avatar
Brian committed
246 247


Brian's avatar
Brian committed
248 249 250 251
<a name="validation">
<h2>Compiler Validation</h2>

<p>
252
Developers working on the GLSL compiler should test frequently to avoid
Brian's avatar
Brian committed
253 254
regressions.
</p>
255

Brian's avatar
Brian committed
256
<p>
257 258 259 260
The <a href="http://people.freedesktop.org/~nh/piglit/">Piglit</a> project
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
261 262
</p>

263 264 265
<p>
The Mesa demos repository also has some good GLSL tests.
</p>
Brian's avatar
Brian committed
266

267 268
</body>
</html>