TGUI  1.5
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#ifndef TGUI_CANVAS_OPENGL3_HPP
26#define TGUI_CANVAS_OPENGL3_HPP
27
28#include <TGUI/Backend/Renderer/OpenGL3/BackendTextureOpenGL3.hpp>
29
30#if !TGUI_BUILD_AS_CXX_MODULE
31 #include <TGUI/Backend/Renderer/BackendRenderTarget.hpp>
32 #include <TGUI/Widgets/CanvasBase.hpp>
33#endif
34
36
37TGUI_MODULE_EXPORT namespace tgui
38{
63 class TGUI_API CanvasOpenGL3 : public CanvasBase
64 {
65 public:
66
67 using Ptr = std::shared_ptr<CanvasOpenGL3>;
68 using ConstPtr = std::shared_ptr<const CanvasOpenGL3>;
69
70 static constexpr const char StaticWidgetType[] = "CanvasOpenGL3";
71
79 CanvasOpenGL3(const char* typeName = StaticWidgetType, bool initRenderer = true);
80
85
89 CanvasOpenGL3(CanvasOpenGL3&& copy) = default;
90
94 ~CanvasOpenGL3() override;
95
99 CanvasOpenGL3& operator= (const CanvasOpenGL3& right);
100
104 CanvasOpenGL3& operator= (CanvasOpenGL3&& right) = default;
105
113 TGUI_NODISCARD static CanvasOpenGL3::Ptr create(const Layout2d& size = {"100%", "100%"});
114
122 TGUI_NODISCARD static CanvasOpenGL3::Ptr copy(const CanvasOpenGL3::ConstPtr& canvas);
123
129 void setSize(const Layout2d& size) override;
130 using Widget::setSize;
131
138 void draw(BackendRenderTarget& target, RenderStates states) const override;
139
147 unsigned int bindFramebuffer() const;
148
150 protected:
151
153 // Makes a copy of the widget
155 TGUI_NODISCARD Widget::Ptr clone() const override;
156
158 protected:
159
160 unsigned int m_textureId = 0;
161 unsigned int m_frameBuffer = 0;
162 Vector2u m_textureSize;
163 Vector2u m_usedTextureSize;
164 std::shared_ptr<BackendTextureOpenGL3> m_backendTexture = std::make_shared<BackendTextureOpenGL3>();
165 };
166}
167
169
170#endif // TGUI_CANVAS_OPENGL3_HPP
Base class for render targets.
Definition BackendRenderTarget.hpp:46
This class is used as base class for the backend-specific canvas widgets.
Definition CanvasBase.hpp:38
CanvasOpenGL3 provides a way to directly render OpenGL contents on a widget.
Definition CanvasOpenGL3.hpp:64
std::shared_ptr< const CanvasOpenGL3 > ConstPtr
Shared constant widget pointer.
Definition CanvasOpenGL3.hpp:68
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:67
~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:313
std::shared_ptr< Widget > Ptr
Shared widget pointer.
Definition Widget.hpp:86
Namespace that contains all TGUI functions and classes.
Definition AbsoluteOrRelativeValue.hpp:38
States used for drawing.
Definition RenderStates.hpp:38