ImageWriter

Description

abstract class Tinman.Terrain.Imaging.ImageWriter

Derived from

Disposable abstract
IImageWriter

Extended by

AsciiArtWriter sealed
AsciiWriter sealed

Abstract base class for IImageWriter implementations.

Public / Constructors

For

[OwnerReturn]
public static method For → (5)

file in : Path

[not-null]
The image file path.

imageFormat opt : ImageFormat = null

The image format to use or null for ImageFormat.Any.

srgb opt : int32 = 0

The sRGB behaviour, see IImageWriter.Srgb.

pixelFormatAnd opt : PixelFormat = PixelFormat.All

The pixel format mask, see IImageWriter.FormatAnd.

pixelFormatOr opt : PixelFormat = PixelFormat.Unknown

The pixel format mask, see IImageWriter.FormatOr.

returns → IImageWriter

The image writer.

Returns an image writer for the given file.

IOException

If this image format does not support writing (i.e. IFileFormat.CanWrite would return false).

Protected / Constructors

Image​Writer

protected constructor ImageWriter → ()

Creates a new instance of ImageWriter.

Protected / Methods

Compute​Pixel​Format

protected method ComputePixelFormat → (1)

input in : PixelFormat

The input pixel format.

returns → PixelFormat

The output pixel format hint.

Computes the output pixel format hint.

See also

IImageWriter.FormatAnd
IImageWriter.FormatOr

To​Config

protected method ToConfig → (1)

value in : ConfigValue

[not-null]
The config value to update.

Sets the common config fields.

ConfigException

If an unexpected error has occurred while building the config value.

Configuration

Config

public static attribute Config → (get)

value : IConfigurator<IImageWriter>

[not-null]
The configurator object.

The configurator object for this type.