ImageFormat

Description

[ShutdownSurvive]
abstract class Tinman.Terrain.Imaging.ImageFormat

Derived from: FileFormat ^abstract
Extended by: GdalImageFormat ^sealed

The supported image file formats.

Each built-in image file format has a short text block that indicates which features are supported:

Write supported: …
See IFileFormat.CanWrite and WriteImage.
IANA media type: …
See FileFormat.ForMime
File extensions: …
See IFileFormat.CanRead³
Prefix sequence: …
See IFileFormat.CanRead¹
Raw value range: …
See IImageInfo.Values

Public / Constants

Any

public static readonly attribute Any → (ImageFormat)

The file format is unknown and will be determined automatically.

Use IFileFormat.Next to walk through all registered formats.

BMP

public static readonly attribute BMP → (ImageFormat)

The BMP image file format.

Write supported: yes
IANA media type: image/bmp
File extensions: .bmp
Prefix sequence: yes
Raw value range: no

When writing *.bmp files, the following information will be lost:

IImageInfo.Coverage, will become PixelCoverage.PixelIsArea.
IImageInfo.Gamma, will become -2.2 (sRGB).
IGeorefInfo.Georef, will become null.
IImageInfo.Layer, will become HeightmapLayer.None.
IImageInfo.NoData, will become Maths.NanD.
PixelFormat.Grayscale, PixelFormat.SixteenBits, PixelFormat.Precision of IImageInfo.PixelFormat, will become PixelFormat.Truecolor / PixelFormat.Alpha.
IImageInfo.Range, will become PixelRange.DefaultUInt8.

DDS

public static readonly attribute DDS → (ImageFormat)

The DDS image file format.

Write supported: no
IANA media type: none
File extensions: .dds
Prefix sequence: yes
Raw value range: no

GIF

public static readonly attribute GIF → (ImageFormat)

The GIF image file format.

Write supported: no
IANA media type: image/gif
File extensions: .gif
Prefix sequence: yes
Raw value range: no

HDR

public static readonly attribute HDR → (ImageFormat)

The HDR image file format.

Write supported: no
IANA media type: image/vnd.radiance
File extensions: .hdr
Prefix sequence: yes
Raw value range: no

JPEG

public static readonly attribute JPEG → (ImageFormat)

The JPEG image file format.

Write supported: no
IANA media type: image/jpeg
File extensions: .jpeg .jpg
Prefix sequence: yes
Raw value range: no

PNG

public static readonly attribute PNG → (ImageFormat)

The PNG image file format.

Write supported: yes
IANA media type: image/png
File extensions: .png
Prefix sequence: yes
Raw value range: no

When writing *.png files, the following information will be lost:

IImageInfo.Coverage, will become PixelCoverage.PixelIsArea.
IImageInfo.Gamma, will become 0 (linear sRGB).
IGeorefInfo.Georef, will become null.
IImageInfo.Layer, will become HeightmapLayer.None.
IImageInfo.NoData, will become Maths.NanD.
PixelFormat.Precision of IImageInfo.PixelFormat will become PixelFormat.SixteenBits.
IImageInfo.Range, will become PixelRange.Identity.

PXB

public static readonly attribute PXB → (ImageFormat)

The PXB image file format ('PiXel Buffer', proprietary).

Write supported: yes
IANA media type: none
File extensions: .pxb
Prefix sequence: yes
Raw value range: no

When writing *.pxb files, the following information will be lost:

IImageInfo.Coverage, will become PixelCoverage.PixelIsArea.
IImageInfo.Gamma, will become 0 (linear sRGB).
IGeorefInfo.Georef, will become null.
IImageInfo.Layer, will become HeightmapLayer.None.
IImageInfo.NoData, will become Maths.NanD.
IImageInfo.Range, will become PixelRange.Identity.

See also: ColorBuffer

SimpleHttp

[ShutdownSurvive]
public static readonly attribute SimpleHttp → (ISimpleHttpImage)

A ISimpleHttpImage object that uses Any to decode image data.

The image format is determined from the binary file format prefix (see IFileFormat.CanRead¹), falling back to the content type (see FileFormat.ForMime), as returned by the web server.

TGA

public static readonly attribute TGA → (ImageFormat)

The TGA image file format.

Write supported: yes
IANA media type: none
File extensions: .tga
Prefix sequence: no
Raw value range: no

When writing *.bmp files, the following information will be lost:

IImageInfo.Coverage, will become PixelCoverage.PixelIsArea.
IImageInfo.Gamma, will become -2.2 (sRGB).
IGeorefInfo.Georef, will become null.
IImageInfo.Layer, will become HeightmapLayer.None.
IImageInfo.NoData, will become Maths.NanD.
PixelFormat.SixteenBits, PixelFormat.Precision of IImageInfo.PixelFormat, will become PixelFormat.Grayscale / PixelFormat.Truecolor / PixelFormat.Alpha.
IImageInfo.Range, will become PixelRange.DefaultUInt8.

TIFF

public static readonly attribute TIFF → (ImageFormat)

The TIFF image file format.

