UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | Public Attributes | List of all members
TImagePixelData< PixelType > Struct Template Reference

#include <ImagePixelData.h>

+ Inheritance diagram for TImagePixelData< PixelType >:

Public Member Functions

 TImagePixelData (const FIntPoint &InSize)
 
 TImagePixelData (const FIntPoint &InSize, TArray64< PixelType > &&InPixels)
 
 TImagePixelData (const FIntPoint &InSize, FImagePixelPayloadPtr InPayload)
 
 TImagePixelData (const FIntPoint &InSize, TArray64< PixelType > &&InPixels, FImagePixelPayloadPtr InPayload)
 
virtual TUniquePtr< FImagePixelData > Move () override
 
virtual TUniquePtr< FImagePixelData > Copy () const override
 
virtual void RetrieveData (const void *&OutDataPtr, int64 &OutSizeBytes) const override
 
- Public Member Functions inherited from FImagePixelData
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)
 

Public Attributes

TArray64< PixelType > Pixels
 

Additional Inherited Members

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

Detailed Description

template<typename PixelType>
struct TImagePixelData< PixelType >

Templated pixel data - currently supports FColor, FFloat16Color and FLinearColor

Constructor & Destructor Documentation

◆ TImagePixelData() [1/4]

template<typename PixelType >
TImagePixelData< PixelType >::TImagePixelData ( const FIntPoint &  InSize)
inline

◆ TImagePixelData() [2/4]

template<typename PixelType >
TImagePixelData< PixelType >::TImagePixelData ( const FIntPoint &  InSize,
TArray64< PixelType > &&  InPixels 
)
inline

◆ TImagePixelData() [3/4]

template<typename PixelType >
TImagePixelData< PixelType >::TImagePixelData ( const FIntPoint &  InSize,
FImagePixelPayloadPtr  InPayload 
)
inline

◆ TImagePixelData() [4/4]

template<typename PixelType >
TImagePixelData< PixelType >::TImagePixelData ( const FIntPoint &  InSize,
TArray64< PixelType > &&  InPixels,
FImagePixelPayloadPtr  InPayload 
)
inline

Member Function Documentation

◆ Copy()

template<typename PixelType >
virtual TUniquePtr< FImagePixelData > TImagePixelData< PixelType >::Copy ( ) const
inlineoverridevirtual

Implements FImagePixelData.

◆ Move()

template<typename PixelType >
virtual TUniquePtr< FImagePixelData > TImagePixelData< PixelType >::Move ( )
inlineoverridevirtual

Implements FImagePixelData.

◆ RetrieveData()

template<typename PixelType >
virtual void TImagePixelData< PixelType >::RetrieveData ( const void *&  OutDataPtr,
int64 &  OutSizeBytes 
) const
inlineoverridevirtual

Retrieve the raw pixel data

Implements FImagePixelData.

Member Data Documentation

◆ Pixels

template<typename PixelType >
TArray64<PixelType> TImagePixelData< PixelType >::Pixels
The documentation for this struct was generated from the following file: