Skip to main content
ID2D1DeviceContext::GetEffectRequiredInputRectangles method

Returns the input rectangles that are required to be supplied by the caller to produce the given output rectangle.

Syntax


HRESULT GetEffectRequiredInputRectangles(
  [in]                             ID2D1Effect                   *renderEffect,
  [in, optional]             const D2D1_RECT_F                   *renderImageRectangle,
  [in, size_is(inputCount)]  const D2D1_EFFECT_INPUT_DESCRIPTION *inputDescriptions,
  [out, size_is(inputCount)]       D2D1_RECT_F                   *requiredInputRects,
                                   UINT32                        inputCount
);

Parameters

renderEffect [in]

Type: ID2D1Effect*

The image whose output is being rendered.

renderImageRectangle [in, optional]

Type: const D2D1_RECT_F*

The portion of the output image whose inputs are being inspected.

inputDescriptions [in]

Type: const D2D1_EFFECT_INPUT_DESCRIPTION*

A list of the inputs whos rectangles are being queried.

requiredInputRects [out]

Type: D2D1_RECT_F*

The input rectangles returned to the caller.

inputCount

Type: UINT32

The number of inputs.

Return value

Type: HRESULT

A failure code, this will typically only be because an effect in the chain returned some error.

Remarks

The caller should be very careful not to place a reliance on the required input rectangles returned. Small changes for correctness to an effect's behavior can result in different rectangles being returned. In addition, different kinds of optimization applied inside the render can also influence the result.

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]

Minimum supported phone

Windows Phone 8.1 [Windows Phone Silverlight 8.1 and Windows Runtime apps]

Header

D2d1_1.h

DLL

D2d1.dll

See also

ID2D1DeviceContext