Update and improve documentation

[libs/gl.git] / source / materials / material.h

diff --git a/source/materials/material.h b/source/materials/material.h
index 98baaa54ff2faf41b7975427dc4412306ac2e906..ff7f53c0d3ffdb23acf15f55c649f6aacaa1708d 100644 (file)
--- a/source/materials/material.h
+++ b/source/materials/material.h
@@ -13,6 +13,9 @@ namespace GL {
 
 class Sampler;
 
+/**
+Base class for materials.  Subclasses provide different shading models.
+*/
 class Material
 {
 private:
@@ -75,15 +78,21 @@ protected:
 public:
        virtual ~Material() = default;
 
+       /** Returns a shader appropriate for this material.  The same shader is
+       returned for materials with the same set of features.  Additional
+       specialization values can be passed in to customize the shader. */
        virtual const Program *create_compatible_shader(const std::map<std::string, int> & = std::map<std::string, int>()) const;
 protected:
        virtual void fill_program_info(std::string &, std::map<std::string, int> &) const = 0;
 
 public:
-       /** Returns the uniforms for the material. */
+       /** Returns the uniform values for the material. */
        const ProgramData &get_shader_data() const { return shdata; }
 
+       /** Returns texture tags used by the material.  The returned array is
+       terminated by an empty tag. */
        virtual const Tag *get_texture_tags() const = 0;
+
        virtual const Texture *get_texture(Tag) const = 0;
        virtual const Sampler *get_sampler(Tag) const { return sampler; }