ID2D1Effect::GetDirtyOutputRectangleCount method

[This documentation is preliminary and is subject to change.]

Applies to: desktop apps | Metro style apps

Gets the number of dirty output recangles that have propagated through the effect graph from the effect inputs.

Syntax

UINT32 GetDirtyOutputRectangleCount();

Parameters

This method has no parameters.

Return value

This method returns the number of dirty output rectangles.

Remarks

If there are no invalid rectangles, this method returns 0.

The first time this method, GetDirtyOutputRectangles, or DrawImage is called, any caches shared between the effect input and the effect output will be invalidated.

If any effect upstream has had its input changed or any properties changed, there will be a single infinitely large dirty rectangle.

The dirty rectangles are not cleared by this call. To clear the dirty rectangles on an effect, draw it with ID2D1DeviceContext::DrawImage. This will clear all accumulated dirty rectangles regardless of which part of the output image is drawn.

Requirements

Minimum supported client

Windows 8 Consumer Preview

Minimum supported server

Windows Server 8 Beta

Header

D2d1.h

DLL

D2d1.dll

See also

ID2D1Effect

ID2D1DeviceContext::DrawImage

ID2D1Effect::GetDirtyOutputRectangles

ID2D1Effect::SetDirtyInputRectangle

 

 

Build date: 2/14/2012