ID2D1DeviceContext::InvalidateEffectInputRectangle method

This indicates that a portion of an effect's input is invalid. This method can be called many times.

You can use this method to propagate invalid rectangles through an effect graph. You can query Direct2D using the GetEffectInvalidRectangles method.

Note  Direct2D does not automatically use these invalid rectangles to reduce the region of an effect that is rendered.

You can also use this method to invalidate caches that have accumulated while rendering effects that have the D2D1_PROPERTY_CACHED property set to true.

Syntax


HRESULT InvalidateEffectInputRectangle(
  [in]  ID2D1Effect *effect,
  UINT32 input,
  [in]  const D2D1_RECT_F *inputRectangle
);

Parameters

effect [in]

Type: ID2D1Effect*

The effect to invalidate.

input

Type: UINT32

The input index.

inputRectangle [in]

Type: const D2D1_RECT_F*

The rect to invalidate.

Return value

Type: HRESULT

The method returns an HRESULT. Possible values include, but are not limited to, those in the following table.

HRESULTDescription
S_OKNo error occurred.
E_OUTOFMEMORYDirect2D could not allocate sufficient memory to complete the call.
E_INVALIDARGAn invalid parameter was passed to the returning function.

 

Requirements

Minimum supported client

Windows 8 and Platform Update for Windows 7 [desktop apps | Windows Store apps]

Minimum supported server

Windows Server 2012 and Platform Update for Windows Server 2008 R2 [desktop apps | Windows Store apps]

Header

D2d1_1.h

DLL

D2d1.dll

See also

ID2D1DeviceContext

 

 

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.