SaveImage_Asynchronous


Saves an image to a file in the background thread.

Syntax

C++
Python
 
def SaveImage_Asynchronous(
	state: SaveImageState,
	inImage: Image,
	inFile: str,
	/,
	*,
	inThreadQueueSize: int = 3,
	inImageFileFormat: ImageFileFormat | None = None,
	inIgnoreErrors: bool = False
)
-> None

Parameters

Name Type Range Default Description
Input will be modified ioState SaveImageState State containing information about asynchronous execution
Input value inThreadQueueSize int 1 - 3 Number of incoming frames that can be buffered before the thread is able to process them
Input value inImage Image An image to be saved
Input value inImageFileFormat ImageFileFormat | None None If Nil the format will be chosen on the basis of extension
Input value inFile str Path to a file
Input value inIgnoreErrors bool False If false the error will be reported as soon as the filter instance is again executed