class ImageWriter in Tinman.Terrain.Imaging

abstract class	ImageWriter	extends	Disposable
		implements	IImageWriter

Configuration

Config

The configurator object for this type.

public static property	Config { get }
type	IConfigurator<IImageWriter>
value	[not-null]	The configurator object.

ToConfig

Returns the configuration value that describes this object.

public abstract method	ToConfig ()
type	ConfigValue
returns		[not-null]	The configuration value.
implements	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.

Public / Attributes

HasGeoref

Can this writer output geo-referencing information?

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

See also:

ReadImageFlags.Geo

LifecycleState

Returns the lifecycle state of this object.

public virtual property	LifecycleState { get }
type	LifecycleState
value		The lifecycle state.
inherited	Disposable.LifecycleState

Srgb

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

public property	Srgb { get set }
type	bool
value		true if the pixel channel values are compressed false if pixel channel values are linear.
implements	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

Public / Methods

AcquireTry

Acquires a strong reference to this disposable object.

[OwnerReturn, ThreadSafe]
public method	AcquireTry ()
type	IDisposable
returns			this if a new strong reference has been acquired, null if this object is already being disposed.
inherited	Disposable.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]
public method	Dispose ()
inherited	Disposable.Dispose

Remarks:

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

WriteImage

Writes the image data provided by the given image reader.

public abstract 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.
implements	IImageWriter.WriteImage

Remarks:

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

Protected / Constructors

ImageWriter

Creates a new instance of ImageWriter.

protected constructor

ImageWriter ()

Protected / Methods

DisposeManaged

Disposes the managed resources held by a concrete subclass. This method will be called at most once per subclass.

protected virtual method	DisposeManaged ()
inherited	Disposable.DisposeManaged

Remarks:

This method will only be called when a disposable object is explicitly destroyed by user code calling the Dispose method. It will not be called when the object is collected as garbage by the system.

Overriding methods must call the DisposeManaged method of their base class. The base call should be the last statement.

The DisposeManaged method is called before the DisposeUnmanaged method.

DisposeUnmanaged

Disposes the unmanaged resources held by a concrete subclass. This method will be called exactly once per subclass.

protected virtual method	DisposeUnmanaged ()
inherited	Disposable.DisposeUnmanaged

Remarks:

Overriding methods must call the DisposeUnmanaged method of their base class. The base call should be the last statement.

The DisposeUnmanaged method is called after the DisposeManaged method.