unreal.ImageWriteOptions

class unreal.ImageWriteOptions(format=DesiredImageFormat.EXR, on_complete=<unreal.OnImageWriteComplete object>, compression_quality=0, overwrite_file=True, async_=True)

Bases: unreal.StructBase

Options specific to writing image files to disk

C++ Source:

  • Module: ImageWriteQueue

  • File: ImageWriteBlueprintLibrary.h

Editor Properties: (see get_editor_property/set_editor_property)

  • async_ (bool): [Read-Write] Async: Whether to perform the writing asynchronously, or to block the game thread until it is complete

  • compression_quality (int32): [Read-Write] Compression Quality: An image format specific compression setting. Either 0 (Default) or 1 (Uncompressed) for EXRs, or a value between 0 and 100.

  • format (DesiredImageFormat): [Read-Write] Format: The desired output image format to write to disk

  • on_complete (OnImageWriteComplete): [Read-Write] On Complete: A callback to invoke when the image has been written, or there was an error

  • overwrite_file (bool): [Read-Write] Overwrite File: Whether to overwrite the image if it already exists

property async_

[Read-Write] Async: Whether to perform the writing asynchronously, or to block the game thread until it is complete

Type

(bool)

property compression_quality

[Read-Write] Compression Quality: An image format specific compression setting. Either 0 (Default) or 1 (Uncompressed) for EXRs, or a value between 0 and 100.

Type

(int32)

property format

[Read-Write] Format: The desired output image format to write to disk

Type

(DesiredImageFormat)

property on_complete

[Read-Write] On Complete: A callback to invoke when the image has been written, or there was an error

Type

(OnImageWriteComplete)

property overwrite_file

[Read-Write] Overwrite File: Whether to overwrite the image if it already exists

Type

(bool)