IOverlayNotify::OnClipChange (Compact 2013)

  • Article

3/26/2014

This method provides notification that the window's visible region has changed. It is essential that any overlay hardware be updated to reflect the change to the visible region before returning from this method.

Syntax

HRESULT OnClipChange(
  RECT* pSourceRect,
  RECT* pDestinationRect,
  RGNDATA* pRgnData
);

Parameters

  • pSourceRect
    [in] A pointer to a RECT structure that defines the region of the video to use.
  • pDestinationRect
    [in] A pointer to a RECT structure that Video destination.
  • pRgnData
    [in] A pointer to a RGNDATA structure that continas the clipping information.

Return Value

Returns an HRESULT value that depends on the implementation.

HRESULT can be one of the following standard constants, or other values not listed.

Value

Description

E_FAIL

Failure.

E_POINTER

Null pointer argument.

E_INVALIDARG

Invalid argument.

E_NOTIMPL

Method is not supported.

S_OK or NOERROR

Success.

Remarks

The calls to OnClipChange happen in synchronization with the window. It is called with an empty clip list to freeze the video before the window moves, and then called again when the window has stabilized with the new clip list.

If the window rectangle is all zeros, the window is invisible. The filter must take a copy of the information if it needs to store it.

Requirements

Header

dshow.h

Library

Strmiids.lib

See Also

Reference

IOverlayNotify Interface