UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FImageWriteTask Class Reference

#include <ImageWriteTask.h>

+ Inheritance diagram for FImageWriteTask:

Public Member Functions

 FImageWriteTask ()
 
virtual IMAGEWRITEQUEUE_API bool RunTask () override final
 
virtual IMAGEWRITEQUEUE_API void OnAbandoned () override final
 
IMAGEWRITEQUEUE_API void AddPreProcessorToSetAlphaOpaque ()
 
- Public Member Functions inherited from IImageWriteTaskBase
virtual ~IImageWriteTaskBase ()
 

Public Attributes

FString Filename
 
EImageFormat Format
 
int32 CompressionQuality
 
bool bOverwriteFile
 
TFunction< void(bool)> OnCompleted
 
TUniquePtr< FImagePixelDataPixelData
 
TArray< FPixelPreProcessorPixelPreProcessors
 

Constructor & Destructor Documentation

◆ FImageWriteTask()

FImageWriteTask::FImageWriteTask ( )
inline

Member Function Documentation

◆ AddPreProcessorToSetAlphaOpaque()

void FImageWriteTask::AddPreProcessorToSetAlphaOpaque ( )

◆ OnAbandoned()

void FImageWriteTask::OnAbandoned ( )
finaloverridevirtual

Implements IImageWriteTaskBase.

◆ RunTask()

bool FImageWriteTask::RunTask ( )
finaloverridevirtual

Implements IImageWriteTaskBase.

Member Data Documentation

◆ bOverwriteFile

bool FImageWriteTask::bOverwriteFile

True if this task is allowed to overwrite an existing file, false otherwise.

◆ CompressionQuality

int32 FImageWriteTask::CompressionQuality

A compression quality setting specific to the desired image format

◆ Filename

FString FImageWriteTask::Filename

The filename to write to

◆ Format

EImageFormat FImageWriteTask::Format

The desired image format to write out

◆ OnCompleted

TFunction<void(bool)> FImageWriteTask::OnCompleted

A function to invoke on the game thread when the task has completed

◆ PixelData

TUniquePtr<FImagePixelData> FImageWriteTask::PixelData

The actual write operation.

◆ PixelPreProcessors

TArray<FPixelPreProcessor> FImageWriteTask::PixelPreProcessors

Array of preprocessors to apply serially to the pixel data when this task is executed.


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