TGUI  0.10-dev
Texture.hpp
1
2//
3// TGUI - Texus' Graphical User Interface
4// Copyright (C) 2012-2021 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_TEXTURE_HPP
27#define TGUI_TEXTURE_HPP
28
30
31#include <TGUI/TextureData.hpp>
32#include <TGUI/Vector2.hpp>
33#include <TGUI/String.hpp>
34#include <TGUI/Global.hpp>
35#include <TGUI/Color.hpp>
36#include <TGUI/Rect.hpp>
37#include <functional>
38
39#if TGUI_HAS_BACKEND_SFML_GRAPHICS
40 #include <SFML/Graphics/Texture.hpp>
41 #include <SFML/Graphics/Shader.hpp>
42#endif
43
45
46namespace tgui
47{
48 class TGUI_API Texture
49 {
50 public:
51
52 using CallbackFunc = std::function<void(std::shared_ptr<TextureData>)>;
53 using BackendTextureLoaderFunc = std::function<bool(BackendTexture&, const String&, bool smooth)>;
54 using TextureLoaderFunc = std::function<std::shared_ptr<TextureData>(Texture&, const String&, bool smooth)>;
55
56
62
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
82
95 Texture(const String& id,
96 const UIntRect& partRect = UIntRect(0, 0, 0, 0),
97 const UIntRect& middlePart = UIntRect(0, 0, 0, 0),
98 bool smooth = m_defaultSmooth);
99
100#if TGUI_HAS_BACKEND_SFML_GRAPHICS
112 Texture(const sf::Texture& texture,
113 const UIntRect& partRect = UIntRect(0, 0, 0, 0),
114 const UIntRect& middlePart = UIntRect(0, 0, 0, 0));
115#endif
116
121
125 Texture(Texture&&) noexcept;
126
131
135 Texture& operator=(const Texture&);
136
140 Texture& operator=(Texture&&) noexcept;
141
142
153 void load(const String& id,
154 const UIntRect& partRect = {},
155 const UIntRect& middleRect = {},
156 bool smooth = m_defaultSmooth);
157
158#if TGUI_HAS_BACKEND_SFML_GRAPHICS
170 void load(const sf::Texture& texture,
171 const UIntRect& partRect = {},
172 const UIntRect& middleRect = {});
173#endif
174
186 void loadFromMemory(const std::uint8_t* data, std::size_t dataSize, const UIntRect& partRect = {}, const UIntRect& middleRect = {}, bool smooth = m_defaultSmooth);
187
188
202 void loadFromPixelData(Vector2u size, const std::uint8_t* pixels, const UIntRect& partRect = {}, const UIntRect& middleRect = {}, bool smooth = m_defaultSmooth);
203
204
211 const String& getId() const;
212
213
220 std::shared_ptr<TextureData> getData() const;
221
222
229
230
238
239
245 bool isSmooth() const;
246
247
258 void setColor(const Color& color);
259
260
272 const Color& getColor() const;
273
274#if TGUI_HAS_BACKEND_SFML_GRAPHICS
279 void setShader(sf::Shader* shader);
280
281
286 sf::Shader* getShader() const;
287#endif
288
296
297
307
308
317 void setCopyCallback(const CallbackFunc& func);
318
319
328 void setDestructCallback(const CallbackFunc& func);
329
330
334 bool operator==(const Texture& right) const;
335
336
340 bool operator!=(const Texture& right) const;
341
342
353 static void setDefaultSmooth(bool smooth);
354
355
364 static bool getDefaultSmooth();
365
366
376 static void setBackendTextureLoader(const BackendTextureLoaderFunc& func);
377
378
386 static const BackendTextureLoaderFunc& getBackendTextureLoader();
387
388
399 static void setTextureLoader(const TextureLoaderFunc& func);
400
401
410 static const TextureLoaderFunc& getTextureLoader();
411
412
414 private:
415
424 void setTextureData(std::shared_ptr<TextureData> data, const UIntRect& partRect, const UIntRect& middleRect);
425
426
428 private:
429
430#if TGUI_HAS_BACKEND_SFML_GRAPHICS
431 sf::Shader* m_shader = nullptr;
432#endif
433
434 std::shared_ptr<TextureData> m_data = nullptr;
435 Color m_color = Color::White;
436
437 UIntRect m_partRect;
438 UIntRect m_middleRect;
439 String m_id;
440
441 CallbackFunc m_copyCallback;
442 CallbackFunc m_destructCallback;
443
444 static bool m_defaultSmooth;
445
446 static TextureLoaderFunc m_textureLoader;
447 static BackendTextureLoaderFunc m_backendTextureLoader;
448 };
449
451}
452
454
455#endif // TGUI_TEXTURE_HPP
Base class for texture implementations that depend on the backend.
Definition: BackendTexture.hpp:41
Wrapper for colors.
Definition: Color.hpp:63
static const Color White
White predefined color.
Definition: Color.hpp:254
Wrapper class to store strings.
Definition: String.hpp:79
Definition: Texture.hpp:49
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.
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.
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.
Texture(const sf::Texture &texture, const UIntRect &partRect=UIntRect(0, 0, 0, 0), const UIntRect &middlePart=UIntRect(0, 0, 0, 0))
Constructor that created the texture from an existing sf::Texture.
bool operator!=(const Texture &right) const
Compares the texture with another one.
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.
Texture()
Default constructor.
Definition: Texture.hpp:61
bool isSmooth() const
Tells whether the smooth filter is enabled or not.
void load(const sf::Texture &texture, const UIntRect &partRect={}, const UIntRect &middleRect={})
Creates the texture from an existing sf::Texture.
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.
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...
Namespace that contains all TGUI functions and classes.
Definition: AbsoluteOrRelativeValue.hpp:36