class TerrainBufferOptions in Tinman.AddOns.Components

Helper class for creating instances of TerrainBuffer.

sealed class

TerrainBufferOptions

Public / Attributes

CacheOptions

Options for creating the texture tile cache.

public property	CacheOptions { get set }
type	PyramidFileCacheOptions
value		The pyramid file cache options or null to open the pyramid file cache in read-only mode (i.e. for sharing between processes resp. machines).

Remarks:

These options are ignored when CachePath is null. Defaults to a fresh instance of a PyramidFileCacheOptions.

CachePath

Path to the texture tile cache.

public property	CachePath { get set }
type	Path
value		The texture tile cache path or null.

Remarks:

Specify null to disable texture tile caching. The default value is null.

See also:

PyramidFileCache.Create

Flags

The terrain buffer flags.

public property	Flags { get set }
type	TerrainBufferFlags
value		The flags.

Remarks:

Defaults to None

HeightmapLayers

The heightmap layers that are going to be used by terrain meshes.

public property	HeightmapLayers { get set }
type	HeightmapLayer
value		The used heightmap layers.

Remarks:

The default value is All.

TextureAtlasOpaque

Options for creating the texture atlas for opaque imagery (i.e. 1-bit alpha or less).

public property	TextureAtlasOpaque { get }
type	TextureAtlasOptions
value	[not-null]	The texture atlas options.

TextureAtlasTransparent

Options for creating the texture atlas for transparent imagery (i.e. 2-bits alpha or more).

public property	TextureAtlasTransparent { get }
type	TextureAtlasOptions
value	[not-null]	The texture atlas options.

VertexCapacity

The capacity of the terrain mesh buffer.

public property	VertexCapacity { get set }
type	int32
value	[>0]	The vertex capacity.

Remarks:

The default value is 2097152.

Public / Constructors

TerrainBufferOptions

Creates a new instance of TerrainBufferOptions.

public constructor

TerrainBufferOptions ()

Public / Methods

CreateTerrainBuffer

Creates a new instance of TerrainBuffer, based on these options.

[OwnerReturn]
public method	CreateTerrainBuffer ()
type	TerrainBuffer
returns		[not-null]	The created TerrainBuffer instance.