Texture.AddDirtyRectangle Method (Rectangle)

[This documentation is for preview only, and is subject to change in later releases. Blank topics are included as placeholders.]

Adds a dirty region to a texture resource.

Namespace:  Microsoft.WindowsMobile.DirectX.Direct3D
Assembly:  Microsoft.WindowsMobile.DirectX (in Microsoft.WindowsMobile.DirectX.dll)

Syntax

'Declaration
Public Sub AddDirtyRectangle ( _
    rect As Rectangle _
)
'Usage
Dim instance As Texture
Dim rect As Rectangle

instance.AddDirtyRectangle(rect)
public void AddDirtyRectangle(
    Rectangle rect
)
public:
void AddDirtyRectangle(
    Rectangle rect
)
member AddDirtyRectangle : 
        rect:Rectangle -> unit 

Parameters

Exceptions

Exception Condition
InvalidCallException

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

Remarks

A dirty region is a portion of a buffer that has been marked obsolete; that is, it must be updated before it is displayed again.

Omitting the 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.

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

.NET Framework Security

Platforms

Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Version Information

.NET Compact Framework

Supported in: 3.5, 2.0

See Also

Reference

Texture Class

Texture Members

AddDirtyRectangle Overload

Microsoft.WindowsMobile.DirectX.Direct3D Namespace