Add some documentation to the GLSL compiler

[libs/gl.git] / source / glsl / compatibility.h

diff --git a/source/glsl/compatibility.h b/source/glsl/compatibility.h
index d3a3a74c0dc493fba95e34f06b1b5eb72f8a3266..ad6c7cbe9c875f3a63c7cdb69c682f2f7f7a0aa3 100644 (file)
--- a/source/glsl/compatibility.h
+++ b/source/glsl/compatibility.h
@@ -8,6 +8,8 @@ namespace Msp {
 namespace GL {
 namespace SL {
 
+/** Generates default precision declarations if they are missing, to satisfy
+GLSL ES requirements. */
 class DefaultPrecisionGenerator: private TraversingVisitor
 {
 private:
@@ -24,9 +26,10 @@ private:
        virtual void visit(Block &);
        virtual void visit(Precision &);
        virtual void visit(VariableDeclaration &);
-       using TraversingVisitor::visit;
 };
 
+/** Removes precision qualifiers from variable declarations, as well as
+default precision declarations. */
 class PrecisionRemover: private TraversingVisitor
 {
 private:
@@ -38,9 +41,10 @@ public:
 private:
        virtual void visit(Precision &);
        virtual void visit(VariableDeclaration &);
-       using TraversingVisitor::visit;
 };
 
+/** Converts structures of the syntax tree to match a particular set of
+features. */
 class LegacyConverter: private TraversingVisitor
 {
 private:
@@ -60,6 +64,7 @@ private:
        virtual void visit(Block &);
        bool check_version(const Version &) const;
        bool check_extension(bool Features::*) const;
+       bool supports_stage(Stage::Type) const;
        bool supports_unified_interface_syntax() const;
        virtual void visit(VariableReference &);
        virtual void visit(Assignment &);
@@ -71,7 +76,6 @@ private:
        virtual void visit(VariableDeclaration &);
        bool supports_interface_blocks(const std::string &) const;
        virtual void visit(InterfaceBlock &);
-       using TraversingVisitor::visit;
 };
 
 } // namespace SL