Microsoft DirectX 8.1 (Visual Basic)

Direct3DVolumeTexture8.AddDirtyBox

Adds a dirty region to a volume texture resource.

object.AddDirtyBox( _ 
    DirtyBox As Any)

Parts

object
Object expression that resolves to a Direct3DVolumeTexture8 object.
DirtyBox
a D3DBOX type, specifying the dirty region to add. Specifying ByVal 0 locks the entire volume texture.

Error Codes

If the method fails, an error is raised and Err.Number can be set to D3DERR_INVALIDCALL.

For information on trapping errors, see the Microsoft® Visual Basic® Error Handling topic.

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 LockBox is called without D3DLOCK_NO_DIRTY_UPDATE or D3DLOCK_READONLY. Also, the destination surface of a CopyRects call is marked dirty.

Applications can optimize what subset of a resource is copied by specifying boxes on the resource. However, the dirty regions may be expanded to optimize alignment.