Microsoft DirectX 9.0 SDK Update (October 2004)

PatchMesh.LockIndexBuffer Method

Language:

Note: This documentation is preliminary and is subject to change.

Locks the index buffer.

Definition

Visual Basic .NET Public Function LockIndexBuffer( _
    ByVal typeIndex As Type, _
    ByVal flags As LockFlags, _
    ByVal ranks() As Integer _
) As Array
C# public Array LockIndexBuffer(
    Type typeIndex,
    LockFlags flags,
    int[] ranks
);
Managed C++ public: Array* LockIndexBuffer(
    Type *typeIndex,
    LockFlags flags,
    int ranks __gc[]
);
JScript .NET public function LockIndexBuffer(
    typeIndex : Type,
    flags : LockFlags,
    ranks : int[]
) : Array;

Parameters

typeIndex System.Type. A Type Leave Site object that indicates the type of array data to return. This can be a value type or any type that contains only value types.
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.
ranks System.Int32[]. Array of one to three Int32 Leave Site values that indicate the dimensions of the returning Array Leave Site.

Return Value

System.Array . An Array Leave Site 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.
OutOfMemoryException Leave Site Microsoft® Direct3D® could not allocate sufficient memory to complete the call.

See Also


© 2004 Microsoft Corporation. All rights reserved. Terms of use.

Feedback? Please provide us with your comments on this topic.
For more help, visit the DirectX Developer Center