IAMOverlayFX::GetOverlayFX method (strmif.h)

The GetOverlayFX method retrieves the effects currently applied to the overlay surface, if any. The application can call this method while the filter graph is running.

Syntax

HRESULT GetOverlayFX(
  DWORD *lpdwOverlayFX
);

Parameters

lpdwOverlayFX

Pointer a variable that receives a value indicating which effects, if any, are currently applied to the overlay surface. The value is a logical combination of flags from the AMOVERLAYFX enumeration.

Return value

Returns an HRESULT value that depends on the implementation of the interface. The DirectShow implementation returns S_OK if successful, or E_POINTER to indicate a NULL pointer argument.

Requirements

   
Minimum supported client Windows XP [desktop apps only]
Minimum supported server Windows Server 2003 [desktop apps only]
Target Platform Windows
Header strmif.h (include Dshow.h)
Library Strmiids.lib

See also

Error and Success Codes

IAMOverlayFX Interface