Gamedev Framework (gf) 1.2.0
A C++17 framework for 2D games
RenderWindow.h
1/*
2 * Gamedev Framework (gf)
3 * Copyright (C) 2016-2022 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_WINDOW_H
25#define GF_RENDER_WINDOW_H
26
27#include "GraphicsApi.h"
28#include "RenderTarget.h"
29
30namespace gf {
31#ifndef DOXYGEN_SHOULD_SKIP_THIS
32inline namespace v1 {
33#endif
34
35 class Window;
36
80 class GF_GRAPHICS_API RenderWindow : public RenderTarget {
81 public:
82
89
94
95 virtual Vector2i getSize() const override;
96
97 void setActive() override;
98
108 void display();
109
116 Image capture() const;
117
118 private:
119 Window& m_window;
120 };
121
122#ifndef DOXYGEN_SHOULD_SKIP_THIS
123}
124#endif
125}
126
127#endif // GF_RENDER_WINDOW_H
Class for loading, manipulating and saving images.
Definition: Image.h:81
Base class for all render targets (window, texture, ...)
Definition: RenderTarget.h:102
A window that can serve as a target for 2D drawing.
Definition: RenderWindow.h:80
void display()
Display on screen what has been rendered to the window so far.
virtual Vector2i getSize() const override
Return the size of the rendering region of the target.
RenderWindow(Window &window)
Constructor.
~RenderWindow()
Destructor.
Image capture() const
Copy the current contents of the render window to an image.
void setActive() override
Activate the render target for rendering.
An OS window.
Definition: Window.h:97
The namespace for gf classes.