IDirectDrawVideo::GetSurfaceDesc method (amvideo.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 GetSurfaceDesc method retrieves a DDSURFACEDESC structure describing the current DirectDraw surface.
Syntax
HRESULT GetSurfaceDesc(
DDSURFACEDESC *pSurfaceDesc
);
Parameters
pSurfaceDesc
Pointer to a DDSURFACEDESC structure describing the current DirectDraw surface.
Return value
Returns an HRESULT value. If no surface has been allocated, this method will return E_FAIL. If a DCI primary surface is in use, the DDSURFACEDESC structure will not be filled in and the call will return S_FALSE.
Remarks
Surfaces are allocated only when the renderer is paused. After the renderer has been paused, it cannot release the surfaces when stopped.
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 | amvideo.h (include Dshow.h) |
| Library | Strmiids.lib |