added ftransform() comment

[mesa.git] / docs / shading.html

diff --git a/docs/shading.html b/docs/shading.html
index cb2c1c3209b900087bc1ce07613bb6fd32d5c521..4e8f18676b70c67b402a3408b417ff5c2f6b3a04 100644 (file)
--- a/docs/shading.html
+++ b/docs/shading.html
@@ -15,7 +15,7 @@ OpenGL Shading Language</a>.
 </p>
 
 <p>
-Last updated on 17 Feb 2007.
+Last updated on 26 March 2007.
 </p>
 
 <p>
@@ -40,10 +40,8 @@ in Mesa:
 
 <ul>
 <li>Dereferencing arrays with non-constant indexes
-<li>User-defined structs
+<li>Comparison of user-defined structs
 <li>Linking of multiple shaders is not supported
-<li>Integer operations are not fully implemented (most are implemented
-    as floating point).
 <li>gl_ClipVertex
 </ul>
 
@@ -67,7 +65,9 @@ All other major features of the shading language should function.
 <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.
-<li>There are massive memory leaks in the compiler.
+<li>There are known memory leaks in the compiler.
+<li>The ftransform() function doesn't necessarily match the results of
+    fixed-function transformation.
 </ul>
 
 <p>
@@ -236,6 +236,50 @@ The final vertex and fragment programs may be interpreted in software
 (see drivers/dri/i915/i915_fragprog.c for example).
 </p>
 
+<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.
+</br>
+
+</ul>
 
 
 </BODY>