Share via

Texture.AddDirtyRectangle(Rectangle) Method (Microsoft.DirectX.Direct3D)

  • Article

Adds a dirty region to a texture resource.

Definition

Visual Basic Public Sub AddDirtyRectangle( _
    ByVal rect As RectangleLeave Site _
)
C# public void AddDirtyRectangle(
    RectangleLeave Site rect
);
C++ public:
void AddDirtyRectangle(
    RectangleLeave Site rect
);
JScript public function AddDirtyRectangle(
    rect : RectangleLeave Site
);

Parameters

rect System.Drawing.Rectangle
A RectangleLeave Site structure that specifies the dirty region to add.

Remarks

Omitting the param_Rectangle_rect parameter expands the dirty region to cover the entire texture.

For performance reasons, dirty regions are recorded only for level zero of a texture. For sublevels, it is assumed that the corresponding (scaled) rectangle or box also is dirty. Dirty regions are automatically recorded when CubeTexture.LockRectangle is called without LockFlags.NoDirtyUpdate or LockFlags.ReadOnly.

Applications can specify which subset of a resource is copied in a Device.UpdateTexture call by specifying dirty regions. This can be used for optimization.

Exceptions

InvalidCallException

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