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

Article
11/06/2009

Locks a rectangle on a texture resource.

Definition

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

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

C++ public:
Array^ LockRectangle(
    Type^ typeLock,
    int level,
    Rectangle rect,
    LockFlags flags,
    array<int>^ ranks
);

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

Parameters

typeLock System.Type
A Type object that indicates the type of data to return. This can be a value type or any type that contains only value types.

level System.Int32
A level of the texture resource to lock.

rect System.Drawing.Rectangle
A Rectangle to lock. To expand the dirty region to cover the entire texture, omit this parameter.

flags Microsoft.DirectX.Direct3D.LockFlags
Zero or more locking flags 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 values that indicate the dimensions of the returning Array.

Return Value

System.Array
An Array object that describes the locked region.

Remarks

Textures created with Pool.Default are not lockable. Textures created in video memory are lockable when created with Usage.Dynamic. For more information about usages, see Usage.

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

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

Video memory textures cannot be locked, but must be modified by calling Device.UpdateSurface or Device.UpdateTexture. There are exceptions for some proprietary driver pixel formats that Microsoft DirectX 9.0 does not recognize. These can be locked.

See Also

Texture.UnlockRectangle

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

typeLock	System.Type A Type object that indicates the type of data to return. This can be a value type or any type that contains only value types.
level	System.Int32 A level of the texture resource to lock.
rect	System.Drawing.Rectangle A Rectangle to lock. To expand the dirty region to cover the entire texture, omit this parameter.
flags	Microsoft.DirectX.Direct3D.LockFlags Zero or more locking flags 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 values that indicate the dimensions of the returning Array.

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

Additional resources