You are here: Start » Image IO » SaveImageToTiff_Asynchronous

SaveImageToTiff_Asynchronous

Saves an image to a TIFF file in the background thread.

Syntax

void fil::SaveImageToTiff_Asynchronous
(
	SaveImageState& ioState,
	const fil::Image& inImage,
	const ftl::File& inFile,
	ftl::Optional<fil::TiffImageCompressionScheme::Type> inCompressionScheme,
	ftl::Optional<int> inJpegQuality
)

Parameters

Name	Type	Range	Default	Description
ioState	SaveImageState&			Object used to maintain state of the function.
inImage	const Image&			An image to be saved
inFile	const File&			Path to a file
inCompressionScheme	Optional<TiffImageCompressionScheme::Type>		NIL	Compression scheme
inJpegQuality	Optional<int>	0 - 100	NIL	Quality (0-100) - used only for JPEG compression scheme

Requirements

For input inImage only pixel formats are supported: uint8, uint16, real, int32.

Read more about pixel formats in Image documentation.

Remarks

This filter is executed in the background thread. Execution errors may be reported with a delay or ignored. Stopping of the program may be delayed, because of waiting for background work to complete.

Errors