IDirect3DVolumeTexture9::AddDirtyBox method (d3d9helper.h)

Adds a dirty region to a volume texture resource.

Syntax

HRESULT AddDirtyBox(
  [in] const D3DBOX *pDirtyBox
);

Parameters

[in] pDirtyBox

Type: const D3DBOX*

Pointer to a D3DBOX structure, specifying the dirty region to add. Specifying NULL expands the dirty region to cover the entire volume texture.

Return value

Type: HRESULT

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) box is also dirty. Dirty regions are automatically recorded when LockBox is called without D3DLOCK_NO_DIRTY_UPDATE or D3DLOCK_READONLY.

Using D3DLOCK_NO_DIRTY_UPDATE and explicitly specifying dirty regions can be used to increase the efficiency of UpdateTexture. Using this method, applications can optimize what subset of a resource is copied by specifying dirty boxes on the resource. However, the dirty regions may be expanded to optimize alignment.

Requirements

See also

IDirect3DVolumeTexture9