Update and improve documentation

[libs/gl.git] / source / effects / ambientocclusion.h

diff --git a/source/effects/ambientocclusion.h b/source/effects/ambientocclusion.h
index 61d4d4f3e44a48daf94468d684d26f14e4b19ba5..a9ffb81e2ac4d52c82557400da03835f6a8a0ef1 100644 (file)
--- a/source/effects/ambientocclusion.h
+++ b/source/effects/ambientocclusion.h
@@ -1,19 +1,17 @@
 #ifndef MSP_GL_AMBIENTOCCLUSION_H_
 #define MSP_GL_AMBIENTOCCLUSION_H_
 
-#include "framebuffer.h"
-#include "mesh.h"
 #include "postprocessor.h"
-#include "program.h"
 #include "programdata.h"
 #include "rendertarget.h"
-#include "texture2d.h"
 
 namespace Msp {
 namespace GL {
 
+class Program;
+
 /**
-Implements screen-space ambient occlusion.
+Darkens recessed areas of the scene to simulate the occlusion of ambient light.
 
 http://en.wikipedia.org/wiki/Screen_Space_Ambient_Occlusion
 */
@@ -28,12 +26,10 @@ public:
                        Loader(Template &);
                };
 
-               unsigned n_samples;
-               float occlusion_radius;
-               float darkness;
-               float edge_depth_threshold;
-
-               Template();
+               unsigned n_samples = 16;
+               float occlusion_radius = 0.5f;
+               float darkness = 1.0f;
+               float edge_depth_threshold = 0.1f;
 
                virtual AmbientOcclusion *create(unsigned, unsigned) const;
        };
@@ -54,7 +50,7 @@ public:
 
 private:
        static const Texture2D &get_or_create_rotate_lookup();
-       static float random(unsigned &);
+       static float radical_inverse(unsigned);
 
 public:
        void set_n_samples(unsigned);
@@ -64,6 +60,8 @@ public:
        void set_darkness(float);
 
        virtual void render(Renderer &, const Texture2D &, const Texture2D &);
+
+       virtual void set_debug_name(const std::string &);
 };
 
 } // namespace GL