UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | Public Attributes | List of all members
FMediaImagePixelData Struct Reference
+ Inheritance diagram for FMediaImagePixelData:

Public Member Functions

 FMediaImagePixelData (TSharedPtr< IMediaTextureSample, ESPMode::ThreadSafe > &InSample, const FIntPoint &InSize, EImagePixelType InPixelType, ERGBFormat InPixelLayout, uint8 InBitDepth, uint8 InNumChannels)
 
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

TSharedPtr< IMediaTextureSample, ESPMode::ThreadSafe > Sample
 

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

ImagePixelData for TextureSample. Can only be used when Stride == Dim.X*"Number of channels"

Constructor & Destructor Documentation

◆ FMediaImagePixelData()

FMediaImagePixelData::FMediaImagePixelData ( TSharedPtr< IMediaTextureSample, ESPMode::ThreadSafe > &  InSample,
const FIntPoint &  InSize,
EImagePixelType  InPixelType,
ERGBFormat  InPixelLayout,
uint8  InBitDepth,
uint8  InNumChannels 
)
inline

Member Function Documentation

◆ Copy()

virtual TUniquePtr< FImagePixelData > FMediaImagePixelData::Copy ( ) const
inlineoverridevirtual

Implements FImagePixelData.

◆ Move()

virtual TUniquePtr< FImagePixelData > FMediaImagePixelData::Move ( )
inlineoverridevirtual

Implements FImagePixelData.

◆ RetrieveData()

virtual void FMediaImagePixelData::RetrieveData ( const void *&  OutDataPtr,
int64 &  OutSizeBytes 
) const
inlineoverridevirtual

Retrieve the raw pixel data

Implements FImagePixelData.

Member Data Documentation

◆ Sample

TSharedPtr<IMediaTextureSample, ESPMode::ThreadSafe> FMediaImagePixelData::Sample
The documentation for this struct was generated from the following file: