Image.h

/*
 * Gamedev Framework (gf)
 * Copyright (C) 2016-2021 Julien Bernard
 *
 * 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.
 *
 * Part of this file comes from SFML, with the same license:
 * Copyright (C) 2007-2015 Laurent Gomila (laurent@sfml-dev.org)
 */
#ifndef GF_IMAGE_H
#define GF_IMAGE_H

#include <cstddef>
#include <cstdint>
#include <vector>

#include "CoreApi.h"
#include "Path.h"
#include "Span.h"
#include "Vector.h"
#include "Rect.h"

namespace gf {
#ifndef DOXYGEN_SHOULD_SKIP_THIS
inline namespace v1 {
#endif

  class InputStream;

  enum PixelFormat {
    Rgba32, 
    Rgb24,  
  };

  class GF_CORE_API Image {
  public:
    Image();

    Image(Vector2i size);

    Image(Vector2i size, Color4u color);

    Image(Vector2i size, Color3u color);

    Image(Vector2i size, const uint8_t *pixels, PixelFormat format = PixelFormat::Rgba32);

    Image(const Path& filename);

    Image(Span<const uint8_t> content);

    Image(InputStream& stream);

    Image(const Image&) = default;

    Image& operator=(const Image&) = default;

    Image(Image&&) = default;

    Image& operator=(Image&&) = default;

    bool saveToFile(const Path& filename) const;

    Image subImage(const RectI& area) const;

    Vector2i getSize() const;

    void createMaskFromColor(const Color4u& color, uint8_t alpha = 0);

    void setPixel(Vector2i pos, const Color4u& color);

    Color4u getPixel(Vector2i pos) const;

    const uint8_t* getPixelsPtr() const;

    void flipHorizontally();

  private:
    Vector2i m_size;
    std::vector<uint8_t> m_pixels;

  };

#ifndef DOXYGEN_SHOULD_SKIP_THIS
}
#endif
}

#endif // GF_IMAGE_H