class VertexBufferBase in Tinman.Terrain.Rendering

Abstract base class for IVertexBuffer implementations.

abstract class	VertexBufferBase	extends	Disposable
		implements	IVertexBuffer
		base of	DirectX11VertexBuffer
			DirectX9VertexBuffer

Public / Attributes

CanLockBuffer

Can the content of this vertex buffer be updated?

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

See also:

IVertexBuffer.LockBuffer
IVertexBuffer.UnlockBuffer

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.

VertexElements

Returns the vertex declaration elements.

public property	VertexElements { get }
type	VertexElements
value	[not-null]	The vertex declaration elements.
implements	IVertexElements.VertexElements

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.

LockBuffer

Locks a region of the buffer for writing.

public abstract method	LockBuffer (BufferUpdateFlag flag = BufferUpdateFlag.Discard)
type	ByteBuffer
params	flag		The update flag to apply. Defaults to Discard.
returns		[not-null]	The locked buffer region.
implements	IVertexBuffer.LockBuffer

Exceptions:

• TinmanException:
  It CanLockBuffer returns false.

UnlockBuffer

Unlocks a previously locked buffer region.

public abstract method	UnlockBuffer ()
implements	IVertexBuffer.UnlockBuffer

Remarks:

Calling UnlockBuffer on a vertex buffer that cannot be locked (i.e. CanLockBuffer returns false) or without a prior call to LockBuffer does not have any effect, the method just returns.

Protected / Constructors

VertexBufferBase

Creates a new instance of VertexBufferBase.

protected constructor	VertexBufferBase (int32 capacity, VertexElements elements)
params	capacity	[>0]	The vertex buffer capacity, in vertices.
	elements	[not-null]	The vertex format.

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.