Update and improve documentation

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

diff --git a/source/materials/pbrmaterial.h b/source/materials/pbrmaterial.h
index 7c0d545936db21b5464c20bf60512f3566b94ae2..18719bd44e98f8616f2fb7e2e85aac79d2baccda 100644 (file)
--- a/source/materials/pbrmaterial.h
+++ b/source/materials/pbrmaterial.h
@@ -8,6 +8,15 @@ namespace GL {
 
 class Texture2D;
 
+/**
+A physically-based material using the Cook-Torrance BRDF.
+
+The material is characterized by base color, metalness and roughness.  Fully
+metallic materials have no diffuse reflection and their specular reflection is
+tinted by the base color.  For fully dielectric materials base color determines
+the color of the diffuse reflection; specular reflection is untinted.
+Roughness affects how blurry specular reflections are.
+*/
 class PbrMaterial: public Material
 {
 public:
@@ -17,7 +26,6 @@ public:
                static ActionMap shared_actions;
 
        public:
-               Loader(PbrMaterial &);
                Loader(PbrMaterial &, Collection &);
 
        private:
@@ -32,6 +40,7 @@ private:
        Property<float> occlusion;
        Property<Color> emission;
        const Texture2D &fresnel_lookup;
+       const Sampler &fresnel_sampler;
 
        static const Tag texture_tags[];
 
@@ -45,10 +54,9 @@ protected:
        virtual void fill_program_info(std::string &, std::map<std::string, int> &) const;
 
 public:
-       DEPRECATED virtual void attach_textures_to(Texturing &, ProgramData &) const;
-
        virtual const Tag *get_texture_tags() const { return texture_tags; }
        virtual const Texture *get_texture(Tag) const;
+       virtual const Sampler *get_sampler(Tag) const;
 
        void set_base_color(const Color &);
        void set_base_color_map(const Texture *);