ID2D1Effect::SetDirtyInputRectangle method

Applies to: desktop apps | Windows Store apps

Sets a rectangle on an effect input that should be considered dirty.

Syntax

void SetDirtyInputRectangle(
  UINT32 Input,
  [in]  const D2D1_RECT_F *inputRectangle
);

Parameters

  • Input
    Type: UINT32

    The effect input on which this dirty rectangle is being applied.

  • inputRectangle [in]
    Type: const D2D1_RECT_F*

    The rectangle that will be set to dirty on the effect input.

Return value

This method does not return a value.

Remarks

This method performs no action beyond recording that the given input rectangle should be considered dirty.

The application can use the GetDirtyOutputRectangles and GetDirtyOutputRectangleCount methods on a downstream effect in order to retrieve the propagation of the dirty rectangle through the graph.

The application can call SetDirtyInputRectangle as often as it wants.

Direct2D can accumulate the dirty rectangles in any way so long as invalid areas of the inputs are not lost. In particular it may:

  • Union dirty rectangles together to produce a larger conservative dirty rectangle.
  • Split overlapping rectangles into multiple non-overlapping rectangles.

The invalid rectangles accumulated on an effect are cleared by calling ID2D1DeviceContext::DrawImage. This will not take into account which parts of the output image are drawn.

Requirements

Minimum supported client

Windows 8

Minimum supported server

Windows Server 2012

Header

D2d1.h

DLL

D2d1.dll

See also

ID2D1Effect

ID2D1Effect::GetDirtyOutputRectangleCount

ID2D1DeviceContext::DrawImage

ID2D1Effect::GetDirtyOutputRectangles

 

 

Send comments about this topic to Microsoft

Build date: 9/5/2012