Share via

IOverlay::GetClipList

  • Article
 
Microsoft DirectShow 9.0

IOverlay::GetClipList

The GetClipList method retrieves the clipping list.

Syntax

  HRESULT GetClipList(
  RECT *pSourceRect,
  RECT *pDestinationRect,
  RGNDATA **ppRgnData
);

Parameters

pSourceRect

[out] Pointer to the bounding client rectangle.

pDestinationRect

[in] Pointer to the destination rectangle.

ppRgnData

[out] Address of a pointer to the header and data describing clipping. If successful, the Microsoft® Win32® CoTaskMemFree function should free memory.

Return Value

Returns S_OK if successful. If the method fails, it returns an HRESULT error code.

Remarks

The IOverlay implementation allocates the memory for the clipping rectangles, because it can vary in length. The filter calling this method should free the memory (using CoTaskMemFree) when it is finished with it.

Requirements

Header: Declared in Strmif.h; include Dshow.h.

Library: Use Strmiids.lib.

See Also