class DirectX11VertexBuffer in Tinman.AddOns.DirectX11

Implementation of the IVertexBuffer interface that uses a Direct3D 11 ID3D11Buffer COM object as D3D11_BIND_VERTEX_BUFFER.

sealed class

DirectX11VertexBuffer

extends

VertexBufferBase

Public / Attributes

CanLockBuffer

Can the content of this vertex buffer be updated?

public override 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	VertexBufferBase.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.
inherited	VertexBufferBase.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.
inherited	VertexBufferBase.MemoryConsumption

NativeHandle

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

public override property	NativeHandle { get }
type	IntPtr
value		The raw handle value.
implements	VertexBufferBase.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.
inherited	VertexBufferBase.VertexElements

Public / Constructors

DirectX11VertexBuffer

Creates a new instance of DirectX11VertexBuffer.

public constructor	DirectX11VertexBuffer (IntPtr context, VertexElements format, int32 capacity, ByteBuffer content = null)
params	context		The ID3D11DeviceContext* COM pointer.
	format	[not-null]	The vertex format.
	capacity	[>0]	The vertex buffer capacity, in vertices. Will be ignored if content is not null.
	content		The static vertex buffer content or null to create a dynamic vertex buffer. Defaults to null.

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 override 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	VertexBufferBase.LockBuffer

Exceptions:

• TinmanException:
  It CanLockBuffer returns false.

UnlockBuffer

Unlocks a previously locked buffer region.

public override method	UnlockBuffer ()
implements	VertexBufferBase.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.