documentation/3.0.1/Texture_8hpp_source

//

// SFML - Simple and Fast Multimedia Library

// Copyright (C) 2007-2025 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


CoordinateType.hpp

GlResource.hpp

Export.hpp

SFML_GRAPHICS_API
#define SFML_GRAPHICS_API
Definition Graphics/Export.hpp:42

Rect.hpp

Vector2.hpp

sf::GlResource::GlResource
GlResource()
Default constructor.

sf::Image
Class for loading, manipulating and saving images.
Definition Image.hpp:55

sf::InputStream
Abstract class for custom file input streams.
Definition InputStream.hpp:46

sf::Texture
Image living on the graphics card that can be used for drawing.
Definition Texture.hpp:56

sf::Texture::update
void update(const Image &image)
Update the texture from an image.

sf::Texture::getMaximumSize
static unsigned int getMaximumSize()
Get the maximum texture size allowed.

sf::Texture::setSmooth
void setSmooth(bool smooth)
Enable or disable the smooth filter.

sf::Texture::RenderTexture
friend class RenderTexture
Definition Texture.hpp:716

sf::Texture::bind
static void bind(const Texture *texture, CoordinateType coordinateType=CoordinateType::Normalized)
Bind a texture for rendering.

sf::Texture::Texture
Texture()
Default constructor.

sf::Texture::isSmooth
bool isSmooth() const
Tell whether the smooth filter is enabled or not.

sf::Texture::update
void update(const std::uint8_t *pixels, Vector2u size, Vector2u dest)
Update a part of the texture from an array of pixels.

sf::Texture::update
void update(const Texture &texture, Vector2u dest)
Update a part of this texture from another texture.

sf::Texture::Texture
Texture(const Texture &copy)
Copy constructor.

sf::Texture::operator=
Texture & operator=(const Texture &)
Copy assignment operator.

sf::Texture::getNativeHandle
unsigned int getNativeHandle() const
Get the underlying OpenGL handle of the texture.

sf::Texture::loadFromStream
bool loadFromStream(InputStream &stream, bool sRgb=false, const IntRect &area={})
Load the texture from a custom stream.

sf::Texture::generateMipmap
bool generateMipmap()
Generate a mipmap using the current texture data.

sf::Texture::copyToImage
Image copyToImage() const
Copy the texture pixels to an image.

sf::Texture::Texture
Texture(Texture &&) noexcept
Move constructor.

sf::Texture::~Texture
~Texture()
Destructor.

sf::Texture::loadFromFile
bool loadFromFile(const std::filesystem::path &filename, bool sRgb=false, const IntRect &area={})
Load the texture from a file on disk.

sf::Texture::isSrgb
bool isSrgb() const
Tell whether the texture source is converted from sRGB or not.

sf::Texture::getSize
Vector2u getSize() const
Return the size of the texture.

sf::Texture::swap
void swap(Texture &right) noexcept
Swap the contents of this texture with those of another.

sf::Texture::loadFromMemory
bool loadFromMemory(const void *data, std::size_t size, bool sRgb=false, const IntRect &area={})
Load the texture from a file in memory.

sf::Texture::RenderTarget
friend class RenderTarget
Definition Texture.hpp:717

sf::Texture::setRepeated
void setRepeated(bool repeated)
Enable or disable repeating.

sf::Texture::update
void update(const Window &window, Vector2u dest)
Update a part of the texture from the contents of a window.

sf::Texture::update
void update(const Image &image, Vector2u dest)
Update a part of the texture from an image.

sf::Texture::update
void update(const Window &window)
Update the texture from the contents of a window.

sf::Texture::update
void update(const std::uint8_t *pixels)
Update the whole texture from an array of pixels.

sf::Texture::Text
friend class Text
Definition Texture.hpp:715

sf::Texture::loadFromImage
bool loadFromImage(const Image &image, bool sRgb=false, const IntRect &area={})
Load the texture from an image.

sf::Texture::isRepeated
bool isRepeated() const
Tell whether the texture is repeated or not.

sf::Texture::update
void update(const Texture &texture)
Update a part of this texture from another texture.

sf::Texture::resize
bool resize(Vector2u size, bool sRgb=false)
Resize the texture.

sf::Window
Window that serves as a target for OpenGL rendering.
Definition Window/Window.hpp:56

sf::CoordinateType
CoordinateType
Types of texture coordinates that can be used for rendering.
Definition CoordinateType.hpp:38

sf::CoordinateType::Normalized
@ Normalized
Texture coordinates in range [0 .. 1].
Definition CoordinateType.hpp:39

sf
Definition AudioResource.hpp:36

sf::swap
void swap(Texture &left, Texture &right) noexcept
Swap the contents of one texture with those of another.

sf::Vector2u
Vector2< unsigned int > Vector2u
Definition Vector2.hpp:209

sf::IntRect
Rect< int > IntRect
Definition Rect.hpp:146