FImagePixelData Struct Reference

#include <ImagePixelData.h>

Inheritance diagram for FImagePixelData:

Public Member Functions
virtual	~FImagePixelData ()
EImagePixelType	GetType () const
FIntPoint	GetSize () const
ERGBFormat	GetPixelLayout () const
uint8	GetBitDepth () const
uint8	GetNumChannels () const
FImageView	GetImageView () const
void	SetAlphaOpaque ()
bool	IsDataWellFormed () const
bool	GetRawData (const void *&OutRawData, int64 &OutSizeBytes) const
int64	GetRawDataSizeInBytes () const
TUniquePtr< FImagePixelData >	CopyImageData () const
TUniquePtr< FImagePixelData >	MoveImageDataToNew ()
template<typename T >
T *	GetPayload ()
template<typename T >
const T *	GetPayload () const
void	SetPayload (FImagePixelPayloadPtr NewPayload)
bool	GetSRGB () const
void	SetSRGB (bool InSRGB)

Protected Member Functions
	FImagePixelData (const FIntPoint &InSize, EImagePixelType InPixelType, ERGBFormat InPixelLayout, uint8 InBitDepth, uint8 InNumChannels, FImagePixelPayloadPtr InPayload)

Constructor & Destructor Documentation

~FImagePixelData()

virtual FImagePixelData::~FImagePixelData ( )

inlinevirtual

FImagePixelData()

FImagePixelData::FImagePixelData ( const FIntPoint &  InSize, EImagePixelType  InPixelType, ERGBFormat  InPixelLayout, uint8  InBitDepth, uint8  InNumChannels, FImagePixelPayloadPtr  InPayload  )

inlineprotected

Member Function Documentation

CopyImageData()

TUniquePtr< FImagePixelData > FImagePixelData::CopyImageData ( ) const

inline

Copy this whole image buffer. This can be very costly for large images.

GetBitDepth()

uint8 FImagePixelData::GetBitDepth ( ) const

inline

Retrieve the number of bits per each channel of color in the data

GetImageView()

FImageView FImagePixelData::GetImageView ( ) const

inline

Get the pixel data as an FImage

GetNumChannels()

uint8 FImagePixelData::GetNumChannels ( ) const

inline

Retrieve the number of channels in the data

GetPayload() [1/2]

template<typename T >

T * FImagePixelData::GetPayload ( )

inline

Return a pointer to the Payload stored in this data.

GetPayload() [2/2]

template<typename T >

const T * FImagePixelData::GetPayload ( ) const

inline

Return a const pointer to the Payload stored in this data.

GetPixelLayout()

ERGBFormat FImagePixelData::GetPixelLayout ( ) const

inline

Retrieve the pixel layout of this data

GetRawData()

bool FImagePixelData::GetRawData ( const void *&  OutRawData, int64 &  OutSizeBytes  ) const

inline

Get the data and its size only if it is well formed

GetRawDataSizeInBytes()

int64 FImagePixelData::GetRawDataSizeInBytes ( ) const

inline

Get the size in bytes, regardless of if it is well formed.

GetSize()

FIntPoint FImagePixelData::GetSize ( ) const

inline

Retrieve the size of this data

GetSRGB()

bool FImagePixelData::GetSRGB ( ) const

inline

GetType()

EImagePixelType FImagePixelData::GetType ( ) const

inline

Retrieve the type of this data

IsDataWellFormed()

bool FImagePixelData::IsDataWellFormed ( ) const

inline

Check that this data is the size it should be

MoveImageDataToNew()

TUniquePtr< FImagePixelData > FImagePixelData::MoveImageDataToNew ( )

inline

Move this whole image buffer to a new allocation.

SetAlphaOpaque()

void FImagePixelData::SetAlphaOpaque ( )

inline

Change the alpha channel to opaque

SetPayload()

void FImagePixelData::SetPayload ( FImagePixelPayloadPtr  NewPayload )

inline

Sets the payload after construction.

SetSRGB()

void FImagePixelData::SetSRGB ( bool  InSRGB )

inline

---

The documentation for this struct was generated from the following file:

• Engine/Source/Runtime/ImageWriteQueue/Public/ImagePixelData.h