unreal.ImageWriteOptions

class unreal.ImageWriteOptions(format: DesiredImageFormat = Ellipsis, on_complete: OnImageWriteComplete = Ellipsis, compression_quality: int = 0, overwrite_file: bool = False, async_: bool = False)

Bases: 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] Whether to perform the writing asynchronously, or to block the game thread until it is complete

  • compression_quality (int32): [Read-Write] 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] The desired output image format to write to disk

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

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

property async_: bool

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

Type:

(bool)

property compression_quality: int

[Read-Write] 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: DesiredImageFormat

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

Type:

(DesiredImageFormat)

property on_complete: OnImageWriteComplete

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

Type:

(OnImageWriteComplete)

property overwrite_file: bool

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

Type:

(bool)