Surface.LockRectangle(Type,Rectangle,LockFlags,Int32,Int32[]) Method (Microsoft.DirectX.Direct3D)

Article
06/30/2006

Locks a rectangle on a surface.

Definition

Visual Basic Public Function LockRectangle( _
    ByVal typeLock As Type, _
    ByVal rect As Rectangle, _
    ByVal flags As LockFlags, _
    ByRef pitch As Integer, _
    ByVal ranks() As Integer _
) As Array

C# public Array LockRectangle(
    Type typeLock,
    Rectangle rect,
    LockFlags flags,
    out int pitch,
    int[] ranks
);

C++ public:
Array^ LockRectangle(
    Type^ typeLock,
    Rectangle rect,
    LockFlags flags,
    [Out] int% pitch,
    array<int>^ ranks
);

JScript public function LockRectangle(
    typeLock : Type,
    rect : Rectangle,
    flags : LockFlags,
    pitch : int,
    ranks : int[]
) : Array;

Parameters

typeLock System.Type
A Type object that specifies the type of array to create.

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.

ranks System.Int32[]
Array of one to three Int32 values that indicate the dimensions of the returned array. The maximum number of ranks allowed is three.

Return Value

System.Array
An Array 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.

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

typeLock	System.Type A Type object that specifies the type of array to create.
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.
ranks	System.Int32[] Array of one to three Int32 values that indicate the dimensions of the returned array. The maximum number of ranks allowed is three.

Surface.LockRectangle(Type,Rectangle,LockFlags,Int32,Int32[]) Method (Microsoft.DirectX.Direct3D)

Additional resources