UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FImageWriteOptions Struct Reference

#include <ImageWriteBlueprintLibrary.h>

Public Member Functions

 FImageWriteOptions ()
 

Public Attributes

EDesiredImageFormat Format
 
FOnImageWriteComplete OnComplete
 
int32 CompressionQuality
 
bool bOverwriteFile
 
bool bAsync
 
TFunction< void(bool)> NativeOnComplete
 

Detailed Description

Options specific to writing image files to disk

Constructor & Destructor Documentation

◆ FImageWriteOptions()

FImageWriteOptions::FImageWriteOptions ( )
inline

Member Data Documentation

◆ bAsync

bool FImageWriteOptions::bAsync

Whether to perform the writing asynchronously, or to block the game thread until it is complete

◆ bOverwriteFile

bool FImageWriteOptions::bOverwriteFile

Whether to overwrite the image if it already exists

◆ CompressionQuality

int32 FImageWriteOptions::CompressionQuality

An image format specific compression setting. Either 0 (Default) or 1 (Uncompressed) for EXRs, or a value between 0 and 100.

◆ Format

EDesiredImageFormat FImageWriteOptions::Format

The desired output image format to write to disk

◆ NativeOnComplete

TFunction<void(bool)> FImageWriteOptions::NativeOnComplete

A native completion callback that will be called in addition to the dynamic one above.

◆ OnComplete

FOnImageWriteComplete FImageWriteOptions::OnComplete

A callback to invoke when the image has been written, or there was an error


The documentation for this struct was generated from the following file: