BaseMesh.LockIndexBuffer Method

Language:

Locks an index buffer and obtains the index buffer data.

Definition

Visual Basic Public Function LockIndexBuffer( _
    ByVal flags As LockFlags _
) As GraphicsStream

C# public GraphicsStream LockIndexBuffer(
    LockFlags flags
);

C++ public:
GraphicsStream^ LockIndexBuffer(
    LockFlags flags
);

JScript public function LockIndexBuffer(
    flags : LockFlags
) : GraphicsStream;

Visual Basic	Public Function LockIndexBuffer( _ ByVal flags As LockFlags _ ) As GraphicsStream
C#	public GraphicsStream LockIndexBuffer( LockFlags flags );
C++	public: GraphicsStream^ LockIndexBuffer( LockFlags flags );
JScript	public function LockIndexBuffer( flags : LockFlags ) : GraphicsStream;

Parameters

flags Microsoft.DirectX.Direct3D.LockFlags
Combination of zero or more LockFlags that describe the type of lock to perform. For this method, the valid flags are Discard, NoDirtyUpdate, NoSystemLock, and ReadOnly. For a description of the flags, see LockFlags.

Return Value

Microsoft.DirectX.GraphicsStream
A GraphicsStream object that represents the locked index buffer.

Remarks

When working with index buffers, multiple lock calls are allowed. However, the number of lock calls must match the number of unlock calls. Calls to Device.DrawPrimitives, for example, will not succeed with any outstanding lock count on any currently set index buffer.

Exceptions

InvalidCallException The method call is invalid. For example, a method's parameter might contain an invalid value.

Applies To

Mesh, ProgressiveMesh