TGUI  1.3-dev
Loading...
Searching...
No Matches
BackendTexture.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_BACKEND_TEXTURE_HPP
27#define TGUI_BACKEND_TEXTURE_HPP
28
29#include <TGUI/Font.hpp>
30#include <TGUI/String.hpp>
31
32#if !TGUI_EXPERIMENTAL_USE_STD_MODULE
33 #include <memory>
34#endif
35
37
38TGUI_MODULE_EXPORT namespace tgui
39{
43 class TGUI_API BackendTexture
44 {
45 public:
46
47 // Don't allow copying or moving, because we don't expect derived classes to handle it correctly
48 BackendTexture(const BackendTexture&) = delete;
50 BackendTexture& operator=(const BackendTexture&) = delete;
51 BackendTexture& operator=(BackendTexture&&) = delete;
52
56 BackendTexture() = default;
57
61 virtual ~BackendTexture() = default;
62
70 bool load(Vector2u size, std::unique_ptr<std::uint8_t[]> pixels, bool smooth);
71
81 virtual bool loadTextureOnly(Vector2u size, const std::uint8_t* pixels, bool smooth);
82
87 TGUI_NODISCARD Vector2u getSize() const;
88
94 virtual void setSmooth(bool smooth);
95
101 TGUI_NODISCARD bool isSmooth() const;
102
110 TGUI_NODISCARD bool isTransparentPixel(Vector2u pixel) const;
111
117 TGUI_NODISCARD const std::uint8_t* getPixels() const;
118
120 protected:
121
122 Vector2u m_imageSize;
123 std::unique_ptr<std::uint8_t[]> m_pixels;
124 bool m_isSmooth = true;
125 };
126}
127
129
130#endif // TGUI_BACKEND_TEXTURE_HPP
Base class for texture implementations that depend on the backend.
Definition BackendTexture.hpp:44
virtual void setSmooth(bool smooth)
Changes whether the smooth filter is enabled or not.
TGUI_NODISCARD bool isSmooth() const
Returns whether the smooth filter is enabled or not.
BackendTexture()=default
Default constructor.
TGUI_NODISCARD bool isTransparentPixel(Vector2u pixel) const
Checks if a certain pixel is transparent.
virtual bool loadTextureOnly(Vector2u size, const std::uint8_t *pixels, bool smooth)
Loads the texture from an array of 32-bits RGBA pixels, but don't take ownership of the pixels.
bool load(Vector2u size, std::unique_ptr< std::uint8_t[]> pixels, bool smooth)
Loads the texture from an array of 32-bits RGBA pixels.
TGUI_NODISCARD const std::uint8_t * getPixels() const
Returns a pointer to the pixels (read-only)
TGUI_NODISCARD Vector2u getSize() const
Returns the size of the entire image.
virtual ~BackendTexture()=default
Virtual destructor.
Namespace that contains all TGUI functions and classes.
Definition AbsoluteOrRelativeValue.hpp:39