BaseMesh.LockVertexBuffer(LockFlags) 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 flags As LockFlags _
) As GraphicsStream
C# public GraphicsStream LockVertexBuffer(
    LockFlags flags
);
C++ public:
GraphicsStream^ LockVertexBuffer(
    LockFlags flags
);
JScript public function LockVertexBuffer(
    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, ReadOnly, and NoOverWrite. For a description of the flags, see LockFlags.

Return Value

Microsoft.DirectX.GraphicsStream
A GraphicsStream object 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