Microsoft DirectX 9.0 SDK Update (October 2004)

BaseMesh.LockIndexBuffer Method

Language:

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

Locks an index buffer and obtains the index buffer data.

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. 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.
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

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

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