Image.hpp

Go to the documentation of this file.

/**********************************************************************************/
/* This file is part of Berserk Engine project                                    */
/* https://github.com/EgorOrachyov/Berserk                                        */
/**********************************************************************************/
/* MIT License                                                                    */
/*                                                                                */
/* Copyright (c) 2018 - 2021 Egor Orachyov                                        */
/*                                                                                */
/* Permission is hereby granted, free of charge, to any person obtaining a copy   */
/* of this software and associated documentation files (the "Software"), to deal  */
/* in the Software without restriction, including without limitation the rights   */
/* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell      */
/* copies of the Software, and to permit persons to whom the Software is          */
/* furnished to do so, subject to the following conditions:                       */
/*                                                                                */
/* The above copyright notice and this permission notice shall be included in all */
/* copies or substantial portions of the Software.                                */
/*                                                                                */
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR     */
/* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,       */
/* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE    */
/* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER         */
/* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,  */
/* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE  */
/* SOFTWARE.                                                                      */
/**********************************************************************************/
 
#ifndef BERSERK_IMAGE_HPP
#define BERSERK_IMAGE_HPP
 
#include <core/Config.hpp>
#include <core/Data.hpp>
#include <core/Typedefs.hpp>
#include <core/string/String.hpp>
#include <rhi/RHIDefs.hpp>
 
BRK_NS_BEGIN
 
class Image {
public:
    using Format = RHITextureFormat;
 
    enum class FileFormat {
        Png,
        Jpg,
        Bmp
    };
 
    BRK_API Image() = default;
    BRK_API Image(uint32 width, uint32 height, Format format);
    BRK_API Image(uint32 width, uint32 height, uint32 stride, uint32 pixelSize, Format format, Ref<Data> pixelData);
    BRK_API Image(const Image &) = default;
    BRK_API Image(Image &&) noexcept = default;
    BRK_API ~Image() = default;
 
    BRK_API Image &operator=(const Image &) = default;
    BRK_API Image &operator=(Image &&) noexcept = default;
 
    BRK_API Image Resize(uint32 newWidth, uint32 newHeight) const;
 
    BRK_API bool Empty() const { return mWidth * mHeight == 0; }
 
    BRK_API uint32 GetWidth() const { return mWidth; }
    BRK_API uint32 GetHeight() const { return mHeight; }
    BRK_API uint32 GetStride() const { return mStride; }
    BRK_API uint32 GetPixelSize() const { return mPixelSize; }
    BRK_API uint32 GetSizeBytes() const { return mStride * mHeight; }
    BRK_API Format GetFormat() const { return mFormat; }
    BRK_API const Ref<Data> &GetPixelData() const { return mPixelData; }
 
    BRK_API bool SaveRgba(const String &filepath, FileFormat fileFormat, int quality = 100) const;
 
    BRK_API static Image LoadRgba(const String &path, uint32 channels = 4);
 
private:
    uint32 mWidth = 0;
    uint32 mHeight = 0;
    uint32 mStride = 0;
    uint32 mPixelSize = 0;
    Format mFormat = Format::Unknown;
    Ref<Data> mPixelData;
};
 
BRK_NS_END
 
#endif//BERSERK_IMAGE_HPP