IVMRImagePresenterExclModeConfig::SetXlcModeDDObjAndPrimarySurface method (strmif.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 SetXlcModeDDObjAndPrimarySurface method informs the VMR of the DirectDraw object and primary surface that were created by the application.

Syntax

HRESULT SetXlcModeDDObjAndPrimarySurface(
  [in] LPDIRECTDRAW7        lpDDObj,
  [in] LPDIRECTDRAWSURFACE7 lpPrimarySurf
);

Parameters

[in] lpDDObj

Specifies the Exclusive Mode DirectDraw object created by the application.

[in] lpPrimarySurf

Specifies the primary surface associated with the DirectDraw object.

Return value

The method returns an HRESULT. Possible values include those in the following table.

Return code Description
S_OK
The method succeeded.

Remarks

The procedure for configuring and using an application-defined DirectDraw Exclusive Mode object is described in DirectDraw Exclusive Mode.

Requirements

Requirement Value
Minimum supported client Windows XP with SP1 [desktop apps only]
Minimum supported server Windows Server 2003 [desktop apps only]
Target Platform Windows
Header strmif.h (include Dshow.h)
Library Strmiids.lib

See also

IVMRImagePresenterExclModeConfig Interface

IVMRImagePresenterExclModeConfig::GetXlcModeDDObjAndPrimarySurface

Using the Video Mixing Renderer