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