OpenRCT2/src/openrct2/core/Imaging.h

#pragma region Copyright (c) 2014-2017 OpenRCT2 Developers
/*****************************************************************************
 * OpenRCT2, an open source clone of Roller Coaster Tycoon 2.
 *
 * OpenRCT2 is the work of many authors, a full list can be found in contributors.md
 * For more information, visit https://github.com/OpenRCT2/OpenRCT2
 *
 * OpenRCT2 is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * A full copy of the GNU General Public License can be found in licence.txt
 *****************************************************************************/
#pragma endregion

#pragma once

#include <functional>
#include <istream>
#include <memory>
#include <string_view>
#include <vector>
#include "../common.h"
#include "../drawing/Drawing.h"

struct rct_drawpixelinfo;
struct rct_palette;

struct PaletteBGRA
{
    uint8 Blue{};
    uint8 Green{};
    uint8 Red{};
    uint8 Alpha{};
};

enum class IMAGE_FORMAT
{
    UNKNOWN,
    AUTOMATIC,  // Automatically detect from file extension
    BITMAP,
    PNG,
    PNG_32,     // Force load to 32bpp buffer
};

struct Image
{
    // Meta
    uint32 Width{};
    uint32 Height{};
    uint32 Depth{};

    // Data
    std::vector<uint8> Pixels;
    std::unique_ptr<rct_palette> Palette;
    uint32 Stride{};
};

using ImageReaderFunc = std::function<Image(std::istream&, IMAGE_FORMAT)>;

namespace Imaging
{
    IMAGE_FORMAT GetImageFormatFromPath(const std::string_view& path);
    Image ReadFromFile(const std::string_view& path, IMAGE_FORMAT format = IMAGE_FORMAT::AUTOMATIC);
    Image ReadFromBuffer(const std::vector<uint8>& buffer, IMAGE_FORMAT format = IMAGE_FORMAT::AUTOMATIC);
    void WriteToFile(const std::string_view& path, const Image& image, IMAGE_FORMAT format = IMAGE_FORMAT::AUTOMATIC);

    void SetReader(IMAGE_FORMAT format, ImageReaderFunc impl);
}