Introduce a typedef for uniform layout hashes in Program

[libs/gl.git] / source / program.h

diff --git a/source/program.h b/source/program.h
index b41f9ac225e9edc724b18d375b278e4793b6b15b..36f380a2a9821835d930e0e29736ef2e706778d2 100644 (file)
--- a/source/program.h
+++ b/source/program.h
@@ -14,6 +14,10 @@ namespace GL {
 
 class Shader;
 
+/**
+A complete shader program.  Programs can be assembled of individual Shaders or
+generated with a set of standard features.
+*/
 class Program: public Bindable<Program>
 {
 public:
@@ -31,6 +35,7 @@ public:
                void vertex_shader(const std::string &);
        };
 
+       typedef unsigned LayoutHash;
        struct UniformBlockInfo;
 
        struct UniformInfo
@@ -50,7 +55,7 @@ public:
                unsigned data_size;
                unsigned bind_point;
                std::vector<const UniformInfo *> uniforms;
-               unsigned layout_hash;
+               LayoutHash layout_hash;
        };
 
        typedef std::list<Shader *> ShaderList;
@@ -64,13 +69,19 @@ private:
        bool linked;
        UniformBlockMap uniform_blocks;
        UniformMap uniforms;
-       unsigned uniform_layout_hash;
+       LayoutHash uniform_layout_hash;
        bool legacy_vars;
 
 public:
+       /// Constructs an empty Program with no Shaders attached.
        Program();
+
+       /// Constructs a Program with standard features.
        Program(const ProgramBuilder::StandardFeatures &);
+
+       /// Constructs a Program from vertex and fragment shader source code.
        Program(const std::string &, const std::string &);
+
 private:
        void init();
 public:
@@ -87,13 +98,13 @@ public:
 
        void link();
 private:
-       static unsigned compute_layout_hash(const std::vector<const UniformInfo *> &);
+       static LayoutHash compute_layout_hash(const std::vector<const UniformInfo *> &);
        static bool uniform_location_compare(const UniformInfo *, const UniformInfo *);
 public:
        bool is_linked() const { return linked; }
        std::string get_info_log() const;
 
-       unsigned get_uniform_layout_hash() const { return uniform_layout_hash; }
+       LayoutHash get_uniform_layout_hash() const { return uniform_layout_hash; }
        const UniformBlockMap &get_uniform_blocks() const { return uniform_blocks; }
        const UniformBlockInfo &get_uniform_block_info(const std::string &) const;
        const UniformMap &get_uniforms() const { return uniforms; }