TGUI 1.11
Loading...
Searching...
No Matches
Texture.hpp
1
2//
3// TGUI - Texus' Graphical User Interface
4// Copyright (C) 2012-2025 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_TEXTURE_HPP
26#define TGUI_TEXTURE_HPP
27
29
30#include <TGUI/TextureData.hpp>
31#include <TGUI/Vector2.hpp>
32#include <TGUI/String.hpp>
33#include <TGUI/Global.hpp>
34#include <TGUI/Color.hpp>
35#include <TGUI/Rect.hpp>
36
37#include <functional>
38
39#if TGUI_HAS_RENDERER_BACKEND_SFML_GRAPHICS
40 #include <SFML/Graphics/Texture.hpp>
41 #include <SFML/Graphics/Shader.hpp>
42#endif
43
45
46namespace tgui
47{
51 class TGUI_API Texture
52 {
53 public:
54
55 using CallbackFunc = std::function<void(std::shared_ptr<TextureData>)>;
56 using BackendTextureLoaderFunc = std::function<bool(BackendTexture&, const String&, bool smooth)>;
57 using TextureLoaderFunc = std::function<std::shared_ptr<TextureData>(Texture&, const String&, bool smooth)>;
58
62 Texture() = default;
63
74 Texture(const char* id,
75 const UIntRect& partRect = UIntRect(0, 0, 0, 0),
76 const UIntRect& middlePart = UIntRect(0, 0, 0, 0),
77 bool smooth = m_defaultSmooth)
78 : Texture(String{id}, partRect, middlePart, smooth)
79 {
80 }
81
94 Texture(const String& id,
95 const UIntRect& partRect = UIntRect(0, 0, 0, 0),
96 const UIntRect& middlePart = UIntRect(0, 0, 0, 0),
97 bool smooth = m_defaultSmooth);
98
99#if TGUI_HAS_RENDERER_BACKEND_SFML_GRAPHICS && !defined(TGUI_REMOVE_DEPRECATED_CODE)
114 TGUI_DEPRECATED("Use Texture() and loadFromPixelData(texture.getSize(), texture.copyToImage().getPixelsPtr()) instead")
115 Texture(const sf::Texture& texture,
116 const UIntRect& partRect = UIntRect(0, 0, 0, 0),
117 const UIntRect& middlePart = UIntRect(0, 0, 0, 0));
118#endif
123
127 Texture(Texture&&) noexcept;
128
133
137 Texture& operator=(const Texture&);
138
142 Texture& operator=(Texture&&) noexcept;
143
154 void load(const String& id,
155 const UIntRect& partRect = {},
156 const UIntRect& middleRect = {},
157 bool smooth = m_defaultSmooth);
158
159#if TGUI_HAS_RENDERER_BACKEND_SFML_GRAPHICS && !defined(TGUI_REMOVE_DEPRECATED_CODE)
174 TGUI_DEPRECATED("Use loadFromPixelData(texture.getSize(), texture.copyToImage().getPixelsPtr()) instead")
175 void load(const sf::Texture& texture,
176 const UIntRect& partRect = {},
177 const UIntRect& middleRect = {});
178#endif
190 void loadFromMemory(const std::uint8_t* data, std::size_t dataSize, const UIntRect& partRect = {}, const UIntRect& middleRect = {}, bool smooth = m_defaultSmooth);
191
205 void loadFromPixelData(Vector2u size, const std::uint8_t* pixels, const UIntRect& partRect = {}, const UIntRect& middleRect = {}, bool smooth = m_defaultSmooth);
206
219 void loadFromBase64(CharStringView imageAsBase64, const UIntRect& partRect = {}, const UIntRect& middleRect = {}, bool smooth = m_defaultSmooth);
220
226 TGUI_NODISCARD const String& getId() const;
227
233 TGUI_NODISCARD std::shared_ptr<TextureData> getData() const;
234
240 TGUI_NODISCARD Vector2u getImageSize() const;
241
247 TGUI_NODISCARD UIntRect getPartRect() const;
248
254 TGUI_NODISCARD bool isSmooth() const;
255
266 void setColor(const Color& color);
267
278 TGUI_NODISCARD const Color& getColor() const;
279
280#if TGUI_HAS_RENDERER_BACKEND_SFML_GRAPHICS
285 void setShader(sf::Shader* shader);
286
291 TGUI_NODISCARD sf::Shader* getShader() const;
292#endif
300 void setMiddleRect(const UIntRect& middleRect);
301
307 TGUI_NODISCARD UIntRect getMiddleRect() const;
308
323 void setScaledNineSlice(bool scaled);
324
334 TGUI_NODISCARD bool getScaledNineSlice() const;
335
343 TGUI_NODISCARD bool isTransparentPixel(Vector2u pos) const;
344
352 void setCopyCallback(const CallbackFunc& func);
353
361 void setDestructCallback(const CallbackFunc& func);
362
366 TGUI_NODISCARD bool operator==(const Texture& right) const;
367
371 TGUI_NODISCARD bool operator!=(const Texture& right) const;
372
383 static void setDefaultSmooth(bool smooth);
384
393 TGUI_NODISCARD static bool getDefaultSmooth();
394
404 static void setBackendTextureLoader(const BackendTextureLoaderFunc& func);
405
413 TGUI_NODISCARD static const BackendTextureLoaderFunc& getBackendTextureLoader();
414
424 static void setTextureLoader(const TextureLoaderFunc& func);
425
433 TGUI_NODISCARD static const TextureLoaderFunc& getTextureLoader();
434
436 private:
437
445 void setTextureData(std::shared_ptr<TextureData> data, const UIntRect& partRect, const UIntRect& middleRect);
446
448 private:
449
450#if TGUI_HAS_RENDERER_BACKEND_SFML_GRAPHICS
451 sf::Shader* m_shader = nullptr;
452#endif
453
454 std::shared_ptr<TextureData> m_data = nullptr;
455 Color m_color = Color::White;
456
457 UIntRect m_partRect;
458 UIntRect m_middleRect;
459 String m_id;
460 bool m_scaledNineSlice = false;
461
462 CallbackFunc m_copyCallback;
463 CallbackFunc m_destructCallback;
464
465 static bool m_defaultSmooth;
466
467 static TextureLoaderFunc m_textureLoader;
468 static BackendTextureLoaderFunc m_backendTextureLoader;
469 };
470
472}
473
475
476#endif // TGUI_TEXTURE_HPP
Base class for texture implementations that depend on the backend.
Definition BackendTexture.hpp:41
Wrapper for colors.
Definition Color.hpp:71
static const Color White
White predefined color.
Definition Color.hpp:258
Wrapper class to store strings.
Definition String.hpp:94
void setScaledNineSlice(bool scaled)
Sets whether the corners of the image can still scale with the image size when 9-slice scaling is use...
UIntRect getMiddleRect() const
Returns the middle rect of the texture which is used for 9-slice scaling.
static void setTextureLoader(const TextureLoaderFunc &func)
Sets a different texture loader.
Texture(const Texture &)
Copy constructor.
static void setDefaultSmooth(bool smooth)
Changes whether textures are smoothed by default or not.
void setMiddleRect(const UIntRect &middleRect)
Sets the middle part of the image for 9-slice scaling (relative to the part defined by partRect)
bool isTransparentPixel(Vector2u pos) const
Checks if a certain pixel is transparent.
std::shared_ptr< TextureData > getData() const
Returns the texture data.
sf::Shader * getShader() const
Returns the shader used to draw the texture.
Texture(Texture &&) noexcept
Move constructor.
void load(const String &id, const UIntRect &partRect={}, const UIntRect &middleRect={}, bool smooth=m_defaultSmooth)
Creates the texture.
static const BackendTextureLoaderFunc & getBackendTextureLoader()
Returns the used backend texture loader.
static bool getDefaultSmooth()
Returns whether textures are smoothed by default or not.
bool operator==(const Texture &right) const
Compares the texture with another one.
Texture(const char *id, const UIntRect &partRect=UIntRect(0, 0, 0, 0), const UIntRect &middlePart=UIntRect(0, 0, 0, 0), bool smooth=m_defaultSmooth)
Constructor that created the texture.
Definition Texture.hpp:74
void setShader(sf::Shader *shader)
Sets the shader used to draw the texture.
bool operator!=(const Texture &right) const
Compares the texture with another one.
void loadFromBase64(CharStringView imageAsBase64, const UIntRect &partRect={}, const UIntRect &middleRect={}, bool smooth=m_defaultSmooth)
Loads the texture from a base64 string.
static const TextureLoaderFunc & getTextureLoader()
Returns the used texture loader.
void setColor(const Color &color)
Sets the global color of the texture.
UIntRect getPartRect() const
Returns which part of the image was loaded.
bool isSmooth() const
Tells whether the smooth filter is enabled or not.
void loadFromPixelData(Vector2u size, const std::uint8_t *pixels, const UIntRect &partRect={}, const UIntRect &middleRect={}, bool smooth=m_defaultSmooth)
Loads the texture from an array of 32-bits RGBA pixels.
bool getScaledNineSlice() const
Returns whether the corners of the image can still scale with the image size when 9-slice scaling is ...
void loadFromMemory(const std::uint8_t *data, std::size_t dataSize, const UIntRect &partRect={}, const UIntRect &middleRect={}, bool smooth=m_defaultSmooth)
Loads the texture from memory (data in memory should contain the entire file, not just the pixels)
static void setBackendTextureLoader(const BackendTextureLoaderFunc &func)
Sets a different backend texture loader.
void setCopyCallback(const CallbackFunc &func)
Sets a callback function for when this texture is copied.
const Color & getColor() const
Returns the global color of the texture.
const String & getId() const
Returns the id that was used to load the texture (for the default loader, the id is the filename)
void setDestructCallback(const CallbackFunc &func)
Sets a callback function for when this texture is destroyed.
Texture(const String &id, const UIntRect &partRect=UIntRect(0, 0, 0, 0), const UIntRect &middlePart=UIntRect(0, 0, 0, 0), bool smooth=m_defaultSmooth)
Constructor that created the texture.
Vector2u getImageSize() const
Returns the size that the loaded image, or the size of the part if only a part of the image is loaded...
Texture()=default
Default constructor.
Namespace that contains all TGUI functions and classes.
Definition AbsoluteOrRelativeValue.hpp:36