SFML - Simple and Fast Multimedia Library

SFML

RenderTexture.hpp
1 //
3 // SFML - Simple and Fast Multimedia Library
4 // Copyright (C) 2007-2017 Laurent Gomila ([email protected])
5 //
6 // This software is provided 'as-is', without any express or implied warranty.
7 // In no event will the authors be held liable for any damages 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 freely,
11 // subject to the following restrictions:
12 //
13 // 1. The origin of this software must not be misrepresented;
14 // you must not claim that you wrote the original software.
15 // If you use this software in a product, an acknowledgment
16 // in the product documentation would be appreciated but is not required.
17 //
18 // 2. Altered source versions must be plainly marked as such,
19 // and must not be misrepresented as being the original software.
20 //
21 // 3. This notice may not be removed or altered from any source distribution.
22 //
24 
25 #ifndef SFML_RENDERTEXTURE_HPP
26 #define SFML_RENDERTEXTURE_HPP
27 
29 // Headers
31 #include <SFML/Graphics/Export.hpp>
32 #include <SFML/Graphics/Texture.hpp>
33 #include <SFML/Graphics/RenderTarget.hpp>
34 
35 
36 namespace sf
37 {
38 namespace priv
39 {
40  class RenderTextureImpl;
41 }
42 
47 class SFML_GRAPHICS_API RenderTexture : public RenderTarget
48 {
49 public:
50 
60  RenderTexture();
61 
66  virtual ~RenderTexture();
67 
86  bool create(unsigned int width, unsigned int height, bool depthBuffer = false);
87 
99  void setSmooth(bool smooth);
100 
109  bool isSmooth() const;
110 
122  void setRepeated(bool repeated);
123 
132  bool isRepeated() const;
133 
148  bool generateMipmap();
149 
165  bool setActive(bool active = true);
166 
176  void display();
177 
187  virtual Vector2u getSize() const;
188 
203  const Texture& getTexture() const;
204 
205 private:
206 
218  virtual bool activate(bool active);
219 
221  // Member data
223  priv::RenderTextureImpl* m_impl;
224  Texture m_texture;
225 };
226 
227 } // namespace sf
228 
229 
230 #endif // SFML_RENDERTEXTURE_HPP
231 
232 
Image living on the graphics card that can be used for drawing.
Definition: Texture.hpp:47
Target for off-screen 2D rendering into a texture.
Base class for all render targets (window, texture, ...)