class IndexBufferBase in Tinman.Terrain.Rendering

Abstract base class for IIndexBuffer implementations.

abstract class	IndexBufferBase	extends	Disposable
		implements	IIndexBuffer
		base of	DirectX11IndexBuffer
			DirectX9IndexBuffer

Public / Attributes

CanSetIndices

Can the content of this index buffer be updated?

public abstract property	CanSetIndices { get }
type	bool
value		true if this index buffer is dynamic and its content can be updated. false if this index buffer is static and its content cannot be updated.
implements	IIndexBuffer.CanSetIndices

See also:

IIndexBuffer.SetIndices

Capacity

Returns the capacity of this object.

public property	Capacity { get }
type	int32
value	[>=0]	The capacity, in elements.
implements	ICapacity.Capacity

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

NativeHandle

Returns the raw handle value of the native resource that is contained in this object.

public abstract property	NativeHandle { get }
type	IntPtr
value		The raw handle value.
implements	INativeHandle.NativeHandle

Remarks:

The documentation of the implementing class will contain information on how to interpret the raw handle value.

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.

SetIndices

Updates a range of indices in the buffer.

public abstract method	SetIndices (int32 bufferIndex, [] int32[] indices, int32 indicesOffset, int32 indicesCount, BufferUpdateFlag flag = BufferUpdateFlag.Discard)
params	bufferIndex	[>=0]	Index of the first index buffer element to update.
	indices	[not-null]	An array holding the updated indices.
	indicesOffset	[>=0]	Offset into indices to first index to read.
	indicesCount	[>=0]	Total number of indices to read from indices.
	flag		The update flag to apply. Defaults to Discard.
implements	IIndexBuffer.SetIndices

Exceptions:

• TinmanException:
  It CanSetIndices returns false.

Protected / Constructors

IndexBufferBase

Creates a new instance of IndexBufferBase.

protected constructor	IndexBufferBase (int32 capacity)
params	capacity	[>0]	The index buffer capacity, in indices.

Protected / Methods

DisposeManaged

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

protected virtual method	DisposeManaged ()
inherited	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.