TINMAN 3D / REALTIME TERRAIN
Software Development Kit - User Manual

class GdalImageFormat in Tinman.AddOns.GDAL

An image format implementation that uses the GDAL (http://www.gdal.org) and PROJ.4 (http://proj4.org) libraries.

sealed class GdalImageFormat extends ImageFormat

Public / Constants

Instance

Uses GDAL for reading image data and georeferences; uses Tinman 3D for coordinate projection.

public static readonly field Instance
type ImageFormat

InstanceProj

Uses GDAL for reading image data and georeferences; uses PROJ.4 for coordinate projection.

public static readonly field InstanceProj
type ImageFormat

Public / Attributes

Description

Long description of this file format.

public override property Description { get }
type string
value [not-null] The description string.
overrides FileFormat.Description

Name

The file format name.

public property Name { get }
type string
value [not-null] The file format name.
inherited FileFormat.Name

Next

Returns the next file format.

[ThreadSafe]
public property Next { get }
type IFileFormat
value The next file format or null.
inherited FileFormat.Next

Remarks:

The first file format can be obtained from implementing classes. This property can be used to cycle all available file formats of the same type.

Type

The type of this file format (e.g. images, shapes, 3D models).

public property Type { get }
type string
value [not-null] The human-readable type name.
inherited FileFormat.Type

Public / Methods

CanRead

Can this file format object be used to read the given path?

public override method CanRead (string suffix, bool directory = false)
type bool
params suffix [not-null] The lower-case pathname suffix (without '.'). Will be empty if the path does not have a pathname suffix.
  directory Does the path refer to a directory (true) or to a file (false)? Defaults to false.
returns true if this file format can be used, false if not.
overrides FileFormat.CanRead

CanReadFind

Returns the first file format in the chain (see IFileFormat) that can read the given path.

public method CanReadFind (string suffix, bool directory = false)
type IFileFormat
params suffix [not-null] The lower-case pathname suffix (without '.'). Will be empty if the path does not have a pathname suffix.
  directory Does the path refer to a directory (true) or to a file (false)? Defaults to false.
returns The found file format or null.
inherited FileFormat.CanReadFind

CanWrite

Can this file format object be used to write the given path?

public virtual method CanWrite (string suffix)
type bool
params suffix [not-null] The lower-case pathname suffix (without '.'). Will be empty if the path does not have a pathname suffix.
returns true if this file format can be used, false if not.
inherited FileFormat.CanWrite

PleaseIncludeInBinaryThanks

This is a no-op method that forces the compiler / linker to include this type in the resulting binary.

public virtual method PleaseIncludeInBinaryThanks ()
inherited FileFormat.PleaseIncludeInBinaryThanks

Remarks:

Calling this stub method makes sure that all lazy constructor calls have been made.

To initialize everything, an application needs to call this method on its root module(s) (see TinmanModule), followed by a call to PleaseIncludeInBinaryThanksAll.

ReadImage

Reads the given image.

[OwnerReturn]
public override method ReadImage (IFileData data, ReadImageFlags flags)
type IImageReader
params data [not-null] The image data provider.
  flags The image reading flags.
returns [not-null] The IImageReader for reading the image data.
implements ImageFormat.ReadImage

ReadTexture

Tries to read the given image data as a texture.

[OwnerReturn]
public virtual method ReadTexture (IFileData data, CubemapFace face)
type TexelBuffer
params data [not-null] The image data provider.
  face The cubemap face.
returns 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).
inherited ImageFormat.ReadTexture

ToString

[Pure]
public override method ToString ()
type string
inherited FileFormat.ToString

WriteImage

Writes an image to the given file.

[OwnerReturn]
public virtual method WriteImage (Path file)
type IImageWriter
params file [not-null] The output image file.
returns [not-null] The image writer object to use.
inherited ImageFormat.WriteImage

Exceptions: