TGUI  1.3.0
Loading...
Searching...
No Matches
CanvasOpenGL3.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
26#ifndef TGUI_CANVAS_OPENGL3_HPP
27#define TGUI_CANVAS_OPENGL3_HPP
28
29#include <TGUI/Backend/Renderer/OpenGL3/BackendTextureOpenGL3.hpp>
30
31#if !TGUI_BUILD_AS_CXX_MODULE
32 #include <TGUI/Backend/Renderer/BackendRenderTarget.hpp>
33 #include <TGUI/Widgets/CanvasBase.hpp>
34#endif
35
37
38TGUI_MODULE_EXPORT namespace tgui
39{
64 class TGUI_API CanvasOpenGL3 : public CanvasBase
65 {
66 public:
67
68 using Ptr = std::shared_ptr<CanvasOpenGL3>;
69 using ConstPtr = std::shared_ptr<const CanvasOpenGL3>;
70
71 static constexpr const char StaticWidgetType[] = "CanvasOpenGL3";
72
73
81 CanvasOpenGL3(const char* typeName = StaticWidgetType, bool initRenderer = true);
82
83
88
89
93 CanvasOpenGL3(CanvasOpenGL3&& copy) = default;
94
95
99 ~CanvasOpenGL3() override;
100
101
105 CanvasOpenGL3& operator= (const CanvasOpenGL3& right);
106
107
111 CanvasOpenGL3& operator= (CanvasOpenGL3&& right) = default;
112
113
122 TGUI_NODISCARD static CanvasOpenGL3::Ptr create(const Layout2d& size = {"100%", "100%"});
123
124
133 TGUI_NODISCARD static CanvasOpenGL3::Ptr copy(const CanvasOpenGL3::ConstPtr& canvas);
134
135
142 void setSize(const Layout2d& size) override;
143 using Widget::setSize;
144
145
153 void draw(BackendRenderTarget& target, RenderStates states) const override;
154
155
163 unsigned int bindFramebuffer() const;
164
165
167 protected:
168
170 // Makes a copy of the widget
172 TGUI_NODISCARD Widget::Ptr clone() const override;
173
174
176 protected:
177
178 unsigned int m_textureId = 0;
179 unsigned int m_frameBuffer = 0;
180 Vector2u m_textureSize;
181 Vector2u m_usedTextureSize;
182 std::shared_ptr<BackendTextureOpenGL3> m_backendTexture = std::make_shared<BackendTextureOpenGL3>();
183 };
184}
185
187
188#endif // TGUI_CANVAS_OPENGL3_HPP
Base class for render targets.
Definition BackendRenderTarget.hpp:48
This class is used as base class for the backend-specific canvas widgets.
Definition CanvasBase.hpp:39
CanvasOpenGL3 provides a way to directly render OpenGL contents on a widget.
Definition CanvasOpenGL3.hpp:65
std::shared_ptr< const CanvasOpenGL3 > ConstPtr
Shared constant widget pointer.
Definition CanvasOpenGL3.hpp:69
CanvasOpenGL3(const CanvasOpenGL3 &copy)
Copy constructor.
static TGUI_NODISCARD CanvasOpenGL3::Ptr copy(const CanvasOpenGL3::ConstPtr &canvas)
Makes a copy of another canvas.
void draw(BackendRenderTarget &target, RenderStates states) const override
Draw the widget to a render target.
std::shared_ptr< CanvasOpenGL3 > Ptr
Shared widget pointer.
Definition CanvasOpenGL3.hpp:68
~CanvasOpenGL3() override
Destructor.
unsigned int bindFramebuffer() const
Binds the framebuffer of the canvas.
TGUI_NODISCARD Widget::Ptr clone() const override
Makes a copy of the widget if you don't know its exact type.
void setSize(const Layout2d &size) override
Changes the size of the widget.
CanvasOpenGL3(CanvasOpenGL3 &&copy)=default
Default move constructor.
static TGUI_NODISCARD CanvasOpenGL3::Ptr create(const Layout2d &size={"100%", "100%"})
Creates a new canvas widget.
Class to store the position or size of a widget.
Definition Layout.hpp:328
std::shared_ptr< Widget > Ptr
Shared widget pointer.
Definition Widget.hpp:87
Namespace that contains all TGUI functions and classes.
Definition AbsoluteOrRelativeValue.hpp:39
States used for drawing.
Definition RenderStates.hpp:39