IDirect3DMobileTexture::AddDirtyRect

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This method adds a dirty region to a texture resource.

Syntax

HRESULT AddDirtyRect(
  CONST RECT* pDirtyRect
);

Parameters

• pDirtyRect
  [in] Pointer to a RECT structure that specifies 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 D3DM_OK (see D3DM Values).

If the method fails, the return value can be D3DMERR_INVALIDCALL (see D3DMERR Values).

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 IDirect3DMobileTexture::LockRect is called without D3DMLOCK_NO_DIRTY_UPDATE or D3DMLOCK_READONLY (see D3DMLOCK Values). Also, the destination surface of a IDirect3DMobileDevice::CopyRects call is marked dirty.

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

Requirements

See Also

Reference

IDirect3DMobileTexture
D3DMLOCK Values

Other Resources

RECT