summaryrefslogtreecommitdiffstats
path: root/src/glsl/glcpp/README
diff options
context:
space:
mode:
Diffstat (limited to 'src/glsl/glcpp/README')
-rw-r--r--src/glsl/glcpp/README32
1 files changed, 32 insertions, 0 deletions
diff --git a/src/glsl/glcpp/README b/src/glsl/glcpp/README
new file mode 100644
index 00000000000..0b5ef508ce9
--- /dev/null
+++ b/src/glsl/glcpp/README
@@ -0,0 +1,32 @@
+glcpp -- GLSL "C" preprocessor
+
+This is a simple preprocessor designed to provide the preprocessing
+needs of the GLSL language. The requirements for this preprocessor are
+specified in the GLSL 1.30 specification availble from:
+
+http://www.opengl.org/registry/doc/GLSLangSpec.Full.1.30.10.pdf
+
+This specification is not precise on some semantics, (for example,
+#define and #if), defining these merely "as is standard for C++
+preprocessors". To fill in these details, I've been using a draft of
+the C99 standard as available from:
+
+http://www.open-std.org/jtc1/sc22/wg14/www/docs/n1256.pdf
+
+Any downstream compiler accepting output from glcpp should be prepared
+to encounter and deal with the following preprocessor macros:
+
+ #line
+ #pragma
+ #extension
+
+All other macros will be handles according to the GLSL specification
+and will not appear in the output.
+
+Known limitations
+-----------------
+The __LINE__ and __FILE__ macros are not yet supported.
+
+A file that ends with a function-like macro name as the last
+non-whitespace token will result in a parse error, (where it should be
+passed through as is). \ No newline at end of file