class GeometryBuffer in Tinman.AddOns.Rendering

Abstract base class for IGeometryBuffer implementations.

abstract class	GeometryBuffer	extends	Disposable
		implements	IGeometryBuffer

Public / Attributes

Indices

The index buffer (optional).

public property	Indices { get }
type	IIndexBuffer
value		The index buffer or null if the geometry is not indexed.
implements	IGeometryBuffer.Indices

Instances

The instance buffer (optional).

public property	Instances { get }
type	IVertexBuffer
value		The instance buffer or null if the geometry is not instanced.
implements	IGeometryBuffer.Instances

LifecycleState

Returns the lifecycle state of this object.

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

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

Vertices

The vertex buffer (required).

public property	Vertices { get }
type	IVertexBuffer
value	[not-null]	The vertex buffer.
implements	IGeometryBuffer.Vertices

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.

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.

Protected / Attributes

indices

The index buffer.

[Owner]
protected field	indices
type	IIndexBuffer

instances

The instance buffer.

[Owner]
protected field	instances
type	IVertexBuffer

vertices

The vertex buffer.

[Owner]
protected field	vertices
type	IVertexBuffer

Protected / Constructors

GeometryBuffer

Creates a new instance of GeometryBuffer.

protected constructor	GeometryBuffer ([Owner] IIndexBuffer indices, [Owner] IVertexBuffer instances, [Owner] IVertexBuffer vertices)
params	indices		The index buffer or null.
	instances		The instance buffer or null.
	vertices	[not-null]	The vertex buffer.

Protected / Methods

DisposeManaged

Disposes the managed resources held by a concrete subclass. This method will be called at most once per subclass.

protected override method	DisposeManaged ()
overrides	Disposable.DisposeManaged

Remarks:

This method will only be called when a disposable object is explicitly destroyed by user code calling the Dispose method. It will not be called when the object is collected as garbage by the system.

Overriding methods must call the DisposeManaged method of their base class. The base call should be the last statement.

The DisposeManaged method is called before the DisposeUnmanaged method.

DisposeUnmanaged

Disposes the unmanaged resources held by a concrete subclass. This method will be called exactly once per subclass.

protected virtual method	DisposeUnmanaged ()
inherited	Disposable.DisposeUnmanaged

Remarks:

Overriding methods must call the DisposeUnmanaged method of their base class. The base call should be the last statement.

The DisposeUnmanaged method is called after the DisposeManaged method.