Texture.hpp

Go to the documentation of this file.

//
// SFML - Simple and Fast Multimedia Library
// Copyright (C) 2007-2024 Laurent Gomila (laurent@sfml-dev.org)
//
// This software is provided 'as-is', without any express or implied warranty.
// In no event will the authors be held liable for any damages arising from the use of this software.
//
// Permission is granted to anyone to use this software for any purpose,
// including commercial applications, and to alter it and redistribute it freely,
// subject to the following restrictions:
//
// 1. The origin of this software must not be misrepresented;
//    you must not claim that you wrote the original software.
//    If you use this software in a product, an acknowledgment
//    in the product documentation would be appreciated but is not required.
//
// 2. Altered source versions must be plainly marked as such,
//    and must not be misrepresented as being the original software.
//
// 3. This notice may not be removed or altered from any source distribution.
//
 
#pragma once

// Headers
#include <SFML/Graphics/Export.hpp>
 
#include <SFML/Graphics/CoordinateType.hpp>
#include <SFML/Graphics/Rect.hpp>
 
#include <SFML/Window/GlResource.hpp>
 
#include <SFML/System/Vector2.hpp>
 
#include <filesystem>
 
#include <cstddef>
#include <cstdint>
 
 
namespace sf
{
class InputStream;
class Window;
class Image;

class SFML_GRAPHICS_API Texture : GlResource
{
public:
    Texture();

    ~Texture();

    Texture(const Texture& copy);

    Texture& operator=(const Texture&);

    Texture(Texture&&) noexcept;

    Texture& operator=(Texture&&) noexcept;

    explicit Texture(const std::filesystem::path& filename, bool sRgb = false);

    Texture(const std::filesystem::path& filename, bool sRgb, const IntRect& area);

    Texture(const void* data, std::size_t size, bool sRgb = false);

    Texture(const void* data, std::size_t size, bool sRgb, const IntRect& area);

    explicit Texture(InputStream& stream, bool sRgb = false);

    Texture(InputStream& stream, bool sRgb, const IntRect& area);

    explicit Texture(const Image& image, bool sRgb = false);

    Texture(const Image& image, bool sRgb, const IntRect& area);

    explicit Texture(Vector2u size, bool sRgb = false);

    [[nodiscard]] bool resize(Vector2u size, bool sRgb = false);

    [[nodiscard]] bool loadFromFile(const std::filesystem::path& filename, bool sRgb = false, const IntRect& area = {});

    [[nodiscard]] bool loadFromMemory(const void* data, std::size_t size, bool sRgb = false, const IntRect& area = {});

    [[nodiscard]] bool loadFromStream(InputStream& stream, bool sRgb = false, const IntRect& area = {});

    [[nodiscard]] bool loadFromImage(const Image& image, bool sRgb = false, const IntRect& area = {});

    [[nodiscard]] Vector2u getSize() const;

    [[nodiscard]] Image copyToImage() const;

    void update(const std::uint8_t* pixels);

    void update(const std::uint8_t* pixels, Vector2u size, Vector2u dest);

    void update(const Texture& texture);

    void update(const Texture& texture, Vector2u dest);

    void update(const Image& image);

    void update(const Image& image, Vector2u dest);

    void update(const Window& window);

    void update(const Window& window, Vector2u dest);

    void setSmooth(bool smooth);

    [[nodiscard]] bool isSmooth() const;

    [[nodiscard]] bool isSrgb() const;

    void setRepeated(bool repeated);

    [[nodiscard]] bool isRepeated() const;

    [[nodiscard]] bool generateMipmap();

    void swap(Texture& right) noexcept;

    [[nodiscard]] unsigned int getNativeHandle() const;

    static void bind(const Texture* texture, CoordinateType coordinateType = CoordinateType::Normalized);

    [[nodiscard]] static unsigned int getMaximumSize();
 
private:
    friend class Text;
    friend class RenderTexture;
    friend class RenderTarget;

    [[nodiscard]] static unsigned int getValidSize(unsigned int size);

    void invalidateMipmap();

    // Member data
    Vector2u      m_size;            
    Vector2u      m_actualSize;      
    unsigned int  m_texture{};       
    bool          m_isSmooth{};      
    bool          m_sRgb{};          
    bool          m_isRepeated{};    
    mutable bool  m_pixelsFlipped{}; 
    bool          m_fboAttachment{}; 
    bool          m_hasMipmap{};     
    std::uint64_t m_cacheId;         
};

SFML_GRAPHICS_API void swap(Texture& left, Texture& right) noexcept;
 
} // namespace sf