TGUI  0.9-dev
BackendRenderTargetSFML.hpp
1
2//
3// TGUI - Texus' Graphical User Interface
4// Copyright (C) 2012-2021 Bruno Van de Velde (vdv_b@tgui.eu)
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
26#ifndef TGUI_BACKEND_RENDER_TARGET_SFML_HPP
27#define TGUI_BACKEND_RENDER_TARGET_SFML_HPP
28
29#include <TGUI/Backend/Renderer/BackendRenderTarget.hpp>
30
31#include <SFML/Graphics/View.hpp>
32#include <SFML/Graphics/RenderStates.hpp>
33
35
36namespace sf
37{
38 class RenderTarget;
39}
40
41namespace tgui
42{
43TGUI_IGNORE_DEPRECATED_WARNINGS_START
48 {
49 public:
50
56 BackendRenderTargetSFML(sf::RenderTarget& target);
57
58
64 sf::RenderTarget* getTarget() const;
65
66
71 void setClearColor(const Color& color) override;
72
73
77 void clearScreen() override;
78
79#ifndef TGUI_REMOVE_DEPRECATED_CODE
86 void setView(FloatRect view, FloatRect viewport) override;
88#endif
89
95 void drawGui(const std::shared_ptr<RootContainer>& root) override;
96
97#ifndef TGUI_REMOVE_DEPRECATED_CODE
108 void addClippingLayer(const RenderStates& states, FloatRect rect) override;
109
110
116 void removeClippingLayer() override;
117#endif
118
125 void drawSprite(const RenderStates& states, const Sprite& sprite) override;
126
127
138 void drawVertexArray(const RenderStates& states, const Vertex* vertices, std::size_t vertexCount,
139 const int* indices, std::size_t indexCount, const std::shared_ptr<BackendTexture>& texture) override;
140
141
143 protected:
144
153 void updateClipping(FloatRect clipRect, FloatRect clipViewport) override;
154
155#ifndef TGUI_REMOVE_DEPRECATED_CODE
157 // Converts tgui::RenderStates to sf::RenderStates
159 TGUI_DEPRECATED("Pass the texture or nullptr to convertRenderStates") sf::RenderStates convertRenderStates(const RenderStates& states);
160#endif
161
163 // Converts tgui::RenderStates to sf::RenderStates
165 sf::RenderStates convertRenderStates(const RenderStates& states, const std::shared_ptr<BackendTexture>& texture);
166
167
169 protected:
170
171 sf::RenderTarget* m_target = nullptr;
172
173#ifdef TGUI_NEXT
174 Color m_clearColor;
175#else
176 Color m_clearColor = {240, 240, 240};
177#endif
178
179#ifndef TGUI_REMOVE_DEPRECATED_CODE
180 TGUI_DEPRECATED("Calculate using m_viewRect, m_viewport and m_targetSize instead. See new updateClipping function.") sf::View m_view;
181 TGUI_DEPRECATED("Use m_clipLayers instead") std::vector<std::pair<FloatRect, sf::View>> m_clippingLayers;
182#endif
183 };
184TGUI_IGNORE_DEPRECATED_WARNINGS_END
186}
187
189
190#endif // TGUI_BACKEND_RENDER_TARGET_SFML_HPP
Render target that uses SFML to draw the gui.
Definition: BackendRenderTargetSFML.hpp:48
void drawVertexArray(const RenderStates &states, const Vertex *vertices, std::size_t vertexCount, const int *indices, std::size_t indexCount, const std::shared_ptr< BackendTexture > &texture) override
Draws a vertex array. This is called by the other draw functions when they are not overriden.
void drawSprite(const RenderStates &states, const Sprite &sprite) override
Draws a texture.
void drawGui(const std::shared_ptr< RootContainer > &root) override
Draws the gui and all of its widgets.
void setView(FloatRect view, FloatRect viewport) override
Informs the render target about which part of the window is used for rendering.
BackendRenderTargetSFML(sf::RenderTarget &target)
Constructs the render target.
void addClippingLayer(const RenderStates &states, FloatRect rect) override
Adds another clipping region.
void setClearColor(const Color &color) override
Select the color that will be used by clearScreen.
sf::RenderTarget * getTarget() const
Returns the SFML render target on which the gui is being drawn.
void updateClipping(FloatRect clipRect, FloatRect clipViewport) override
Called from addClippingLayer and removeClippingLayer to apply the clipping.
void clearScreen() override
Clears the screen, called at the beginning of each frame when gui.mainLoop() is called.
void removeClippingLayer() override
Removes the last added clipping region.
Base class for render targets.
Definition: BackendRenderTarget.hpp:48
virtual void setView(FloatRect view, FloatRect viewport)
Informs the render target about which part of the window is used for rendering.
Wrapper for colors.
Definition: Color.hpp:63
Definition: Sprite.hpp:45
Namespace that contains all TGUI functions and classes.
Definition: AbsoluteOrRelativeValue.hpp:36
States used for drawing.
Definition: RenderStates.hpp:39
Definition: Vertex.hpp:37