Gamedev Framework (gf)  0.1.0
A C++11 framework for 2D games
PostProcessing.h
1 /*
2  * Gamedev Framework (gf)
3  * Copyright (C) 2016 Julien Bernard
4  *
5  * This software is provided 'as-is', without any express or implied
6  * warranty. In no event will the authors be held liable for any damages
7  * arising from the use of this software.
8  *
9  * Permission is granted to anyone to use this software for any purpose,
10  * including commercial applications, and to alter it and redistribute it
11  * freely, subject to the following restrictions:
12  *
13  * 1. The origin of this software must not be misrepresented; you must not
14  * claim that you wrote the original software. If you use this software
15  * in a product, an acknowledgment in the product documentation would be
16  * appreciated but is not required.
17  * 2. Altered source versions must be plainly marked as such, and must not be
18  * misrepresented as being the original software.
19  * 3. This notice may not be removed or altered from any source distribution.
20  */
21 #ifndef GF_POST_PROCESSING_H
22 #define GF_POST_PROCESSING_H
23 
24 #include "Drawable.h"
25 #include "Portability.h"
26 #include "Rect.h"
27 #include "Vertex.h"
28 
29 namespace gf {
30 #ifndef DOXYGEN_SHOULD_SKIP_THIS
31 inline namespace v1 {
32 #endif
33 
34  class Effect;
35  class Texture;
36 
37  /**
38  * @ingroup graphics
39  * @brief A post-processing drawable
40  *
41  * This class is a light-weight object to apply a post-processing effect to
42  * a texture. The texture generally comes froma gf::RenderTexture.
43  *
44  * @sa gf::RenderTexture
45  */
46  class GF_API PostProcessing : public Drawable {
47  public:
48  /**
49  * @brief Default constructor
50  */
52 
53  /**
54  * @brief Set the source texture
55  *
56  * @param texture The source texture
57  */
58  void setTexture(const Texture& texture);
59 
60  /**
61  * @brief Set the texture rectangle
62  *
63  * @param textureRect The texture rectangle
64  */
65  void setTextureRect(const RectF& textureRect);
66 
67  /**
68  * @brief Set the effect to apply
69  *
70  * @param effect The post-processing effect
71  */
72  void setEffect(Effect& effect) {
73  m_effect = &effect;
74  }
75 
76  virtual void draw(RenderTarget& target, RenderStates states) override;
77 
78  private:
79  void updatePositions();
80  void updateTexCoords();
81 
82  private:
83  const Texture *m_texture;
84  RectF m_textureRect;
85  Effect *m_effect;
86  Vertex m_vertices[4];
87  };
88 
89 #ifndef DOXYGEN_SHOULD_SKIP_THIS
90 }
91 #endif
92 }
93 
94 #endif // GF_POST_PROCESSING_H
void setTextureRect(const RectF &textureRect)
Set the texture rectangle.
Base class for all render targets (window, texture, ...)
Definition: RenderTarget.h:65
Define the states used for drawing to a RenderTarget.
Definition: RenderStates.h:81
A point associated with a color and a texture coordinate.
Definition: Vertex.h:75
Abstract base class for objects that can be drawn to a render window.
Definition: Drawable.h:79
A texture for colored images.
Definition: Texture.h:317
A post-processing drawable.
Definition: PostProcessing.h:46
Rect< float > RectF
A float rectangle.
Definition: Rect.h:306
Definition: Action.h:34
PostProcessing()
Default constructor.
A post-processing effect.
Definition: Effect.h:38
#define GF_API
Definition: Portability.h:35
void setEffect(Effect &effect)
Set the effect to apply.
Definition: PostProcessing.h:72
virtual void draw(RenderTarget &target, RenderStates states) override
Draw the object to a render target.
void setTexture(const Texture &texture)
Set the source texture.