interface IImageWriter in Tinman.Terrain.Imaging

Base interface for classes that write image data.

interface	IImageWriter	extends	IConfigurable
			IDisposable
			ISrgb
		base of	ImageWriter

Attributes

HasGeoref

Can this writer output geo-referencing information?

property	HasGeoref { get }
type	bool
value		true if this writer can write geo-referencing information, false if not.

See also:

ReadImageFlags.Geo

LifecycleState

Returns the lifecycle state of this object.

property	LifecycleState { get }
type	LifecycleState
value		The lifecycle state.
inherited	ILifecycleState.LifecycleState

Srgb

Does this object store or process compressed sRGB pixel channel values?

property	Srgb { get set }
type	bool
value		true if the pixel channel values are compressed false if pixel channel values are linear.
inherited	ISrgb.Srgb

Remarks:

This flag is taken into account when pixels are encoded resp. decoded from resp. to a ColorBuffer, which always stores linear sRGB pixels: This object will only perform sRGB conversion if this flag is set to true.

The default value is true.

See also:

ColorF.ToSrgbF
ColorF.FromSrgbF

Methods

AcquireTry

Acquires a strong reference to this disposable object.

[OwnerReturn, ThreadSafe]
method	AcquireTry ()
type	IDisposable
returns			this if a new strong reference has been acquired, null if this object is already being disposed.
inherited	IDisposable.AcquireTry

Remarks:

The object will not be actually disposed by calls to Dispose when there is at least one strong reference left. Code that calls the AcquireTry method is responsible for calling the Dispose method accordingly.

This method is not intended to be used in performance-critical code. It should only be used to high-level resource management.

Dispose

Releases all resources held by this object if there are no more strong references to it, decrements the reference counter by one otherwise.

[Dispose, OwnerThis, ThreadSafe]
method	Dispose ()
inherited	IDisposable.Dispose

Remarks:

The Dispose method silently returns if the object has already been disposed.

ToConfig

Returns the configuration value that describes this object.

method	ToConfig ()
type	ConfigValue
returns		[not-null]	The configuration value.
inherited	IConfigurable.ToConfig

Remarks:

All configurable objects need to implement this interface. For simple types, it is preferable to delegate to ToValue.

The returned value may be of type Invalid, which means that this object in its current state cannot be described with the configuration API.

Before returning the resulting configuration value, Cache must be called on it, passing this IConfigurable object as parameter.

WriteImage

Writes the image data provided by the given image reader.

method	WriteImage ([Owner] IImageReader imageReader, IProgressMonitor progress = null)
params	imageReader	[not-null]	The image reader.
	progress		Optional progress monitor to use. A fixed number of progress ticks should be generated for each written image pixel. Defaults to null.

Remarks:

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