Share via

BaseMesh.LockVertexBuffer(Type,LockFlags,Int32[]) Method (Microsoft.DirectX.Direct3D)

  • Article

Locks a vertex buffer and obtains a pointer to the vertex buffer memory.

Definition

Visual Basic Public Function LockVertexBuffer( _
    ByVal typeVertex As TypeLeave Site, _
    ByVal flags As LockFlags, _
    ByVal ranks() As Integer _
) As ArrayLeave Site
C# public ArrayLeave Site LockVertexBuffer(
    TypeLeave Site typeVertex,
    LockFlags flags,
    int[] ranks
);
C++ public:
ArrayLeave Site^ LockVertexBuffer(
    TypeLeave Site^ typeVertex,
    LockFlags flags,
    array<int>^ ranks
);
JScript public function LockVertexBuffer(
    typeVertex : TypeLeave Site,
    flags : LockFlags,
    ranks : int[]
) : ArrayLeave Site;

Parameters

typeVertex System.Type
A TypeLeave 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, ReadOnly, and NoOverWrite. For a description of the flags, see LockFlags.
ranks System.Int32[]
Array of one to three Int32Leave Site values that indicate the dimensions of the returning ArrayLeave Site.

Return Value

System.Array
An ArrayLeave Site that represents the locked vertex buffer.

Remarks

When working with vertex 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 vertex 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