IDDrawExclModeVideo::SetDDrawObject 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 SetDDrawObject method sets the DirectDraw object to be used in subsequent drawing.

Syntax

HRESULT SetDDrawObject(
  [in] IDirectDraw *pDDrawObject
);

Parameters

[in] pDDrawObject

Pointer to the IDirectDraw interface on the object to use.

Return value

Returns an HRESULT value. Possible values include the following.

Return code	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 method to share its DirectDraw object with the Overlay Mixer filter, so that the video can be drawn in a specified surface, as set in IDDrawExclModeVideo::SetDDrawSurface.

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