CubeTexture.AddDirtyRectangle Method

Language:

Adds a dirty region to a cube texture resource.

Definition

Visual Basic Public Sub AddDirtyRectangle( _
    ByVal faceType As CubeMapFace, _
    ByVal rect As Rectangle _
)

C# public void AddDirtyRectangle(
    CubeMapFace faceType,
    Rectangle rect
);

C++ public:
void AddDirtyRectangle(
    CubeMapFace faceType,
    Rectangle rect
);

JScript public function AddDirtyRectangle(
    faceType : CubeMapFace,
    rect : Rectangle
);

Visual Basic	Public Sub AddDirtyRectangle( _ ByVal faceType As CubeMapFace, _ ByVal rect As Rectangle _ )
C#	public void AddDirtyRectangle( CubeMapFace faceType, Rectangle rect );
C++	public: void AddDirtyRectangle( CubeMapFace faceType, Rectangle rect );
JScript	public function AddDirtyRectangle( faceType : CubeMapFace, rect : Rectangle );

Parameters

faceType Microsoft.DirectX.Direct3D.CubeMapFace
A CubeMapFace value that identifies the face where the dirty region will be added. Omitting the sig_CubeMapFace_Rectangle parameter indicates that the dirty region should expand to cover the full face.

rect System.Drawing.Rectangle
A Rectangle that specifies the dirty region.

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.

Exceptions

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

faceType	Microsoft.DirectX.Direct3D.CubeMapFace A CubeMapFace value that identifies the face where the dirty region will be added. Omitting the sig_CubeMapFace_Rectangle parameter indicates that the dirty region should expand to cover the full face.
rect	System.Drawing.Rectangle A Rectangle that specifies the dirty region.