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

class ModelTexture_Image in Tinman.AddOns.Models

sealed class ModelTexture_Image extends ModelTexture

Configuration

ToConfig

Returns the configuration value that describes this object.

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

CanPreloadResource

Does this resource handle support preloading?

public property CanPreloadResource { get }
type bool
value true if preloading is supported (i.e. PreloadResource will never return null),
false if preloading is not supported (i.e. PreloadResource always returns null).
inherited ModelTexture.CanPreloadResource

PreferredTextureFormat

The preferred format to use for this model texture.

public override property PreferredTextureFormat { get }
type TextureFormat
value The preferred texture format or null.
overrides ModelTexture.PreferredTextureFormat

Public / Methods

CreateResource

Creates a new resource object, using the given graphics context.

[OwnerReturn]
public virtual method CreateResource (Graphics graphics)
type IResource
params graphics [not-null] The graphics context to use.
returns The resource object or null.
inherited ModelTexture.CreateResource

Remarks:

Resource objects may implement the IMemoryConsumption interface. In this case, the reported memory consumption will be interpreted as an estimate on how much GPU memory is consumed by the resource. This estimate can then be used for resource caching (e.g. CacheMemory).

Equals

Compares this object with the given one.

[Pure]
public override method Equals (IResourceHandle other)
type bool
params other The object to compare to.
returns true if this object is equal to other, false if not.
overrides ModelTexture.Equals

GetHashCode

[Pure]
public override method GetHashCode ()
type int32
overrides ModelTexture.GetHashCode

PreloadResource

Preloads resource data, without creating the resource object.

[OwnerReturn, ThreadSafe]
public method PreloadResource ()
type IResourceData
returns The preloaded resource data or null if this resource handle does not support resp. require preloading.
inherited ModelTexture.PreloadResource

Remarks:

Calling CreateResource on the returned resource will perform no additional loading, which means that all necessary data is already present in memory.

ReadElevation

Reads elevation data.

public override method ReadElevation (PixelRange range)
type ElevationBuffer
params range The pixel range to use (see ScanlineRange).
returns [not-null] The elevation data.
overrides ModelTexture.ReadElevation

ReadPixels

Reads pixel data.

public override method ReadPixels ()
type ColorBuffer
returns The pixel data or null if not found.
implements ModelTexture.ReadPixels

ReadTexels

Reads texture data.

[OwnerReturn]
public override method ReadTexels ()
type TexelBuffer
returns The texture data or null if not found.
overrides ModelTexture.ReadTexels

ToString

[Pure]
public override method ToString ()
type string