Edit

IMILBitmapEffectPrimitive::GetOutput method (mileffects.h)

  • Article

Performs pixel processing for the bitmap effect.

Syntax

HRESULT GetOutput(
  [in]          ULONG                         uiIndex,
  [in]          IMILBitmapEffectRenderContext *pContext,
  [in, out]     VARIANT_BOOL                  *pfModifyInPlace,
  [out, retval] IWICBitmapSource              **ppBitmapSource
);

Parameters

[in] uiIndex

Type: ULONG

A zero based index value indicating which output pin to use for output.

[in] pContext

Type: IMILBitmapEffectRenderContext*

The render context to use to determine how the effect should be rendered.

[in, out] pfModifyInPlace

Type: VARIANT_BOOL*

A value that indicates whether the effect should attempt to modify the input image in place.

[out, retval] ppBitmapSource

Type: IWICBitmapSource**

When this method returns, contains a pointer to the effect output.

Return value

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

If pfModifyInPlace is VARIANT_TRUE, the input image may be modified and returned. If the custom effect does not support in place modifications, set pfModifyInPlace to VARIANT_FALSE to indicate a new image was created.

Requirements

Requirement Value
Minimum supported client Windows XP with SP2, Windows Vista [desktop apps only]
Minimum supported server Windows Server 2008 [desktop apps only]
Target Platform Windows
Header mileffects.h
Redistributable Microsoft .Net 3.0