Files
UnrealEngineUWP/Engine/Source/Runtime/ImageWrapper/Private/ImageWrapperBase.h
Chris Gagnon 00f8b72a0b Merging //UE4/Dev-Main to Dev-Editor (//UE4/Dev-Editor)
#rb none

[CL 5602170 by Chris Gagnon in Dev-Editor branch]
2019-03-27 15:03:08 -04:00

132 lines
2.5 KiB
C++

// Copyright 1998-2019 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"
/**
* The abstract helper class for handling the different image formats
*/
class FImageWrapperBase
: public IImageWrapper
{
public:
/** Default Constructor. */
FImageWrapperBase();
public:
/**
* Gets the image's raw data.
*
* @return A read-only byte array containing the data.
*/
const TArray<uint8>& GetRawData() const
{
return RawData;
}
public:
/**
* Compresses the data.
*
* @param Quality The compression quality.
*/
virtual void Compress(int32 Quality) = 0;
/**
* Resets the local variables.
*/
virtual void Reset();
/**
* Sets last error message.
*
* @param ErrorMessage The error message to set.
*/
virtual void SetError(const TCHAR* ErrorMessage);
/**
* Function to uncompress our data
*
* @param InFormat How we want to manipulate the RGB data
*/
virtual void Uncompress(const ERGBFormat InFormat, int32 InBitDepth) = 0;
public:
//~ IImageWrapper interface
virtual const TArray<uint8>& GetCompressed(int32 Quality = 0) override;
virtual int32 GetBitDepth() const override
{
return BitDepth;
}
virtual ERGBFormat GetFormat() const override
{
return Format;
}
virtual int32 GetHeight() const override
{
return Height;
}
virtual bool GetRaw(const ERGBFormat InFormat, int32 InBitDepth, const TArray<uint8>*& OutRawData) override;
virtual int32 GetWidth() const override
{
return Width;
}
virtual int32 GetNumFrames() const override
{
return NumFrames;
}
virtual int32 GetFramerate() const override
{
return Framerate;
}
virtual bool SetCompressed(const void* InCompressedData, int32 InCompressedSize) override;
virtual bool SetRaw(const void* InRawData, int32 InRawSize, const int32 InWidth, const int32 InHeight, const ERGBFormat InFormat, const int32 InBitDepth) override;
virtual bool SetAnimationInfo(int32 InNumFrames, int32 InFramerate) override;
protected:
/** Arrays of compressed/raw data */
TArray<uint8> RawData;
TArray<uint8> CompressedData;
/** Format of the raw data */
ERGBFormat RawFormat;
int8 RawBitDepth;
/** Format of the image */
ERGBFormat Format;
/** Bit depth of the image */
int8 BitDepth;
/** Width/Height of the image data */
int32 Width;
int32 Height;
/** Animation information */
int32 NumFrames;
int32 Framerate;
/** Last Error Message. */
FString LastError;
};