IDDrawExclModeVideo::SetDDrawSurface method (strmif.h)

Article
02/22/2024

[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 SetDDrawSurface method specifies the DirectDraw surface to be used in subsequent drawing.

Syntax

HRESULT SetDDrawSurface(
  [in] IDirectDrawSurface *pDDrawSurface
);

Parameters

[in] pDDrawSurface

Pointer to the IDirectDrawSurface interface on the surface to use.

Return value

Returns an HRESULT value that depends on the implementation of the interface.

The current DirectShow implementation return values include the following.

Return value	Description
S_OK	Success.
E_INVALIDARG	Argument is invalid.
A DirectDraw error code	A DirectDraw error is encountered when trying to set the specified surface on the Overlay Mixer.

Remarks

A game application can use this to share its DirectDraw surface with the Overlay Mixer filter so that the video can be drawn in a specified surface. This surface must be associated with the object specified in IDDrawExclModeVideo::SetDDrawObject.

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