class DirectX11IndexBuffer in Tinman.AddOns.DirectX11

Implementation of the IIndexBuffer interface that uses a Direct3D 11 ID3D11Buffer COM object as D3D11_BIND_INDEX_BUFFER.

sealed class

DirectX11IndexBuffer

extends

IndexBufferBase

Public / Attributes

CanSetIndices

Can the content of this index buffer be updated?

public override 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	IndexBufferBase.CanSetIndices

See also:

IIndexBuffer.SetIndices

Capacity

Returns the capacity of this object.

public property	Capacity { get }
type	int32
value	[>=0]	The capacity, in elements.
inherited	IndexBufferBase.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	IndexBufferBase.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	IndexBufferBase.NativeHandle

Remarks:

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

Public / Constructors

DirectX11IndexBuffer

Creates a new instance of DirectX11IndexBuffer.

public constructor	DirectX11IndexBuffer (IntPtr context, int32 capacity, [] int32[] content = null, int32 offset = 0)
params	context		The ID3D11DeviceContext* COM pointer.
	capacity	[>0]	The index buffer capacity, in indices.
	content		The static vertex buffer content or null to create a dynamic vertex buffer. Defaults to null.
	offset	[>=0]	Offset into content. Will be ignored if content is null. Defaults to 0.

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 override 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	IndexBufferBase.SetIndices

Exceptions:

• TinmanException:
  It CanSetIndices returns false.