FImagePixelData | Unreal Engine 5.2 Documentation

Inheritance Hierarchy


Module	ImageWriteQueue
Header	/Engine/Source/Runtime/ImageWriteQueue/Public/ImagePixelData.h
Include	#include "ImagePixelData.h"

struct FImagePixelData

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

	Type	Name	Description
		~FImagePixelData ()

Type	Name	Description
TUniquePtr< FImagePixelData >	CopyImageData ()	Copy this whole image buffer. This can be very costly for large images.
uint8	GetBitDepth ()	Retrieve the number of bits per each channel of color in the data
FImageView	GetImageView ()	Get the pixel data as an FImage
uint8	GetNumChannels ()	Retrieve the number of channels in the data
T *	GetPayload ()	Return a pointer to the Payload stored in this data.
const T *	GetPayload ()	Return a const pointer to the Payload stored in this data.
ERGBFormat	GetPixelLayout ()	Retrieve the pixel layout of this data
bool	GetRawData ( const void*& OutRawData, int64& OutSizeBytes )	Get the data and its size only if it is well formed
int64	GetRawDataSizeInBytes ()	Get the size in bytes, regardless of if it is well formed.
FIntPoint	GetSize ()	Retrieve the size of this data
bool	GetSRGB ()
EImagePixelType	GetType ()	NOTE : before, U8 would be written to EXR linear now it will get gamma corrected if bSRGB (which is on by default) Retrieve the type of this data
bool	IsDataWellFormed ()	Check that this data is the size it should be
TUniquePtr< FImagePixelData >	MoveImageDataToNew ()	Move this whole image buffer to a new allocation.
void	SetPayload ( FImagePixelPayloadPtr NewPayload )	Sets the payload after construction.
void	SetSRGB ( bool InSRGB )