IImageWriter

Description

interface Tinman.Terrain.Imaging.IImageWriter

Derived from

IDisposable
IConfigurable

Extended by

ImageWriter abstract

Base interface for classes that write image data.

The following default image writer properties exist:

  • HasGeoref:
    Indicates whether geo-referencing information can be written or not.

  • ISrgb.Srgb:
    Controls sRGB compression when writing color channel values.

Implementing classes may provide additional properties to control how image data is written.

Public / Methods

Write​Image

public method WriteImage → (2)

imageReader in : IImageReader own

[not-null]
The image reader.

progress opt : IProgressMonitor = null

Optional progress monitor to use. A fixed number of progress ticks should be generated for each written image pixel.

Writes the image data provided by the given image reader.

IOException

If an I/O error has occurred while writing the image file.

Public / Attributes

Has​Georef

public attribute HasGeoref → (get)

value : bool

true if this writer can write geo-referencing information, false if not.

Can this writer output geo-referencing information?

If a writer cannot output geo-referencing information, it is good practice to omit ReadImageFlags.Geo when reading the input image data.

See also

ReadImageFlags.Geo

Srgb

public attribute Srgb → (get,set)

value : int32

< 0 : force image writer to output linear sRGB color channel values,
> 0 : force image writer to output compressed sRGB color channel values,
= 0 : let image write choose according to its file format specifications.

Controls how to apply sRGB compression when writing image data.

Defaults to 0.