]> git.tdb.fi Git - libs/gl.git/blob - source/shadowmap.h
Require texture data to be uploaded in a format matching the storage
[libs/gl.git] / source / shadowmap.h
1 #ifndef MSP_GL_SHADOWMAP_H_
2 #define MSP_GL_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         Framebuffer fbo;
28         Matrix shadow_matrix;
29         Texture2D depth_buf;
30         Vector3 target;
31         float radius;
32         float depth_bias;
33         mutable ProgramData shdata;
34         bool rendered;
35
36 public:
37         ShadowMap(unsigned, Renderable &, const Light &);
38
39         /** Sets the ShadowMap target point and radius.  The transformation matrix is
40         computed so that a sphere with the specified parameters will be completely
41         covered by the ShadowMap. */
42         void set_target(const Vector3 &, float);
43
44         /** Sets the darkness of shadows.  Must be in the range between 0.0 and 1.0,
45         inclusive.  Only usable with shaders, and provided through the
46         shadow_darkness uniform. */
47         void set_darkness(float);
48
49         /** Sets a distance beyond objects from which the shadow starts.  Expressed
50         in pixel-sized units.  Must be positive; values less than 1.0 are not
51         recommended.  Larger values produce less depth artifacts, but may prevent
52         thin objects from casting shadows on nearby sufraces. */
53         void set_depth_bias(float);
54
55         const Texture2D &get_depth_texture() const { return depth_buf; }
56         const Matrix &get_shadow_matrix() const { return shadow_matrix; }
57
58         virtual void setup_frame(Renderer &);
59         virtual void finish_frame();
60
61         virtual void render(Renderer &, const Tag & = Tag()) const;
62 };
63
64 } // namespace GL
65 } // namespace Msp
66
67 #endif