Write supported: no
IANA media type: image/tiff
File extensions: .tif .tiff
Prefix sequence: yes
Raw value range: yes

TIFF 6.0 Specifications
https://www.itu.int/itudoc/itu-t/com16/tiff-fx/docs/tiff6.html

BitsPerSample H.102
may be 8, 16, 32, or 64
must be the same for all samples
must not be 8 if SampleFormat is 3
Compression H.103
may be 1, 5, 8, or 32773
PhotometricInterpretation H.106
may be 0, 1, or 2
PlanarConfiguration H.11C
may be 1 or 2
Differencing Predictor H.13D
may be 1, 2 or 3
SampleFormat H.153
may be 1, 2, 3, or 4
must be the same for all samples

BigTIFF Extension
https://libtiff.gitlab.io/libtiff/specification/bigtiff.html
OGC GeoTIFF standard 1.1
https://docs.ogc.org/is/19-008r4/19-008r4.html
TIFFTAG_GDAL_METADATA
https://gdal.org/en/stable/drivers/raster/gtiff.html#metadata

SCALE, OFFSET
If defined, the scale and offset are applied to the values that are read from the image file, while PixelRange.DefaultFloat is used as the default pixel range.

TIFFTAG_GDAL_NODATA
https://gdal.org/en/stable/drivers/raster/gtiff.html#nodata-value

TXB

public static readonly attribute TXB → (ImageFormat)

The TXB image file format ('TeXel Buffer', proprietary).

Write supported: no
IANA media type: none
File extensions: .txb
Prefix sequence: yes
Raw value range: no

See also: TexelBuffer

Public / Constructors

Coalesce

[Pure]
public static method Coalesce → (1)

format ⁱⁿ : ImageFormat: The image format to return or null.
returns → ImageFormat: format ⁱⁿ if not null, otherwise Any.

Returns format ⁱⁿ if not null.

ForName

[Pure]
public static method ForName → (1)

name ⁱⁿ : string: [not-empty]
The file image format name.
returns → ImageFormat: The file image format or Any if not found.

Returns a file image format by its IFileFormat.Name.

Public / Methods

ReadImage

[OwnerReturn]
public method ReadImage → (2)

data ⁱⁿ : IFileData: [not-null]
The image data provider.
flags ⁱⁿ : ReadImageFlags: The image reading flags.
returns → IImageReader: The validated IImageReader for reading the image data (see IValidatable.Validate).

Reads the given image.

IOException: If an I/O error has occurred while opening the image data.

GeorefException: If the image contains unsupported geo-referencing metadata.

ValidatingException: If a validation error has occurred on data ⁱⁿ or the returned image reader.

ReadTexture

[OwnerReturn]
public virtual method ReadTexture → (2)

data ⁱⁿ : IFileData: [not-null]
The image data provider.
face ⁱⁿ : CubemapFace: The cubemap face.
returns → TexelBuffer: The read TexelBuffer or null if the given image data cannot be interpreted as a texture (pixels must be read separately and then encoded as texels).

Tries to read the given image data as a texture.

IOException: If an I/O error has occurred.

ValidatingException: If a validation error has occurred on data ⁱⁿ or the returned image reader.

WriteImage

[OwnerReturn]
public virtual method WriteImage → (1)

file ⁱⁿ : Path: [not-null]
The output image file.
returns → IImageWriter: The image writer object to use.

Writes an image to the given file.

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

See also: IImageOps.WriteImage

Protected / Constructors

ImageFormat

protected constructor ImageFormat → (4)

name ⁱⁿ : string: [not-empty]
Value for IFileFormat.Name
description ⁱⁿ : string: [not-empty]
Value for IFileFormat.Description
mime ⁱⁿ : string: Value for IFileFormat.Mime
isAny ^opt : bool = false: Is this an automatic file format?

Creates a new instance of ImageFormat.

Protected / Methods

CannotWrite

protected static method CannotWrite → (2)

source ⁱⁿ : string @ Tag: The error source tag.
file ⁱⁿ : Path: The output image file path.
returns → IOException: The ready-to-throw exception.

Returns an IOException for the case when an image format does not support writing.

DoReadImage

[OwnerReturn]
protected abstract method DoReadImage → (2)

data ⁱⁿ : IFileData: The image data provider: will never be null and IValidatable.Validate did not report any errors.
flags ⁱⁿ : ReadImageFlags: The image reading flags.
returns → IImageReader: The IImageReader for reading the image data. The IValidatable.Validate has not yet been called on it.

Reads the given image.

IOException: If an I/O error has occurred while opening the image.

GeorefException: If the image contains unsupported geo-referencing metadata.

ImageFormat

Description

Public / Constants

Any

BMP

DDS

GIF

HDR

JPEG

PNG

PXB

Simple­Http

TGA

TIFF

TXB

Public / Constructors

Coalesce

For­Name

Public / Methods

Read­Image

Read­Texture

Write­Image

Protected / Constructors

Image­Format

Protected / Methods

Cannot­Write

Do­Read­Image

SimpleHttp

ForName

ReadImage

ReadTexture

WriteImage

ImageFormat

CannotWrite

DoReadImage