IVPBaseConfig::GetOverlaySurface method (vpconfig.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 GetOverlaySurface method queries whether the caller should use the driver's overlay surface. If so, the method returns a pointer to the surface.
Syntax
HRESULT GetOverlaySurface(
[out] LPDIRECTDRAWSURFACE *ppddOverlaySurface
);
Parameters
[out] ppddOverlaySurface
Address of a pointer to the IDirectDrawSurface interface. If the caller should use the driver's overlay surface, it sets this variable equal to the IDirectDrawSurface interface for the overlay surface.
Return value
Returns S_OK if the overlay surface object was returned.
Remarks
The Overlay Mixer uses this function to determine if the driver requires the Overlay Mixer to use the driver's overlay surface. If this function returns NULL, then the Overlay Mixer allocates its own surface.
Include Dvp.h and Vptype.h before Vpconfig.h.
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 | vpconfig.h |