Update and improve documentation

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

diff --git a/source/materials/pbrmaterial.h b/source/materials/pbrmaterial.h
index 9669bc35a3a1086e117c73cc8aa2e2f4d677d315..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: