Surface.LockRectangle Method

Language:

Locks a rectangle on a surface.

Definition

Visual Basic Public Function LockRectangle( _
    ByVal rect As Rectangle, _
    ByVal flags As LockFlags, _
    ByRef pitch As Integer _
) As GraphicsStream

C# public GraphicsStream LockRectangle(
    Rectangle rect,
    LockFlags flags,
    out int pitch
);

C++ public:
GraphicsStream^ LockRectangle(
    Rectangle rect,
    LockFlags flags,
    [Out] int% pitch
);

JScript public function LockRectangle(
    rect : Rectangle,
    flags : LockFlags,
    pitch : int
) : GraphicsStream;

Visual Basic	Public Function LockRectangle( _ ByVal rect As Rectangle, _ ByVal flags As LockFlags, _ ByRef pitch As Integer _ ) As GraphicsStream
C#	public GraphicsStream LockRectangle( Rectangle rect, LockFlags flags, out int pitch );
C++	public: GraphicsStream^ LockRectangle( Rectangle rect, LockFlags flags, [Out] int% pitch );
JScript	public function LockRectangle( rect : Rectangle, flags : LockFlags, pitch : int ) : GraphicsStream;

Parameters

rect System.Drawing.Rectangle
A Rectangle object that represents the rectangle to lock.

flags Microsoft.DirectX.Direct3D.LockFlags
A LockFlags object that specifies the type of lock to apply.

pitch System.Int32
Integer that represents the returned pitch value of the locked region.

Return Value

Microsoft.DirectX.GraphicsStream
A GraphicsStream object that describes the locked region.

Remarks

If LockFlags.DoNotWait is specified and the driver cannot lock the surface immediately, Surface.LockRectangle throws WasStillDrawingException so that an application can use the CPU cycles while waiting for the driver to lock the surface.

The only lockable format for a depth-stencil surface is Format.D16Lockable.

For performance reasons, dirty regions are recorded only for level zero of a texture. Dirty regions are automatically recorded when Surface.LockRectangle is called without LockFlags.NoDirtyUpdate or LockFlags.ReadOnly. For more information, see Device.UpdateTexture.

A multisample back buffer cannot be locked.

Exceptions

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

rect	System.Drawing.Rectangle A Rectangle object that represents the rectangle to lock.
flags	Microsoft.DirectX.Direct3D.LockFlags A LockFlags object that specifies the type of lock to apply.
pitch	System.Int32 Integer that represents the returned pitch value of the locked region.