Microsoft DirectX 9.0 SDK Update (October 2004)

Texture.AddDirtyRectangle Method

Language:

Note: This documentation is preliminary and is subject to change.

Adds a dirty region to a texture resource.

Definition

Visual Basic .NET Public Sub AddDirtyRectangle( _
    ByVal rect As Rectangle _
)
C# public void AddDirtyRectangle(
    Rectangle rect
);
Managed C++ public: void AddDirtyRectangle(
    Rectangle rect
);
JScript .NET public function AddDirtyRectangle(
    rect : Rectangle
);

Parameters

rect System.Drawing.Rectangle. A Rectangle Leave 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.


© 2004 Microsoft Corporation. All rights reserved. Terms of use.

Feedback? Please provide us with your comments on this topic.
For more help, visit the DirectX Developer Center