source/shadowmap.h

   1 #ifndef SHADOWMAP_H_
   2 #define SHADOWMAP_H_
   3
   4 #include "effect.h"
   5 #include "framebuffer.h"
   6 #include "programdata.h"
   7 #include "texture2d.h"
   8 #include "vector.h"
   9
  10 namespace Msp {
  11 namespace GL {
  12
  13 class Light;
  14 class Scene;
  15
  16 /**
  17 Creates shadows on a Scene through a shadow map texture.  In the preparation
  18 phase, the scene is rendered to a depth texture from the point of view of the
  19 lightsource.  This texture is then used in the rendering phase together with
  20 texture coordinate generation to determine whether each fragment is lit.
  21 */
  22 class ShadowMap: public Effect
  23 {
  24 private:
  25         unsigned size;
  26         const Light &light;
  27         mutable Framebuffer fbo;
  28         mutable Matrix light_matrix;
  29         unsigned unit;
  30         Texture2D depth_buf;
  31         Vector3 target;
  32         float radius;
  33         float depth_bias;
  34         ProgramData shdata;
  35         mutable bool rendered;
  36
  37 public:
  38         ShadowMap(unsigned, const Renderable &, const Light &);
  39
  40         /** Sets the ShadowMap target point and radius.  The transformation matrix is
  41         computed so that a sphere with the specified parameters will be completely
  42         covered by the ShadowMap. */
  43         void set_target(const Vector3 &, float);
  44
  45         /** Sets the darkness of shadows.  Must be in the range between 0.0 and 1.0,
  46         inclusive.  Only usable with shaders, and provided through the
  47         shadow_darkness uniform. */
  48         void set_darkness(float);
  49
  50         /** Sets a distance beyond objects from which the shadow starts.  Expressed
  51         in pixel-sized units.  Must be positive; values less than 1.0 are not
  52         recommended.  Larger values produce less depth artifacts, but may prevent
  53         thin objects from casting shadows on nearby sufraces. */
  54         void set_depth_bias(float);
  55
  56         /** Sets the texture unit to bind the shadow map to during the rendering
  57         phase.  Provided to shaders through the shadow and shadow_unit uniforms.
  58         The default is texture unit 3. */
  59         void set_texture_unit(unsigned);
  60
  61         virtual void setup_frame() const;
  62         virtual void finish_frame() const;
  63
  64         virtual void render(Renderer &, const Tag &) const;
  65 };
  66
  67 } // namespace GL
  68 } // namespace Msp
  69
  70 #endif