IVPBaseConfig::SetSurfaceParameters 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 SetSurfaceParameters method informs the device of the layout of the overlay surface. The downstream filter (the Overlay Mixer, VBI Surface Allocator, or Video Port Manager) calls this method after it creates the overlay surface.
Syntax
HRESULT SetSurfaceParameters(
[in] DWORD dwPitch,
[in] DWORD dwXOrigin,
[in] DWORD dwYOrigin
);
Parameters
[in] dwPitch
Specifies the stride of the surface (also called the pitch), in pixels.
[in] dwXOrigin
Specifies the X-coordinate of the pixel at which valid data starts.
[in] dwYOrigin
Specifies the Y-coordinate of the pixel at which valid data starts.
Return value
Returns S_OK if successful, or E_NOTIMPL.
Remarks
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 |