ImageWrapperBase.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreTypes.h"
#include "Containers/Array.h"
#include "Containers/EnumAsByte.h"
#include "Containers/UnrealString.h"
#include "IImageWrapper.h"
 
 
class FImageWrapperBase
    : public IImageWrapper
{
public:
 
    FImageWrapperBase();
 
public:
 
    const TArray64<uint8>& GetRawData() const
    {
        return RawData;
    }
 
    void MoveRawData(TArray64<uint8>& OutRawData)
    {
        OutRawData = MoveTemp(RawData);
    }
 
public:
 
    virtual void Compress(int32 Quality) = 0;
 
    virtual void Reset();
 
    void SetError(const TCHAR* ErrorMessage);
    
    const FString & GetLastError() const
    {
        return LastError;
    }
 
    virtual void Uncompress(const ERGBFormat InFormat, int32 InBitDepth) = 0;
 
    virtual void Uncompress(const ERGBFormat InFormat, int32 InBitDepth, FDecompressedImageOutput& OutDecompressedImage);
 
public:
 
    //~ IImageWrapper interface
 
    virtual TArray64<uint8> GetCompressed(int32 Quality = 0) override;
 
    virtual int32 GetBitDepth() const override
    {
        return BitDepth;
    }
 
    virtual ERGBFormat GetFormat() const override
    {
        return Format;
    }
 
    virtual int64 GetHeight() const override
    {
        return Height;
    }
 
    virtual bool GetRaw(const ERGBFormat InFormat, int32 InBitDepth, TArray64<uint8>& OutRawData) override;
 
    // Use this version when you expect more information such as mipmaps, etc. 
    virtual bool GetRaw(const ERGBFormat InFormat, int32 InBitDepth, FDecompressedImageOutput& OutDecompressedImage) override;
 
    virtual int64 GetWidth() const override
    {
        return Width;
    }
 
    virtual bool SetCompressed(const void* InCompressedData, int64 InCompressedSize) override;
    virtual bool SetRaw(const void* InRawData, int64 InRawSize, const int32 InWidth, const int32 InHeight, const ERGBFormat InFormat, const int32 InBitDepth, const int32 InBytesPerRow = 0) override;
 
    virtual bool SupportsMetadata() const override;
 
    virtual void AddMetadata(const FString& InKey, const FString& InValue) override;
 
    virtual void GetMetadata(TStringMap& OutMetadata) const override;
 
protected:
 
    int64 GetBytesPerPel() const { return GetRGBFormatBytesPerPel(Format,BitDepth); }
    int64 GetBytesPerRow() const { return Width * GetBytesPerPel(); }
 
    // For writers: after SetRaw(), call this to get an ImageView of the raw data that was set
    //  can return false if the SetRaw does not map to an image format
    //  pixels point at the RawData array
    bool GetImageViewOfSetRawForCompress(FImageView & OutImage) const;
 
    TArray64<uint8> RawData;
    TArray64<uint8> CompressedData;
 
    ERGBFormat Format;
    int BitDepth;
 
    int64 Width;
    int64 Height;
    
    FString LastError;
};