interface IResource in Tinman.Terrain.Rendering

Base interface for classes that wrap GPU resources.

interface	IResource	extends	IDisposable
			IMemoryConsumption
		base of	Bitmap
			EnvironmentMapResource
			IGeometryBuffer
			IIndexBuffer
			IRenderTarget
			ITexture
			IVertexBuffer
			ModelGeometryBuffer
			PixelFont
			ScreenQuad
			ShadowMappingResource
			TerrainBufferResource
			VertexBufferCache

Remarks

The amount of memory reported by MemoryConsumption is interpreted as the estimated amount of GPU memory that is consumed by this resource.

Attributes

LifecycleState

Returns the lifecycle state of this object.

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

MemoryConsumption

Returns the estimated memory consumption of this object.

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

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.

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.