You are here: Start » AVL.NET » AVL.SaveImageToTiff_Asynchronous
Saves an image to a TIFF file in the background thread.
Namespace: | AvlNet |
---|---|
Assembly: | AVL.NET.dll |
Syntax
C++
C#
public static void SaveImageToTiff_Asynchronous ( AvlNet.SaveImageState ioState, int inThreadQueueSize, AvlNet.Image inImage, string inFile, AvlNet.TiffImageCompressionScheme? inCompressionScheme, int? inJpegQuality, bool inIgnoreErrors )
Parameters
Name | Type | Range | Default | Description | |
---|---|---|---|---|---|
ioState | AvlNet.SaveImageState | State containing information about asynchronous execution. | |||
inThreadQueueSize | int | <1, INF> | 3 | Number of incoming frames that can be buffered before the thread is able to process them. Default value: 3. | |
inImage | AvlNet.Image | An image to be saved. | |||
inFile | string | Path to a file. | |||
inCompressionScheme | AvlNet.TiffImageCompressionScheme? | Compression scheme. Default value: atl::NIL. | |||
inJpegQuality | int? | <0, 100> | Quality (0-100) - used only for JPEG compression scheme. Default value: atl::NIL. | ||
inIgnoreErrors | bool | If false the error will be reported as soon as the filter instance is again executed. |
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
List of possible exceptions:
Error type | Description |
---|---|
DomainError | Compression is not supported for 32-bit pixel type. |
DomainError | inJpegQuality set in SaveImageToTiff_Asynchronous is valid only with inCompressionScheme set as JPEG. |
DomainError | Path name cannot be empty in SaveImageToTiff_Asynchronous. |