interface ICanvasContent in Tinman.Terrain.Tools

Base interface for creating content for heightmap canvas blocks.

interface	ICanvasContent	extends	IDisposable
		base of	CanvasContent

Attributes

LifecycleState

Returns the lifecycle state of this object.

property	LifecycleState { get }
type	LifecycleState
value		The lifecycle state.
inherited	ILifecycleState.LifecycleState

Methods

AcquireTry

Acquires a strong reference to this disposable object.

[OwnerReturn, ThreadSafe]
method	AcquireTry ()
type	IDisposable
returns			this if a new strong reference has been acquired, null if this object is already being disposed.
inherited	IDisposable.AcquireTry

Remarks:

The object will not be actually disposed by calls to Dispose when there is at least one strong reference left. Code that calls the AcquireTry method is responsible for calling the Dispose method accordingly.

This method is not intended to be used in performance-critical code. It should only be used to high-level resource management.

Create

Creates content for a canvas block.

method	Create (int32 cacheIndex, ColorBuffer pixels)
params	cacheIndex	[>=0]	The cache index of the canvas block.
	pixels	[not-null]	The pixel contents. The given pixel buffer will have a width and height equal to BlockSize.

Delete

Deletes content for a canvas block.

method	Delete (int32 cacheIndex)
params	cacheIndex	[>=0]	The cache index of the canvas block.

Dispose

Releases all resources held by this object if there are no more strong references to it, decrements the reference counter by one otherwise.

[Dispose, OwnerThis, ThreadSafe]
method	Dispose ()
inherited	IDisposable.Dispose

Remarks:

The Dispose method silently returns if the object has already been disposed.

Reset

Resets the canvas content cache.

method	Reset (int32 cacheSize)
params	cacheSize	[>0]	The cache size, in blocks (see CacheSize).