IDirect3DCubeTexture9::AddDirtyRect Method

Adds a dirty region to a cube texture resource.

Syntax

HRESULT AddDirtyRect(      

    D3DCUBEMAP_FACES FaceType,
    CONST RECT *pDirtyRect
);

Parameters

FaceType

[in] Member of the D3DCUBEMAP_FACES enumerated type, identifying the cube map face.

pDirtyRect

[in] Pointer to a RECT structure, specifying the dirty region. Specifying NULL expands the dirty region to cover the entire cube 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 IDirect3DCubeTexture9::LockRect or IDirect3DVolumeTexture9::LockBox is called without D3DLOCK_NO_DIRTY_UPDATE or D3DLOCK_READONLY. Also, the destination surface of a IDirect3DDevice9::UpdateSurface call is marked dirty.

See Also

IDirect3DCubeTexture9::GetLevelDesc, IDirect3DCubeTexture9::LockRect, IDirect3DCubeTexture9::UnlockRect