class CanvasContent in Tinman.Terrain.Tools

Default implementation of the ICanvasContent interface that stores the pixels of each canvas block as ColorBuffer objects.

sealed class	CanvasContent	extends	Disposable
		implements	ICanvasContent

Public / Attributes

LifecycleState

Returns the lifecycle state of this object.

public virtual property	LifecycleState { get }
type	LifecycleState
value		The lifecycle state.
inherited	Disposable.LifecycleState

Public / Methods

AcquireTry

Acquires a strong reference to this disposable object.

[OwnerReturn, ThreadSafe]
public method	AcquireTry ()
type	IDisposable
returns			this if a new strong reference has been acquired, null if this object is already being disposed.
inherited	Disposable.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.

public 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.
implements	ICanvasContent.Create

Delete

Deletes content for a canvas block.

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

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]
public method	Dispose ()
inherited	Disposable.Dispose

Remarks:

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

Get

Returns a canvas content block.

public method	Get (int32 cacheIndex)
type	ColorBuffer
params	cacheIndex	[>=0]	The cache index of the canvas block.
returns			The canvas block content or null.

Reset

Resets the canvas content cache.

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