d3d9.dllAddDirtyRect
Microsoft DirectX 9.0 SDK Update (October 2004)

IDirect3DTexture9::AddDirtyRect Method


Adds a dirty region to a texture resource.

Syntax

HRESULT AddDirtyRect(      

    CONST RECT *pDirtyRect );

Parameters

pDirtyRect
[in] Pointer to a RECT World Wide Web link structure, specifying the dirty region to add. Specifying NULL expands the dirty region to cover the entire texture.

Return Value

If the method succeeds, the return value is D3D_OK.

If the method fails, the return value can be D3DERR_INVALIDCALL.

Remarks

For performance reasons, dirty regions are only recorded for level zero of a texture. For sublevels, it is assumed that the corresponding (scaled) rectangle or box is also dirty. Dirty regions are automatically recorded when LockRect or IDirect3DVolumeTexture9::LockBox is called without D3DLOCK_NO_DIRTY_UPDATE or D3DLOCK_READONLY. Also, the destination surface of IDirect3DDevice9::UpdateSurface is marked dirty.

Applications can optimize what subset of a resource is copied by specifying dirty regions on the resource.



© 2004 Microsoft Corporation. All rights reserved.
Feedback? Please provide us with your comments on this topic.
For more help, visit the DirectX Developer Center.