IDDrawExclModeVideo::GetDDrawSurface method (strmif.h)

Article
07/27/2023

[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 GetDDrawSurface method retrieves the DirectDraw surface being used by the Overlay Mixer.

Syntax

HRESULT GetDDrawSurface(
  [out] IDirectDrawSurface **ppDDrawSurface,
  [out] BOOL               *pbUsingExternal
);

Parameters

[out] ppDDrawSurface

Address of a pointer to the IDirectDrawSurface interface that is being used by the Overlay Mixer.

[out] pbUsingExternal

Pointer to a variable that receives a Boolean value. It receives the value TRUE if the Overlay Mixer is using a DirectDraw surface specified by IDDrawExclModeVideo::SetDDrawSurface, or FALSE otherwise.

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

If the filter graph has not set a DirectDraw surface and the Overlay Mixer has not yet allocated one, then pDDrawSurface will be set to NULL and pdUsingExternal will be set to FALSE.

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