Method GetEffectRequiredInputRectangles

Namespace

PaintDotNet.Direct2D1

Assembly

PaintDotNet.Windows.dll

GetEffectRequiredInputRectangles(IDeviceEffect, in RectFloat?, ReadOnlySpan<EffectInputDescription>)

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

IReadOnlyList<RectFloat> GetEffectRequiredInputRectangles(IDeviceEffect renderEffect, in RectFloat? renderImageRectangle, ReadOnlySpan<EffectInputDescription> inputDescriptions)

Parameters

renderEffect IDeviceEffect

The effect whose output is being rendered.

renderImageRectangle RectFloat?

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

inputDescriptions ReadOnlySpan<EffectInputDescription>

A list of the inputs whose rectangles are being queried.

Returns

IReadOnlyList<RectFloat>

The input rectangles.

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.