#include <BmpImageWrapper.h>

Inheritance diagram for FBmpImageWrapper:

Public Member Functions
	FBmpImageWrapper (bool bInHasHeader=true, bool bInHalfHeight=false)

bool	UncompressBMPData (const ERGBFormat InFormat, const int32 InBitDepth)

bool	LoadBMPHeader ()

bool	LoadBMPInfoHeader (int64 HeaderOffset)

virtual void	Compress (int32 Quality) override

virtual void	Uncompress (const ERGBFormat InFormat, int32 InBitDepth) override

virtual bool	SetCompressed (const void *InCompressedData, int64 InCompressedSize) override

virtual bool	CanSetRawFormat (const ERGBFormat InFormat, const int32 InBitDepth) const override

virtual ERawImageFormat::Type	GetSupportedRawFormat (const ERawImageFormat::Type InFormat) const override

Public Member Functions inherited from FImageWrapperBase
	FImageWrapperBase ()

const TArray64< uint8 > &	GetRawData () const

void	MoveRawData (TArray64< uint8 > &OutRawData)

virtual void	Reset ()

void	SetError (const TCHAR *ErrorMessage)

const FString &	GetLastError () const

virtual void	Uncompress (const ERGBFormat InFormat, int32 InBitDepth, FDecompressedImageOutput &OutDecompressedImage)

virtual TArray64< uint8 >	GetCompressed (int32 Quality=0) override

virtual int32	GetBitDepth () const override

virtual ERGBFormat	GetFormat () const override

virtual int64	GetHeight () const override

virtual bool	GetRaw (const ERGBFormat InFormat, int32 InBitDepth, TArray64< uint8 > &OutRawData) override

virtual bool	GetRaw (const ERGBFormat InFormat, int32 InBitDepth, FDecompressedImageOutput &OutDecompressedImage) override

virtual int64	GetWidth () const 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

Public Member Functions inherited from IImageWrapper
virtual TArray64< uint8 >	GetExportData (int32 Quality=0)

bool	GetRaw (TArray64< uint8 > &OutRawData)

bool	GetRaw (FDecompressedImageOutput &OutDecompressedImage)

bool	GetRawImage (FImage &OutImage)

bool	GetRawImage (FDecompressedImageOutput &OutDecompressedImage)

bool	GetRaw (const ERGBFormat InFormat, int32 InBitDepth, TArray< uint8 > &OutRawData)

bool	GetRaw (const ERGBFormat InFormat, int32 InBitDepth, TArrayView64< uint8 > OutRawData)

bool	GetSRGB () const

ERawImageFormat::Type	GetClosestRawImageFormat (bool *bIsExactMatch=nullptr) const

void	SetDebugImageName (const TCHAR *InDebugImageName)

virtual	~IImageWrapper ()

Additional Inherited Members
Public Types inherited from IImageWrapper
using	TStringMap = TMap< FString, FString >

Static Public Member Functions inherited from IImageWrapper
static IMAGEWRAPPER_API void	ConvertRawImageFormat (ERawImageFormat::Type RawFormat, ERGBFormat &OutFormat, int &OutBitDepth)

static IMAGEWRAPPER_API ERawImageFormat::Type	ConvertRGBFormat (ERGBFormat RGBFormat, int BitDepth, bool *bIsExactMatch=nullptr)

static IMAGEWRAPPER_API int64	GetRGBFormatBytesPerPel (ERGBFormat RGBFormat, int BitDepth)

Protected Member Functions inherited from FImageWrapperBase
int64	GetBytesPerPel () const

int64	GetBytesPerRow () const

bool	GetImageViewOfSetRawForCompress (FImageView &OutImage) const

Protected Attributes inherited from FImageWrapperBase
TArray64< uint8 >	RawData

TArray64< uint8 >	CompressedData

ERGBFormat	Format

int	BitDepth

int64	Width

int64	Height

FString	LastError

Protected Attributes inherited from IImageWrapper
const TCHAR *	DebugImageName = nullptr

Detailed Description

BMP implementation of the helper class

Constructor & Destructor Documentation

◆ FBmpImageWrapper()

FBmpImageWrapper::FBmpImageWrapper	(	bool	bInHasHeader = `true`,
		bool	bInHalfHeight = `false`
	)

Default Constructor.

BMP image wrapper class. This code was adapted from UTextureFactory::ImportTexture, but has not been throughly tested.

Member Function Documentation

◆ CanSetRawFormat()

bool FBmpImageWrapper::CanSetRawFormat	(	const ERGBFormat	InFormat,
		const int32	InBitDepth
	)		const

overridevirtual

CanSetRawFormat returns true if SetRaw will accept this format

Implements IImageWrapper.

◆ Compress()

void FBmpImageWrapper::Compress ( int32 Quality )

overridevirtual

Compresses the data.

Parameters

Quality The compression quality.

returns void. call SetError() in your implementation if you fail.

Implements FImageWrapperBase.

◆ GetSupportedRawFormat()

ERawImageFormat::Type FBmpImageWrapper::GetSupportedRawFormat ( const ERawImageFormat::Type InFormat ) const

overridevirtual

returns InFormat if supported, else maps to something supported the returned format will pass CanSetRawFormat()

Implements IImageWrapper.

◆ LoadBMPHeader()

bool FBmpImageWrapper::LoadBMPHeader ( )

Load the header information, returns true if successful.

Returns: true if successful

◆ LoadBMPInfoHeader()

bool FBmpImageWrapper::LoadBMPInfoHeader ( int64 HeaderOffset )

Load the sub-header information, returns true if successful.

Returns: true if successful

◆ SetCompressed()

bool FBmpImageWrapper::SetCompressed	(	const void *	InCompressedData,
		int64	InCompressedSize
	)

overridevirtual

Sets the compressed data. Can then call GetRaw().

Parameters

InCompressedData	The memory address of the start of the compressed data.
InCompressedSize	The size of the compressed data parsed.

Returns: true if data was the expected format.

after SetCompressed, image info queries like GetWidth and GetBitDepth are allowed call GetRaw to get the decoded bits decompression is not done until GetRaw

Reimplemented from FImageWrapperBase.

◆ Uncompress()

void FBmpImageWrapper::Uncompress	(	const ERGBFormat	InFormat,
		int32	InBitDepth
	)

overridevirtual

Function to uncompress our data

Parameters

InFormat	How we want to manipulate the RGB data
InBitDepth	The bit depth per-channel of the image.

returns void. call SetError() in your implementation if you fail.

Implements FImageWrapperBase.

◆ UncompressBMPData()

bool FBmpImageWrapper::UncompressBMPData	(	const ERGBFormat	InFormat,
		const int32	InBitDepth
	)

Helper function used to uncompress BMP data from a buffer

The documentation for this class was generated from the following files:

Engine/Source/Runtime/ImageWrapper/Private/Formats/BmpImageWrapper.h
Engine/Source/Runtime/ImageWrapper/Private/Formats/BmpImageWrapper.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FBmpImageWrapper()

Member Function Documentation

◆ CanSetRawFormat()

◆ Compress()

◆ GetSupportedRawFormat()

◆ LoadBMPHeader()

◆ LoadBMPInfoHeader()

◆ SetCompressed()

◆ Uncompress()

◆ UncompressBMPData()