SFML 2.5.1

- Main Page
- Related Pages
- Modules
- Namespaces
- Classes
- Files

- File List
- File Members

RenderWindow.hpp
1 //
3 // SFML - Simple and Fast Multimedia Library
4 // Copyright (C) 2007-2018 Laurent Gomila (laurent@sfml-dev.org)
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_RENDERWINDOW_HPP
26 #define SFML_RENDERWINDOW_HPP
27
29 // Headers
31 #include <SFML/Graphics/Export.hpp>
32 #include <SFML/Graphics/RenderTarget.hpp>
33 #include <SFML/Graphics/Image.hpp>
34 #include <SFML/Window/Window.hpp>
35 #include <string>
36
37
38 namespace sf
39 {
44 class SFML_GRAPHICS_API RenderWindow : public Window, public RenderTarget
45 {
46 public:
47
55 RenderWindow();
56
76 RenderWindow(VideoMode mode, const String& title, Uint32 style = Style::Default, const ContextSettings& settings = ContextSettings());
77
94 explicit RenderWindow(WindowHandle handle, const ContextSettings& settings = ContextSettings());
95
102 virtual ~RenderWindow();
103
113 virtual Vector2u getSize() const;
114
131 bool setActive(bool active = true);
132
158 SFML_DEPRECATED Image capture() const;
159
160 protected:
161
170 virtual void onCreate();
171
179 virtual void onResize();
180 };
181
182 } // namespace sf
183
184
185 #endif // SFML_RENDERWINDOW_HPP
186
187
sf::Image
Class for loading, manipulating and saving images.
Definition: Image.hpp:47
sf::RenderTarget
Base class for all render targets (window, texture, ...)
Definition: RenderTarget.hpp:53
sf::RenderWindow
Window that can serve as a target for 2D drawing.
Definition: RenderWindow.hpp:45
sf::RenderWindow::RenderWindow
RenderWindow(WindowHandle handle, const ContextSettings &settings=ContextSettings())
Construct the window from an existing control.
sf::RenderWindow::~RenderWindow
virtual ~RenderWindow()
Destructor.
sf::RenderWindow::capture
Image capture() const
Copy the current contents of the window to an image.
sf::RenderWindow::onCreate
virtual void onCreate()
Function called after the window has been created.
sf::RenderWindow::onResize
virtual void onResize()
Function called after the window has been resized.
sf::RenderWindow::RenderWindow
RenderWindow()
Default constructor.
sf::RenderWindow::getSize
virtual Vector2u getSize() const
Get the size of the rendering region of the window.
sf::RenderWindow::RenderWindow
RenderWindow(VideoMode mode, const String &title, Uint32 style=Style::Default, const ContextSettings &settings=ContextSettings())
Construct a new window.
sf::RenderWindow::setActive
bool setActive(bool active=true)
Activate or deactivate the window as the current target for OpenGL rendering.
sf::String
Utility string class that automatically handles conversions between types and encodings.
Definition: String.hpp:46
sf::Vector2< unsigned int >
sf::VideoMode
VideoMode defines a video mode (width, height, bpp)
Definition: VideoMode.hpp:42
sf::Window
Window that serves as a target for OpenGL rendering.
Definition: Window/Window.hpp:59
sf::WindowHandle
platform specific WindowHandle
Define a low-level window handle type, specific to each platform.
Definition: WindowHandle.hpp:68
sf::Style::Default
@ Default
Default window style.
Definition: WindowStyle.hpp:46
sf::ContextSettings
Structure defining the settings of the OpenGL context attached to a window.
Definition: ContextSettings.hpp:38