FImageWriteTask

Windows
MacOS
Linux

Inheritance Hierarchy

IImageWriteTaskBase

FImageWriteTask

References

Module

ImageWriteQueue

Header

/Engine/Source/Runtime/ImageWriteQueue/Public/ImageWriteTask.h

Include

#include "ImageWriteTask.h"

Syntax

class FImageWriteTask : public IImageWriteTaskBase

Variables

Name Description

Public variable

bool

 

bOverwriteFile

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

Public variable

int32

 

CompressionQuality

A compression quality setting specific to the desired image format

Public variable

FString

 

Filename

The filename to write to

Public variable

EImageFormat

 

Format

The desired image format to write out

Public variable

TFunction< void...

 

OnCompleted

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

Public variable

TUniquePtr< FIm...

 

PixelData

The actual write operation.

Public variable

TArray< FPixelP...

 

PixelPreProcessors

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

Constructors

Name Description

Public function

FImageWriteTask()

Overridden from IImageWriteTaskBase

Name Description

Public function Virtual

void

 

OnAbandoned()

Public function Virtual

bool

 

RunTask()

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback