class TextureAtlasOptions in Tinman.Terrain.Rendering

Provides options for creating instances of TextureAtlas.

sealed class

TextureAtlasOptions

implements

IMemoryConsumption

Public / Attributes

Factory

The texture factory to use.

public property	Factory { get set }
type	ITextureFactory
value		The texture factory or null.

Remarks:

If a texture factory has been specified, additional logic is applied:

• Format:
  The ValidateTextureFormat is used to validate the given texture format.
• TextureSize:
  TileSize:
  The ValidateTextureSize is used to validate the given size value.
• MemoryConsumption:
  A correct estimate is computed from AvailableVideoMemory, instead of returning 0.

Format

The texture format to use.

public property	Format { get set }
type	TextureFormat
value	[not-null]	The texture format.

Remarks:

Defaults to A8R8G8B8.

MemoryConsumption

Returns the estimated memory consumption of this object.

public property	MemoryConsumption { get }
type	int64
value	[>=0]	The estimated memory consumption, in bytes.
implements	IMemoryConsumption.MemoryConsumption

MemoryConsumptionMegabytes

Specifies the maximum video RAM consumption.

public property	MemoryConsumptionMegabytes { get set }
type	int32
value	[>=0]	The maximum video RAM usage, in megabytes. Set to 0 to disable the limit.

Remarks:

Defaults to 0 (i.e. no limit).

MemoryConsumptionPercent

Specifies the maximum video RAM consumption.

public property	MemoryConsumptionPercent { get set }
type	int32
value	[0..100]	The maximum video RAM usage, in percent of available video RAM (see AvailableVideoMemory). Set to 0 to disable the limit.

Remarks:

Defaults to 25%.

TextureSize

The maximum cache texture size.

public property	TextureSize { get set }
type	int32
value	[pow2]	The cache texture size.

Remarks:

Defaults to 4096.

TileCount

The minimum number of cached tiles.

public property	TileCount { get set }
type	int32
value	[>0]	The minimum number of cached tiles.

Remarks:

Defaults to 256.

See also:

IPyramidBase.TileSize

TileSize

The tile size.

public property	TileSize { get set }
type	int32
value	[pow2]	The tile size.

Remarks:

Defaults to 256.

See also:

IPyramidBase.TileSize

Public / Constructors

TextureAtlasOptions

Creates a new instance of TextureAtlasOptions.

public constructor	TextureAtlasOptions (ITextureFactory factory = null)
params	factory		The initial texture factory to use. Defaults to null.

---

Creates a new instance of TextureAtlasOptions.

public constructor	TextureAtlasOptions (TextureAtlasOptions other)
params	other	[not-null]	The options object to copy from.

Public / Methods

CreateTextureAtlas

Creates a new instance of TextureAtlas, using the current options.

[OwnerReturn]
public method	CreateTextureAtlas ([Owner] ITexelPyramid pyramid = null)
type	TextureAtlas
params	pyramid		The texel pyramid to allocate as ID 0. If null, no allocation will be performed. Defaults to null.
returns		[not-null]	The created TextureAtlas instance.

Remarks:

A texture factory must be specified prior to calling this method (see Factory).

Exceptions:

• TinmanException:
  If Factory is null.