interface IIndexBuffer in Tinman.Terrain.Rendering

Base interface for classes that represent index buffers for rendering geometry.

interface	IIndexBuffer	extends	ICapacity
			INativeHandle
			IResource
		base of	IndexBufferBase

Remarks

An IIndexBuffer object always stores 32-bit indices.

Attributes

Capacity

Returns the capacity of this object.

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

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

NativeHandle

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

property	NativeHandle { get }
type	IntPtr
value		The raw handle value.
inherited	INativeHandle.NativeHandle

Remarks:

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

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.

CanSetIndices

Can the content of this index buffer be updated?

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.

See also:

SetIndices

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.

SetIndices

Updates a range of indices in the buffer.

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.

Exceptions:

• TinmanException:
  It CanSetIndices returns false.