Image.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/Color.hpp>
#include <SFML/Graphics/Rect.hpp>
 
#include <SFML/System/Vector2.hpp>
 
#include <filesystem>
#include <optional>
#include <string_view>
#include <vector>
 
#include <cstddef>
#include <cstdint>
 
 
namespace sf
{
class InputStream;

class SFML_GRAPHICS_API Image
{
public:
    Image() = default;

    explicit Image(Vector2u size, Color color = Color::Black);

    Image(Vector2u size, const std::uint8_t* pixels);

    explicit Image(const std::filesystem::path& filename);

    Image(const void* data, std::size_t size);

    explicit Image(InputStream& stream);

    void resize(Vector2u size, Color color = Color::Black);

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

    [[nodiscard]] bool loadFromFile(const std::filesystem::path& filename);

    [[nodiscard]] bool loadFromMemory(const void* data, std::size_t size);

    [[nodiscard]] bool loadFromStream(InputStream& stream);

    [[nodiscard]] bool saveToFile(const std::filesystem::path& filename) const;

    [[nodiscard]] std::optional<std::vector<std::uint8_t>> saveToMemory(std::string_view format) const;

    [[nodiscard]] Vector2u getSize() const;

    void createMaskFromColor(Color color, std::uint8_t alpha = 0);

    [[nodiscard]] bool copy(const Image& source, Vector2u dest, const IntRect& sourceRect = {}, bool applyAlpha = false);

    void setPixel(Vector2u coords, Color color);

    [[nodiscard]] Color getPixel(Vector2u coords) const;

    [[nodiscard]] const std::uint8_t* getPixelsPtr() const;

    void flipHorizontally();

    void flipVertically();
 
private:
    // Member data
    Vector2u                  m_size;   
    std::vector<std::uint8_t> m_pixels; 
};
 
} // namespace sf