IVMRSurface9::GetSurface method (vmr9.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 GetSurface method retrieves the attached Direct3D surface.

Syntax

HRESULT GetSurface(
  [out] IDirect3DSurface9 **lplpSurface
);

Parameters

[out] lplpSurface

Address of a variable that receives an IDirect3DSurface9 interface pointer. The caller must release the interface.

Return value

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

Return code Description
S_OK
The method succeeded.
E_POINTER
lplpSurface is invalid.
E_FAIL
No Direct3D surface is attached to this sample.

Remarks

The media sample object increments the reference count on the returned interface. The caller must call Release on the interface.

Include DShow.h and D3d9.h before Vmr9.h.

Requirements

Requirement Value
Minimum supported client Windows XP with SP2 [desktop apps only]
Minimum supported server Windows Server 2003 R2 [desktop apps only]
Target Platform Windows
Header vmr9.h
Library Strmiids.lib

See also

IVMRSurface9 Interface

Using the Video Mixing Renderer