Share via

VolumeTexture.AddDirtyBox(Box) Method (Microsoft.DirectX.Direct3D)

  • Article

Adds a dirty region to a volume texture resource.

Definition

Visual Basic Public Sub AddDirtyBox( _
    ByVal box As Box _
)
C# public void AddDirtyBox(
    Box box
);
C++ public:
void AddDirtyBox(
    Box box
);
JScript public function AddDirtyBox(
    box : Box
);

Parameters

box Microsoft.DirectX.Direct3D.Box
A Box structure that specifies the dirty region to add. Omitting this parameter expands the dirty region to cover the entire volume texture.

Remarks

For performance reasons, dirty regions are recorded only for level 0 of a texture. For sublevels, it is assumed that the corresponding (scaled) rectangle or box is also dirty. Dirty regions are automatically recorded when CubeTexture.LockRectangle is called without LockFlags.NoDirtyUpdate or LockFlags.ReadOnly.

Applications can specify which subset of a resource is copied in a Device.UpdateTexture call by specifying dirty regions. This can be used for optimization.

Exceptions

InvalidCallException

The method call is invalid. For example, a method's parameter might contain an invalid value.