IOverlay::GetClipList method (strmif.h)
[The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, IMFMediaEngine, and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
The GetClipList method retrieves the clipping list.
Syntax
HRESULT GetClipList(
[out] RECT *pSourceRect,
[in] RECT *pDestinationRect,
[out] RGNDATA **ppRgnData
);
Parameters
[out] pSourceRect
Pointer to the bounding client rectangle.
[in] pDestinationRect
Pointer to the destination rectangle.
[out] ppRgnData
Address of a pointer to the header and data describing clipping. If successful, free the allocated memory by calling CoTaskMemFree.
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
| Requirement | Value |
|---|---|
| Minimum supported client | Windows 2000 Professional [desktop apps only] |
| Minimum supported server | Windows 2000 Server [desktop apps only] |
| Target Platform | Windows |
| Header | strmif.h (include Dshow.h) |
| Library | Strmiids.lib |