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

struct Tinman.Image.Info

Short Name:
  • struct Image.Info
Fields:

Provides information about an image.

Fields

The following table lists all fields of this config type.

Field Type Constraint Default
required width number    

The image width, in pixels.

required height number    

The image height, in pixels.

optional coverage Coverage.Type  
PixelIsArea

The pixel coverage of the image.

optional pixelFormat PixelFormat[]  
[Truecolor, Alpha, SixteenBits]

The pixel format of the image.

optional nodata number  
nan

The raw pixel value that represents no-data / void pixels.

optional pixelRange PixelRange  
{{0, 0}, {0, 0}}

The pixel value range of the image.

optional gamma number  
1

Depending on the value V of this field, the following gamma correction is applied to the image pixels:

  • V > 0
    Given a normalized image pixel value N, the resulting linear pixel value L is computed as L = pow(N, V).

  • V = -2.2
    The normalized image pixel value is fed into the sRGB decompression function (which can be approximated with a power of 2.2) and the resulting value is used as the linear pixel value.

  • V = -0.45455
    The normalized image pixel value is fed into the sRGB compression function (which can be approximated with a power of 0.45455) and the resulting value value is used as the linear pixel value (which is not correct in a mathematical sense, but might be necessary in rare cases).

  • For all other values of V, the normalized and linear pixel values are treated as being equivalent.

optional layer Heightmap.Layer  
None

The target heightmap layer.

optional georef Tinman.Georef  
null

The georeferencing information that is attached to the image file.

optional fileFormat string  
'Any'

The image file format.

optional filePath path  
<?>

Path to the image file.

external groundSampleDistance number    

Estimated ground sample distance, in metres.

external optimalHeightmapSize Vec2[]    

Optimal heightmap cubesize for the image resolution.

Usages

The following table shows all usages of this config type.

Used By: