D3DImage.AddDirtyRect(Int32Rect) Method

Definition

Namespace:

System.Windows.Interop

Assembly:

PresentationCore.dll

Specifies the area of the back buffer that changed.

public:
 void AddDirtyRect(System::Windows::Int32Rect dirtyRect);

public void AddDirtyRect (System.Windows.Int32Rect dirtyRect);

member this.AddDirtyRect : System.Windows.Int32Rect -> unit

Public Sub AddDirtyRect (dirtyRect As Int32Rect)

Parameters

dirtyRect

Int32Rect

An Int32Rect that represents the area that changed.

Exceptions

InvalidOperationException

The bitmap has not been locked by a call to the Lock() or TryLock(Duration) methods.

-or-

The back buffer has not been assigned by a call to the SetBackBuffer(D3DResourceType, IntPtr) method.

ArgumentOutOfRangeException

One or more of the following conditions is true.

dirtyRect.X < 0

dirtyRect.Y < 0

dirtyRect.Width < 0 or dirtyRect.Width > PixelWidthdirtyRect.Height < 0 or dirtyRect.Height > PixelHeight

Examples

The following code example shows how to call the AddDirtyRect method to specify the changed region in the back buffer. For more information, see Walkthrough: Hosting Direct3D9 Content in WPF.

d3dimg.Lock();
// Repeatedly calling SetBackBuffer with the same IntPtr is 
// a no-op. There is no performance penalty.
d3dimg.SetBackBuffer(D3DResourceType.IDirect3DSurface9, pSurface);
HRESULT.Check(Render());
d3dimg.AddDirtyRect(new Int32Rect(0, 0, d3dimg.PixelWidth, d3dimg.PixelHeight));
d3dimg.Unlock();

Remarks

Call the AddDirtyRect method to indicate changes your code has made to the back buffer. To be rendered, the changed area on the back buffer must have a corresponding changed area on the D3DImage.

Call the SetBackBuffer and Lock methods before calling the AddDirtyRect method.

Call the Unlock method to copy the changed areas to the front buffer.

Note

After a few calls to the AddDirtyRect method, the changed areas are merged into a single area. This means you must have valid data outside of the changed areas.

See also

• Unlock()
• SetBackBuffer(D3DResourceType, IntPtr)