PatchMesh.LockIndexBuffer(LockFlags) Method (Microsoft.DirectX.Direct3D)

Locks the index buffer.

Definition

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

Parameters

flags Microsoft.DirectX.Direct3D.LockFlags
Zero or more LockFlags that describe the type of lock to perform. For this method, the valid flags are Discard, NoDirtyUpdate, NoSysLock, 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

The index buffer is usually locked, written to, and then unlocked for reading. Patch mesh index buffers are 16-bit buffers.

Exceptions

InvalidCallException

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

OutOfMemoryExceptionLeave Site

Microsoft Direct3D could not allocate sufficient memory to complete the call.

See Also