interface IVertexBuffer in Tinman.Terrain.Rendering

A binary vertex buffer, typically stored in high-performance GPU memory.

interface	IVertexBuffer	extends	ICapacity
			INativeHandle
			IResource
			IVertexElements
		base of	VertexBufferBase

Remarks

Vertex data is written in binary form, usually formatted using an IVertexFormat object.

Attributes

CanLockBuffer

Can the content of this vertex buffer be updated?

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.

See also:

LockBuffer
UnlockBuffer

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.

VertexElements

Returns the vertex declaration elements.

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

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.

LockBuffer

Locks a region of the buffer for writing.

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.

Exceptions:

• TinmanException:
  It CanLockBuffer returns false.

UnlockBuffer

Unlocks a previously locked buffer region.

method

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.