TGUI  1.6.1
Loading...
Searching...
No Matches
BackendRenderTargetSFML.hpp
1
2//
3// TGUI - Texus' Graphical User Interface
4// Copyright (C) 2012-2024 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#ifndef TGUI_BACKEND_RENDER_TARGET_SFML_HPP
26#define TGUI_BACKEND_RENDER_TARGET_SFML_HPP
27
28#include <TGUI/Config.hpp>
29#if !TGUI_BUILD_AS_CXX_MODULE
30 #include <TGUI/Backend/Renderer/BackendRenderTarget.hpp>
31
32 namespace sf
33 {
34 class RenderTarget;
35 }
36#endif
37
38#include <SFML/Graphics/View.hpp>
39#include <SFML/Graphics/RenderStates.hpp>
40
42
43TGUI_MODULE_EXPORT namespace tgui
44{
49 {
50 public:
51
57 BackendRenderTargetSFML(sf::RenderTarget& target);
58
64 TGUI_NODISCARD sf::RenderTarget* getTarget() const;
65
70 void setClearColor(const Color& color) override;
71
75 void clearScreen() override;
76
82 void drawGui(const std::shared_ptr<RootContainer>& root) override;
83
90 void drawSprite(const RenderStates& states, const Sprite& sprite) override;
91
102 void drawVertexArray(const RenderStates& states, const Vertex* vertices, std::size_t vertexCount,
103 const unsigned int* indices, std::size_t indexCount, const std::shared_ptr<BackendTexture>& texture) override;
104
106 protected:
107
116 void updateClipping(FloatRect clipRect, FloatRect clipViewport) override;
117
119 // Converts tgui::RenderStates to sf::RenderStates
121 TGUI_NODISCARD sf::RenderStates convertRenderStates(const RenderStates& states, const std::shared_ptr<BackendTexture>& texture);
122
124 protected:
125
126 sf::RenderTarget* m_target = nullptr;
127
128 Color m_clearColor;
129 };
130
132}
133
135
136#endif // TGUI_BACKEND_RENDER_TARGET_SFML_HPP
Render target that uses SFML to draw the gui.
Definition BackendRenderTargetSFML.hpp:49
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.
BackendRenderTargetSFML(sf::RenderTarget &target)
Constructs the render target.
void setClearColor(const Color &color) override
Select the color that will be used by clearScreen.
void drawVertexArray(const RenderStates &states, const Vertex *vertices, std::size_t vertexCount, const unsigned 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.
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.
Base class for render targets.
Definition BackendRenderTarget.hpp:46
Wrapper for colors.
Definition Color.hpp:73
Definition Sprite.hpp:47
Namespace that contains all TGUI functions and classes.
Definition AbsoluteOrRelativeValue.hpp:38
States used for drawing.
Definition RenderStates.hpp:38
Definition Vertex.hpp:39