gallium/docs: fix section title formatting
[mesa.git] / docs / shading.html
index aba3959742929273b8792b2c98d4fdcea6349cbe..a28c5b33b04ef129ab11b5ebf05b850f410f6f10 100644 (file)
@@ -1,16 +1,24 @@
-<HTML>
+<!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>
 
-<TITLE>Shading Language Support</TITLE>
+<div class="header">
+  <h1>The Mesa 3D Graphics Library</h1>
+</div>
 
-<link rel="stylesheet" type="text/css" href="mesa.css"></head>
+<iframe src="contents.html"></iframe>
+<div class="content">
 
-<BODY>
-
-<H1>Shading Language Support</H1>
+<h1>Shading Language Support</h1>
 
 <p>
 This page describes the features and status of Mesa's support for the
-<a href="http://opengl.org/documentation/glsl/" target="_parent">
+<a href="https://opengl.org/documentation/glsl/">
 OpenGL Shading Language</a>.
 </p>
 
@@ -19,7 +27,7 @@ Contents
 </p>
 <ul>
 <li><a href="#envvars">Environment variables</a>
-<li><a href="#120">GLSL 1.20 support</a>
+<li><a href="#support">GLSL 1.40 support</a>
 <li><a href="#unsup">Unsupported Features</a>
 <li><a href="#notes">Implementation Notes</a>
 <li><a href="#hints">Programming Hints</a>
@@ -29,9 +37,7 @@ Contents
 </ul>
 
 
-
-<a name="envvars">
-<h2>Environment Variables</h2>
+<h2 id="envvars">Environment Variables</h2>
 
 <p>
 The <b>MESA_GLSL</b> environment variable can be set to a comma-separated
@@ -43,6 +49,7 @@ execution.  These are generally used for debugging.
 <li><b>log</b> - log all GLSL shaders to files.
     The filenames will be "shader_X.vert" or "shader_X.frag" where X
     the shader ID.
+<li><b>cache_info</b> - print debug information about shader cache
 <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
@@ -57,12 +64,25 @@ execution.  These are generally used for debugging.
 Example:  export MESA_GLSL=dump,nopt
 </p>
 
+<p>
+Shaders can be dumped and replaced on runtime for debugging purposes. Mesa 
+needs to be configured with '--with-sha1' to enable this functionality. This 
+feature is not currently supported by SCons build.
+
+This is controlled via following environment variables:
+<ul>
+<li><b>MESA_SHADER_DUMP_PATH</b> - path where shader sources are dumped
+<li><b>MESA_SHADER_READ_PATH</b> - path where replacement shaders are read
+</ul>
+Note, path set must exist before running for dumping or replacing to work. 
+When both are set, these paths should be different so the dumped shaders do 
+not clobber the replacement shaders.
+</p>
 
-<a name="120">
-<h2>GLSL Version</h2>
+<h2 id="support">GLSL Version</h2>
 
 <p>
-The GLSL compiler currently supports version 1.20 of the shading language.
+The GLSL compiler currently supports version 3.30 of the shading language.
 </p>
 
 <p>
@@ -70,14 +90,12 @@ Several GLSL extensions are also supported:
 </p>
 <ul>
 <li>GL_ARB_draw_buffers
-<li>GL_ARB_texture_rectangle
 <li>GL_ARB_fragment_coord_conventions
-<li>GL_EXT_texture_array
+<li>GL_ARB_shader_bit_encoding
 </ul>
 
 
-<a name="unsup">
-<h2>Unsupported Features</h2>
+<h2 id="unsup">Unsupported Features</h2>
 
 <p>XXX update this section</p>
 
@@ -90,7 +108,6 @@ in Mesa:
 <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.
-<li>gl_ClipVertex
 <li>The gl_Color and gl_SecondaryColor varying vars are interpolated
     without perspective correction
 </ul>
@@ -100,8 +117,7 @@ All other major features of the shading language should function.
 </p>
 
 
-<a name="notes">
-<h2>Implementation Notes</h2>
+<h2 id="notes">Implementation Notes</h2>
 
 <ul>
 <li>Shading language programs are compiled into low-level programs
@@ -124,8 +140,7 @@ These issues will be addressed/resolved in the future.
 </p>
 
 
-<a name="hints">
-<h2>Programming Hints</h2>
+<h2 id="hints">Programming Hints</h2>
 
 <ul>
 <li>Use the built-in library functions whenever possible.
@@ -141,8 +156,7 @@ These issues will be addressed/resolved in the future.
 </ul>
 
 
-<a name="standalone">
-<h2>Stand-alone GLSL Compiler</h2>
+<h2 id="standalone">Stand-alone GLSL Compiler</h2>
 
 <p>
 The stand-alone GLSL compiler program can be used to compile GLSL shaders
@@ -151,7 +165,7 @@ into low-level GPU code.
 
 <p>
 This tool is useful for:
-<p>
+</p>
 <ul>
 <li>Inspecting GPU code to gain insight into compilation
 <li>Generating initial GPU code for subsequent hand-tuning
@@ -159,7 +173,7 @@ This tool is useful for:
 </ul>
 
 <p>
-After building Mesa, the compiler can be found at src/glsl/glsl_compiler
+After building Mesa, the compiler can be found at src/compiler/glsl/glsl_compiler
 </p>
 
 <p>
@@ -167,7 +181,7 @@ Here's an example of using the compiler to compile a vertex shader and
 emit GL_ARB_vertex_program-style instructions:
 </p>
 <pre>
-    src/glsl/glsl_compiler --dump-ast myshader.vert
+    src/compiler/glsl/glsl_compiler --version XXX --dump-ast myshader.vert
 </pre>
 
 Options include
@@ -175,18 +189,19 @@ Options include
 <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> - ???
+<li><b>--dump-builder</b> - dump GLSL IR code
+<li><b>--link</b> - link shaders
+<li><b>--just-log</b> - display only shader / linker info if exist,
+without any header or separator
+<li><b>--version</b> - [Mandatory] define the GLSL version to use
 </ul>
 
 
-
-
-<a name="implementation">
-<h2>Compiler Implementation</h2>
+<h2 id="implementation">Compiler Implementation</h2>
 
 <p>
 The source code for Mesa's shading language compiler is in the
-<code>src/glsl/</code> directory.
+<code>src/compiler/glsl/</code> directory.
 </p>
 
 <p>
@@ -199,54 +214,7 @@ 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>
-
-
-<a name="validation">
-<h2>Compiler Validation</h2>
+<h2 id="validation">Compiler Validation</h2>
 
 <p>
 Developers working on the GLSL compiler should test frequently to avoid
@@ -254,15 +222,14 @@ regressions.
 </p>
 
 <p>
-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.
+The <a href="https://piglit.freedesktop.org/">Piglit</a> project
+has many GLSL tests.
 </p>
 
 <p>
 The Mesa demos repository also has some good GLSL tests.
 </p>
 
-</BODY>
-</HTML>
+</div>
+</body>
+</html>