Gamedev Framework (gf)  0.17.0
A C++14 framework for 2D games
RenderTexture.h
1 /*
2  * Gamedev Framework (gf)
3  * Copyright (C) 2016-2019 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  * Part of this file comes from SFML, with the same license:
22  * Copyright (C) 2007-2015 Laurent Gomila (laurent@sfml-dev.org)
23  */
24 #ifndef GF_RENDER_TEXTURE_H
25 #define GF_RENDER_TEXTURE_H
26 
27 #include "Portability.h"
28 #include "RenderTarget.h"
29 
30 namespace gf {
31 #ifndef DOXYGEN_SHOULD_SKIP_THIS
32 inline namespace v1 {
33 #endif
34 
98  class GF_API RenderTexture : public RenderTarget {
99  public:
105  RenderTexture(Vector2i size);
106 
117  void setSmooth(bool smooth = true) {
118  m_texture.setSmooth(smooth);
119  }
120 
128  bool isSmooth() const {
129  return m_texture.isSmooth();
130  }
131 
142  void setRepeated(bool repeated = true) {
143  m_texture.setRepeated(repeated);
144  }
145 
153  bool isRepeated() const {
154  return m_texture.isRepeated();
155  }
156 
157  virtual Vector2i getSize() const override;
158 
164  void resize(Vector2i size);
165 
173  void setActive();
174 
183  void display();
184 
191  Image capture() const;
192 
207  const Texture& getTexture() const {
208  return m_texture;
209  }
210 
211  private:
213  Texture m_texture;
214  };
215 
216 #ifndef DOXYGEN_SHOULD_SKIP_THIS
217 }
218 #endif
219 }
220 
221 #endif // GF_RENDER_TEXTURE_H
Target for off-screen 2D rendering into a texture.
Definition: RenderTexture.h:98
Base class for all render targets (window, texture, ...)
Definition: RenderTarget.h:90
bool isRepeated() const
Check if the texture is repeated or not.
Definition: RenderTexture.h:153
void setSmooth(bool smooth=true)
Enable or disable texture smoothing.
Definition: RenderTexture.h:117
void setRepeated(bool repeated=true)
Enable or disable texture repeating.
Definition: RenderTexture.h:142
A texture for colored images.
Definition: Texture.h:309
Class for loading, manipulating and saving images.
Definition: Image.h:80
The namespace for gf classes.
Definition: Action.h:35
bool isSmooth() const
Check if the smooth filtering is enabled or not.
Definition: RenderTexture.h:128
const Texture & getTexture() const
Get a read-only reference to the target texture.
Definition: RenderTexture.h:207